Class: CyberSource::PostPaymentCredentialsRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostPaymentCredentialsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 74

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?(:'paymentCredentialType')
    self.payment_credential_type = attributes[:'paymentCredentialType']
  end

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

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

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

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

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

  if attributes.has_key?(:'authenticatedIdentities')
    if (value = attributes[:'authenticatedIdentities']).is_a?(Array)
      self.authenticated_identities = value
    end
  end
end

Instance Attribute Details

#authenticated_identities ⇒ Object

Returns the value of attribute authenticated_identities.



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

def authenticated_identities
  @authenticated_identities
end

#client_correlation_id ⇒ Object

Used to correlate authentication and payment credential requests.



23
24
25
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 23

def client_correlation_id
  @client_correlation_id
end

#device_information ⇒ Object

Returns the value of attribute device_information.



29
30
31
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 29

def device_information
  @device_information
end

#merchant_information ⇒ Object

Returns the value of attribute merchant_information.



27
28
29
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 27

def merchant_information
  @merchant_information
end

#order_information ⇒ Object

Returns the value of attribute order_information.



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

def order_information
  @order_information
end

#payment_credential_type ⇒ Object

The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If "NETWORK_TOKEN" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested. If "SECURITY_CODE" is supplied then dynamic CVV will be requested and returned with the network token card number. Dynamic CVV is only supported for Amex and SCOF. If "CRYPTOGRAM" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex. Possible Values: - NETWORK_TOKEN - SECURITY_CODE - CRYPTOGRAM



17
18
19
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 17

def payment_credential_type
  @payment_credential_type
end

#transaction_type ⇒ Object

Specifies the type of transaction for which the network token credentials are required. Possible Values: - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default. - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.



20
21
22
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 20

def transaction_type
  @transaction_type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 34

def self.attribute_map
  {
    :'payment_credential_type' => :'paymentCredentialType',
    :'transaction_type' => :'transactionType',
    :'client_correlation_id' => :'clientCorrelationId',
    :'order_information' => :'orderInformation',
    :'merchant_information' => :'merchantInformation',
    :'device_information' => :'deviceInformation',
    :'authenticated_identities' => :'authenticatedIdentities'
  }
end

.json_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 47

def self.json_map
  {
    :'payment_credential_type' => :'payment_credential_type',
    :'transaction_type' => :'transaction_type',
    :'client_correlation_id' => :'client_correlation_id',
    :'order_information' => :'order_information',
    :'merchant_information' => :'merchant_information',
    :'device_information' => :'device_information',
    :'authenticated_identities' => :'authenticated_identities'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 60

def self.swagger_types
  {
    :'payment_credential_type' => :'String',
    :'transaction_type' => :'String',
    :'client_correlation_id' => :'String',
    :'order_information' => :'Tmsv2tokenstokenIdpaymentcredentialsOrderInformation',
    :'merchant_information' => :'Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation',
    :'device_information' => :'Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation',
    :'authenticated_identities' => :'Array<Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_credential_type == o.payment_credential_type &&
      transaction_type == o.transaction_type &&
      client_correlation_id == o.client_correlation_id &&
      order_information == o.order_information &&
      merchant_information == o.merchant_information &&
      device_information == o.device_information &&
      authenticated_identities == o.authenticated_identities
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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 255

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 168

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


155
156
157
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 161

def hash
  [payment_credential_type, transaction_type, client_correlation_id, order_information, merchant_information, device_information, authenticated_identities].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



113
114
115
116
117
118
119
120
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 113

def list_invalid_properties
  invalid_properties = Array.new
  #if !@client_correlation_id.nil? && @client_correlation_id !~ Regexp.new(/[A-Za-z0-9]+/)
    #invalid_properties.push('invalid value for "client_correlation_id", must conform to the pattern /[A-Za-z0-9]+/.')
  #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



235
236
237
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 235

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 241

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



229
230
231
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 229

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



124
125
126
127
 
# File 'lib/cybersource_rest_client/models/post_payment_credentials_request.rb', line 124

def valid?
  #return false if !@client_correlation_id.nil? && @client_correlation_id !~ Regexp.new(/[A-Za-z0-9]+/)
  true
end