Class: TogaiClient::Proposal

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Proposal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/togai_client/models/proposal.rb', line 165

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::Proposal` 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::Proposal`. 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?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'price_plan_id')
    self.price_plan_id = attributes[:'price_plan_id']
  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?(:'idempotency_key')
    self.idempotency_key = attributes[:'idempotency_key']
  end

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

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

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

  if attributes.key?(:'wallet_topup_details')
    self.wallet_topup_details = attributes[:'wallet_topup_details']
  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?(:'effective_from')
    self.effective_from = attributes[:'effective_from']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



20
21
22
 
# File 'lib/togai_client/models/proposal.rb', line 20

def 
  @account_id
end

#association_override ⇒ Object

Returns the value of attribute association_override.



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

def association_override
  @association_override
end

#comment ⇒ Object

Returns the value of attribute comment.



59
60
61
 
# File 'lib/togai_client/models/proposal.rb', line 59

def comment
  @comment
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#effective_from ⇒ Object

Returns the value of attribute effective_from.



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

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Returns the value of attribute effective_until.



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

def effective_until
  @effective_until
end

#expiry_date ⇒ Object

Returns the value of attribute expiry_date.



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

def expiry_date
  @expiry_date
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/togai_client/models/proposal.rb', line 18

def id
  @id
end

#idempotency_key ⇒ Object

Returns the value of attribute idempotency_key.



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

def idempotency_key
  @idempotency_key
end

#invoice_currency ⇒ Object

Returns the value of attribute invoice_currency.



53
54
55
 
# File 'lib/togai_client/models/proposal.rb', line 53

def invoice_currency
  @invoice_currency
end

#invoice_id ⇒ Object

Returns the value of attribute invoice_id.



51
52
53
 
# File 'lib/togai_client/models/proposal.rb', line 51

def invoice_id
  @invoice_id
end

#payment_mode ⇒ Object

Returns the value of attribute payment_mode.



61
62
63
 
# File 'lib/togai_client/models/proposal.rb', line 61

def payment_mode
  @payment_mode
end

#price ⇒ Object

Returns the value of attribute price.



49
50
51
 
# File 'lib/togai_client/models/proposal.rb', line 49

def price
  @price
end

#price_plan_id ⇒ Object

Id of the price plan, Required for ENTITLEMENT_GRANT, ASSOCIATION purchase



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

def price_plan_id
  @price_plan_id
end

#price_plan_version ⇒ Object

Returns the value of attribute price_plan_version.



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

def price_plan_version
  @price_plan_version
end

#proposal_response_date ⇒ Object

Returns the value of attribute proposal_response_date.



63
64
65
 
# File 'lib/togai_client/models/proposal.rb', line 63

def proposal_response_date
  @proposal_response_date
end

#purchase_plan_override ⇒ Object

Returns the value of attribute purchase_plan_override.



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

def purchase_plan_override
  @purchase_plan_override
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#rate_card_quantities ⇒ Object

Returns the value of attribute rate_card_quantities.



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

def rate_card_quantities
  @rate_card_quantities
end

#status ⇒ Object

Returns the value of attribute status.



55
56
57
 
# File 'lib/togai_client/models/proposal.rb', line 55

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



57
58
59
 
# File 'lib/togai_client/models/proposal.rb', line 57

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#wallet_topup_details ⇒ Object

Returns the value of attribute wallet_topup_details.



37
38
39
 
# File 'lib/togai_client/models/proposal.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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/togai_client/models/proposal.rb', line 449

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/togai_client/models/proposal.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/togai_client/models/proposal.rb', line 88

def self.attribute_map
  {
    :'id' => :'id',
    :'account_id' => :'accountId',
    :'price_plan_id' => :'pricePlanId',
    :'quantity' => :'quantity',
    :'rate_card_quantities' => :'rateCardQuantities',
    :'idempotency_key' => :'idempotencyKey',
    :'price_plan_version' => :'pricePlanVersion',
    :'purchase_plan_override' => :'purchasePlanOverride',
    :'association_override' => :'associationOverride',
    :'wallet_topup_details' => :'walletTopupDetails',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'effective_from' => :'effectiveFrom',
    :'effective_until' => :'effectiveUntil',
    :'expiry_date' => :'expiryDate',
    :'price' => :'price',
    :'invoice_id' => :'invoiceId',
    :'invoice_currency' => :'invoiceCurrency',
    :'status' => :'status',
    :'type' => :'type',
    :'comment' => :'comment',
    :'payment_mode' => :'paymentMode',
    :'proposal_response_date' => :'proposalResponseDate'
  }
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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/togai_client/models/proposal.rb', line 425

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



