Class: Courier::Send::InvalidListRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_id:, list_pattern:, additional_properties: nil) ⇒ Send::InvalidListRecipient

Parameters:

  • user_id (String)
  • list_pattern (String)
  • 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/invalid_list_recipient.rb', line 14

def initialize(user_id:, list_pattern:, additional_properties: nil)
  # @type [String]
  @user_id = user_id
  # @type [String]
  @list_pattern = list_pattern
  # @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/invalid_list_recipient.rb', line 8

def additional_properties
  @additional_properties
end

#list_pattern ⇒ Object (readonly)

Returns the value of attribute list_pattern.



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

def list_pattern
  @list_pattern
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.from_json(json_object:) ⇒ Send::InvalidListRecipient

Deserialize a JSON object to an instance of InvalidListRecipient

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  user_id = struct.user_id
  list_pattern = struct.list_pattern
  new(user_id: user_id, list_pattern: list_pattern, 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/invalid_list_recipient.rb', line 46

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of InvalidListRecipient to a JSON object

Returns:

  • (JSON) 


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

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