Class: Courier::Profiles::Intercom

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/profiles/types/intercom.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(from:, to:, additional_properties: nil) ⇒ Profiles::Intercom

Parameters:

  • from (String)
  • to (Profiles::IntercomRecipient)
  • 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/profiles/types/intercom.rb', line 15

def initialize(from:, to:, additional_properties: nil)
  # @type [String]
  @from = from
  # @type [Profiles::IntercomRecipient]
  @to = to
  # @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/profiles/types/intercom.rb', line 9

def additional_properties
  @additional_properties
end

#from ⇒ Object (readonly)

Returns the value of attribute from.



9
10
11
 
# File 'lib/trycourier/profiles/types/intercom.rb', line 9

def from
  @from
end

#to ⇒ Object (readonly)

Returns the value of attribute to.



9
10
11
 
# File 'lib/trycourier/profiles/types/intercom.rb', line 9

def to
  @to
end

Class Method Details

.from_json(json_object:) ⇒ Profiles::Intercom

Deserialize a JSON object to an instance of Intercom

Parameters:

  • json_object (JSON)

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/trycourier/profiles/types/intercom.rb', line 28

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  from = struct.from
  if parsed_json["to"].nil?
    to = nil
  else
    to = parsed_json["to"].to_json
    to = Profiles::IntercomRecipient.from_json(json_object: to)
  end
  new(from: from, to: to, 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) 


52
53
54
55
 
# File 'lib/trycourier/profiles/types/intercom.rb', line 52

def self.validate_raw(obj:)
  obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
  Profiles::IntercomRecipient.validate_raw(obj: obj.to)
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of Intercom to a JSON object

Returns:

  • (JSON) 


44
45
46
 
# File 'lib/trycourier/profiles/types/intercom.rb', line 44

def to_json(*_args)
  { "from": @from, "to": @to }.to_json
end