Class: CtdDocumentation::GetCustomAttributeCategoriesResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/get_custom_attribute_categories_response.rb

Overview

GetCustomAttributeCategoriesResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(count_filtered = SKIP, count_total = SKIP, count_in_page = SKIP, objects = SKIP) ⇒ GetCustomAttributeCategoriesResponse

Returns a new instance of GetCustomAttributeCategoriesResponse.



53
54
55
56
57
58
59
60
61
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 53

def initialize(count_filtered = SKIP,
               count_total = SKIP,
               count_in_page = SKIP,
               objects = SKIP)
  @count_filtered = count_filtered unless count_filtered == SKIP
  @count_total = count_total unless count_total == SKIP
  @count_in_page = count_in_page unless count_in_page == SKIP
  @objects = objects unless objects == SKIP
end

Instance Attribute Details

#count_filtered ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 14

def count_filtered
  @count_filtered
end

#count_in_page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 22

def count_in_page
  @count_in_page
end

#count_total ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 18

def count_total
  @count_total
end

#objects ⇒ List of CustomAttributeCategory

TODO: Write general description for this method

Returns:



26
27
28
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 26

def objects
  @objects
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  count_filtered =
    hash.key?('count_filtered') ? hash['count_filtered'] : SKIP
  count_total = hash.key?('count_total') ? hash['count_total'] : SKIP
  count_in_page = hash.key?('count_in_page') ? hash['count_in_page'] : SKIP
  # Parameter is an array, so we need to iterate through it
  objects = nil
  unless hash['objects'].nil?
    objects = []
    hash['objects'].each do |structure|
      objects << (CustomAttributeCategory.from_hash(structure) if structure)
    end
  end

  objects = SKIP unless hash.key?('objects')

  # Create object from extracted values.
  GetCustomAttributeCategoriesResponse.new(count_filtered,
                                           count_total,
                                           count_in_page,
                                           objects)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['count_filtered'] = 'count_filtered'
  @_hash['count_total'] = 'count_total'
  @_hash['count_in_page'] = 'count_in_page'
  @_hash['objects'] = 'objects'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/ctd_documentation/models/get_custom_attribute_categories_response.rb', line 39

def self.optionals
  %w[
    count_filtered
    count_total
    count_in_page
    objects
  ]
end