Class: Wallee::SubscriptionCharge

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

Overview

The subscription charge represents a single charge carried out for a particular subscription.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionCharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'discardedBy')
    self.discarded_by = attributes[:'discardedBy']
  end

  if attributes.has_key?(:'discardedOn')
    self.discarded_on = attributes[:'discardedOn']
  end

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

  if attributes.has_key?(:'failedOn')
    self.failed_on = attributes[:'failedOn']
  end

  if attributes.has_key?(:'failedUrl')
    self.failed_url = attributes[:'failedUrl']
  end

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

  if attributes.has_key?(:'language')
    self.language = attributes[:'language']
  end

  if attributes.has_key?(:'ledgerEntries')
    if (value = attributes[:'ledgerEntries']).is_a?(Array)
      self.ledger_entries = value
    end
  end

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

  if attributes.has_key?(:'plannedExecutionDate')
    self.planned_execution_date = attributes[:'plannedExecutionDate']
  end

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

  if attributes.has_key?(:'processingType')
    self.processing_type = attributes[:'processingType']
  end

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end

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

  if attributes.has_key?(:'subscription')
    self.subscription = attributes[:'subscription']
  end

  if attributes.has_key?(:'succeedOn')
    self.succeed_on = attributes[:'succeedOn']
  end

  if attributes.has_key?(:'successUrl')
    self.success_url = attributes[:'successUrl']
  end

  if attributes.has_key?(:'transaction')
    self.transaction = attributes[:'transaction']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

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

Instance Attribute Details

#created_on ⇒ Object

Returns the value of attribute created_on.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 24

def created_on
  @created_on
end

#discarded_by ⇒ Object

Returns the value of attribute discarded_by.



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

def discarded_by
  @discarded_by
end

#discarded_on ⇒ Object

Returns the value of attribute discarded_on.



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

def discarded_on
  @discarded_on
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#failed_url ⇒ Object

The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.



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

def failed_url
  @failed_url
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#ledger_entries ⇒ Object

Returns the value of attribute ledger_entries.



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

def ledger_entries
  @ledger_entries
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#planned_execution_date ⇒ Object

Returns the value of attribute planned_execution_date.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#processing_type ⇒ Object

Returns the value of attribute processing_type.



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

def processing_type
  @processing_type
end

#reference ⇒ Object

Returns the value of attribute reference.



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

def reference
  @reference
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#subscription ⇒ Object

The field subscription indicates the subscription to which the charge belongs to.



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

def subscription
  @subscription
end

#succeed_on ⇒ Object

Returns the value of attribute succeed_on.



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

def succeed_on
  @succeed_on
end

#success_url ⇒ Object

The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.



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

def success_url
  @success_url
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created_on' => :'createdOn',
    :'discarded_by' => :'discardedBy',
    :'discarded_on' => :'discardedOn',
    :'external_id' => :'externalId',
    :'failed_on' => :'failedOn',
    :'failed_url' => :'failedUrl',
    :'id' => :'id',
    :'language' => :'language',
    :'ledger_entries' => :'ledgerEntries',
    :'linked_space_id' => :'linkedSpaceId',
    :'planned_execution_date' => :'plannedExecutionDate',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processing_type' => :'processingType',
    :'reference' => :'reference',
    :'state' => :'state',
    :'subscription' => :'subscription',
    :'succeed_on' => :'succeedOn',
    :'success_url' => :'successUrl',
    :'transaction' => :'transaction',
    :'type' => :'type',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'created_on' => :'DateTime',
    :'discarded_by' => :'Integer',
    :'discarded_on' => :'DateTime',
    :'external_id' => :'String',
    :'failed_on' => :'DateTime',
    :'failed_url' => :'String',
    :'id' => :'Integer',
    :'language' => :'String',
    :'ledger_entries' => :'Array<SubscriptionLedgerEntry>',
    :'linked_space_id' => :'Integer',
    :'planned_execution_date' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'processing_type' => :'SubscriptionChargeProcessingType',
    :'reference' => :'String',
    :'state' => :'SubscriptionChargeState',
    :'subscription' => :'Subscription',
    :'succeed_on' => :'DateTime',
    :'success_url' => :'String',
    :'transaction' => :'Transaction',
    :'type' => :'SubscriptionChargeType',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_on == o.created_on &&
      discarded_by == o.discarded_by &&
      discarded_on == o.discarded_on &&
      external_id == o.external_id &&
      failed_on == o.failed_on &&
      failed_url == o.failed_url &&
      id == o.id &&
      language == o.language &&
      ledger_entries == o.ledger_entries &&
      linked_space_id == o.linked_space_id &&
      planned_execution_date == o.planned_execution_date &&
      planned_purge_date == o.planned_purge_date &&
      processing_type == o.processing_type &&
      reference == o.reference &&
      state == o.state &&
      subscription == o.subscription &&
      succeed_on == o.succeed_on &&
      success_url == o.success_url &&
      transaction == o.transaction &&
      type == o.type &&
      version == o.version
end

#_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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 375

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Wallee.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 441

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

#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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 354

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


341
342
343
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



347
348
349
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 347

def hash
  [created_on, discarded_by, discarded_on, external_id, failed_on, failed_url, id, language, ledger_entries, linked_space_id, planned_execution_date, planned_purge_date, processing_type, reference, state, subscription, succeed_on, success_url, transaction, type, version].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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 237

def list_invalid_properties
  invalid_properties = Array.new
  if !@failed_url.nil? && @failed_url.to_s.length > 500
    invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.')
  end

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

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

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

  if !@success_url.nil? && @success_url.to_s.length < 9
    invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.')
  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



421
422
423
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 421

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



427
428
429
430
431
432
433
434
435
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 427

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



415
416
417
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 415

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



264
265
266
267
268
269
270
271
 
# File 'lib/wallee-ruby-sdk/models/subscription_charge.rb', line 264

def valid?
  return false if !@failed_url.nil? && @failed_url.to_s.length > 500
  return false if !@failed_url.nil? && @failed_url.to_s.length < 9
  return false if !@reference.nil? && @reference.to_s.length > 100
  return false if !@success_url.nil? && @success_url.to_s.length > 500
  return false if !@success_url.nil? && @success_url.to_s.length < 9
  true
end