Class: Courier::Send::EmailHead

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/send/types/email_head.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(inherit_default:, content: nil, additional_properties: nil) ⇒ Send::EmailHead

Parameters:

  • inherit_default (Boolean)
  • content (String) (defaults to: nil)
  • 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/send/types/email_head.rb', line 14

def initialize(inherit_default:, content: nil, additional_properties: nil)
  # @type [Boolean]
  @inherit_default = inherit_default
  # @type [String]
  @content = content
  # @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/send/types/email_head.rb', line 8

def additional_properties
  @additional_properties
end

#content ⇒ Object (readonly)

Returns the value of attribute content.



8
9
10
 
# File 'lib/trycourier/send/types/email_head.rb', line 8

def content
  @content
end

#inherit_default ⇒ Object (readonly)

Returns the value of attribute inherit_default.



8
9
10
 
# File 'lib/trycourier/send/types/email_head.rb', line 8

def inherit_default
  @inherit_default
end

Class Method Details

.from_json(json_object:) ⇒ Send::EmailHead

Deserialize a JSON object to an instance of EmailHead

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  inherit_default = struct.inheritDefault
  content = struct.content
  new(inherit_default: inherit_default, content: content, 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/send/types/email_head.rb', line 46

def self.validate_raw(obj:)
  obj.inherit_default.is_a?(Boolean) != false || raise("Passed value for field obj.inherit_default is not the expected type, validation failed.")
  obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of EmailHead to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/send/types/email_head.rb', line 38

def to_json(*_args)
  { "inheritDefault": @inherit_default, "content": @content }.to_json
end