Class: CityPayApiClient::PaylinkTokenStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaylinkTokenStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



187
188
189
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
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 187

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_paid ⇒ Object

the amount that has been paid against the session.



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

def amount_paid
  @amount_paid
end

#auth_code ⇒ Object

an authorisation code if the transaction was processed and isPaid is true.



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

def auth_code
  @auth_code
end

#card ⇒ Object

a description of the card that was used for payment if paid.



25
26
27
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 25

def card
  @card
end

#created ⇒ Object

the date and time that the session was created.



28
29
30
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 28

def created
  @created
end

#datetime ⇒ Object

the date and time of the current status.



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

def datetime
  @datetime
end

#identifier ⇒ Object

the merchant identifier, to help identifying the token.



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

def identifier
  @identifier
end

#is_attachment ⇒ Object

true if an attachment exists.



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

def is_attachment
  @is_attachment
end

#is_cancelled ⇒ Object

true if the session was cancelled either by the user or by a system request.



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

def is_cancelled
  @is_cancelled
end

#is_closed ⇒ Object

true if the token has been closed.



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

def is_closed
  @is_closed
end

#is_customer_receipt_email_sent ⇒ Object

true if a customer receipt has been sent.



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

def is_customer_receipt_email_sent
  @is_customer_receipt_email_sent
end

#is_email_sent ⇒ Object

true if an email was sent.



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

def is_email_sent
  @is_email_sent
end

#is_expired ⇒ Object

true if the session has expired.



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

def is_expired
  @is_expired
end

#is_form_viewed ⇒ Object

true if the form was ever displayed to the addressee.



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

def is_form_viewed
  @is_form_viewed
end

#is_merchant_notification_email_sent ⇒ Object

true if a merchant notification receipt was sent.



58
59
60
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 58

def is_merchant_notification_email_sent
  @is_merchant_notification_email_sent
end

#is_open_for_payment ⇒ Object

true if the session is still open for payment or false if it has been closed.



61
62
63
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 61

def is_open_for_payment
  @is_open_for_payment
end

#is_paid ⇒ Object

whether the session has been paid and therefore can be considered as complete.



64
65
66
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 64

def is_paid
  @is_paid
end

#is_payment_attempted ⇒ Object

true if payment has been attempted.



67
68
69
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 67

def is_payment_attempted
  @is_payment_attempted
end

#is_postback_ok ⇒ Object

true if a post back was executed successfully.



70
71
72
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 70

def is_postback_ok
  @is_postback_ok
end

#is_request_challenged ⇒ Object

true if the request has been challenged using 3-D Secure.



73
74
75
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 73

def is_request_challenged
  @is_request_challenged
end

#is_sms_sent ⇒ Object

true if an SMS was sent.



76
77
78
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 76

def is_sms_sent
  @is_sms_sent
end

#is_validated ⇒ Object

whether the token generation was successfully validated.



79
80
81
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 79

def is_validated
  @is_validated
end

#last_event_date_time ⇒ Object

the date and time that the session last had an event actioned against it.



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

def last_event_date_time
  @last_event_date_time
end

#last_payment_result ⇒ Object

the result of the last payment if one exists.



85
86
87
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 85

def last_payment_result
  @last_payment_result
end

#mid ⇒ Object

identifies the merchant account.



88
89
90
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 88

def mid
  @mid
end

#payment_attempts_count ⇒ Object

the number of attempts made to pay.



91
92
93
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 91

def payment_attempts_count
  @payment_attempts_count
end

#state_history ⇒ Object

Returns the value of attribute state_history.



93
94
95
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 93

def state_history
  @state_history
end

#token ⇒ Object

the token value which uniquely identifies the session.



96
97
98
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 96

def token
  @token
end

#trans_no ⇒ Object

a transaction number if the transacstion was processed and isPaid is true.



99
100
101
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 99

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



429
430
431
432
433
434
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
462
463
464
465
466
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 429

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



136
137
138
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 136

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



