Class: UltracartClient::ResultSet

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/result_set.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResultSet

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



61
62
63
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
89
90
 
# File 'lib/ultracart_api/models/result_set.rb', line 61

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.has_key?(:'limit')
    self.limit = attributes[:'limit']
  end

  if attributes.has_key?(:'more')
    self.more = attributes[:'more']
  end

  if attributes.has_key?(:'next_offset')
    self.next_offset = attributes[:'next_offset']
  end

  if attributes.has_key?(:'offset')
    self.offset = attributes[:'offset']
  end

  if attributes.has_key?(:'total_records')
    self.total_records = attributes[:'total_records']
  end
end

Instance Attribute Details

#count ⇒ Object

Number of results in this set



18
19
20
 
# File 'lib/ultracart_api/models/result_set.rb', line 18

def count
  @count
end

#limit ⇒ Object

Maximum number of results that can be returned in a set



21
22
23
 
# File 'lib/ultracart_api/models/result_set.rb', line 21

def limit
  @limit
end

#more ⇒ Object

True if there are more results to query



24
25
26
 
# File 'lib/ultracart_api/models/result_set.rb', line 24

def more
  @more
end

#next_offset ⇒ Object

The next offset that you should query to retrieve more results



27
28
29
 
# File 'lib/ultracart_api/models/result_set.rb', line 27

def next_offset
  @next_offset
end

#offset ⇒ Object

Offset of this result set (zero based)



30
31
32
 
# File 'lib/ultracart_api/models/result_set.rb', line 30

def offset
  @offset
end

#total_records ⇒ Object

The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.



33
34
35
 
# File 'lib/ultracart_api/models/result_set.rb', line 33

def total_records
  @total_records
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/ultracart_api/models/result_set.rb', line 36

def self.attribute_map
  {
    :'count' => :'count',
    :'limit' => :'limit',
    :'more' => :'more',
    :'next_offset' => :'next_offset',
    :'offset' => :'offset',
    :'total_records' => :'total_records'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ultracart_api/models/result_set.rb', line 48

def self.swagger_types
  {
    :'count' => :'Integer',
    :'limit' => :'Integer',
    :'more' => :'BOOLEAN',
    :'next_offset' => :'Integer',
    :'offset' => :'Integer',
    :'total_records' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ultracart_api/models/result_set.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      count == o.count &&
      limit == o.limit &&
      more == o.more &&
      next_offset == o.next_offset &&
      offset == o.offset &&
      total_records == o.total_records
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/ultracart_api/models/result_set.rb', line 154

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ultracart_api/models/result_set.rb', line 220

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ultracart_api/models/result_set.rb', line 133

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/ultracart_api/models/result_set.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/ultracart_api/models/result_set.rb', line 126

def hash
  [count, limit, more, next_offset, offset, total_records].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



94
95
96
97
 
# File 'lib/ultracart_api/models/result_set.rb', line 94

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
 
# File 'lib/ultracart_api/models/result_set.rb', line 200

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
 
# File 'lib/ultracart_api/models/result_set.rb', line 206

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



194
195
196
 
# File 'lib/ultracart_api/models/result_set.rb', line 194

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



101
102
103
 
# File 'lib/ultracart_api/models/result_set.rb', line 101

def valid?
  true
end