Class: TogaiClient::CreditRequest

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

Overview

Payload to grant Credits

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditRequest

Initializes the object



83
84
85
86
87
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/togai_client/models/credit_request.rb', line 83

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

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



24
25
26
 
# File 'lib/togai_client/models/credit_request.rb', line 24

def applicable_entity_ids
  @applicable_entity_ids
end

#credit_amount ⇒ Object

Returns the value of attribute credit_amount.



30
31
32
 
# File 'lib/togai_client/models/credit_request.rb', line 30

def credit_amount
  @credit_amount
end

#effective_from ⇒ Object

Returns the value of attribute effective_from.



26
27
28
 
# File 'lib/togai_client/models/credit_request.rb', line 26

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Returns the value of attribute effective_until.



28
29
30
 
# File 'lib/togai_client/models/credit_request.rb', line 28

def effective_until
  @effective_until
end

#grantor_id ⇒ Object

The entity through which the credit has been granted



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

def grantor_id
  @grantor_id
end

#idempotency_key ⇒ Object

The idempotency key for uniqueness of the credit record



38
39
40
 
# File 'lib/togai_client/models/credit_request.rb', line 38

def idempotency_key
  @idempotency_key
end

#priority ⇒ Object

Returns the value of attribute priority.



32
33
34
 
# File 'lib/togai_client/models/credit_request.rb', line 32

def priority
  @priority
end

#purpose ⇒ Object

Returns the value of attribute purpose.



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

def purpose
  @purpose
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



56
57
58
 
# File 'lib/togai_client/models/credit_request.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/togai_client/models/credit_request.rb', line 41

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'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/togai_client/models/credit_request.rb', line 219

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

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/togai_client/models/credit_request.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/togai_client/models/credit_request.rb', line 61

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/togai_client/models/credit_request.rb', line 190

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
end

#_to_hash(value) ⇒ Hash

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/togai_client/models/credit_request.rb', line 314

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

See Also:

  • `==` method


206
207
208
 
# File 'lib/togai_client/models/credit_request.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



212
213
214
 
# File 'lib/togai_client/models/credit_request.rb', line 212

def hash
  [, purpose, applicable_entity_ids, effective_from, effective_until, credit_amount, priority, grantor_id, idempotency_key].hash
end

#list_invalid_properties ⇒ Object

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/togai_client/models/credit_request.rb', line 145

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



290
291
292
 
# File 'lib/togai_client/models/credit_request.rb', line 290

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/togai_client/models/credit_request.rb', line 296

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



284
285
286
 
# File 'lib/togai_client/models/credit_request.rb', line 284

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



169
170
171
172
173
174
175
176
 
# File 'lib/togai_client/models/credit_request.rb', line 169

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?
  true
end