Class: Courier::Tenants::SubscriptionTopic

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/tenants/types/subscription_topic.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, status:, additional_properties: nil) ⇒ Tenants::SubscriptionTopic

Parameters:

  • id (String) —

    Topic ID

  • status (Tenants::SubscriptionTopicStatus)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 15

def initialize(id:, status:, additional_properties: nil)
  # @type [String] Topic ID
  @id = id
  # @type [Tenants::SubscriptionTopicStatus]
  @status = status
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



9
10
11
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 9

def additional_properties
  @additional_properties
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



9
10
11
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 9

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



9
10
11
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 9

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Tenants::SubscriptionTopic

Deserialize a JSON object to an instance of SubscriptionTopic

Parameters:

  • json_object (JSON)

Returns:



28
29
30
31
32
33
34
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 28

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  id = struct.id
  status = struct.status
  new(id: id, status: status, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


47
48
49
50
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 47

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.status.is_a?(Tenants::SubscriptionTopicStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SubscriptionTopic to a JSON object

Returns:

  • (JSON) 


39
40
41
 
# File 'lib/trycourier/tenants/types/subscription_topic.rb', line 39

def to_json(*_args)
  { "id": @id, "status": @status }.to_json
end