Class: CityPayApiClient::PaylinkTokenRequestModel

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/paylink_token_request_model.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaylinkTokenRequestModel

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::PaylinkTokenRequestModel` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::PaylinkTokenRequestModel`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

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

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

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

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

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

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

  if attributes.key?(:'identifier')
    self.identifier = attributes[:'identifier']
  else
    self.identifier = nil
  end

  if attributes.key?(:'merchantid')
    self.merchantid = attributes[:'merchantid']
  else
    self.merchantid = nil
  end

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

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

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

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

Instance Attribute Details

#accountno ⇒ Object

To be able to use credential on file (COF) services. A cardholder account may be created once the payment has been authorised, this is then stored "on file" for subsequent charging for example re-authorisation, unscheduled payment, delayed charges, incremental authorisation, recurring payments, resubmission or no-show style agreements. Specifies an alpha-numeric account number that the Paylink service uses when creating a Cardholder Account. The value should be no longer than 20 characters in length.



19
20
21
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 19

def accountno
  @accountno
end

#amount ⇒ Object

Specifies the intended value of the transaction in the lowest denomination with no spacing characters or decimal point. This is the net total to be processed. An example of £74.95 would be presented as 7495.



22
23
24
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 22

def amount
  @amount
end

#cardholder ⇒ Object

Returns the value of attribute cardholder.



24
25
26
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 24

def cardholder
  @cardholder
end

#cart ⇒ Object

Returns the value of attribute cart.



26
27
28
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 26

def cart
  @cart
end

#client_version ⇒ Object

The clientVersion field is used to specify the version of your application that has invoked the Paylink payment process. This feature is typically used for tracing issues relating to application deployments, or any Paylink integration module or plugin.



29
30
31
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 29

def client_version
  @client_version
end

#config ⇒ Object

Returns the value of attribute config.



31
32
33
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 31

def config
  @config
end

#currency ⇒ Object

A currency for the token. This value should be only used on multi-currency accounts and be an appropriate currency which the account is configured for.



34
35
36
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 34

def currency
  @currency
end

#email ⇒ Object

The email field is used for the Merchant to be notified on completion of the transaction . The value may be supplied to override the default stored value. Emails sent to this address by the Paylink service should not be forwarded on to the cardholder as it may contain certain information that is used by the Paylink service to validate and authenticate Paylink Token Requests: for example, the Merchant ID and the licence key.



37
38
39
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 37

def email
  @email
end

#identifier ⇒ Object

Identifies a particular transaction linked to a Merchant account. It enables accurate duplicate checking within a pre-configured time period, as well as transaction reporting and tracing. The identifier should be unique to prevent payment card processing attempts from being rejected due to duplication.



40
41
42
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 40

def identifier
  @identifier
end

#merchantid ⇒ Object

The merchant id you wish to process this transaction with.



43
44
45
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 43

def merchantid
  @merchantid
end

#payment_intent_id ⇒ Object

A payment intent id already previously registered for this token.



46
47
48
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 46

def payment_intent_id
  @payment_intent_id
end

#recurring ⇒ Object

True if the intent of this cardholder initiated transaction is to establish a recurring payment model, processable as merchant initiated transactions.



49
50
51
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 49

def recurring
  @recurring
end

#subscription_id ⇒ Object

an id associated with a subscription to link the token request against.



52
53
54
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 52

def subscription_id
  @subscription_id
end

#tx_type ⇒ Object

A value to override the transaction type if requested by your account manager.



55
56
57
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 55

def tx_type
  @tx_type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
374
375
376
377
378
379
380
381
382
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 345

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 = CityPayApiClient.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 58

def self.attribute_map
  {
    :'accountno' => :'accountno',
    :'amount' => :'amount',
    :'cardholder' => :'cardholder',
    :'cart' => :'cart',
    :'client_version' => :'client_version',
    :'config' => :'config',
    :'currency' => :'currency',
    :'email' => :'email',
    :'identifier' => :'identifier',
    :'merchantid' => :'merchantid',
    :'payment_intent_id' => :'payment_intent_id',
    :'recurring' => :'recurring',
    :'subscription_id' => :'subscription_id',
    :'tx_type' => :'tx_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 321

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



108
109
110
111
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'accountno' => :'String',
    :'amount' => :'Integer',
    :'cardholder' => :'PaylinkCardHolder',
    :'cart' => :'PaylinkCart',
    :'client_version' => :'String',
    :'config' => :'PaylinkConfig',
    :'currency' => :'String',
    :'email' => :'String',
    :'identifier' => :'String',
    :'merchantid' => :'Integer',
    :'payment_intent_id' => :'String',
    :'recurring' => :'Boolean',
    :'subscription_id' => :'String',
    :'tx_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accountno == o.accountno &&
      amount == o.amount &&
      cardholder == o.cardholder &&
      cart == o.cart &&
      client_version == o.client_version &&
      config == o.config &&
      currency == o.currency &&
      email == o.email &&
      identifier == o.identifier &&
      merchantid == o.merchantid &&
      payment_intent_id == o.payment_intent_id &&
      recurring == o.recurring &&
      subscription_id == o.subscription_id &&
      tx_type == o.tx_type
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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 416

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:

  • to be compared

Returns:

See Also:

  • `==` method


308
309
310
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



314
315
316
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 314

def hash
  [accountno, amount, cardholder, cart, client_version, config, currency, email, identifier, merchantid, payment_intent_id, recurring, subscription_id, tx_type].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



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
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 194

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

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

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

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

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

  if @identifier.to_s.length > 50
    invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 50.')
  end

  if @identifier.to_s.length < 4
    invalid_properties.push('invalid value for "identifier", the character length must be greater than or equal to 4.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



392
393
394
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 392

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 398

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 presentation of the object



386
387
388
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 386

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/citypay_api_client/models/paylink_token_request_model.rb', line 234

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@currency.nil? && @currency.to_s.length < 3
  return false if !@email.nil? && @email.to_s.length > 254
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @identifier.to_s.length < 4
  return false if @merchantid.nil?
  true
end