Class: Courier::Commons::ChannelPreference

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel:, additional_properties: nil) ⇒ Commons::ChannelPreference

Parameters:

  • channel (Commons::ChannelClassification)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(channel:, additional_properties: nil)
  # @type [Commons::ChannelClassification]
  @channel = channel
  # @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/commons/types/channel_preference.rb', line 9

def additional_properties
  @additional_properties
end

#channel ⇒ Object (readonly)

Returns the value of attribute channel.



9
10
11
 
# File 'lib/trycourier/commons/types/channel_preference.rb', line 9

def channel
  @channel
end

Class Method Details

.from_json(json_object:) ⇒ Commons::ChannelPreference

Deserialize a JSON object to an instance of ChannelPreference

Parameters:

  • json_object (JSON)

Returns:



25
26
27
28
29
30
 
# File 'lib/trycourier/commons/types/channel_preference.rb', line 25

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


43
44
45
 
# File 'lib/trycourier/commons/types/channel_preference.rb', line 43

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of ChannelPreference to a JSON object

Returns:

  • (JSON) 


35
36
37
 
# File 'lib/trycourier/commons/types/channel_preference.rb', line 35

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