Class: TogaiClient::Credit

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Credit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/togai_client/models/credit.rb', line 144

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#applicable_entity_ids ⇒ Object

List of entity ids for which the credit is applicable. If null or empty, the credit is applicable to all ids. This list can accept special values like: - ALL_USAGE_METER_RATE_CARDS: To apply the credit to all usage meter rate cards - ALL_FIXED_FEE_RATE_CARDS: To apply the credit to all fixed fee rate cards



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

def applicable_entity_ids
  @applicable_entity_ids
end

#consumed_amount ⇒ Object

Returns the value of attribute consumed_amount.



50
51
52
 
# File 'lib/togai_client/models/credit.rb', line 50

def consumed_amount
  @consumed_amount
end

#created_at ⇒ Object

Returns the value of attribute created_at.



52
53
54
 
# File 'lib/togai_client/models/credit.rb', line 52

def created_at
  @created_at
end

#credit_amount ⇒ Object

Returns the value of attribute credit_amount.



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

def credit_amount
  @credit_amount
end

#credit_unit ⇒ Object

Returns the value of attribute credit_unit.



46
47
48
 
# File 'lib/togai_client/models/credit.rb', line 46

def credit_unit
  @credit_unit
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



42
43
44
 
# File 'lib/togai_client/models/credit.rb', line 42

def customer_id
  @customer_id
end

#effective_from ⇒ Object

Returns the value of attribute effective_from.



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

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Returns the value of attribute effective_until.



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

def effective_until
  @effective_until
end

#grantor_id ⇒ Object

The entity through which the credit has been granted



34
35
36
 
# File 'lib/togai_client/models/credit.rb', line 34

def grantor_id
  @grantor_id
end

#hold_amount ⇒ Object

Returns the value of attribute hold_amount.



48
49
50
 
# File 'lib/togai_client/models/credit.rb', line 48

def hold_amount
  @hold_amount
end

#id ⇒ Object

Identifier of credits



40
41
42
 
# File 'lib/togai_client/models/credit.rb', line 40

def id
  @id
end

#idempotency_key ⇒ Object

The idempotency key for uniqueness of the credit record



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

def idempotency_key
  @idempotency_key
end

#priority ⇒ Object

Returns the value of attribute priority.



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

def priority
  @priority
end

#purpose ⇒ Object

Returns the value of attribute purpose.



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

def purpose
  @purpose
end

#status ⇒ Object

Returns the value of attribute status.



44
45
46
 
# File 'lib/togai_client/models/credit.rb', line 44

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



54
55
56
 
# File 'lib/togai_client/models/credit.rb', line 54

def updated_at
  @updated_at
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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/togai_client/models/credit.rb', line 403

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



102
103
104
 
# File 'lib/togai_client/models/credit.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/togai_client/models/credit.rb', line 79

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'purpose' => :'purpose',
    :'applicable_entity_ids' => :'applicableEntityIds',
    :'effective_from' => :'effectiveFrom',
    :'effective_until' => :'effectiveUntil',
    :'credit_amount' => :'creditAmount',
    :'priority' => :'priority',
    :'grantor_id' => :'grantorId',
    :'idempotency_key' => :'idempotencyKey',
    :'id' => :'id',
    :'customer_id' => :'customerId',
    :'status' => :'status',
    :'credit_unit' => :'creditUnit',
    :'hold_amount' => :'holdAmount',
    :'consumed_amount' => :'consumedAmount',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/togai_client/models/credit.rb', line 379

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)



136
137
138
139
140
 
# File 'lib/togai_client/models/credit.rb', line 136

def self.openapi_all_of
  [
  :'CreditRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/togai_client/models/credit.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/togai_client/models/credit.rb', line 107

def self.openapi_types
  {
    :'account_id' => :'String',
    :'purpose' => :'String',
    :'applicable_entity_ids' => :'Array<String>',
    :'effective_from' => :'Date',
    :'effective_until' => :'Date',
    :'credit_amount' => :'Float',
    :'priority' => :'Integer',
    :'grantor_id' => :'String',
    :'idempotency_key' => :'String',
    :'id' => :'String',
    :'customer_id' => :'String',
    :'status' => :'String',
    :'credit_unit' => :'String',
    :'hold_amount' => :'Float',
    :'consumed_amount' => :'Float',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/togai_client/models/credit.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      purpose == o.purpose &&
      applicable_entity_ids == o.applicable_entity_ids &&
      effective_from == o.effective_from &&
      effective_until == o.effective_until &&
      credit_amount == o.credit_amount &&
      priority == o.priority &&
      grantor_id == o.grantor_id &&
      idempotency_key == o.idempotency_key &&
      id == o.id &&
      customer_id == o.customer_id &&
      status == o.status &&
      credit_unit == o.credit_unit &&
      hold_amount == o.hold_amount &&
      consumed_amount == o.consumed_amount &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/togai_client/models/credit.rb', line 474

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


366
367
368
 
# File 'lib/togai_client/models/credit.rb', line 366

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



372
373
374
 
# File 'lib/togai_client/models/credit.rb', line 372

def hash
  [, purpose, applicable_entity_ids, effective_from, effective_until, credit_amount, priority, grantor_id, idempotency_key, id, customer_id, status, credit_unit, hold_amount, consumed_amount, created_at, updated_at].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



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
284
285
286
 
# File 'lib/togai_client/models/credit.rb', line 246

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

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

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

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

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

  if @id.to_s.length > 50
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
  end

  if @customer_id.nil?
    invalid_properties.push('invalid value for "customer_id", customer_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

  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



450
451
452
 
# File 'lib/togai_client/models/credit.rb', line 450

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/togai_client/models/credit.rb', line 456

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



444
445
446
 
# File 'lib/togai_client/models/credit.rb', line 444

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/togai_client/models/credit.rb', line 290

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @purpose.nil?
  return false if @effective_from.nil?
  return false if @priority.nil?
  return false if @id.nil?
  return false if @id.to_s.length > 50
  return false if @customer_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "CONSUMED", "EXPIRED", "VOIDED"])
  return false unless status_validator.valid?(@status)
  return false if @created_at.nil?
  true
end