Class: CyberSource::V2paymentsProcessingInformationAuthorizationOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsProcessingInformationAuthorizationOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 102

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

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

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

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

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

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

  if attributes.has_key?(:'ignoreAvsResult')
    self.ignore_avs_result = attributes[:'ignoreAvsResult']
  else
    self.ignore_avs_result = false
  end

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

  if attributes.has_key?(:'ignoreCvResult')
    self.ignore_cv_result = attributes[:'ignoreCvResult']
  else
    self.ignore_cv_result = false
  end

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

Instance Attribute Details

#auth_indicator ⇒ Object

Flag that specifies the purpose of the authorization. Possible values: - 0: Preauthorization - 1: Final authorization For processor-specific information, see the auth_indicator field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



27
28
29
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 27

def auth_indicator
  @auth_indicator
end

#auth_type ⇒ Object

Authorization type. Possible values: - AUTOCAPTURE: automatic capture. - STANDARDCAPTURE: standard capture. - VERBAL: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



18
19
20
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 18

def auth_type
  @auth_type
end

#balance_inquiry ⇒ Object

Flag that indicates whether to return balance information.



33
34
35
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 33

def balance_inquiry
  @balance_inquiry
end

#decline_avs_flags ⇒ Object

An array of AVS flags that cause the reply flag to be returned. ‘Important` To receive declines for the AVS code N, include the value N in the array.



39
40
41
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 39

def decline_avs_flags
  @decline_avs_flags
end

#ignore_avs_result ⇒ Object

Flag that indicates whether to allow the capture service to run even when the payment receives an AVS decline.



36
37
38
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 36

def ignore_avs_result
  @ignore_avs_result
end

#ignore_cv_result ⇒ Object

Flag that indicates whether to allow the capture service to run even when the payment receives a CVN decline.



42
43
44
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 42

def ignore_cv_result
  @ignore_cv_result
end

#initiator ⇒ Object

Returns the value of attribute initiator.



44
45
46
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 44

def initiator
  @initiator
end

#partial_auth_indicator ⇒ Object

Flag that indicates whether the transaction is enabled for partial authorization or not. When your request includes this field, this value overrides the information in your CyberSource account. For processor-specific information, see the auth_partial_auth_indicator field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



30
31
32
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 30

def partial_auth_indicator
  @partial_auth_indicator
end

#verbal_auth_code ⇒ Object

Authorization code. **Forced Capture** Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. **Verbal Authorization** Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the auth_code field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



21
22
23
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 21

def verbal_auth_code
  @verbal_auth_code
end

#verbal_auth_transaction_id ⇒ Object

Transaction ID (TID).



24
25
26
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 24

def verbal_auth_transaction_id
  @verbal_auth_transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 69

def self.attribute_map
  {
    :'auth_type' => :'authType',
    :'verbal_auth_code' => :'verbalAuthCode',
    :'verbal_auth_transaction_id' => :'verbalAuthTransactionId',
    :'auth_indicator' => :'authIndicator',
    :'partial_auth_indicator' => :'partialAuthIndicator',
    :'balance_inquiry' => :'balanceInquiry',
    :'ignore_avs_result' => :'ignoreAvsResult',
    :'decline_avs_flags' => :'declineAvsFlags',
    :'ignore_cv_result' => :'ignoreCvResult',
    :'initiator' => :'initiator'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 85

def self.swagger_types
  {
    :'auth_type' => :'String',
    :'verbal_auth_code' => :'String',
    :'verbal_auth_transaction_id' => :'String',
    :'auth_indicator' => :'String',
    :'partial_auth_indicator' => :'BOOLEAN',
    :'balance_inquiry' => :'BOOLEAN',
    :'ignore_avs_result' => :'BOOLEAN',
    :'decline_avs_flags' => :'Array<String>',
    :'ignore_cv_result' => :'BOOLEAN',
    :'initiator' => :'V2paymentsProcessingInformationAuthorizationOptionsInitiator'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_type == o.auth_type &&
      verbal_auth_code == o.verbal_auth_code &&
      verbal_auth_transaction_id == o.verbal_auth_transaction_id &&
      auth_indicator == o.auth_indicator &&
      partial_auth_indicator == o.partial_auth_indicator &&
      balance_inquiry == o.balance_inquiry &&
      ignore_avs_result == o.ignore_avs_result &&
      decline_avs_flags == o.decline_avs_flags &&
      ignore_cv_result == o.ignore_cv_result &&
      initiator == o.initiator
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



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
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 281

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 347

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 260

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


247
248
249
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 253

def hash
  [auth_type, verbal_auth_code, verbal_auth_transaction_id, auth_indicator, partial_auth_indicator, balance_inquiry, ignore_avs_result, decline_avs_flags, ignore_cv_result, initiator].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if !@auth_type.nil? && @auth_type.to_s.length > 15
    invalid_properties.push('invalid value for "auth_type", the character length must be smaller than or equal to 15.')
  end

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

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

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



327
328
329
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 327

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



333
334
335
336
337
338
339
340
341
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 333

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



321
322
323
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 321

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



180
181
182
183
184
185
186
 
# File 'lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb', line 180

def valid?
  return false if !@auth_type.nil? && @auth_type.to_s.length > 15
  return false if !@verbal_auth_code.nil? && @verbal_auth_code.to_s.length > 7
  return false if !@verbal_auth_transaction_id.nil? && @verbal_auth_transaction_id.to_s.length > 15
  return false if !@auth_indicator.nil? && @auth_indicator.to_s.length > 1
  true
end