Class: PostfinancecheckoutRubySdk::SubscriptionLedgerEntryCreate

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionLedgerEntryCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 90

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

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

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

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

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

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

Instance Attribute Details

#amount_including_tax ⇒ Object

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



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

def amount_including_tax
  @amount_including_tax
end

#component_reference_name ⇒ Object

Returns the value of attribute component_reference_name.



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

def component_reference_name
  @component_reference_name
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.



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

def external_id
  @external_id
end

#quantity ⇒ Object

The number of items that were consumed.



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

def quantity
  @quantity
end

#subscription_metric_id ⇒ Object

Returns the value of attribute subscription_metric_id.



47
48
49
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 47

def subscription_metric_id
  @subscription_metric_id
end

#subscription_version ⇒ Object

The subscription version that the ledger entry belongs to.



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

def subscription_version
  @subscription_version
end

#taxes ⇒ Object

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



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

def taxes
  @taxes
end

#title ⇒ Object

The title that indicates what the ledger entry is about.



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

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



278
279
280
281
282
283
284
285
286
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 278

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



64
65
66
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 50

def self.attribute_map
  {
    :'quantity' => :'quantity',
    :'subscription_version' => :'subscriptionVersion',
    :'external_id' => :'externalId',
    :'taxes' => :'taxes',
    :'amount_including_tax' => :'amountIncludingTax',
    :'title' => :'title',
    :'component_reference_name' => :'componentReferenceName',
    :'subscription_metric_id' => :'subscriptionMetricId'
  }
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 254

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



83
84
85
86
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 69

def self.openapi_types
  {
    :'quantity' => :'Float',
    :'subscription_version' => :'Integer',
    :'external_id' => :'String',
    :'taxes' => :'Array<TaxCreate>',
    :'amount_including_tax' => :'Float',
    :'title' => :'String',
    :'component_reference_name' => :'String',
    :'subscription_metric_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      subscription_version == o.subscription_version &&
      external_id == o.external_id &&
      taxes == o.taxes &&
      amount_including_tax == o.amount_including_tax &&
      title == o.title &&
      component_reference_name == o.component_reference_name &&
      subscription_metric_id == o.subscription_metric_id
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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 349

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


243
244
245
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 249

def hash
  [quantity, subscription_version, external_id, taxes, amount_including_tax, title, component_reference_name, subscription_metric_id].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



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 150

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

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

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

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

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

  if @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.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length 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



325
326
327
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 331

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



319
320
321
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 319

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



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_ledger_entry_create.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @quantity.nil?
  return false if @subscription_version.nil?
  return false if @external_id.nil?
  return false if @amount_including_tax.nil?
  return false if @title.nil?
  return false if @title.to_s.length > 150
  return false if @title.to_s.length < 1
  true
end