Class: WalleeRubySdk::SubscriptionLedgerEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb

Overview

The subscription ledger entry represents a single change on the subscription balance.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionLedgerEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 178

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::SubscriptionLedgerEntry` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::SubscriptionLedgerEntry`. 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?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregated_tax_rate ⇒ Object

The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.



85
86
87
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 85

def aggregated_tax_rate
  @aggregated_tax_rate
end

#amount_excluding_tax ⇒ Object

The leger entry’s amount with discounts applied, excluding taxes.



31
32
33
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 31

def amount_excluding_tax
  @amount_excluding_tax
end

#amount_including_tax ⇒ Object

The leger entry’s amount with discounts applied, including taxes.



76
77
78
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 76

def amount_including_tax
  @amount_including_tax
end

#component_reference_name ⇒ Object

Returns the value of attribute component_reference_name.



56
57
58
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 56

def component_reference_name
  @component_reference_name
end

#component_reference_sku ⇒ Object

Returns the value of attribute component_reference_sku.



68
69
70
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 68

def component_reference_sku
  @component_reference_sku
end

#created_by ⇒ Object

The ID of the user the ledger entry was created by.



66
67
68
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 66

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



51
52
53
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 51

def created_on
  @created_on
end

#discount_including_tax ⇒ Object

The discount allocated to the ledger entry, including taxes.



79
80
81
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 79

def discount_including_tax
  @discount_including_tax
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



40
41
42
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 40

def external_id
  @external_id
end

#fee_type ⇒ Object

Returns the value of attribute fee_type.



45
46
47
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 45

def fee_type
  @fee_type
end

#id ⇒ Object

A unique identifier for the object.



71
72
73
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 71

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



61
62
63
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 61

def linked_space_id
  @linked_space_id
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



34
35
36
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 34

def planned_purge_date
  @planned_purge_date
end

#pro_rata_calculated ⇒ Object

Returns the value of attribute pro_rata_calculated.



63
64
65
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 63

def pro_rata_calculated
  @pro_rata_calculated
end

#quantity ⇒ Object

The number of items that were consumed.



28
29
30
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 28

def quantity
  @quantity
end

#state ⇒ Object

Returns the value of attribute state.



73
74
75
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 73

def state
  @state
end

#subscription_metric_id ⇒ Object

Returns the value of attribute subscription_metric_id.



58
59
60
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 58

def subscription_metric_id
  @subscription_metric_id
end

#subscription_version ⇒ Object

The subscription version that the ledger entry belongs to.



37
38
39
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 37

def subscription_version
  @subscription_version
end

#tax_amount ⇒ Object

The sum of all taxes applied to the ledger entry.



82
83
84
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 82

def tax_amount
  @tax_amount
end

#taxes ⇒ Object

A set of tax lines, each of which specifies a tax applied to the ledger entry.



43
44
45
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 43

def taxes
  @taxes
end

#title ⇒ Object

The title that indicates what the ledger entry is about.



48
49
50
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 48

def title
  @title
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



54
55
56
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 54

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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 432

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 = WalleeRubySdk.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



138
139
140
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 138

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 110

def self.attribute_map
  {
    :'quantity' => :'quantity',
    :'amount_excluding_tax' => :'amountExcludingTax',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'subscription_version' => :'subscriptionVersion',
    :'external_id' => :'externalId',
    :'taxes' => :'taxes',
    :'fee_type' => :'feeType',
    :'title' => :'title',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'component_reference_name' => :'componentReferenceName',
    :'subscription_metric_id' => :'subscriptionMetricId',
    :'linked_space_id' => :'linkedSpaceId',
    :'pro_rata_calculated' => :'proRataCalculated',
    :'created_by' => :'createdBy',
    :'component_reference_sku' => :'componentReferenceSku',
    :'id' => :'id',
    :'state' => :'state',
    :'amount_including_tax' => :'amountIncludingTax',
    :'discount_including_tax' => :'discountIncludingTax',
    :'tax_amount' => :'taxAmount',
    :'aggregated_tax_rate' => :'aggregatedTaxRate'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 408

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



171
172
173
174
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 171

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 143

def self.openapi_types
  {
    :'quantity' => :'Float',
    :'amount_excluding_tax' => :'Float',
    :'planned_purge_date' => :'Time',
    :'subscription_version' => :'Integer',
    :'external_id' => :'String',
    :'taxes' => :'Array<Tax>',
    :'fee_type' => :'ProductFeeType',
    :'title' => :'String',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'component_reference_name' => :'String',
    :'subscription_metric_id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'pro_rata_calculated' => :'Boolean',
    :'created_by' => :'Integer',
    :'component_reference_sku' => :'String',
    :'id' => :'Integer',
    :'state' => :'SubscriptionLedgerEntryState',
    :'amount_including_tax' => :'Float',
    :'discount_including_tax' => :'Float',
    :'tax_amount' => :'Float',
    :'aggregated_tax_rate' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      amount_excluding_tax == o.amount_excluding_tax &&
      planned_purge_date == o.planned_purge_date &&
      subscription_version == o.subscription_version &&
      external_id == o.external_id &&
      taxes == o.taxes &&
      fee_type == o.fee_type &&
      title == o.title &&
      created_on == o.created_on &&
      version == o.version &&
      component_reference_name == o.component_reference_name &&
      subscription_metric_id == o.subscription_metric_id &&
      linked_space_id == o.linked_space_id &&
      pro_rata_calculated == o.pro_rata_calculated &&
      created_by == o.created_by &&
      component_reference_sku == o.component_reference_sku &&
      id == o.id &&
      state == o.state &&
      amount_including_tax == o.amount_including_tax &&
      discount_including_tax == o.discount_including_tax &&
      tax_amount == o.tax_amount &&
      aggregated_tax_rate == o.aggregated_tax_rate
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



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 503

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


397
398
399
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 397

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



403
404
405
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 403

def hash
  [quantity, amount_excluding_tax, planned_purge_date, subscription_version, external_id, taxes, fee_type, title, created_on, version, component_reference_name, subscription_metric_id, linked_space_id, pro_rata_calculated, created_by, component_reference_sku, id, state, amount_including_tax, discount_including_tax, tax_amount, aggregated_tax_rate].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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 284

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 150
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 150.')
  end

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

  if !@component_reference_sku.nil? && @component_reference_sku.to_s.length > 100
    invalid_properties.push('invalid value for "component_reference_sku", the character length must be smaller than or equal to 100.')
  end

  pattern = Regexp.new(/([0-9a-zA-Z\-_]+)/)
  if !@component_reference_sku.nil? && @component_reference_sku !~ pattern
    invalid_properties.push("invalid value for \"component_reference_sku\", must conform to the pattern #{pattern}.")
  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



479
480
481
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 479

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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 485

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



473
474
475
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 473

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 309

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 150
  return false if !@title.nil? && @title.to_s.length < 1
  return false if !@component_reference_sku.nil? && @component_reference_sku.to_s.length > 100
  pattern = Regexp.new(/([0-9a-zA-Z\-_]+)/)
  return false if !@component_reference_sku.nil? && @component_reference_sku !~ pattern
  true
end