Class: Courier::Commons::Email

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/commons/types/email.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(footer:, header:, additional_properties: nil) ⇒ Commons::Email

Parameters:

  • footer (Object)
  • header (Object)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
 
# File 'lib/trycourier/commons/types/email.rb', line 14

def initialize(footer:, header:, additional_properties: nil)
  # @type [Object]
  @footer = footer
  # @type [Object]
  @header = header
  # @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.



8
9
10
 
# File 'lib/trycourier/commons/types/email.rb', line 8

def additional_properties
  @additional_properties
end

#footer ⇒ Object (readonly)

Returns the value of attribute footer.



8
9
10
 
# File 'lib/trycourier/commons/types/email.rb', line 8

def footer
  @footer
end

#header ⇒ Object (readonly)

Returns the value of attribute header.



8
9
10
 
# File 'lib/trycourier/commons/types/email.rb', line 8

def header
  @header
end

Class Method Details

.from_json(json_object:) ⇒ Commons::Email

Deserialize a JSON object to an instance of Email

Parameters:

  • json_object (JSON)

Returns:



27
28
29
30
31
32
33
 
# File 'lib/trycourier/commons/types/email.rb', line 27

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  footer = struct.footer
  header = struct.header
  new(footer: footer, header: header, 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) 


46
47
48
49
 
# File 'lib/trycourier/commons/types/email.rb', line 46

def self.validate_raw(obj:)
  obj.footer.is_a?(Object) != false || raise("Passed value for field obj.footer is not the expected type, validation failed.")
  obj.header.is_a?(Object) != false || raise("Passed value for field obj.header is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of Email to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/commons/types/email.rb', line 38

def to_json(*_args)
  { "footer": @footer, "header": @header }.to_json
end