141
142
143
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 141

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'amount_paid' => :'amount_paid',
    :'auth_code' => :'auth_code',
    :'card' => :'card',
    :'created' => :'created',
    :'datetime' => :'datetime',
    :'identifier' => :'identifier',
    :'is_attachment' => :'is_attachment',
    :'is_cancelled' => :'is_cancelled',
    :'is_closed' => :'is_closed',
    :'is_customer_receipt_email_sent' => :'is_customer_receipt_email_sent',
    :'is_email_sent' => :'is_email_sent',
    :'is_expired' => :'is_expired',
    :'is_form_viewed' => :'is_form_viewed',
    :'is_merchant_notification_email_sent' => :'is_merchant_notification_email_sent',
    :'is_open_for_payment' => :'is_open_for_payment',
    :'is_paid' => :'is_paid',
    :'is_payment_attempted' => :'is_payment_attempted',
    :'is_postback_ok' => :'is_postback_ok',
    :'is_request_challenged' => :'is_request_challenged',
    :'is_sms_sent' => :'is_sms_sent',
    :'is_validated' => :'is_validated',
    :'last_event_date_time' => :'last_event_date_time',
    :'last_payment_result' => :'last_payment_result',
    :'mid' => :'mid',
    :'payment_attempts_count' => :'payment_attempts_count',
    :'state_history' => :'state_history',
    :'token' => :'token',
    :'trans_no' => :'trans_no'
  }
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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 405

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



180
181
182
183
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 180

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'amount_paid' => :'Integer',
    :'auth_code' => :'String',
    :'card' => :'String',
    :'created' => :'Time',
    :'datetime' => :'Time',
    :'identifier' => :'String',
    :'is_attachment' => :'Boolean',
    :'is_cancelled' => :'Boolean',
    :'is_closed' => :'Boolean',
    :'is_customer_receipt_email_sent' => :'Boolean',
    :'is_email_sent' => :'Boolean',
    :'is_expired' => :'Boolean',
    :'is_form_viewed' => :'Boolean',
    :'is_merchant_notification_email_sent' => :'Boolean',
    :'is_open_for_payment' => :'Boolean',
    :'is_paid' => :'Boolean',
    :'is_payment_attempted' => :'Boolean',
    :'is_postback_ok' => :'Boolean',
    :'is_request_challenged' => :'Boolean',
    :'is_sms_sent' => :'Boolean',
    :'is_validated' => :'Boolean',
    :'last_event_date_time' => :'Time',
    :'last_payment_result' => :'String',
    :'mid' => :'Integer',
    :'payment_attempts_count' => :'Integer',
    :'state_history' => :'Array<PaylinkStateEvent>',
    :'token' => :'String',
    :'trans_no' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount_paid == o.amount_paid &&
      auth_code == o.auth_code &&
      card == o.card &&
      created == o.created &&
      datetime == o.datetime &&
      identifier == o.identifier &&
      is_attachment == o.is_attachment &&
      is_cancelled == o.is_cancelled &&
      is_closed == o.is_closed &&
      is_customer_receipt_email_sent == o.is_customer_receipt_email_sent &&
      is_email_sent == o.is_email_sent &&
      is_expired == o.is_expired &&
      is_form_viewed == o.is_form_viewed &&
      is_merchant_notification_email_sent == o.is_merchant_notification_email_sent &&
      is_open_for_payment == o.is_open_for_payment &&
      is_paid == o.is_paid &&
      is_payment_attempted == o.is_payment_attempted &&
      is_postback_ok == o.is_postback_ok &&
      is_request_challenged == o.is_request_challenged &&
      is_sms_sent == o.is_sms_sent &&
      is_validated == o.is_validated &&
      last_event_date_time == o.last_event_date_time &&
      last_payment_result == o.last_payment_result &&
      mid == o.mid &&
      payment_attempts_count == o.payment_attempts_count &&
      state_history == o.state_history &&
      token == o.token &&
      trans_no == o.trans_no
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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 500

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



398
399
400
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 398

def hash
  [amount_paid, auth_code, card, created, datetime, identifier, is_attachment, is_cancelled, is_closed, is_customer_receipt_email_sent, is_email_sent, is_expired, is_form_viewed, is_merchant_notification_email_sent, is_open_for_payment, is_paid, is_payment_attempted, is_postback_ok, is_request_challenged, is_sms_sent, is_validated, last_event_date_time, last_payment_result, mid, payment_attempts_count, state_history, token, trans_no].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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 318

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@identifier.nil? && @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.nil? && @identifier.to_s.length < 4
    invalid_properties.push('invalid value for "identifier", the character length must be greater than or equal to 4.')
  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



476
477
478
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 476

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



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 482

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



470
471
472
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 470

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



334
335
336
337
338
339
 
# File 'lib/citypay_api_client/models/paylink_token_status.rb', line 334

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