157
158
159
160
161
 
# File 'lib/togai_client/models/proposal.rb', line 157

def self.openapi_all_of
  [
  :'Purchase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



151
152
153
154
 
# File 'lib/togai_client/models/proposal.rb', line 151

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

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/togai_client/models/proposal.rb', line 122

def self.openapi_types
  {
    :'id' => :'String',
    :'account_id' => :'String',
    :'price_plan_id' => :'String',
    :'quantity' => :'Integer',
    :'rate_card_quantities' => :'Hash<String, Float>',
    :'idempotency_key' => :'String',
    :'price_plan_version' => :'Integer',
    :'purchase_plan_override' => :'PricePlanDetailsOverride',
    :'association_override' => :'CreatePricePlanDetailsOverride',
    :'wallet_topup_details' => :'WalletTopupDetails',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'effective_from' => :'Date',
    :'effective_until' => :'Date',
    :'expiry_date' => :'Time',
    :'price' => :'Float',
    :'invoice_id' => :'String',
    :'invoice_currency' => :'String',
    :'status' => :'PurchaseStatus',
    :'type' => :'PurchaseType',
    :'comment' => :'String',
    :'payment_mode' => :'String',
    :'proposal_response_date' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/togai_client/models/proposal.rb', line 382

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      price_plan_id == o.price_plan_id &&
      quantity == o.quantity &&
      rate_card_quantities == o.rate_card_quantities &&
      idempotency_key == o.idempotency_key &&
      price_plan_version == o.price_plan_version &&
      purchase_plan_override == o.purchase_plan_override &&
      association_override == o.association_override &&
      wallet_topup_details == o.wallet_topup_details &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      effective_from == o.effective_from &&
      effective_until == o.effective_until &&
      expiry_date == o.expiry_date &&
      price == o.price &&
      invoice_id == o.invoice_id &&
      invoice_currency == o.invoice_currency &&
      status == o.status &&
      type == o.type &&
      comment == o.comment &&
      payment_mode == o.payment_mode &&
      proposal_response_date == o.proposal_response_date
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



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/togai_client/models/proposal.rb', line 520

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


412
413
414
 
# File 'lib/togai_client/models/proposal.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



418
419
420
 
# File 'lib/togai_client/models/proposal.rb', line 418

def hash
  [id, , price_plan_id, quantity, rate_card_quantities, idempotency_key, price_plan_version, purchase_plan_override, association_override, wallet_topup_details, created_at, updated_at, effective_from, effective_until, expiry_date, price, invoice_id, invoice_currency, status, type, comment, payment_mode, proposal_response_date].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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/togai_client/models/proposal.rb', line 287

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 @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @account_id.to_s.length < 1
    invalid_properties.push('invalid value for "account_id", the character length must be great than or equal to 1.')
  end

  if !@price_plan_id.nil? && @price_plan_id.to_s.length < 1
    invalid_properties.push('invalid value for "price_plan_id", the character length must be great than or equal to 1.')
  end

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

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

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

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

  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



496
497
498
 
# File 'lib/togai_client/models/proposal.rb', line 496

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



502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/togai_client/models/proposal.rb', line 502

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



490
491
492
 
# File 'lib/togai_client/models/proposal.rb', line 490

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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/togai_client/models/proposal.rb', line 327

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @account_id.nil?
  return false if @account_id.to_s.length < 1
  return false if !@price_plan_id.nil? && @price_plan_id.to_s.length < 1
  return false if @created_at.nil?
  return false if @status.nil?
  return false if @type.nil?
  return false if @payment_mode.nil?
  payment_mode_validator = EnumAttributeValidator.new('String', ["PREPAID", "POSTPAID"])
  return false unless payment_mode_validator.valid?(@payment_mode)
  true
end