Class: Courier::Profiles::SubscribeToListsRequestListObject

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(list_id:, preferences: nil, additional_properties: nil) ⇒ Profiles::SubscribeToListsRequestListObject

Parameters:

  • list_id (String)
  • preferences (Commons::RecipientPreferences) (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/profiles/types/subscribe_to_lists_request_list_object.rb', line 15

def initialize(list_id:, preferences: nil, additional_properties: nil)
  # @type [String]
  @list_id = list_id
  # @type [Commons::RecipientPreferences]
  @preferences = preferences
  # @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/profiles/types/subscribe_to_lists_request_list_object.rb', line 9

def additional_properties
  @additional_properties
end

#list_id ⇒ Object (readonly)

Returns the value of attribute list_id.



9
10
11
 
# File 'lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb', line 9

def list_id
  @list_id
end

#preferences ⇒ Object (readonly)

Returns the value of attribute preferences.



9
10
11
 
# File 'lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb', line 9

def preferences
  @preferences
end

Class Method Details

.from_json(json_object:) ⇒ Profiles::SubscribeToListsRequestListObject

Deserialize a JSON object to an instance of SubscribeToListsRequestListObject

Parameters:

  • json_object (JSON)

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb', line 28

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  list_id = struct.listId
  if parsed_json["preferences"].nil?
    preferences = nil
  else
    preferences = parsed_json["preferences"].to_json
    preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
  end
  new(list_id: list_id, preferences: preferences, 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) 


52
53
54
55
 
# File 'lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb', line 52

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SubscribeToListsRequestListObject to a JSON object

Returns:

  • (JSON) 


44
45
46
 
# File 'lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb', line 44

def to_json(*_args)
  { "listId": @list_id, "preferences": @preferences }.to_json
end