Class: OpenapiClient::RecurringPaymentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/recurring_payment_details.rb

Overview

Details about existing gateway schedule.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurringPaymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

User supplied comments.



52
53
54
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 52

def comments
  @comments
end

#creation_date ⇒ Object

Date recurring payment was created.



28
29
30
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 28

def creation_date
  @creation_date
end

#frequency ⇒ Object

Returns the value of attribute frequency.



40
41
42
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 40

def frequency
  @frequency
end

#invoice_number ⇒ Object

Invoice number.



25
26
27
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 25

def invoice_number
  @invoice_number
end

#next_attempt_date ⇒ Object

Date of next transaction process attempt.



34
35
36
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 34

def next_attempt_date
  @next_attempt_date
end

#number_of_payments ⇒ Object

Number of times the recurring payment will process.



43
44
45
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 43

def number_of_payments
  @number_of_payments
end

#payment_method_details ⇒ Object

Returns the value of attribute payment_method_details.



38
39
40
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 38

def payment_method_details
  @payment_method_details
end

#purchase_order_number ⇒ Object

Purchase order number.



22
23
24
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 22

def purchase_order_number
  @purchase_order_number
end

#run_count ⇒ Object

Times the recurring payment has already run.



46
47
48
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 46

def run_count
  @run_count
end

#start_date ⇒ Object

Date of mandate signature.



31
32
33
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 31

def start_date
  @start_date
end

#state ⇒ Object

State of the recurring payment.



49
50
51
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 49

def state
  @state
end

#store_id ⇒ Object

Store ID number.



19
20
21
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 19

def store_id
  @store_id
end

#transaction_amount ⇒ Object

Returns the value of attribute transaction_amount.



36
37
38
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 36

def transaction_amount
  @transaction_amount
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 77

def self.attribute_map
  {
    :'store_id' => :'storeId',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'invoice_number' => :'invoiceNumber',
    :'creation_date' => :'creationDate',
    :'start_date' => :'startDate',
    :'next_attempt_date' => :'nextAttemptDate',
    :'transaction_amount' => :'transactionAmount',
    :'payment_method_details' => :'paymentMethodDetails',
    :'frequency' => :'frequency',
    :'number_of_payments' => :'numberOfPayments',
    :'run_count' => :'runCount',
    :'state' => :'state',
    :'comments' => :'comments'
  }
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



305
306
307
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 305

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 96

def self.openapi_types
  {
    :'store_id' => :'String',
    :'purchase_order_number' => :'String',
    :'invoice_number' => :'String',
    :'creation_date' => :'String',
    :'start_date' => :'String',
    :'next_attempt_date' => :'String',
    :'transaction_amount' => :'Amount',
    :'payment_method_details' => :'PaymentMethodDetails',
    :'frequency' => :'Frequency',
    :'number_of_payments' => :'Integer',
    :'run_count' => :'Integer',
    :'state' => :'String',
    :'comments' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      store_id == o.store_id &&
      purchase_order_number == o.purchase_order_number &&
      invoice_number == o.invoice_number &&
      creation_date == o.creation_date &&
      start_date == o.start_date &&
      next_attempt_date == o.next_attempt_date &&
      transaction_amount == o.transaction_amount &&
      payment_method_details == o.payment_method_details &&
      frequency == o.frequency &&
      number_of_payments == o.number_of_payments &&
      run_count == o.run_count &&
      state == o.state &&
      comments == o.comments
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



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
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 333

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 407

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 312

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


292
293
294
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 298

def hash
  [store_id, purchase_order_number, invoice_number, creation_date, start_date, next_attempt_date, transaction_amount, payment_method_details, frequency, number_of_payments, run_count, state, comments].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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 184

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

  if !@number_of_payments.nil? && @number_of_payments > 999
    invalid_properties.push('invalid value for "number_of_payments", must be smaller than or equal to 999.')
  end

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

  if !@run_count.nil? && @run_count > 999
    invalid_properties.push('invalid value for "run_count", must be smaller than or equal to 999.')
  end

  if !@run_count.nil? && @run_count < 0
    invalid_properties.push('invalid value for "run_count", must be greater than or equal to 0.')
  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



383
384
385
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 383

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 389

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



377
378
379
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 377

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



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/openapi_client/models/recurring_payment_details.rb', line 211

def valid?
  return false if !@store_id.nil? && @store_id.to_s.length > 20
  return false if !@number_of_payments.nil? && @number_of_payments > 999
  return false if !@number_of_payments.nil? && @number_of_payments < 1
  return false if !@run_count.nil? && @run_count > 999
  return false if !@run_count.nil? && @run_count < 0
  state_validator = EnumAttributeValidator.new('String', ["Installed", "Inactivated", "Cancelled"])
  return false unless state_validator.valid?(@state)
  true
end