Class: CityPayApiClient::AuthRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthRequest

Initializes the object



190
191
192
193
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
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
267
268
269
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 190

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tag')
    if (value = attributes[:'tag']).is_a?(Array)
      self.tag = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#airline_data ⇒ Object

Returns the value of attribute airline_data.



18
19
20
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 18

def airline_data
  @airline_data
end

#amount ⇒ Object

The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits. No decimal points are to be included and no divisional characters such as 1,024. The amount should be the total amount required for the transaction. For example with GBP £1,021.95 the amount value is 102195.



21
22
23
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 21

def amount
  @amount
end

#avs_postcode_policy ⇒ Object

A policy value which determines whether an AVS postcode policy is enforced or bypassed. Values are: ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.



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

def avs_postcode_policy
  @avs_postcode_policy
end

#bill_to ⇒ Object

Returns the value of attribute bill_to.



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

def bill_to
  @bill_to
end

#cardholder_agreement ⇒ Object

Merchant-initiated transactions (MITs) are payments you trigger, where the cardholder has previously consented to you carrying out such payments. These may be scheduled (such as recurring payments and installments) or unscheduled (like account top-ups triggered by balance thresholds and no-show charges). Scheduled These are regular payments using stored card details, like installments or a monthly subscription fee. - ‘I` Instalment - A single purchase of goods or services billed to a cardholder in multiple transactions, over a period of time agreed by the cardholder and you. - `R` Recurring - Transactions processed at fixed, regular intervals not to exceed one year between transactions, representing an agreement between a cardholder and you to purchase goods or services provided over a period of time. Unscheduled These are payments using stored card details that do not occur on a regular schedule, like top-ups for a digital wallet triggered by the balance falling below a certain threshold. - `A` Reauthorisation - a purchase made after the original purchase. A common scenario is delayed/split shipments. - `C` Unscheduled Payment - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. This includes account top-ups triggered by balance thresholds. - `D` Delayed Charge - A delayed charge is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental account charge after original services are rendered. - `L` Incremental - An incremental authorisation is typically found in hotel and car rental environments, where the cardholder has agreed to pay for any service incurred during the duration of the contract. An incremental authorisation is where you need to seek authorisation of further funds in addition to what you have originally requested. A common scenario is additional services charged to the contract, such as extending a stay in a hotel. - `S` Resubmission - When the original purchase occurred, but you were not able to get authorisation at the time the goods or services were provided. It should be only used where the goods or services have already been provided, but the authorisation request is declined for insufficient funds. - `X` No-show - A no-show is a transaction where you are enabled to charge for services which the cardholder entered into an agreement to purchase, but the cardholder did not meet the terms of the agreement. - `N` Not Applicable - For all other transactions the value will be not applicable.



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

def cardholder_agreement
  @cardholder_agreement
end

#cardnumber ⇒ Object

The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value. The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting. The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes. When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.



32
33
34
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 32

def cardnumber
  @cardnumber
end

#cp_card_token ⇒ Object

The card token previously stored and created by the /tokenise route.



35
36
37
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 35

def cp_card_token
  @cp_card_token
end

#csc ⇒ Object

The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe. When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing. The CSC number aids fraud prevention in Mail Order and Internet payments. Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC. The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored. This applies to all entities handling card data. It should also not be used in any hashing process. CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.



38
39
40
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 38

def csc
  @csc
end

#csc_policy ⇒ Object

A policy value which determines whether a CSC policy is enforced or bypassed. Values are: ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.



41
42
43
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 41

def csc_policy
  @csc_policy
end

#currency ⇒ Object

The processing currency for the transaction. Will default to the merchant account currency.



44
45
46
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 44

def currency
  @currency
end

#duplicate_policy ⇒ Object

A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result. Values are ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window. `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window. `3` to ignore. Transactions that are ignored will have the same affect as bypass.



47
48
49
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 47

def duplicate_policy
  @duplicate_policy
end

#event_management ⇒ Object

Returns the value of attribute event_management.



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

def event_management
  @event_management
end

#expmonth ⇒ Object

The month of expiry of the card. The month value should be a numerical value between 1 and 12.



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

def expmonth
  @expmonth
end

#expyear ⇒ Object

The year of expiry of the card.



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

def expyear
  @expyear
end

#external_mpi ⇒ Object

Returns the value of attribute external_mpi.



57
58
59
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 57

def external_mpi
  @external_mpi
end

#identifier ⇒ Object

