Class: Courier::Send::Metadata
- Inherits:
-
Object
- Object
- Courier::Send::Metadata
- Defined in:
- lib/trycourier/send/types/metadata.rb
Instance Attribute Summary collapse
-
#additional_properties ⇒ Object
readonly
Returns the value of attribute additional_properties.
-
#utm ⇒ Object
readonly
Returns the value of attribute utm.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Send::Metadata
Deserialize a JSON object to an instance of Metadata.
-
.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.
Instance Method Summary collapse
- #initialize(utm: nil, additional_properties: nil) ⇒ Send::Metadata constructor
-
#to_json(*_args) ⇒ JSON
Serialize an instance of Metadata to a JSON object.
Constructor Details
#initialize(utm: nil, additional_properties: nil) ⇒ Send::Metadata
14 15 16 17 18 19 |
# File 'lib/trycourier/send/types/metadata.rb', line 14 def initialize(utm: nil, additional_properties: nil) # @type [Send::Utm] @utm = utm # @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/send/types/metadata.rb', line 9 def additional_properties @additional_properties end |
#utm ⇒ Object (readonly)
Returns the value of attribute utm.
9 10 11 |
# File 'lib/trycourier/send/types/metadata.rb', line 9 def utm @utm end |
Class Method Details
.from_json(json_object:) ⇒ Send::Metadata
Deserialize a JSON object to an instance of Metadata
25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/trycourier/send/types/metadata.rb', line 25 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) if parsed_json["utm"].nil? utm = nil else utm = parsed_json["utm"].to_json utm = Send::Utm.from_json(json_object: utm) end new(utm: utm, 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.
48 49 50 |
# File 'lib/trycourier/send/types/metadata.rb', line 48 def self.validate_raw(obj:) obj.utm.nil? || Send::Utm.validate_raw(obj: obj.utm) end |
Instance Method Details
#to_json(*_args) ⇒ JSON
Serialize an instance of Metadata to a JSON object
40 41 42 |
# File 'lib/trycourier/send/types/metadata.rb', line 40 def to_json(*_args) { "utm": @utm }.to_json end |