Class: TogaiClient::CreateCustomInvoiceRequest

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

Overview

Payload to create invoice

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCustomInvoiceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#apply_credits ⇒ Object

This property defines the behaviour of whether or not to use credits to net off with the invoice amount. Default: true



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

def apply_credits
  @apply_credits
end

#apply_wallet_balance ⇒ Object

This property defines the behaviour of whether or not to use wallet amount to net off with the invoice amount. Default: true



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

def apply_wallet_balance
  @apply_wallet_balance
end

#auto_advance ⇒ Object

This property defines the behaviour of status transition of the invoice. If true, invoice auto transitions from ‘DRAFT` to `DUE` or `PAID` at the end of pricing cycle. If false, the invoice’s state doesn’t automatically advance without an explicit action. Default: false



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

def auto_advance
  @auto_advance
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#idempotency_key ⇒ Object

Returns the value of attribute idempotency_key.



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

def idempotency_key
  @idempotency_key
end

#line_items ⇒ Object

Returns the value of attribute line_items.



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

def line_items
  @line_items
end

#owner_type ⇒ Object

Returns the value of attribute owner_type.



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

def owner_type
  @owner_type
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#status ⇒ Object

Status to create an invoice in.



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

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 324

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



82
83
84
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 66

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'owner_type' => :'ownerType',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'idempotency_key' => :'idempotencyKey',
    :'status' => :'status',
    :'line_items' => :'lineItems',
    :'auto_advance' => :'autoAdvance',
    :'apply_credits' => :'applyCredits',
    :'apply_wallet_balance' => :'applyWalletBalance'
  }
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 300

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



103
104
105
106
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 87

def self.openapi_types
  {
    :'account_id' => :'String',
    :'owner_type' => :'String',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'idempotency_key' => :'String',
    :'status' => :'String',
    :'line_items' => :'Array<CustomInvoiceLineItem>',
    :'auto_advance' => :'Boolean',
    :'apply_credits' => :'Boolean',
    :'apply_wallet_balance' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      owner_type == o.owner_type &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      idempotency_key == o.idempotency_key &&
      status == o.status &&
      line_items == o.line_items &&
      auto_advance == o.auto_advance &&
      apply_credits == o.apply_credits &&
      apply_wallet_balance == o.apply_wallet_balance
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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 395

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


287
288
289
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 293

def hash
  [, owner_type, start_date, end_date, idempotency_key, status, line_items, auto_advance, apply_credits, apply_wallet_balance].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



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

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

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

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

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

  if @line_items.length > 50
    invalid_properties.push('invalid value for "line_items", number of items must be less than or equal to 50.')
  end

  if @line_items.length < 1
    invalid_properties.push('invalid value for "line_items", number of items must be greater than or equal to 1.')
  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



371
372
373
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 371

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



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

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



365
366
367
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 365

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/togai_client/models/create_custom_invoice_request.rb', line 214

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  owner_type_validator = EnumAttributeValidator.new('String', ["ACCOUNT", "INVOICE_GROUP"])
  return false unless owner_type_validator.valid?(@owner_type)
  return false if @start_date.nil?
  return false if @end_date.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "DUE", "PAID"])
  return false unless status_validator.valid?(@status)
  return false if @line_items.nil?
  return false if @line_items.length > 50
  return false if @line_items.length < 1
  true
end