Class: Courier::Commons::RecipientPreferences

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(categories: nil, notifications: nil, additional_properties: nil) ⇒ Commons::RecipientPreferences

Parameters:



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

def initialize(categories: nil, notifications: nil, additional_properties: nil)
  # @type [Commons::NOTIFICATION_PREFERENCES]
  @categories = categories
  # @type [Commons::NOTIFICATION_PREFERENCES]
  @notifications = notifications
  # @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/recipient_preferences.rb', line 9

def additional_properties
  @additional_properties
end

#categories ⇒ Object (readonly)

Returns the value of attribute categories.



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

def categories
  @categories
end

#notifications ⇒ Object (readonly)

Returns the value of attribute notifications.



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

def notifications
  @notifications
end

Class Method Details

.from_json(json_object:) ⇒ Commons::RecipientPreferences

Deserialize a JSON object to an instance of RecipientPreferences

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  categories = struct.categories
  notifications = struct.notifications
  new(categories: categories, notifications: notifications, 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/commons/types/recipient_preferences.rb', line 47

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of RecipientPreferences to a JSON object

Returns:

  • (JSON) 


39
40
41
 
# File 'lib/trycourier/commons/types/recipient_preferences.rb', line 39

def to_json(*_args)
  { "categories": @categories, "notifications": @notifications }.to_json
end