Class: OpenapiClient::ReferencedOrderPaymentSchedulesRequest

Inherits:
PaymentSchedulesRequest show all
Defined in:
lib/openapi_client/models/referenced_order_payment_schedules_request.rb

Overview

Request to create a new payment schedule using a referenced order ID.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PaymentSchedulesRequest

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ ReferencedOrderPaymentSchedulesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 119

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

  # call parent's initialize
  super(attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing ⇒ Object

Returns the value of attribute billing.



53
54
55
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 53

def billing
  @billing
end

#client_locale ⇒ Object

Returns the value of attribute client_locale.



48
49
50
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 48

def client_locale
  @client_locale
end

#comments ⇒ Object

User supplied comments.



58
59
60
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 58

def comments
  @comments
end

#dynamic_merchant_name ⇒ Object

Dynamic merchant name for the cardholder’s statement.



42
43
44
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 42

def dynamic_merchant_name
  @dynamic_merchant_name
end

#frequency ⇒ Object

Returns the value of attribute frequency.



44
45
46
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 44

def frequency
  @frequency
end

#invoice_number ⇒ Object

Invoice number.



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

def invoice_number
  @invoice_number
end

#maximum_failures ⇒ Object

Number of failures that can be encountered before re-tries cease.



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

def maximum_failures
  @maximum_failures
end

#number_of_payments ⇒ Object

Number of times the recurring payment will process.



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

def number_of_payments
  @number_of_payments
end

#order_id ⇒ Object

Client order ID if supplied by client.



51
52
53
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 51

def order_id
  @order_id
end

#purchase_order_number ⇒ Object

Purchase order number.



37
38
39
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 37

def purchase_order_number
  @purchase_order_number
end

#referenced_order_id ⇒ Object

Order ID used to create recurring payment from existing transaction.



61
62
63
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 61

def referenced_order_id
  @referenced_order_id
end

#request_type ⇒ Object

Object name of the payment schedules request.



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

def request_type
  @request_type
end

#shipping ⇒ Object

Returns the value of attribute shipping.



55
56
57
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 55

def shipping
  @shipping
end

#start_date ⇒ Object

Date of mandate signature.



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

def start_date
  @start_date
end

#store_id ⇒ Object

Store ID number.



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

def store_id
  @store_id
end

#transaction_amount ⇒ Object

Returns the value of attribute transaction_amount.



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

def transaction_amount
  @transaction_amount
end

#transaction_origin ⇒ Object

Returns the value of attribute transaction_origin.



39
40
41
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 39

def transaction_origin
  @transaction_origin
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 64

def self.attribute_map
  {
    :'request_type' => :'requestType',
    :'store_id' => :'storeId',
    :'start_date' => :'startDate',
    :'number_of_payments' => :'numberOfPayments',
    :'maximum_failures' => :'maximumFailures',
    :'invoice_number' => :'invoiceNumber',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'transaction_origin' => :'transactionOrigin',
    :'dynamic_merchant_name' => :'dynamicMerchantName',
    :'frequency' => :'frequency',
    :'transaction_amount' => :'transactionAmount',
    :'client_locale' => :'clientLocale',
    :'order_id' => :'orderId',
    :'billing' => :'billing',
    :'shipping' => :'shipping',
    :'comments' => :'comments',
    :'referenced_order_id' => :'referencedOrderId'
  }
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



345
346
347
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 345

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
115
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 110

def self.openapi_all_of
  [
  :'PaymentSchedulesRequest',
  :'ReferencedOrderPaymentSchedulesRequestAllOf'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 87

def self.openapi_types
  {
    :'request_type' => :'String',
    :'store_id' => :'String',
    :'start_date' => :'Date',
    :'number_of_payments' => :'Integer',
    :'maximum_failures' => :'Integer',
    :'invoice_number' => :'String',
    :'purchase_order_number' => :'String',
    :'transaction_origin' => :'TransactionOrigin',
    :'dynamic_merchant_name' => :'String',
    :'frequency' => :'Frequency',
    :'transaction_amount' => :'Amount',
    :'client_locale' => :'ClientLocale',
    :'order_id' => :'String',
    :'billing' => :'Billing',
    :'shipping' => :'Shipping',
    :'comments' => :'String',
    :'referenced_order_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_type == o.request_type &&
      store_id == o.store_id &&
      start_date == o.start_date &&
      number_of_payments == o.number_of_payments &&
      maximum_failures == o.maximum_failures &&
      invoice_number == o.invoice_number &&
      purchase_order_number == o.purchase_order_number &&
      transaction_origin == o.transaction_origin &&
      dynamic_merchant_name == o.dynamic_merchant_name &&
      frequency == o.frequency &&
      transaction_amount == o.transaction_amount &&
      client_locale == o.client_locale &&
      order_id == o.order_id &&
      billing == o.billing &&
      shipping == o.shipping &&
      comments == o.comments &&
      referenced_order_id == o.referenced_order_id && super(o)
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



374
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
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 374

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
    OpenapiClient.const_get(type).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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 439

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 352

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.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[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


332
333
334
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 338

def hash
  [request_type, store_id, start_date, number_of_payments, maximum_failures, invoice_number, purchase_order_number, transaction_origin, dynamic_merchant_name, frequency, transaction_amount, client_locale, order_id, billing, shipping, comments, referenced_order_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



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
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 206

def list_invalid_properties
  invalid_properties = super
  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 !@maximum_failures.nil? && @maximum_failures > 999
    invalid_properties.push('invalid value for "maximum_failures", must be smaller than or equal to 999.')
  end

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @referenced_order_id !~ pattern
    invalid_properties.push("invalid value for \"referenced_order_id\", 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



419
420
421
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 419

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



425
426
427
428
429
430
431
432
433
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 425

def to_hash
  hash = super
  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



413
414
415
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 413

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



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 242

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 !@maximum_failures.nil? && @maximum_failures > 999
  return false if !@maximum_failures.nil? && @maximum_failures < 1
  return false if @referenced_order_id.nil?
  return false if @referenced_order_id !~ Regexp.new(/^(?!\s*$).+/)
  true && super
end