Class: CyberSource::PostInstrumentIdentifierRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/post_instrument_identifier_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInstrumentIdentifierRequest

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
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 121

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'_links')
    self._links = attributes[:'_links']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'object')
    self.object = attributes[:'object']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

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

  if attributes.has_key?(:'tokenProvisioningInformation')
    self.token_provisioning_information = attributes[:'tokenProvisioningInformation']
  end

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

  if attributes.has_key?(:'pointOfSaleInformation')
    self.point_of_sale_information = attributes[:'pointOfSaleInformation']
  end

  if attributes.has_key?(:'bankAccount')
    self. = attributes[:'bankAccount']
  end

  if attributes.has_key?(:'tokenizedCard')
    self.tokenized_card = attributes[:'tokenizedCard']
  end

  if attributes.has_key?(:'issuer')
    self.issuer = attributes[:'issuer']
  end

  if attributes.has_key?(:'processingInformation')
    self.processing_information = attributes[:'processingInformation']
  end

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

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.has_key?(:'_embedded')
    self._embedded = attributes[:'_embedded']
  end
end

Instance Attribute Details

#_embedded ⇒ Object

Returns the value of attribute _embedded.



51
52
53
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 51

def _embedded
  @_embedded
end

#_links ⇒ Object

Returns the value of attribute _links.



16
17
18
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 16

def _links
  @_links
end

#bank_account ⇒ Object

Returns the value of attribute bank_account.



39
40
41
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 39

def 
  @bank_account
end

#bill_to ⇒ Object

Returns the value of attribute bill_to.



47
48
49
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 47

def bill_to
  @bill_to
end

#card ⇒ Object

Returns the value of attribute card.



35
36
37
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 35

def card
  @card
end

#id ⇒ Object

The Id of the Instrument Identifier Token.



19
20
21
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 19

def id
  @id
end

#issuer ⇒ Object

Returns the value of attribute issuer.



43
44
45
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 43

def issuer
  @issuer
end

#metadata ⇒ Object

Returns the value of attribute metadata.



49
50
51
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 49

def metadata
  @metadata
end

#object ⇒ Object

The type. Possible Values: - instrumentIdentifier



22
23
24
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 22

def object
  @object
end

#point_of_sale_information ⇒ Object

Returns the value of attribute point_of_sale_information.



37
38
39
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 37

def point_of_sale_information
  @point_of_sale_information
end

#processing_information ⇒ Object

Returns the value of attribute processing_information.



45
46
47
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 45

def processing_information
  @processing_information
end

#source ⇒ Object

Source of the card details. Possible Values: - CONTACTLESS_TAP



31
32
33
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 31

def source
  @source
end

#state ⇒ Object

Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed.



25
26
27
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 25

def state
  @state
end

#token_provisioning_information ⇒ Object

Returns the value of attribute token_provisioning_information.



33
34
35
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 33

def token_provisioning_information
  @token_provisioning_information
end

#tokenized_card ⇒ Object

Returns the value of attribute tokenized_card.



41
42
43
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 41

def tokenized_card
  @tokenized_card
end

#type ⇒ Object

The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token



28
29
30
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 28

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 54

def self.attribute_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'object' => :'object',
    :'state' => :'state',
    :'type' => :'type',
    :'source' => :'source',
    :'token_provisioning_information' => :'tokenProvisioningInformation',
    :'card' => :'card',
    :'point_of_sale_information' => :'pointOfSaleInformation',
    :'bank_account' => :'bankAccount',
    :'tokenized_card' => :'tokenizedCard',
    :'issuer' => :'issuer',
    :'processing_information' => :'processingInformation',
    :'bill_to' => :'billTo',
    :'metadata' => :'metadata',
    :'_embedded' => :'_embedded'
  }
end

.json_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 76

def self.json_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'object' => :'object',
    :'state' => :'state',
    :'type' => :'type',
    :'source' => :'source',
    :'token_provisioning_information' => :'token_provisioning_information',
    :'card' => :'card',
    :'point_of_sale_information' => :'point_of_sale_information',
    :'bank_account' => :'bank_account',
    :'tokenized_card' => :'tokenized_card',
    :'issuer' => :'issuer',
    :'processing_information' => :'processing_information',
    :'bill_to' => :'bill_to',
    :'metadata' => :'metadata',
    :'_embedded' => :'_embedded'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 98

def self.swagger_types
  {
    :'_links' => :'TmsEmbeddedInstrumentIdentifierLinks',
    :'id' => :'String',
    :'object' => :'String',
    :'state' => :'String',
    :'type' => :'String',
    :'source' => :'String',
    :'token_provisioning_information' => :'Ptsv2paymentsTokenInformationTokenProvisioningInformation',
    :'card' => :'TmsEmbeddedInstrumentIdentifierCard',
    :'point_of_sale_information' => :'TmsEmbeddedInstrumentIdentifierPointOfSaleInformation',
    :'bank_account' => :'TmsEmbeddedInstrumentIdentifierBankAccount',
    :'tokenized_card' => :'Tmsv2TokenizedCard',
    :'issuer' => :'TmsEmbeddedInstrumentIdentifierIssuer',
    :'processing_information' => :'TmsEmbeddedInstrumentIdentifierProcessingInformation',
    :'bill_to' => :'TmsEmbeddedInstrumentIdentifierBillTo',
    :'metadata' => :'TmsEmbeddedInstrumentIdentifierMetadata',
    :'_embedded' => :'TmsEmbeddedInstrumentIdentifierEmbedded'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      id == o.id &&
      object == o.object &&
      state == o.state &&
      type == o.type &&
      source == o.source &&
      token_provisioning_information == o.token_provisioning_information &&
      card == o.card &&
      point_of_sale_information == o.point_of_sale_information &&
       == o. &&
      tokenized_card == o.tokenized_card &&
      issuer == o.issuer &&
      processing_information == o.processing_information &&
      bill_to == o.bill_to &&
      metadata == o.metadata &&
      _embedded == o._embedded
end

#_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



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
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 264

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 330

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

#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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 236

def hash
  [_links, id, object, state, type, source, token_provisioning_information, card, point_of_sale_information, , tokenized_card, issuer, processing_information, bill_to, metadata, _embedded].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
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  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



310
311
312
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 310

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 316

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



304
305
306
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 304

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



201
202
203
 
# File 'lib/cybersource_rest_client/models/post_instrument_identifier_request.rb', line 201

def valid?
  true
end