fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/v1_tokens_ach_request.rb

@@ -0,0 +1,525 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1TokensAchRequest Model.
+  class V1TokensAchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account holder name
+    # >For CC, this is the 'Name (as it appears) on Card'. For ACH, this is the
+    # 'Name on Account'.
+    # >
+    # @return [String]
+    attr_accessor :account_holder_name
+
+    # Account number
+    # >For CC transactions, a credit card number. For ACH transactions, a bank
+    # account number. String lengths are conditional, CC should be 13-19 and ACH
+    # should be 4-19.
+    # >
+    # @return [String]
+    attr_accessor :account_number
+
+    # This field can be used to correlate Tokens in our system to data within an
+    # outside software integration
+    # >Must be unique per location. When running a transaction and using a
+    # stored token, this field can be used in place of account_vault_id.
+    # >
+    # @return [String]
+    attr_accessor :account_vault_api_id
+
+    # This field can be used to correlate Tokens in our system to data within an
+    # outside software integration
+    # >Must be unique per location. When running a transaction and using a
+    # stored token, this field can be used in place of token_id.
+    # >
+    # @return [String]
+    attr_accessor :token_api_id
+
+    # DEPRECATED (Use token_c1 instead)
+    # @return [String]
+    attr_accessor :accountvault_c1
+
+    # DEPRECATED (Use token_c2 instead)
+    # @return [String]
+    attr_accessor :accountvault_c2
+
+    # DEPRECATED (Use token_c3 instead)
+    # @return [String]
+    attr_accessor :accountvault_c3
+
+    # Custom field 1 for API users to store custom data
+    # @return [String]
+    attr_accessor :token_c1
+
+    # Custom field 2 for API users to store custom data
+    # @return [String]
+    attr_accessor :token_c2
+
+    # Custom field 3 for API users to store custom data
+    # @return [String]
+    attr_accessor :token_c3
+
+    # SEC code for the account
+    # @return [AchSecCode3Enum]
+    attr_accessor :ach_sec_code
+
+    # Billing Address Object
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # Used to associate the Token with a Contact.
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Used to store a customer identification number.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Identity verification
+    # @return [IdentityVerification2]
+    attr_accessor :identity_verification
+
+    # A valid Location Id associated with the Contact for this Token
+    # @return [String]
+    attr_accessor :location_id
+
+    # Can be used to pull payment info from a previous token api id.
+    # @return [String]
+    attr_accessor :previous_account_vault_api_id
+
+    # Can be used to pull payment info from a previous token api id.
+    # @return [String]
+    attr_accessor :previous_token_api_id
+
+    # Can be used to pull payment info from a previous token.
+    # @return [String]
+    attr_accessor :previous_account_vault_id
+
+    # Can be used to pull payment info from a previous token.
+    # @return [String]
+    attr_accessor :previous_token_id
+
+    # Can be used to pull payment info from a previous transaction.
+    # @return [String]
+    attr_accessor :previous_transaction_id
+
+    # Terms agreement.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :terms_agree
+
+    # The ip address of the client that agreed to terms.
+    # @return [String]
+    attr_accessor :terms_agree_ip
+
+    # Used to describe the Token for easier identification within our UI.
+    # @return [String]
+    attr_accessor :title
+
+    # Token Import Id
+    # @return [String]
+    attr_accessor :token_import_id
+
+    # (ECOMM) Directory Server Transaction ID (Such as XID, TAVV)
+    # @return [String]
+    attr_accessor :secure_directory_server_transaction_id
+
+    # (ECOMM)  Secure Program Protocol Version
+    # @return [Integer]
+    attr_accessor :secure_protocol_version
+
+    # (ECOMM) The token authentication value associated with 3D secure
+    # transactions (Such as CAVV, UCAF auth data)
+    # @return [String]
+    attr_accessor :secure_auth_data
+
+    # (ECOMM) Used for UCAF collection indicator or Discover Autentication type
+    # @return [Integer]
+    attr_accessor :secure_collection_indicator
+
+    # 3DS Server Transaction ID.  If this field is sent and 3DS authentication
+    # was done with Fortis, the 3DS fields
+    # secure_directory_server_transaction_id, secure_protocol_version, and
+    # secure_collection_indicator will be pre-populated.
+    # @return [String]
+    attr_accessor :three_ds_server_trans_id
+
+    # ACS Transaction ID
+    # @return [String]
+    attr_accessor :acs_transaction_id
+
+    # ACS Transaction ID
+    # @return [Joi18]
+    attr_accessor :joi
+
+    # Account type
+    # >For ACH, must be provided as either 'checking' or 'savings'. For CC,
+    # field is read only. System will identify card_type and generate a value
+    # for this field automatically. i.e. visa, mc, disc, amex, jcb, diners.
+    # >
+    # @return [AccountType13Enum]
+    attr_accessor :account_type
+
+    # This identifies whether the ACH account belongs to a company or
+    # individual. This can affect which SEC code is used when attempting to run
+    # a transaction.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_company
+
+    # Required for ACH. The Routing Number for the bank account being used.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_holder_name'] = 'account_holder_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_vault_api_id'] = 'account_vault_api_id'
+      @_hash['token_api_id'] = 'token_api_id'
+      @_hash['accountvault_c1'] = 'accountvault_c1'
+      @_hash['accountvault_c2'] = 'accountvault_c2'
+      @_hash['accountvault_c3'] = 'accountvault_c3'
+      @_hash['token_c1'] = 'token_c1'
+      @_hash['token_c2'] = 'token_c2'
+      @_hash['token_c3'] = 'token_c3'
+      @_hash['ach_sec_code'] = 'ach_sec_code'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['identity_verification'] = 'identity_verification'
+      @_hash['location_id'] = 'location_id'
+      @_hash['previous_account_vault_api_id'] =
+        'previous_account_vault_api_id'
+      @_hash['previous_token_api_id'] = 'previous_token_api_id'
+      @_hash['previous_account_vault_id'] = 'previous_account_vault_id'
+      @_hash['previous_token_id'] = 'previous_token_id'
+      @_hash['previous_transaction_id'] = 'previous_transaction_id'
+      @_hash['terms_agree'] = 'terms_agree'
+      @_hash['terms_agree_ip'] = 'terms_agree_ip'
+      @_hash['title'] = 'title'
+      @_hash['token_import_id'] = 'token_import_id'
+      @_hash['secure_directory_server_transaction_id'] =
+        'secure_directory_server_transaction_id'
+      @_hash['secure_protocol_version'] = 'secure_protocol_version'
+      @_hash['secure_auth_data'] = 'secure_auth_data'
+      @_hash['secure_collection_indicator'] = 'secure_collection_indicator'
+      @_hash['three_ds_server_trans_id'] = 'three_ds_server_trans_id'
+      @_hash['acs_transaction_id'] = 'acs_transaction_id'
+      @_hash['joi'] = '_joi'
+      @_hash['account_type'] = 'account_type'
+      @_hash['is_company'] = 'is_company'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_holder_name
+        account_number
+        account_vault_api_id
+        token_api_id
+        accountvault_c1
+        accountvault_c2
+        accountvault_c3
+        token_c1
+        token_c2
+        token_c3
+        ach_sec_code
+        billing_address
+        contact_id
+        customer_id
+        identity_verification
+        previous_account_vault_api_id
+        previous_token_api_id
+        previous_account_vault_id
+        previous_token_id
+        previous_transaction_id
+        terms_agree
+        terms_agree_ip
+        title
+        token_import_id
+        secure_directory_server_transaction_id
+        secure_protocol_version
+        secure_auth_data
+        secure_collection_indicator
+        three_ds_server_trans_id
+        acs_transaction_id
+        joi
+        account_type
+        is_company
+        routing_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_holder_name
+        account_number
+        account_vault_api_id
+        token_api_id
+        accountvault_c1
+        accountvault_c2
+        accountvault_c3
+        token_c1
+        token_c2
+        token_c3
+        ach_sec_code
+        contact_id
+        customer_id
+        previous_account_vault_api_id
+        previous_token_api_id
+        previous_account_vault_id
+        previous_token_id
+        previous_transaction_id
+        terms_agree_ip
+        title
+        token_import_id
+        secure_directory_server_transaction_id
+        secure_protocol_version
+        secure_auth_data
+        secure_collection_indicator
+        three_ds_server_trans_id
+        acs_transaction_id
+        account_type
+        routing_number
+      ]
+    end
+
+    def initialize(location_id = nil, account_holder_name = SKIP,
+                   account_number = SKIP, account_vault_api_id = SKIP,
+                   token_api_id = SKIP, accountvault_c1 = SKIP,
+                   accountvault_c2 = SKIP, accountvault_c3 = SKIP,
+                   token_c1 = SKIP, token_c2 = SKIP, token_c3 = SKIP,
+                   ach_sec_code = SKIP, billing_address = SKIP,
+                   contact_id = SKIP, customer_id = SKIP,
+                   identity_verification = SKIP,
+                   previous_account_vault_api_id = SKIP,
+                   previous_token_api_id = SKIP,
+                   previous_account_vault_id = SKIP, previous_token_id = SKIP,
+                   previous_transaction_id = SKIP, terms_agree = SKIP,
+                   terms_agree_ip = SKIP, title = SKIP, token_import_id = SKIP,
+                   secure_directory_server_transaction_id = SKIP,
+                   secure_protocol_version = SKIP, secure_auth_data = SKIP,
+                   secure_collection_indicator = SKIP,
+                   three_ds_server_trans_id = SKIP, acs_transaction_id = SKIP,
+                   joi = SKIP, account_type = SKIP, is_company = false,
+                   routing_number = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @account_holder_name = account_holder_name unless account_holder_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_vault_api_id = account_vault_api_id unless account_vault_api_id == SKIP
+      @token_api_id = token_api_id unless token_api_id == SKIP
+      @accountvault_c1 = accountvault_c1 unless accountvault_c1 == SKIP
+      @accountvault_c2 = accountvault_c2 unless accountvault_c2 == SKIP
+      @accountvault_c3 = accountvault_c3 unless accountvault_c3 == SKIP
+      @token_c1 = token_c1 unless token_c1 == SKIP
+      @token_c2 = token_c2 unless token_c2 == SKIP
+      @token_c3 = token_c3 unless token_c3 == SKIP
+      @ach_sec_code = ach_sec_code unless ach_sec_code == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @identity_verification = identity_verification unless identity_verification == SKIP
+      @location_id = location_id
+      unless previous_account_vault_api_id == SKIP
+        @previous_account_vault_api_id =
+          previous_account_vault_api_id
+      end
+      @previous_token_api_id = previous_token_api_id unless previous_token_api_id == SKIP
+      unless previous_account_vault_id == SKIP
+        @previous_account_vault_id =
+          previous_account_vault_id
+      end
+      @previous_token_id = previous_token_id unless previous_token_id == SKIP
+      @previous_transaction_id = previous_transaction_id unless previous_transaction_id == SKIP
+      @terms_agree = terms_agree unless terms_agree == SKIP
+      @terms_agree_ip = terms_agree_ip unless terms_agree_ip == SKIP
+      @title = title unless title == SKIP
+      @token_import_id = token_import_id unless token_import_id == SKIP
+      unless secure_directory_server_transaction_id == SKIP
+        @secure_directory_server_transaction_id =
+          secure_directory_server_transaction_id
+      end
+      @secure_protocol_version = secure_protocol_version unless secure_protocol_version == SKIP
+      @secure_auth_data = secure_auth_data unless secure_auth_data == SKIP
+      unless secure_collection_indicator == SKIP
+        @secure_collection_indicator =
+          secure_collection_indicator
+      end
+      @three_ds_server_trans_id = three_ds_server_trans_id unless three_ds_server_trans_id == SKIP
+      @acs_transaction_id = acs_transaction_id unless acs_transaction_id == SKIP
+      @joi = joi unless joi == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @is_company = is_company unless is_company == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      account_holder_name =
+        hash.key?('account_holder_name') ? hash['account_holder_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_vault_api_id =
+        hash.key?('account_vault_api_id') ? hash['account_vault_api_id'] : SKIP
+      token_api_id = hash.key?('token_api_id') ? hash['token_api_id'] : SKIP
+      accountvault_c1 =
+        hash.key?('accountvault_c1') ? hash['accountvault_c1'] : SKIP
+      accountvault_c2 =
+        hash.key?('accountvault_c2') ? hash['accountvault_c2'] : SKIP
+      accountvault_c3 =
+        hash.key?('accountvault_c3') ? hash['accountvault_c3'] : SKIP
+      token_c1 = hash.key?('token_c1') ? hash['token_c1'] : SKIP
+      token_c2 = hash.key?('token_c2') ? hash['token_c2'] : SKIP
+      token_c3 = hash.key?('token_c3') ? hash['token_c3'] : SKIP
+      ach_sec_code = hash.key?('ach_sec_code') ? hash['ach_sec_code'] : SKIP
+      billing_address = BillingAddress.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      identity_verification = IdentityVerification2.from_hash(hash['identity_verification']) if
+        hash['identity_verification']
+      previous_account_vault_api_id =
+        hash.key?('previous_account_vault_api_id') ? hash['previous_account_vault_api_id'] : SKIP
+      previous_token_api_id =
+        hash.key?('previous_token_api_id') ? hash['previous_token_api_id'] : SKIP
+      previous_account_vault_id =
+        hash.key?('previous_account_vault_id') ? hash['previous_account_vault_id'] : SKIP
+      previous_token_id =
+        hash.key?('previous_token_id') ? hash['previous_token_id'] : SKIP
+      previous_transaction_id =
+        hash.key?('previous_transaction_id') ? hash['previous_transaction_id'] : SKIP
+      terms_agree = hash.key?('terms_agree') ? hash['terms_agree'] : SKIP
+      terms_agree_ip =
+        hash.key?('terms_agree_ip') ? hash['terms_agree_ip'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      token_import_id =
+        hash.key?('token_import_id') ? hash['token_import_id'] : SKIP
+      secure_directory_server_transaction_id =
+        hash.key?('secure_directory_server_transaction_id') ? hash['secure_directory_server_transaction_id'] : SKIP
+      secure_protocol_version =
+        hash.key?('secure_protocol_version') ? hash['secure_protocol_version'] : SKIP
+      secure_auth_data =
+        hash.key?('secure_auth_data') ? hash['secure_auth_data'] : SKIP
+      secure_collection_indicator =
+        hash.key?('secure_collection_indicator') ? hash['secure_collection_indicator'] : SKIP
+      three_ds_server_trans_id =
+        hash.key?('three_ds_server_trans_id') ? hash['three_ds_server_trans_id'] : SKIP
+      acs_transaction_id =
+        hash.key?('acs_transaction_id') ? hash['acs_transaction_id'] : SKIP
+      joi = Joi18.from_hash(hash['_joi']) if hash['_joi']
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      is_company = hash['is_company'] ||= false
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1TokensAchRequest.new(location_id,
+                             account_holder_name,
+                             account_number,
+                             account_vault_api_id,
+                             token_api_id,
+                             accountvault_c1,
+                             accountvault_c2,
+                             accountvault_c3,
+                             token_c1,
+                             token_c2,
+                             token_c3,
+                             ach_sec_code,
+                             billing_address,
+                             contact_id,
+                             customer_id,
+                             identity_verification,
+                             previous_account_vault_api_id,
+                             previous_token_api_id,
+                             previous_account_vault_id,
+                             previous_token_id,
+                             previous_transaction_id,
+                             terms_agree,
+                             terms_agree_ip,
+                             title,
+                             token_import_id,
+                             secure_directory_server_transaction_id,
+                             secure_protocol_version,
+                             secure_auth_data,
+                             secure_collection_indicator,
+                             three_ds_server_trans_id,
+                             acs_transaction_id,
+                             joi,
+                             account_type,
+                             is_company,
+                             routing_number,
+                             additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_holder_name: #{@account_holder_name}, account_number:"\
+      " #{@account_number}, account_vault_api_id: #{@account_vault_api_id}, token_api_id:"\
+      " #{@token_api_id}, accountvault_c1: #{@accountvault_c1}, accountvault_c2:"\
+      " #{@accountvault_c2}, accountvault_c3: #{@accountvault_c3}, token_c1: #{@token_c1},"\
+      " token_c2: #{@token_c2}, token_c3: #{@token_c3}, ach_sec_code: #{@ach_sec_code},"\
+      " billing_address: #{@billing_address}, contact_id: #{@contact_id}, customer_id:"\
+      " #{@customer_id}, identity_verification: #{@identity_verification}, location_id:"\
+      " #{@location_id}, previous_account_vault_api_id: #{@previous_account_vault_api_id},"\
+      " previous_token_api_id: #{@previous_token_api_id}, previous_account_vault_id:"\
+      " #{@previous_account_vault_id}, previous_token_id: #{@previous_token_id},"\
+      " previous_transaction_id: #{@previous_transaction_id}, terms_agree: #{@terms_agree},"\
+      " terms_agree_ip: #{@terms_agree_ip}, title: #{@title}, token_import_id:"\
+      " #{@token_import_id}, secure_directory_server_transaction_id:"\
+      " #{@secure_directory_server_transaction_id}, secure_protocol_version:"\
+      " #{@secure_protocol_version}, secure_auth_data: #{@secure_auth_data},"\
+      " secure_collection_indicator: #{@secure_collection_indicator}, three_ds_server_trans_id:"\
+      " #{@three_ds_server_trans_id}, acs_transaction_id: #{@acs_transaction_id}, joi: #{@joi},"\
+      " account_type: #{@account_type}, is_company: #{@is_company}, routing_number:"\
+      " #{@routing_number}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_holder_name: #{@account_holder_name.inspect}, account_number:"\
+      " #{@account_number.inspect}, account_vault_api_id: #{@account_vault_api_id.inspect},"\
+      " token_api_id: #{@token_api_id.inspect}, accountvault_c1: #{@accountvault_c1.inspect},"\
+      " accountvault_c2: #{@accountvault_c2.inspect}, accountvault_c3:"\
+      " #{@accountvault_c3.inspect}, token_c1: #{@token_c1.inspect}, token_c2:"\
+      " #{@token_c2.inspect}, token_c3: #{@token_c3.inspect}, ach_sec_code:"\
+      " #{@ach_sec_code.inspect}, billing_address: #{@billing_address.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, customer_id: #{@customer_id.inspect}, identity_verification:"\
+      " #{@identity_verification.inspect}, location_id: #{@location_id.inspect},"\
+      " previous_account_vault_api_id: #{@previous_account_vault_api_id.inspect},"\
+      " previous_token_api_id: #{@previous_token_api_id.inspect}, previous_account_vault_id:"\
+      " #{@previous_account_vault_id.inspect}, previous_token_id: #{@previous_token_id.inspect},"\
+      " previous_transaction_id: #{@previous_transaction_id.inspect}, terms_agree:"\
+      " #{@terms_agree.inspect}, terms_agree_ip: #{@terms_agree_ip.inspect}, title:"\
+      " #{@title.inspect}, token_import_id: #{@token_import_id.inspect},"\
+      ' secure_directory_server_transaction_id:'\
+      " #{@secure_directory_server_transaction_id.inspect}, secure_protocol_version:"\
+      " #{@secure_protocol_version.inspect}, secure_auth_data: #{@secure_auth_data.inspect},"\
+      " secure_collection_indicator: #{@secure_collection_indicator.inspect},"\
+      " three_ds_server_trans_id: #{@three_ds_server_trans_id.inspect}, acs_transaction_id:"\
+      " #{@acs_transaction_id.inspect}, joi: #{@joi.inspect}, account_type:"\
+      " #{@account_type.inspect}, is_company: #{@is_company.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end