Class: TogaiClient::PurchaseListResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/purchase_list_response.rb

Overview

Represents a Purchase for List Response

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseListResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/togai_client/models/purchase_list_response.rb', line 126

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::PurchaseListResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::PurchaseListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'price_plan_id')
    self.price_plan_id = attributes[:'price_plan_id']
  end

  if attributes.key?(:'price_plan_name')
    self.price_plan_name = attributes[:'price_plan_name']
  end

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.key?(:'rate_card_quantities')
    if (value = attributes[:'rate_card_quantities']).is_a?(Hash)
      self.rate_card_quantities = value
    end
  end

  if attributes.key?(:'price_plan_version')
    self.price_plan_version = attributes[:'price_plan_version']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'idempotency_key')
    self.idempotency_key = attributes[:'idempotency_key']
  end

  if attributes.key?(:'purchase_plan')
    self.purchase_plan = attributes[:'purchase_plan']
  end

  if attributes.key?(:'wallet_topup_details')
    self.wallet_topup_details = attributes[:'wallet_topup_details']
  end

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.key?(:'invoice_currency')
    self.invoice_currency = attributes[:'invoice_currency']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end
end

Instance Attribute Details

#created_atObject

Returns the value of attribute created_at.



43
44
45
# File 'lib/togai_client/models/purchase_list_response.rb', line 43

def created_at
  @created_at
end

#idObject

Returns the value of attribute id.



19
20
21
# File 'lib/togai_client/models/purchase_list_response.rb', line 19

def id
  @id
end

#idempotency_keyObject

Returns the value of attribute idempotency_key.



33
34
35
# File 'lib/togai_client/models/purchase_list_response.rb', line 33

def idempotency_key
  @idempotency_key
end

#invoice_currencyObject

Returns the value of attribute invoice_currency.



41
42
43
# File 'lib/togai_client/models/purchase_list_response.rb', line 41

def invoice_currency
  @invoice_currency
end

#priceObject

Returns the value of attribute price.



39
40
41
# File 'lib/togai_client/models/purchase_list_response.rb', line 39

def price
  @price
end

#price_plan_idObject

Returns the value of attribute price_plan_id.



21
22
23
# File 'lib/togai_client/models/purchase_list_response.rb', line 21

def price_plan_id
  @price_plan_id
end

#price_plan_nameObject

Returns the value of attribute price_plan_name.



23
24
25
# File 'lib/togai_client/models/purchase_list_response.rb', line 23

def price_plan_name
  @price_plan_name
end

#price_plan_versionObject

Returns the value of attribute price_plan_version.



29
30
31
# File 'lib/togai_client/models/purchase_list_response.rb', line 29

def price_plan_version
  @price_plan_version
end

#purchase_planObject

Returns the value of attribute purchase_plan.



35
36
37
# File 'lib/togai_client/models/purchase_list_response.rb', line 35

def purchase_plan
  @purchase_plan
end

#quantityObject

Returns the value of attribute quantity.



25
26
27
# File 'lib/togai_client/models/purchase_list_response.rb', line 25

def quantity
  @quantity
end

#rate_card_quantitiesObject

Returns the value of attribute rate_card_quantities.



27
28
29
# File 'lib/togai_client/models/purchase_list_response.rb', line 27

def rate_card_quantities
  @rate_card_quantities
end

#statusObject

Returns the value of attribute status.



31
32
33
# File 'lib/togai_client/models/purchase_list_response.rb', line 31

def status
  @status
end

#typeObject

Returns the value of attribute type.



47
48
49
# File 'lib/togai_client/models/purchase_list_response.rb', line 47

def type
  @type
end

#updated_atObject

Returns the value of attribute updated_at.



45
46
47
# File 'lib/togai_client/models/purchase_list_response.rb', line 45

def updated_at
  @updated_at
end

#wallet_topup_detailsObject

Returns the value of attribute wallet_topup_details.



37
38
39
# File 'lib/togai_client/models/purchase_list_response.rb', line 37

def wallet_topup_details
  @wallet_topup_details
end

Class Method Details

._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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/togai_client/models/purchase_list_response.rb', line 306

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = TogaiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



93
94
95
# File 'lib/togai_client/models/purchase_list_response.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/togai_client/models/purchase_list_response.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'price_plan_id' => :'pricePlanId',
    :'price_plan_name' => :'pricePlanName',
    :'quantity' => :'quantity',
    :'rate_card_quantities' => :'rateCardQuantities',
    :'price_plan_version' => :'pricePlanVersion',
    :'status' => :'status',
    :'idempotency_key' => :'idempotencyKey',
    :'purchase_plan' => :'purchasePlan',
    :'wallet_topup_details' => :'walletTopupDetails',
    :'price' => :'price',
    :'invoice_currency' => :'invoiceCurrency',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'type' => :'type'
  }
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/togai_client/models/purchase_list_response.rb', line 282

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



119
120
121
122
# File 'lib/togai_client/models/purchase_list_response.rb', line 119

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/togai_client/models/purchase_list_response.rb', line 98

def self.openapi_types
  {
    :'id' => :'String',
    :'price_plan_id' => :'String',
    :'price_plan_name' => :'String',
    :'quantity' => :'Integer',
    :'rate_card_quantities' => :'Hash<String, Float>',
    :'price_plan_version' => :'Integer',
    :'status' => :'PurchaseStatus',
    :'idempotency_key' => :'String',
    :'purchase_plan' => :'PricePlanDetails',
    :'wallet_topup_details' => :'WalletTopupDetails',
    :'price' => :'Float',
    :'invoice_currency' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'type' => :'PurchaseType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/togai_client/models/purchase_list_response.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      price_plan_id == o.price_plan_id &&
      price_plan_name == o.price_plan_name &&
      quantity == o.quantity &&
      rate_card_quantities == o.rate_card_quantities &&
      price_plan_version == o.price_plan_version &&
      status == o.status &&
      idempotency_key == o.idempotency_key &&
      purchase_plan == o.purchase_plan &&
      wallet_topup_details == o.wallet_topup_details &&
      price == o.price &&
      invoice_currency == o.invoice_currency &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      type == o.type
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



377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/togai_client/models/purchase_list_response.rb', line 377

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
# File 'lib/togai_client/models/purchase_list_response.rb', line 269

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



275
276
277
# File 'lib/togai_client/models/purchase_list_response.rb', line 275

def hash
  [id, price_plan_id, price_plan_name, quantity, rate_card_quantities, price_plan_version, status, idempotency_key, purchase_plan, wallet_topup_details, price, invoice_currency, created_at, updated_at, type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/togai_client/models/purchase_list_response.rb', line 212

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



353
354
355
# File 'lib/togai_client/models/purchase_list_response.rb', line 353

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/togai_client/models/purchase_list_response.rb', line 359

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



347
348
349
# File 'lib/togai_client/models/purchase_list_response.rb', line 347

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



236
237
238
239
240
241
242
243
# File 'lib/togai_client/models/purchase_list_response.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @status.nil?
  return false if @created_at.nil?
  return false if @type.nil?
  true
end