visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/bill_to56.rb

@@ -0,0 +1,555 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # BillTo56 Model.
+  class BillTo56 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customer’s first name. This name must be the same as the name on the card.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### SEPA
+    # Required for Create Mandate and Import Mandate
+    # #### BACS
+    # Required for Import Mandate
+    # #### Visa Acceptance Latin American Processing
+    # **Important** For an authorization request, Visa Acceptance Latin American
+    # Processing concatenates `orderInformation.billTo.firstName` and
+    # `orderInformation.billTo.lastName`. If the concatenated value exceeds 30
+    # characters, Visa Acceptance Latin American Processing declines the
+    # authorization request.\
+    # **Note** Visa Acceptance Latin American Processing is the name of a
+    # specific processing connection that Visa Acceptance supports. In the Visa
+    # Acceptance API documentation, Visa Acceptance Latin American Processing
+    # does not refer to the general topic of processing in Latin America. The
+    # information in this field description is for the specific processing
+    # connection called _Visa Acceptance Latin American Processing_. It is not
+    # for any other Latin American processors that Visa Acceptance supports.
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # #### For Payouts:
+    # This field may be sent only for FDC Compass.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Customer’s last name. This name must be the same as the name on the card.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### SEPA
+    # Required for Create Mandate and Import Mandate
+    # #### BACS
+    # Required for Import Mandate
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### Visa Acceptance Latin American Processing
+    # **Important** For an authorization request, Visa Acceptance Latin American
+    # Processing concatenates `orderInformation.billTo.firstName` and
+    # `orderInformation.billTo.lastName`. If the concatenated value exceeds 30
+    # characters, Visa Acceptance Latin American Processing declines the
+    # authorization request.\
+    # **Note** Visa Acceptance Latin American Processing is the name of a
+    # specific processing connection that Visa Acceptance supports. In the Visa
+    # Acceptance API documentation, Visa Acceptance Latin American Processing
+    # does not refer to the general topic of processing in Latin America. The
+    # information in this field description is for the specific processing
+    # connection called Visa Acceptance Latin American Processing. It is not for
+    # any other Latin American processors that Visa Acceptance supports.
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # #### For Payouts:
+    # This field may be sent only for FDC Compass.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### RBS WorldPay Atlanta
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Customer’s middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Customer’s name suffix.
+    # @return [String]
+    attr_accessor :name_suffix
+
+    # Payment card billing street address as it appears on the credit card
+    # issuer’s records.
+    # #### SEPA
+    # Required for Create Mandate and Import Mandate
+    # #### Atos
+    # This field must not contain colons (:).
+    # #### Visa Acceptance through VisaNet
+    # **Important** When you populate orderInformation.billTo.address1 and
+    # orderInformation.billTo.address2,
+    # Visa Acceptance through VisaNet concatenates the two values. If the
+    # concatenated value exceeds 40 characters,
+    # Visa Acceptance through VisaNet truncates the value at 40 characters
+    # before sending it to Visa and the issuing bank.
+    # Truncating this value affects AVS results and therefore might also affect
+    # risk decisions and chargebacks.
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet
+    # accepts and stores non-ASCII characters correctly and displays them
+    # correctly in reports. However, the limitations
+    # of the credit card networks prevent Visa Acceptance through VisaNet from
+    # transmitting non-ASCII characters to the
+    # credit card networks. Therefore, Visa Acceptance through VisaNet replaces
+    # non-ASCII characters with meaningless
+    # ASCII characters for transmission to the credit card networks.
+    # #### FDMS Nashville
+    # When the street name is numeric, it must be sent in numeric format. For
+    # example, if the address is _One First Street_,
+    # it must be sent as _1 1st Street_.
+    # Required if keyed; not used if swiped.
+    # String (20)
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### All other processors:
+    # Optional.
+    # String (60)
+    # #### For Payouts
+    # This field may be sent only for FDC Compass.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # @return [String]
+    attr_accessor :address1
+
+    # Used for additional address information. For example: _Attention: Accounts
+    # Payable_
+    # Optional field.
+    # For Payouts: This field may be sent only for FDC Compass.
+    # #### Atos
+    # This field must not contain colons (:).
+    # #### Visa Acceptance through VisaNet
+    # **Important** When you populate `orderInformation.billTo.address1` and
+    # `orderInformation.billTo.address2`,
+    # Visa Acceptance through VisaNet concatenates the two values. If the
+    # concatenated value exceeds 40 characters,
+    # Visa Acceptance through VisaNet truncates the value at 40 characters
+    # before sending it to Visa and the issuing bank.
+    # Truncating this value affects AVS results and therefore might also affect
+    # risk decisions and chargebacks.
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet
+    # accepts and stores non-ASCII characters correctly and displays them
+    # correctly in reports. However, the limitations
+    # of the credit card networks prevent Visa Acceptance through VisaNet from
+    # transmitting non-ASCII characters to the
+    # credit card networks. Therefore, Visa Acceptance through VisaNet replaces
+    # non-ASCII characters with meaningless
+    # ASCII characters for transmission to the credit card networks.
+    # #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions
+    # This value is used for AVS.
+    # #### FDMS Nashville
+    # `orderInformation.billTo.address1` and `orderInformation.billTo.address2`
+    # together cannot exceed 20 characters.
+    # String (20)
+    # #### All Other Processors
+    # String (60)
+    # @return [String]
+    attr_accessor :address2
+
+    # Payment card billing city.
+    # #### SEPA
+    # Required for Create Mandate and Import Mandate
+    # #### Atos
+    # This field must not contain colons (:).
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # #### For Payouts:
+    # This field may be sent only for FDC Compass.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :locality
+
+    # State or province of the billing address. Use the [State, Province, and
+    # Territory Codes for the United States and Canada](
+    # For Payouts: This field may be sent only for FDC Compass.
+    # ##### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet
+    # accepts and stores non-ASCII characters correctly and displays them
+    # correctly in reports. However, the limitations
+    # of the credit card networks prevent Visa Acceptance through VisaNet from
+    # transmitting non-ASCII characters to the
+    # credit card networks. Therefore, Visa Acceptance through VisaNet replaces
+    # non-ASCII characters with meaningless
+    # ASCII characters for transmission to the credit card networks.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :administrative_area
+
+    # Postal code for the billing address. The postal code must consist of 5 to
+    # 9 digits.
+    # When the billing country is the U.S., the 9-digit postal code must follow
+    # this format:
+    # [5 digits][dash][4 digits]
+    # **Example** `12345-6789`
+    # When the billing country is Canada, the 6-digit postal code must follow
+    # this format:
+    # [alpha][numeric][alpha][space][numeric][alpha][numeric]
+    # **Example** `A1B 2C3`
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### SEPA
+    # Required for Create Mandate and Import Mandate
+    # #### For Payouts:
+    #  This field may be sent only for FDC Compass.
+    # #### American Express Direct
+    # Before sending the postal code to the processor, Visa Acceptance removes
+    # all nonalphanumeric characters and, if the remaining value is longer than
+    # nine characters, truncates the value starting from the right side.
+    # #### Atos
+    # This field must not contain colons (:).
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet
+    # accepts and stores non-ASCII characters correctly and displays them
+    # correctly in reports. However, the limitations
+    # of the credit card networks prevent Visa Acceptance through VisaNet from
+    # transmitting non-ASCII characters to the
+    # credit card networks. Therefore, Visa Acceptance through VisaNet replaces
+    # non-ASCII characters with meaningless ASCII
+    # characters for transmission to the credit card networks.
+    # #### FDMS Nashville
+    # Required if `pointOfSaleInformation.entryMode=keyed` and the address is in
+    # the U.S. or Canada.
+    # Optional if `pointOfSaleInformation.entryMode=keyed` and the address is
+    # **not** in the U.S. or Canada.
+    # Not used if swiped.
+    # #### RBS WorldPay Atlanta:
+    # For best card-present keyed rates, send the postal code if
+    # `pointOfSaleInformation.entryMode=keyed`.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### All other processors:
+    # Optional field.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Name of the customer’s company.
+    # **Visa Acceptance through VisaNet**
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # @return [String]
+    attr_accessor :company
+
+    # Customer's email address, including the full domain name.
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### Invoicing
+    # Email address for the customer for sending the invoice. If the invoice is
+    # in SENT status and email is updated, the old email customer payment link
+    # won't work and you must resend the invoice with the new payment link.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :email
+
+    # Payment card billing country. Use the two-character [ISO Standard Country
+    # Codes](
+    # #### SEPA/BACS
+    # Required for Create Mandate and Import Mandate
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet
+    # accepts and stores non-ASCII characters correctly and displays them
+    # correctly in reports. However, the limitations
+    # of the credit card networks prevent Visa Acceptance through VisaNet from
+    # transmitting non-ASCII characters to the
+    # credit card networks. Therefore, Visa Acceptance through VisaNet replaces
+    # non-ASCII characters with meaningless ASCII
+    # characters for transmission to the credit card networks.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Required when `processingInformation.billPaymentOptions.billPayment=true`
+    # and `pointOfSaleInformation.entryMode=keyed`.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :country
+
+    # Title.
+    # @return [String]
+    attr_accessor :title
+
+    # Customer’s phone number.
+    # It is recommended that you include the country code when the order is from
+    # outside the U.S.
+    # #### Chase Paymentech Solutions
+    # Optional field.
+    # ####  Credit Mutuel-CIC
+    # Optional field.
+    # #### Visa Acceptance through VisaNet
+    # Credit card networks cannot process transactions that contain non-ASCII
+    # characters. Visa Acceptance through VisaNet accepts and stores non-ASCII
+    # characters correctly and displays them correctly in reports. However, the
+    # limitations of the credit card networks prevent Visa Acceptance through
+    # VisaNet from transmitting non-ASCII characters to the credit card
+    # networks. Therefore, Visa Acceptance through VisaNet replaces non-ASCII
+    # characters with meaningless ASCII characters for transmission to the
+    # credit card networks.
+    # #### For Payouts:
+    # This field may be sent only for FDC Compass.
+    # #### OmniPay Direct
+    # Optional field.
+    # #### SIX
+    # Optional field.
+    # #### TSYS Acquiring Solutions
+    # Optional field.
+    # #### Worldpay VAP
+    # Optional field.
+    # #### All other processors
+    # Not used.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'firstName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['name_suffix'] = 'nameSuffix'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['locality'] = 'locality'
+      @_hash['administrative_area'] = 'administrativeArea'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['company'] = 'company'
+      @_hash['email'] = 'email'
+      @_hash['country'] = 'country'
+      @_hash['title'] = 'title'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        middle_name
+        name_suffix
+        address1
+        address2
+        locality
+        administrative_area
+        postal_code
+        company
+        email
+        country
+        title
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, last_name = SKIP, middle_name = SKIP,
+                   name_suffix = SKIP, address1 = SKIP, address2 = SKIP,
+                   locality = SKIP, administrative_area = SKIP,
+                   postal_code = SKIP, company = SKIP, email = SKIP,
+                   country = SKIP, title = SKIP, phone_number = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @name_suffix = name_suffix unless name_suffix == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @locality = locality unless locality == SKIP
+      @administrative_area = administrative_area unless administrative_area == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @company = company unless company == SKIP
+      @email = email unless email == SKIP
+      @country = country unless country == SKIP
+      @title = title unless title == SKIP
+      @phone_number = phone_number unless phone_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.
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      name_suffix = hash.key?('nameSuffix') ? hash['nameSuffix'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      locality = hash.key?('locality') ? hash['locality'] : SKIP
+      administrative_area =
+        hash.key?('administrativeArea') ? hash['administrativeArea'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      company = hash.key?('company') ? hash['company'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+
+      # Create object from extracted values.
+      BillTo56.new(first_name,
+                   last_name,
+                   middle_name,
+                   name_suffix,
+                   address1,
+                   address2,
+                   locality,
+                   administrative_area,
+                   postal_code,
+                   company,
+                   email,
+                   country,
+                   title,
+                   phone_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name}, last_name: #{@last_name}, middle_name:"\
+      " #{@middle_name}, name_suffix: #{@name_suffix}, address1: #{@address1}, address2:"\
+      " #{@address2}, locality: #{@locality}, administrative_area: #{@administrative_area},"\
+      " postal_code: #{@postal_code}, company: #{@company}, email: #{@email}, country:"\
+      " #{@country}, title: #{@title}, phone_number: #{@phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " middle_name: #{@middle_name.inspect}, name_suffix: #{@name_suffix.inspect}, address1:"\
+      " #{@address1.inspect}, address2: #{@address2.inspect}, locality: #{@locality.inspect},"\
+      " administrative_area: #{@administrative_area.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, company: #{@company.inspect}, email: #{@email.inspect}, country:"\
+      " #{@country.inspect}, title: #{@title.inspect}, phone_number: #{@phone_number.inspect}>"
+    end
+  end
+end