The identifier of the transaction to process. The value should be a valid reference and may be used to perform post processing actions and to aid in reconciliation of transactions. The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127. The identifier is recommended to be distinct for each transaction such as a [random unique identifier](en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable. When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.



60
61
62
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 60

def identifier
  @identifier
end

#initiation ⇒ Object

Transactions charged using the API are defined as: **Cardholder Initiated**: A _cardholder initiated transaction_ (CIT) is where the cardholder selects the card for use for a purchase using previously stored details. An example would be a customer buying an item from your website after being present with their saved card details at checkout. **Merchant Intiated**: A _merchant initiated transaction_ (MIT) is an authorisation initiated where you as the merchant submit a cardholders previously stored details without the cardholder’s participation. An example would be a subscription to a membership scheme to debit their card monthly. MITs have different reasons such as reauthorisation, delayed, unscheduled, incremental, recurring, instalment, no-show or resubmission. The following values apply - ‘M` - specifies that the transaction is initiated by the merchant - `C` - specifies that the transaction is initiated by the cardholder Where transactions are merchant initiated, a valid cardholder agreement must be defined.



63
64
65
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 63

def initiation
  @initiation
end

#match_avsa ⇒ Object

A policy value which determines whether an AVS address policy is enforced, bypassed or ignored. Values are: ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.



66
67
68
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 66

def match_avsa
  @match_avsa
end

#mcc6012 ⇒ Object

Returns the value of attribute mcc6012.



68
69
70
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 68

def mcc6012
  @mcc6012
end

#merchantid ⇒ Object

Identifies the merchant account to perform processing for.



71
72
73
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 71

def merchantid
  @merchantid
end

#name_on_card ⇒ Object

The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.



74
75
76
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 74

def name_on_card
  @name_on_card
end

#payment_intent_id ⇒ Object

A payment intent id previously registered that this transaction is linked to.



77
78
79
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 77

def payment_intent_id
  @payment_intent_id
end

#pre_auth ⇒ Object

A policy value which determines whether a pre auth policy is enforced or bypassed. Values are: ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Enforces pre-authorisation when it does not pre-auth by default. `2` to bypass. Bypasses pre-authorisation when it is enabled to pre auth by default. `3` to ignore. The same as the default policy (0). Although it currently mirrors the default, this option is included for compatibility with other policies.



80
81
82
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 80

def pre_auth
  @pre_auth
end

#ship_to ⇒ Object

Returns the value of attribute ship_to.



82
83
84
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 82

def ship_to
  @ship_to
end

#tag ⇒ Object

Returns the value of attribute tag.



84
85
86
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 84

def tag
  @tag
end

#threeds_token ⇒ Object

The threedsecure token generated by a call to /areq which may or may not be challenged.



87
88
89
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 87

def threeds_token
  @threeds_token
end

#threedsecure ⇒ Object

Returns the value of attribute threedsecure.



89
90
91
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 89

def threedsecure
  @threedsecure
end

#trans_info ⇒ Object

Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id.



92
93
94
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 92

def trans_info
  @trans_info
end

#trans_type ⇒ Object

The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field.



95
96
97
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 95

def trans_type
  @trans_type
end

#uuid ⇒ Object

A uuid for the session. The value tracks through 3ds session and therefore should be a valid v4 uuid.



98
99
100
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 98

def uuid
  @uuid
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 697

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



137
138
139
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 137

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



142
143
144
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 142

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



101
102
103
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
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 101

def self.attribute_map
  {
    :'airline_data' => :'airline_data',
    :'amount' => :'amount',
    :'avs_postcode_policy' => :'avs_postcode_policy',
    :'bill_to' => :'bill_to',
    :'cardholder_agreement' => :'cardholder_agreement',
    :'cardnumber' => :'cardnumber',
    :'cp_card_token' => :'cp_card_token',
    :'csc' => :'csc',
    :'csc_policy' => :'csc_policy',
    :'currency' => :'currency',
    :'duplicate_policy' => :'duplicate_policy',
    :'event_management' => :'event_management',
    :'expmonth' => :'expmonth',
    :'expyear' => :'expyear',
    :'external_mpi' => :'external_mpi',
    :'identifier' => :'identifier',
    :'initiation' => :'initiation',
    :'match_avsa' => :'match_avsa',
    :'mcc6012' => :'mcc6012',
    :'merchantid' => :'merchantid',
    :'name_on_card' => :'name_on_card',
    :'payment_intent_id' => :'payment_intent_id',
    :'pre_auth' => :'pre_auth',
    :'ship_to' => :'ship_to',
    :'tag' => :'tag',
    :'threeds_token' => :'threeds_token',
    :'threedsecure' => :'threedsecure',
    :'trans_info' => :'trans_info',
    :'trans_type' => :'trans_type',
    :'uuid' => :'uuid'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 673

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



183
184
185
186
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 183

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

.openapi_types ⇒ Object

Attribute type mapping.



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/citypay_api_client/models/auth_request.rb', line 147

def self.openapi_types
  {
    :'airline_data' => :'AirlineAdvice',
    :'amount' => :'Integer',
    :'avs_postcode_policy' => :'String',
    :'bill_to' => :'ContactDetails',
    :'cardholder_agreement' => :'String',
    :'cardnumber' => :'String',
    :'cp_card_token' => :'String',
    :'csc' => :'String',
    :'csc_policy' => :'String',
    :'currency' => :'String',
    :'duplicate_policy' => :'String',
    :'event_management' => :'EventDataModel',
    :'expmonth' => :'Integer',
    :'expyear' => :'Integer',
    :'external_mpi' => :'ExternalMPI',
    :'identifier' => :'String',
    :'initiation' => :'String',
    :'match_avsa' => :'String',
    :'mcc6012' => :'MCC6012',
    :'merchantid' => :'Integer',
    :'name_on_card' => :'String',
    :'payment_intent_id' => :'String',
    :'pre_auth' => :'String',
    :'ship_to' => :'ContactDetails',
    :'tag' => :'Array<String>',
    :'threeds_token' => :'String',
    :'threedsecure' => :'ThreeDSecure',
    :'trans_info' => :'String',
    :'trans_type' => :'String',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 623

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      airline_data == o.airline_data &&
      amount == o.amount &&
      avs_postcode_policy == o.avs_postcode_policy &&
      bill_to == o.bill_to &&
      cardholder_agreement == o.cardholder_agreement &&
      cardnumber == o.cardnumber &&
      cp_card_token == o.cp_card_token &&
      csc == o.csc &&
      csc_policy == o.csc_policy &&
      currency == o.currency &&
      duplicate_policy == o.duplicate_policy &&
      event_management == o.event_management &&
      expmonth == o.expmonth &&
      expyear == o.expyear &&
      external_mpi == o.external_mpi &&
      identifier == o.identifier &&
      initiation == o.initiation &&
      match_avsa == o.match_avsa &&
      mcc6012 == o.mcc6012 &&
      merchantid == o.merchantid &&
      name_on_card == o.name_on_card &&
      payment_intent_id == o.payment_intent_id &&
      pre_auth == o.pre_auth &&
      ship_to == o.ship_to &&
      tag == o.tag &&
      threeds_token == o.threeds_token &&
      threedsecure == o.threedsecure &&
      trans_info == o.trans_info &&
      trans_type == o.trans_type &&
      uuid == o.uuid
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 768

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

See Also:

  • `==` method


660
661
662
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 660

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



666
667
668
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 666

def hash
  [airline_data, amount, avs_postcode_policy, bill_to, cardholder_agreement, cardnumber, cp_card_token, csc, csc_policy, currency, duplicate_policy, event_management, expmonth, expyear, external_mpi, identifier, initiation, match_avsa, mcc6012, merchantid, name_on_card, payment_intent_id, pre_auth, ship_to, tag, threeds_token, threedsecure, trans_info, trans_type, uuid].hash
end

#list_invalid_properties ⇒ Object

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



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
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 335

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 !@cardholder_agreement.nil? && @cardholder_agreement.to_s.length > 1
    invalid_properties.push('invalid value for "cardholder_agreement", the character length must be smaller than or equal to 1.')
  end

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

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

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

  if !@csc.nil? && @csc.to_s.length < 3
    invalid_properties.push('invalid value for "csc", the character length must be greater 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 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 !@expmonth.nil? && @expmonth > 12
    invalid_properties.push('invalid value for "expmonth", must be smaller than or equal to 12.')
  end

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

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

  if !@expyear.nil? && @expyear < 2000
    invalid_properties.push('invalid value for "expyear", must be greater than or equal to 2000.')
  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 !@initiation.nil? && @initiation.to_s.length > 1
    invalid_properties.push('invalid value for "initiation", the character length must be smaller than or equal to 1.')
  end

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



744
745
746
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 744

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 750

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



738
739
740
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 738

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/citypay_api_client/models/auth_request.rb', line 435

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if !@cardholder_agreement.nil? && @cardholder_agreement.to_s.length > 1
  return false if !@cardnumber.nil? && @cardnumber.to_s.length > 22
  return false if !@cardnumber.nil? && @cardnumber.to_s.length < 12
  return false if !@csc.nil? && @csc.to_s.length > 4
  return false if !@csc.nil? && @csc.to_s.length < 3
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@currency.nil? && @currency.to_s.length < 3
  return false if !@expmonth.nil? && @expmonth > 12
  return false if !@expmonth.nil? && @expmonth < 1
  return false if !@expyear.nil? && @expyear > 2100
  return false if !@expyear.nil? && @expyear < 2000
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @identifier.to_s.length < 4
  return false if !@initiation.nil? && @initiation.to_s.length > 1
  return false if @merchantid.nil?
  return false if !@name_on_card.nil? && @name_on_card.to_s.length > 45
  return false if !@name_on_card.nil? && @name_on_card.to_s.length < 2
  return false if !@trans_info.nil? && @trans_info.to_s.length > 50
  return false if !@trans_type.nil? && @trans_type.to_s.length > 1
  return false if !@uuid.nil? && @uuid.to_s.length > 36
  return false if !@uuid.nil? && @uuid.to_s.length < 36
  true
end