Class: CityPayApiClient::PaylinkTokenCreated

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaylinkTokenCreated

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachments ⇒ Object

Returns the value of attribute attachments.



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

def attachments
  @attachments
end

#bps ⇒ Object

true if BPS has been enabled on this token.



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

def bps
  @bps
end

#date_created ⇒ Object

Date and time the token was generated.



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

def date_created
  @date_created
end

#errors ⇒ Object

Returns the value of attribute errors.



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

def errors
  @errors
end

#id ⇒ Object

A unique id of the request.



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

def id
  @id
end

#identifier ⇒ Object

The identifier as presented in the TokenRequest.



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

def identifier
  @identifier
end

#merchantid ⇒ Object

The merchant id of the token.



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

def merchantid
  @merchantid
end

#mode ⇒ Object

Determines whether the token is live or test.



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

def mode
  @mode
end

#qrcode ⇒ Object

A URL of a qrcode which can be used to refer to the token URL.



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

def qrcode
  @qrcode
end

#result ⇒ Object

The result field contains the result for the Paylink Token Request. 0 - indicates that an error was encountered while creating the token. 1 - which indicates that a Token was successfully created.



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

def result
  @result
end

#server_version ⇒ Object

the version of the server performing the call.



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

def server_version
  @server_version
end

#source ⇒ Object

The incoming IP address of the call.



50
51
52
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 50

def source
  @source
end

#token ⇒ Object

A token generated for the request used to refer to the transaction in consequential calls.



53
54
55
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 53

def token
  @token
end

#url ⇒ Object

The Paylink token URL used to checkout by the card holder.



56
57
58
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 56

def url
  @url
end

#usc ⇒ Object

A UrlShortCode (USC) used for short links.



59
60
61
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 59

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 321

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 62

def self.attribute_map
  {
    :'attachments' => :'attachments',
    :'bps' => :'bps',
    :'date_created' => :'date_created',
    :'errors' => :'errors',
    :'id' => :'id',
    :'identifier' => :'identifier',
    :'merchantid' => :'merchantid',
    :'mode' => :'mode',
    :'qrcode' => :'qrcode',
    :'result' => :'result',
    :'server_version' => :'server_version',
    :'source' => :'source',
    :'token' => :'token',
    :'url' => :'url',
    :'usc' => :'usc'
  }
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 297

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



114
115
116
117
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 93

def self.openapi_types
  {
    :'attachments' => :'Array<PaylinkAttachmentResult>',
    :'bps' => :'String',
    :'date_created' => :'Time',
    :'errors' => :'Array<PaylinkErrorCode>',
    :'id' => :'String',
    :'identifier' => :'String',
    :'merchantid' => :'Integer',
    :'mode' => :'String',
    :'qrcode' => :'String',
    :'result' => :'Integer',
    :'server_version' => :'String',
    :'source' => :'String',
    :'token' => :'String',
    :'url' => :'String',
    :'usc' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attachments == o.attachments &&
      bps == o.bps &&
      date_created == o.date_created &&
      errors == o.errors &&
      id == o.id &&
      identifier == o.identifier &&
      merchantid == o.merchantid &&
      mode == o.mode &&
      qrcode == o.qrcode &&
      result == o.result &&
      server_version == o.server_version &&
      source == o.source &&
      token == o.token &&
      url == o.url &&
      usc == o.usc
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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 392

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


284
285
286
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 290

def hash
  [attachments, bps, date_created, errors, id, identifier, merchantid, mode, qrcode, result, server_version, source, token, url, usc].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



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

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

  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

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

  if @token.nil?
    invalid_properties.push('invalid value for "token", token cannot be nil.')
  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



368
369
370
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 368

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 374

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



362
363
364
 
# File 'lib/citypay_api_client/models/paylink_token_created.rb', line 362

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



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

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