class CyberSource::V2paymentsProcessingInformationAuthorizationOptions

Attributes

auth_indicator[RW]

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)

auth_type[RW]

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)

balance_inquiry[RW]

Flag that indicates whether to return balance information.

decline_avs_flags[RW]

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.

ignore_avs_result[RW]

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

ignore_cv_result[RW]

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

initiator[RW]
partial_auth_indicator[RW]

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)

verbal_auth_code[RW]

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)

verbal_auth_transaction_id[RW]

Transaction ID (TID).

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
auth_indicator=(auth_indicator) click to toggle source

Custom attribute writer method with validation @param [Object] auth_indicator Value to be assigned

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 220
def auth_indicator=(auth_indicator)
  if !auth_indicator.nil? && auth_indicator.to_s.length > 1
    fail ArgumentError, 'invalid value for "auth_indicator", the character length must be smaller than or equal to 1.'
  end

  @auth_indicator = auth_indicator
end
auth_type=(auth_type) click to toggle source

Custom attribute writer method with validation @param [Object] auth_type Value to be assigned

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 190
def auth_type=(auth_type)
  if !auth_type.nil? && auth_type.to_s.length > 15
    fail ArgumentError, 'invalid value for "auth_type", the character length must be smaller than or equal to 15.'
  end

  @auth_type = auth_type
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 247
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 327
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 321
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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
verbal_auth_code=(verbal_auth_code) click to toggle source

Custom attribute writer method with validation @param [Object] verbal_auth_code Value to be assigned

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 200
def verbal_auth_code=(verbal_auth_code)
  if !verbal_auth_code.nil? && verbal_auth_code.to_s.length > 7
    fail ArgumentError, 'invalid value for "verbal_auth_code", the character length must be smaller than or equal to 7.'
  end

  @verbal_auth_code = verbal_auth_code
end
verbal_auth_transaction_id=(verbal_auth_transaction_id) click to toggle source

Custom attribute writer method with validation @param [Object] verbal_auth_transaction_id Value to be assigned

# File lib/cyberSource_client/models/v2payments_processing_information_authorization_options.rb, line 210
def verbal_auth_transaction_id=(verbal_auth_transaction_id)
  if !verbal_auth_transaction_id.nil? && verbal_auth_transaction_id.to_s.length > 15
    fail ArgumentError, 'invalid value for "verbal_auth_transaction_id", the character length must be smaller than or equal to 15.'
  end

  @verbal_auth_transaction_id = verbal_auth_transaction_id
end