Class: Courier::Brands::BrandsResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(paging:, results:, additional_properties: nil) ⇒ Brands::BrandsResponse

Parameters:

  • paging (Commons::Paging)
  • results (Array<Brands::Brand>)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



16
17
18
19
20
21
22
23
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 16

def initialize(paging:, results:, additional_properties: nil)
  # @type [Commons::Paging]
  @paging = paging
  # @type [Array<Brands::Brand>]
  @results = results
  # @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.



10
11
12
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 10

def additional_properties
  @additional_properties
end

#paging ⇒ Object (readonly)

Returns the value of attribute paging.



10
11
12
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 10

def paging
  @paging
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



10
11
12
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 10

def results
  @results
end

Class Method Details

.from_json(json_object:) ⇒ Brands::BrandsResponse

Deserialize a JSON object to an instance of BrandsResponse

Parameters:

  • json_object (JSON)

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 29

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["paging"].nil?
    paging = nil
  else
    paging = parsed_json["paging"].to_json
    paging = Commons::Paging.from_json(json_object: paging)
  end
  results = parsed_json["results"]&.map do |v|
    v = v.to_json
    Brands::Brand.from_json(json_object: v)
  end
  new(paging: paging, results: results, 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) 


56
57
58
59
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 56

def self.validate_raw(obj:)
  Commons::Paging.validate_raw(obj: obj.paging)
  obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of BrandsResponse to a JSON object

Returns:

  • (JSON) 


48
49
50
 
# File 'lib/trycourier/brands/types/brands_response.rb', line 48

def to_json(*_args)
  { "paging": @paging, "results": @results }.to_json
end