Class: Courier::Brands::BrandColors

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/brands/types/brand_colors.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(primary: nil, secondary: nil, tertiary: nil, additional_properties: nil) ⇒ Brands::BrandColors

Parameters:

  • primary (String) (defaults to: nil)
  • secondary (String) (defaults to: nil)
  • tertiary (String) (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
23
24
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 15

def initialize(primary: nil, secondary: nil, tertiary: nil, additional_properties: nil)
  # @type [String]
  @primary = primary
  # @type [String]
  @secondary = secondary
  # @type [String]
  @tertiary = tertiary
  # @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/brands/types/brand_colors.rb', line 8

def additional_properties
  @additional_properties
end

#primary ⇒ Object (readonly)

Returns the value of attribute primary.



8
9
10
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 8

def primary
  @primary
end

#secondary ⇒ Object (readonly)

Returns the value of attribute secondary.



8
9
10
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 8

def secondary
  @secondary
end

#tertiary ⇒ Object (readonly)

Returns the value of attribute tertiary.



8
9
10
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 8

def tertiary
  @tertiary
end

Class Method Details

.from_json(json_object:) ⇒ Brands::BrandColors

Deserialize a JSON object to an instance of BrandColors

Parameters:

  • json_object (JSON)

Returns:



30
31
32
33
34
35
36
37
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 30

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


50
51
52
53
54
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 50

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of BrandColors to a JSON object

Returns:

  • (JSON) 


42
43
44
 
# File 'lib/trycourier/brands/types/brand_colors.rb', line 42

def to_json(*_args)
  { "primary": @primary, "secondary": @secondary, "tertiary": @tertiary }.to_json
end