Class: CyberSource::Ptsv2paymentsRecurringPaymentInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb

Overview

This object contains recurring payment information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsRecurringPaymentInformation

Initializes the object



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
147
148
149
150
151
152
153
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 104

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?(:'endDate')
    self.end_date = attributes[:'endDate']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_type ⇒ Object

Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount



43
44
45
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 43

def amount_type
  @amount_type
end

#end_date ⇒ Object

The date after which no further recurring authorizations should be performed. Format: ‘YYYY-MM-DD` Note This field is required for recurring transactions.



19
20
21
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 19

def end_date
  @end_date
end

#frequency ⇒ Object

Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 Example values accepted (31 days): - 31 - 031 - 0031 Note This field is required for recurring transactions.



22
23
24
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 22

def frequency
  @frequency
end

#maximum_amount ⇒ Object

This API field will contain the maximum amount agreed to by the cardholder. The currency of this amount will be specified in Field 49—Currency Code,Transaction.



46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 46

def maximum_amount
  @maximum_amount
end

#number_of_payments ⇒ Object

Total number of payments for the duration of the recurring subscription.



25
26
27
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 25

def number_of_payments
  @number_of_payments
end

#occurrence ⇒ Object

This value indicates how often a recurring payment occurs. Valid Values : • 01 (Daily) • 02 (Twice weekly) • 03 (Weekly) • 04 (Ten days) • 05 (Fortnightly) • 06 (Monthly) • 07 (Every two months) • 08 (Trimester) • 09 (Quarterly) • 10 (Twice yearly) • 11 (Annually) • 12 (Unscheduled)



37
38
39
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 37

def occurrence
  @occurrence
end

#original_purchase_date ⇒ Object

Date of original purchase. Required for recurring transactions. Format: ‘YYYY-MM-DDTHH:MM:SSZ` Note: If this field is empty, the current date is used.



28
29
30
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 28

def original_purchase_date
  @original_purchase_date
end

#reference_number ⇒ Object

This will contain a unique reference number for the recurring payment transaction.



49
50
51
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 49

def reference_number
  @reference_number
end

#sequence_number ⇒ Object

This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC. This field records recurring sequence, e.g. 1st for initial, 2 for subsequent, 3 etc



31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 31

def sequence_number
  @sequence_number
end

#type ⇒ Object

This contains the type of recurring payment. Valid Values : 1 - Registration/First transaction 2 - Subsequent transaction 3 - Modification 4 - Cancellation



34
35
36
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 34

def type
  @type
end

#validation_indicator ⇒ Object

This tag will contain a value that indicates whether or not the recurring payment transaction has been validated. Valid values : 0- Not validated 1- Validated



40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 40

def validation_indicator
  @validation_indicator
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 52

def self.attribute_map
  {
    :'end_date' => :'endDate',
    :'frequency' => :'frequency',
    :'number_of_payments' => :'numberOfPayments',
    :'original_purchase_date' => :'originalPurchaseDate',
    :'sequence_number' => :'sequenceNumber',
    :'type' => :'type',
    :'occurrence' => :'occurrence',
    :'validation_indicator' => :'validationIndicator',
    :'amount_type' => :'amountType',
    :'maximum_amount' => :'maximumAmount',
    :'reference_number' => :'referenceNumber'
  }
end

.json_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 69

def self.json_map
  {
    :'end_date' => :'end_date',
    :'frequency' => :'frequency',
    :'number_of_payments' => :'number_of_payments',
    :'original_purchase_date' => :'original_purchase_date',
    :'sequence_number' => :'sequence_number',
    :'type' => :'type',
    :'occurrence' => :'occurrence',
    :'validation_indicator' => :'validation_indicator',
    :'amount_type' => :'amount_type',
    :'maximum_amount' => :'maximum_amount',
    :'reference_number' => :'reference_number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 86

def self.swagger_types
  {
    :'end_date' => :'String',
    :'frequency' => :'Integer',
    :'number_of_payments' => :'Integer',
    :'original_purchase_date' => :'String',
    :'sequence_number' => :'Integer',
    :'type' => :'String',
    :'occurrence' => :'String',
    :'validation_indicator' => :'String',
    :'amount_type' => :'String',
    :'maximum_amount' => :'String',
    :'reference_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_date == o.end_date &&
      frequency == o.frequency &&
      number_of_payments == o.number_of_payments &&
      original_purchase_date == o.original_purchase_date &&
      sequence_number == o.sequence_number &&
      type == o.type &&
      occurrence == o.occurrence &&
      validation_indicator == o.validation_indicator &&
      amount_type == o.amount_type &&
      maximum_amount == o.maximum_amount &&
      reference_number == o.reference_number
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



270
271
272
273
274
275
276
277
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 249

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 the attribute

      # is documented as an array but the input is not

      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

See Also:

  • `==` method


236
237
238
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



242
243
244
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 242

def hash
  [end_date, frequency, number_of_payments, original_purchase_date, sequence_number, type, occurrence, validation_indicator, amount_type, maximum_amount, reference_number].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



157
158
159
160
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



316
317
318
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 316

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 322

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



310
311
312
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 310

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



164
165
166
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb', line 164

def valid?
  true
end