Class: Courier::Send::ListPatternRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(list_pattern: nil, data: nil, additional_properties: nil) ⇒ Send::ListPatternRecipient

Parameters:

  • list_pattern (String) (defaults to: nil)
  • data (Send::MESSAGE_DATA) (defaults to: nil)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
 
# File 'lib/trycourier/send/types/list_pattern_recipient.rb', line 15

def initialize(list_pattern: nil, data: nil, additional_properties: nil)
  # @type [String]
  @list_pattern = list_pattern
  # @type [Send::MESSAGE_DATA]
  @data = data
  # @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/list_pattern_recipient.rb', line 9

def additional_properties
  @additional_properties
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



9
10
11
 
# File 'lib/trycourier/send/types/list_pattern_recipient.rb', line 9

def data
  @data
end

#list_pattern ⇒ Object (readonly)

Returns the value of attribute list_pattern.



9
10
11
 
# File 'lib/trycourier/send/types/list_pattern_recipient.rb', line 9

def list_pattern
  @list_pattern
end

Class Method Details

.from_json(json_object:) ⇒ Send::ListPatternRecipient

Deserialize a JSON object to an instance of ListPatternRecipient

Parameters:

  • json_object (JSON)

Returns:



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

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


47
48
49
50
 
# File 'lib/trycourier/send/types/list_pattern_recipient.rb', line 47

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of ListPatternRecipient to a JSON object

Returns:

  • (JSON) 


39
40
41
 
# File 'lib/trycourier/send/types/list_pattern_recipient.rb', line 39

def to_json(*_args)
  { "list_pattern": @list_pattern, "data": @data }.to_json
end