Class: PCPServerSDK::Models::CardPaymentMethodSpecificInput

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb

Overview

Object containing the specific input details for card payments.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardPaymentMethodSpecificInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authorization_mode ⇒ Object

Returns the value of attribute authorization_mode.



8
9
10
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 8

def authorization_mode
  @authorization_mode
end

#card ⇒ Object

Returns the value of attribute card.



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 27

def card
  @card
end

#card_on_file_recurring_expiration ⇒ Object

The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD Supported soon



36
37
38
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 36

def card_on_file_recurring_expiration
  @card_on_file_recurring_expiration
end

#card_on_file_recurring_frequency ⇒ Object

Period of payment occurrence for recurring and installment payments. Allowed values: * Yearly * Quarterly * Monthly * Weekly * Daily Supported soon



33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 33

def card_on_file_recurring_frequency
  @card_on_file_recurring_frequency
end

#payment_processing_token ⇒ Object

ID of the token to use to create the payment.



13
14
15
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 13

def payment_processing_token
  @payment_processing_token
end

#payment_product_id ⇒ Object

Payment product identifier - please check product documentation for a full overview of possible values.



25
26
27
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 25

def payment_product_id
  @payment_product_id
end

#recurring ⇒ Object

Returns the value of attribute recurring.



10
11
12
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 10

def recurring
  @recurring
end

#reporting_token ⇒ Object

Token to identify the card in the reporting.



16
17
18
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 16

def reporting_token
  @reporting_token
end

#return_url ⇒ Object

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.



30
31
32
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 30

def return_url
  @return_url
end

#transaction_channel ⇒ Object

Returns the value of attribute transaction_channel.



18
19
20
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 18

def transaction_channel
  @transaction_channel
end

#unscheduled_card_on_file_requestor ⇒ Object

Returns the value of attribute unscheduled_card_on_file_requestor.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 20

def unscheduled_card_on_file_requestor
  @unscheduled_card_on_file_requestor
end

#unscheduled_card_on_file_sequence_indicator ⇒ Object

Returns the value of attribute unscheduled_card_on_file_sequence_indicator.



22
23
24
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 22

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 229

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 = PCPServerSDK::Models.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



79
80
81
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 61

def self.attribute_map
  {
    :'authorization_mode' => :'authorizationMode',
    :'recurring' => :'recurring',
    :'payment_processing_token' => :'paymentProcessingToken',
    :'reporting_token' => :'reportingToken',
    :'transaction_channel' => :'transactionChannel',
    :'unscheduled_card_on_file_requestor' => :'unscheduledCardOnFileRequestor',
    :'unscheduled_card_on_file_sequence_indicator' => :'unscheduledCardOnFileSequenceIndicator',
    :'payment_product_id' => :'paymentProductId',
    :'card' => :'card',
    :'return_url' => :'returnUrl',
    :'card_on_file_recurring_frequency' => :'cardOnFileRecurringFrequency',
    :'card_on_file_recurring_expiration' => :'cardOnFileRecurringExpiration'
  }
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 205

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



102
103
104
105
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 84

def self.openapi_types
  {
    :'authorization_mode' => :'AuthorizationMode',
    :'recurring' => :'CardRecurrenceDetails',
    :'payment_processing_token' => :'String',
    :'reporting_token' => :'String',
    :'transaction_channel' => :'TransactionChannel',
    :'unscheduled_card_on_file_requestor' => :'UnscheduledCardOnFileRequestor',
    :'unscheduled_card_on_file_sequence_indicator' => :'UnscheduledCardOnFileSequenceIndicator',
    :'payment_product_id' => :'Integer',
    :'card' => :'CardInfo',
    :'return_url' => :'String',
    :'card_on_file_recurring_frequency' => :'String',
    :'card_on_file_recurring_expiration' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_mode == o.authorization_mode &&
      recurring == o.recurring &&
      payment_processing_token == o.payment_processing_token &&
      reporting_token == o.reporting_token &&
      transaction_channel == o.transaction_channel &&
      unscheduled_card_on_file_requestor == o.unscheduled_card_on_file_requestor &&
      unscheduled_card_on_file_sequence_indicator == o.unscheduled_card_on_file_sequence_indicator &&
      payment_product_id == o.payment_product_id &&
      card == o.card &&
      return_url == o.return_url &&
      card_on_file_recurring_frequency == o.card_on_file_recurring_frequency &&
      card_on_file_recurring_expiration == o.card_on_file_recurring_expiration
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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 300

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


192
193
194
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 198

def hash
  [authorization_mode, recurring, payment_processing_token, reporting_token, transaction_channel, unscheduled_card_on_file_requestor, unscheduled_card_on_file_sequence_indicator, payment_product_id, card, return_url, card_on_file_recurring_frequency, card_on_file_recurring_expiration].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 276

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 282

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



270
271
272
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 270

def to_s
  to_hash.to_s
end