Class: Courier::Send::ChannelMetadata

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(utm: nil, additional_properties: nil) ⇒ Send::ChannelMetadata

Parameters:

  • utm (Send::Utm) (defaults to: nil)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
 
# File 'lib/trycourier/send/types/channel_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/channel_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/channel_metadata.rb', line 9

def utm
  @utm
end

Class Method Details

.from_json(json_object:) ⇒ Send::ChannelMetadata

Deserialize a JSON object to an instance of ChannelMetadata

Parameters:

  • json_object (JSON)

Returns:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/trycourier/send/types/channel_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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


48
49
50
 
# File 'lib/trycourier/send/types/channel_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 ChannelMetadata to a JSON object

Returns:

  • (JSON) 


40
41
42
 
# File 'lib/trycourier/send/types/channel_metadata.rb', line 40

def to_json(*_args)
  { "utm": @utm }.to_json
end