visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor.rb

@@ -0,0 +1,275 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor Model.
+  class MerchantDescriptor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your merchant name.
+    # **Note** For Paymentech processor using Visa Acceptance Payouts, the
+    # maximum data length is 22.
+    # #### PIN debit
+    # Your business name. This name is displayed on the cardholder’s statement.
+    # When you
+    # include more than one consecutive space, extra spaces are removed.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # #### Airline processing
+    # Your merchant name. This name is displayed on the cardholder’s statement.
+    # When you include more than one consecutive space, extra spaces are
+    # removed.
+    # **Note** Some airline fee programs may require the original ticket number
+    # (ticket identifier) or the ancillary service description in positions 13
+    # through 23 of this field.
+    # **Important** This value must consist of English characters.
+    # Required for captures and credits.
+    # @return [String]
+    attr_accessor :name
+
+    # An alternate name for the merchant.
+    # @return [String]
+    attr_accessor :alternate_name
+
+    # Contact information for the merchant.
+    # **Note** These are the maximum data lengths for the following payment
+    # processors:
+    # - FDCCompass (13)
+    # - Paymentech (13)
+    # @return [String]
+    attr_accessor :contact
+
+    # First line of merchant's address.
+    # @return [String]
+    attr_accessor :address1
+
+    # Merchant's City.
+    # #### PIN debit
+    # City for your business location. This value might be displayed on the
+    # cardholder’s statement.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # @return [String]
+    attr_accessor :locality
+
+    # Merchant's country.
+    # #### PIN debit
+    # Country code for your business location. Use the [ISO Standard Country
+    # Codes](
+    # This value might be displayed on the cardholder’s statement.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # **Note** If your business is located in the U.S. or Canada and you include
+    # this field in a
+    # request, you must also include
+    # `merchantInformation.merchantDescriptor.administrativeArea`.
+    # Optional field for PIN debit credit or PIN debit purchase.
+    # @return [String]
+    attr_accessor :country
+
+    # Merchant's postal code.
+    # #### PIN debit
+    # Postal code for your business location. This value might be displayed on
+    # the cardholder’s statement.
+    # If your business is domiciled in the U.S., you can use a 5-digit or
+    # 9-digit postal code. A 9-digit postal code must follow this format:
+    # [5 digits][dash][4 digits]
+    # Example: `12345-6789`
+    # If your business is domiciled in Canada, you can use a 6-digit or 9-digit
+    # postal code. A 6-digit postal code must follow this format:
+    # [alpha][numeric][alpha][space]
+    # [numeric][alpha][numeric]
+    # Example: `A1B 2C3`
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # **Note** This field is supported only for businesses located in the U.S.
+    # or Canada.
+    # **Important** Mastercard requires a postal code for any country that uses
+    # postal codes.
+    # You can provide the postal code in your account or you can include this
+    # field in your request.
+    # Optional field for PIN debit credit or PIN debit purchase.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state where the merchant is located.
+    # #### PIN debit
+    # State code or region code for your business. Use the Use the [State,
+    # Province, and Territory Codes for the United States and Canada]( This
+    # value might be displayed on the cardholder’s statement.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # **Note** This field is supported only for businesses located in the U.S.
+    # or Canada.
+    # Optional field for PIN debit credit or PIN debit purchase.
+    # @return [String]
+    attr_accessor :administrative_area
+
+    # Merchant phone as contact information for CNP transactions
+    # @return [String]
+    attr_accessor :phone
+
+    # Address of company's website provided by merchant
+    # @return [String]
+    attr_accessor :url
+
+    # #### Visa Platform Connect
+    # This field will indicate merchant country of origin
+    # @return [String]
+    attr_accessor :country_of_origin
+
+    # The identifier of the store.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The name of the store.
+    # @return [String]
+    attr_accessor :store_name
+
+    # #### Visa Platform Connect
+    # Indicates customer service phone number of Merchant.
+    # @return [String]
+    attr_accessor :customer_service_phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['alternate_name'] = 'alternateName'
+      @_hash['contact'] = 'contact'
+      @_hash['address1'] = 'address1'
+      @_hash['locality'] = 'locality'
+      @_hash['country'] = 'country'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['administrative_area'] = 'administrativeArea'
+      @_hash['phone'] = 'phone'
+      @_hash['url'] = 'url'
+      @_hash['country_of_origin'] = 'countryOfOrigin'
+      @_hash['store_id'] = 'storeId'
+      @_hash['store_name'] = 'storeName'
+      @_hash['customer_service_phone_number'] = 'customerServicePhoneNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        alternate_name
+        contact
+        address1
+        locality
+        country
+        postal_code
+        administrative_area
+        phone
+        url
+        country_of_origin
+        store_id
+        store_name
+        customer_service_phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, alternate_name = SKIP, contact = SKIP,
+                   address1 = SKIP, locality = SKIP, country = SKIP,
+                   postal_code = SKIP, administrative_area = SKIP, phone = SKIP,
+                   url = SKIP, country_of_origin = SKIP, store_id = SKIP,
+                   store_name = SKIP, customer_service_phone_number = SKIP)
+      @name = name unless name == SKIP
+      @alternate_name = alternate_name unless alternate_name == SKIP
+      @contact = contact unless contact == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @locality = locality unless locality == SKIP
+      @country = country unless country == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @administrative_area = administrative_area unless administrative_area == SKIP
+      @phone = phone unless phone == SKIP
+      @url = url unless url == SKIP
+      @country_of_origin = country_of_origin unless country_of_origin == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @store_name = store_name unless store_name == SKIP
+      unless customer_service_phone_number == SKIP
+        @customer_service_phone_number =
+          customer_service_phone_number
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      alternate_name = hash.key?('alternateName') ? hash['alternateName'] : SKIP
+      contact = hash.key?('contact') ? hash['contact'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      locality = hash.key?('locality') ? hash['locality'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      administrative_area =
+        hash.key?('administrativeArea') ? hash['administrativeArea'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      country_of_origin =
+        hash.key?('countryOfOrigin') ? hash['countryOfOrigin'] : SKIP
+      store_id = hash.key?('storeId') ? hash['storeId'] : SKIP
+      store_name = hash.key?('storeName') ? hash['storeName'] : SKIP
+      customer_service_phone_number =
+        hash.key?('customerServicePhoneNumber') ? hash['customerServicePhoneNumber'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor.new(name,
+                             alternate_name,
+                             contact,
+                             address1,
+                             locality,
+                             country,
+                             postal_code,
+                             administrative_area,
+                             phone,
+                             url,
+                             country_of_origin,
+                             store_id,
+                             store_name,
+                             customer_service_phone_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, alternate_name: #{@alternate_name}, contact: #{@contact},"\
+      " address1: #{@address1}, locality: #{@locality}, country: #{@country}, postal_code:"\
+      " #{@postal_code}, administrative_area: #{@administrative_area}, phone: #{@phone}, url:"\
+      " #{@url}, country_of_origin: #{@country_of_origin}, store_id: #{@store_id}, store_name:"\
+      " #{@store_name}, customer_service_phone_number: #{@customer_service_phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, alternate_name: #{@alternate_name.inspect},"\
+      " contact: #{@contact.inspect}, address1: #{@address1.inspect}, locality:"\
+      " #{@locality.inspect}, country: #{@country.inspect}, postal_code: #{@postal_code.inspect},"\
+      " administrative_area: #{@administrative_area.inspect}, phone: #{@phone.inspect}, url:"\
+      " #{@url.inspect}, country_of_origin: #{@country_of_origin.inspect}, store_id:"\
+      " #{@store_id.inspect}, store_name: #{@store_name.inspect}, customer_service_phone_number:"\
+      " #{@customer_service_phone_number.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor1.rb

@@ -0,0 +1,71 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor1 Model.
+  class MerchantDescriptor1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the store.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The name of the store.
+    # @return [String]
+    attr_accessor :store_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_id'] = 'storeId'
+      @_hash['store_name'] = 'storeName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_id
+        store_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_id = SKIP, store_name = SKIP)
+      @store_id = store_id unless store_id == SKIP
+      @store_name = store_name unless store_name == 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.
+      store_id = hash.key?('storeId') ? hash['storeId'] : SKIP
+      store_name = hash.key?('storeName') ? hash['storeName'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor1.new(store_id,
+                              store_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id}, store_name: #{@store_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id.inspect}, store_name: #{@store_name.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor11.rb

@@ -0,0 +1,90 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor11 Model.
+  class MerchantDescriptor11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your merchant name.
+    # **Note** For Paymentech processor using Visa Acceptance Payouts, the
+    # maximum data length is 22.
+    # #### PIN debit
+    # Your business name. This name is displayed on the cardholder’s statement.
+    # When you
+    # include more than one consecutive space, extra spaces are removed.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # #### Airline processing
+    # Your merchant name. This name is displayed on the cardholder’s statement.
+    # When you include more than one consecutive space, extra spaces are
+    # removed.
+    # **Note** Some airline fee programs may require the original ticket number
+    # (ticket identifier) or the ancillary service description in positions 13
+    # through 23 of this field.
+    # **Important** This value must consist of English characters.
+    # Required for captures and credits.
+    # @return [String]
+    attr_accessor :name
+
+    # Email address of the merchant.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, email = SKIP)
+      @name = name unless name == SKIP
+      @email = email unless email == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor11.new(name,
+                               email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, email: #{@email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, email: #{@email.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor13.rb

@@ -0,0 +1,67 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor13 Model.
+  class MerchantDescriptor13 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Alternate contact information for your business,such as an email address
+    # or URL.
+    # This value might be displayed on the cardholder’s statement.
+    # When you do not include this value in your capture or credit request, the
+    # merchant URL from your Visa Acceptance account is used.
+    # Important This value must consist of English characters
+    # @return [String]
+    attr_accessor :alternate_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alternate_name'] = 'alternateName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alternate_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alternate_name = SKIP)
+      @alternate_name = alternate_name unless alternate_name == 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.
+      alternate_name = hash.key?('alternateName') ? hash['alternateName'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor13.new(alternate_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alternate_name: #{@alternate_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alternate_name: #{@alternate_name.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor30.rb

@@ -0,0 +1,81 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor30 Model.
+  class MerchantDescriptor30 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your merchant name.
+    # **Note** For Paymentech processor using Visa Acceptance Payouts, the
+    # maximum data length is 22.
+    # #### PIN debit
+    # Your business name. This name is displayed on the cardholder’s statement.
+    # When you
+    # include more than one consecutive space, extra spaces are removed.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # #### Airline processing
+    # Your merchant name. This name is displayed on the cardholder’s statement.
+    # When you include more than one consecutive space, extra spaces are
+    # removed.
+    # **Note** Some airline fee programs may require the original ticket number
+    # (ticket identifier) or the ancillary service description in positions 13
+    # through 23 of this field.
+    # **Important** This value must consist of English characters.
+    # Required for captures and credits.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP)
+      @name = name unless name == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor30.new(name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}>"
+    end
+  end
+end