fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/v1_fullboarding_request.rb

@@ -0,0 +1,489 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1FullboardingRequest Model.
+  class V1FullboardingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :parent_id
+
+    # The ID of the template to be used - this value will be provided by Fortis.
+    # @return [String]
+    attr_accessor :template_id
+
+    # Client Issues Id to track that can be used to track each submitted
+    # merchant application. This id should be generated and sent in the request
+    # payload, and will be returned in the response payload. If no id is
+    # submitted in the payload request, this field will be null in the response.
+    # @return [String]
+    attr_accessor :client_app_id
+
+    # Merchant email address.
+    # @return [String]
+    attr_accessor :email
+
+    # Merchant 'Doing Business As' name.
+    # @return [String]
+    attr_accessor :dba_name
+
+    # Merchant legal name.
+    # >(leave blank if same as DBA name).
+    # >
+    # @return [String]
+    attr_accessor :legal_name
+
+    # Merchant's business website.
+    # >(Required if "ecommerce_percent" is greater than 0).
+    # >
+    # @return [String]
+    attr_accessor :website
+
+    # Merchant's phone number.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The Ownership Type of the merchant's business.
+    # @return [OwnershipTypeEnum]
+    attr_accessor :ownership_type
+
+    # Federal Tax ID (EIN).
+    # @return [String]
+    attr_accessor :fed_tax_id
+
+    # Average Transaction Amount.
+    # >Average transaction amount rounded to the next dollar.
+    # >
+    # @return [Integer]
+    attr_accessor :average_ticket
+
+    # Highest transaction amount rounded to the next dollar
+    # >Highest transaction amount rounded to the next dollar (No decimal).
+    # >
+    # @return [Integer]
+    attr_accessor :high_ticket
+
+    # Average monthly credit card volume rounded to the next dollar.
+    # >Average monthly credit card volume rounded to the next dollar.
+    # >
+    # @return [Integer]
+    attr_accessor :cc_monthly_volume
+
+    # Average monthly echeck volume rounded to the next dollar.
+    # >Average monthly echeck volume rounded to the next dollar.
+    # >
+    # @return [Integer]
+    attr_accessor :ec_monthly_volume
+
+    # Merchant's MCC code.
+    # @return [String]
+    attr_accessor :mcc_code
+
+    # Description of Goods or Services.
+    # @return [String]
+    attr_accessor :business_description
+
+    # Card present/swiped percentage
+    # >The sum total of "swiped_percent", "keyed_percent" and
+    # "ecommerce_percent" must add up to 100.
+    # >
+    # @return [Integer]
+    attr_accessor :swiped_percent
+
+    # Card not present/keyed percentage
+    # >The sum total of "swiped_percent", "keyed_percent" and
+    # "ecommerce_percent" must add up to 100.
+    # >
+    # @return [Integer]
+    attr_accessor :keyed_percent
+
+    # eCommerce percentage.
+    # >The sum total of "swiped_percent", "keyed_percent" and
+    # "ecommerce_percent" must add up to 100.
+    # >
+    # @return [Integer]
+    attr_accessor :ecommerce_percent
+
+    # Indicates whether or not the merchant is a foreign entity.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_foreign_entity
+
+    # Indicates whether or not the merchant is personally guaranteed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :personally_guaranteed
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [PreferredLanguageEnum]
+    attr_accessor :preferred_language
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[Address81]]
+    attr_accessor :addresses
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[Owner]]
+    attr_accessor :owners
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[BankAccount1]]
+    attr_accessor :bank_accounts
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[Document]]
+    attr_accessor :documents
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[PricingElement]]
+    attr_accessor :pricing_elements
+
+    # Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >Merchant preferred language. English(“en-US”) will be used if no value is
+    # supplied.
+    # >
+    # @return [Array[KycResponseObject]]
+    attr_accessor :kyc_response_objects
+
+    # Valid JSON of metadata related to merchant.
+    # @return [Object]
+    attr_accessor :metadata
+
+    # Signer IP address.
+    # @return [String]
+    attr_accessor :signer_ip
+
+    # Array of SEC codes that will be allowed, Only applicable for ACH. Valid
+    # values are 'PPD', 'WEB', 'TEL', 'CCD'.
+    # @return [Array[SecCodeEnum]]
+    attr_accessor :sec_codes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['parent_id'] = 'parent_id'
+      @_hash['template_id'] = 'template_id'
+      @_hash['client_app_id'] = 'client_app_id'
+      @_hash['email'] = 'email'
+      @_hash['dba_name'] = 'dba_name'
+      @_hash['legal_name'] = 'legal_name'
+      @_hash['website'] = 'website'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['ownership_type'] = 'ownership_type'
+      @_hash['fed_tax_id'] = 'fed_tax_id'
+      @_hash['average_ticket'] = 'average_ticket'
+      @_hash['high_ticket'] = 'high_ticket'
+      @_hash['cc_monthly_volume'] = 'cc_monthly_volume'
+      @_hash['ec_monthly_volume'] = 'ec_monthly_volume'
+      @_hash['mcc_code'] = 'mcc_code'
+      @_hash['business_description'] = 'business_description'
+      @_hash['swiped_percent'] = 'swiped_percent'
+      @_hash['keyed_percent'] = 'keyed_percent'
+      @_hash['ecommerce_percent'] = 'ecommerce_percent'
+      @_hash['is_foreign_entity'] = 'is_foreign_entity'
+      @_hash['personally_guaranteed'] = 'personally_guaranteed'
+      @_hash['preferred_language'] = 'preferred_language'
+      @_hash['addresses'] = 'addresses'
+      @_hash['owners'] = 'owners'
+      @_hash['bank_accounts'] = 'bank_accounts'
+      @_hash['documents'] = 'documents'
+      @_hash['pricing_elements'] = 'pricing_elements'
+      @_hash['kyc_response_objects'] = 'kyc_response_objects'
+      @_hash['metadata'] = 'metadata'
+      @_hash['signer_ip'] = 'signer_ip'
+      @_hash['sec_codes'] = 'sec_codes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        parent_id
+        template_id
+        client_app_id
+        legal_name
+        website
+        ec_monthly_volume
+        preferred_language
+        documents
+        pricing_elements
+        kyc_response_objects
+        metadata
+        signer_ip
+        sec_codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        parent_id
+        client_app_id
+        legal_name
+        website
+        ec_monthly_volume
+        preferred_language
+        signer_ip
+      ]
+    end
+
+    def initialize(email = nil, dba_name = nil, phone_number = nil,
+                   ownership_type = nil, fed_tax_id = nil, average_ticket = nil,
+                   high_ticket = nil, cc_monthly_volume = nil, mcc_code = nil,
+                   business_description = nil, swiped_percent = nil,
+                   keyed_percent = nil, ecommerce_percent = nil,
+                   is_foreign_entity = nil, personally_guaranteed = nil,
+                   addresses = nil, owners = nil, bank_accounts = nil,
+                   parent_id = SKIP, template_id = SKIP, client_app_id = SKIP,
+                   legal_name = SKIP, website = SKIP, ec_monthly_volume = SKIP,
+                   preferred_language = SKIP, documents = SKIP,
+                   pricing_elements = SKIP, kyc_response_objects = SKIP,
+                   metadata = SKIP, signer_ip = SKIP, sec_codes = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @parent_id = parent_id unless parent_id == SKIP
+      @template_id = template_id unless template_id == SKIP
+      @client_app_id = client_app_id unless client_app_id == SKIP
+      @email = email
+      @dba_name = dba_name
+      @legal_name = legal_name unless legal_name == SKIP
+      @website = website unless website == SKIP
+      @phone_number = phone_number
+      @ownership_type = ownership_type
+      @fed_tax_id = fed_tax_id
+      @average_ticket = average_ticket
+      @high_ticket = high_ticket
+      @cc_monthly_volume = cc_monthly_volume
+      @ec_monthly_volume = ec_monthly_volume unless ec_monthly_volume == SKIP
+      @mcc_code = mcc_code
+      @business_description = business_description
+      @swiped_percent = swiped_percent
+      @keyed_percent = keyed_percent
+      @ecommerce_percent = ecommerce_percent
+      @is_foreign_entity = is_foreign_entity
+      @personally_guaranteed = personally_guaranteed
+      @preferred_language = preferred_language unless preferred_language == SKIP
+      @addresses = addresses
+      @owners = owners
+      @bank_accounts = bank_accounts
+      @documents = documents unless documents == SKIP
+      @pricing_elements = pricing_elements unless pricing_elements == SKIP
+      @kyc_response_objects = kyc_response_objects unless kyc_response_objects == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @signer_ip = signer_ip unless signer_ip == SKIP
+      @sec_codes = sec_codes unless sec_codes == 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.
+      email = hash.key?('email') ? hash['email'] : nil
+      dba_name = hash.key?('dba_name') ? hash['dba_name'] : nil
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : nil
+      ownership_type =
+        hash.key?('ownership_type') ? hash['ownership_type'] : nil
+      fed_tax_id = hash.key?('fed_tax_id') ? hash['fed_tax_id'] : nil
+      average_ticket =
+        hash.key?('average_ticket') ? hash['average_ticket'] : nil
+      high_ticket = hash.key?('high_ticket') ? hash['high_ticket'] : nil
+      cc_monthly_volume =
+        hash.key?('cc_monthly_volume') ? hash['cc_monthly_volume'] : nil
+      mcc_code = hash.key?('mcc_code') ? hash['mcc_code'] : nil
+      business_description =
+        hash.key?('business_description') ? hash['business_description'] : nil
+      swiped_percent =
+        hash.key?('swiped_percent') ? hash['swiped_percent'] : nil
+      keyed_percent = hash.key?('keyed_percent') ? hash['keyed_percent'] : nil
+      ecommerce_percent =
+        hash.key?('ecommerce_percent') ? hash['ecommerce_percent'] : nil
+      is_foreign_entity =
+        hash.key?('is_foreign_entity') ? hash['is_foreign_entity'] : nil
+      personally_guaranteed =
+        hash.key?('personally_guaranteed') ? hash['personally_guaranteed'] : nil
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (Address81.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = nil unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      owners = nil
+      unless hash['owners'].nil?
+        owners = []
+        hash['owners'].each do |structure|
+          owners << (Owner.from_hash(structure) if structure)
+        end
+      end
+
+      owners = nil unless hash.key?('owners')
+      # Parameter is an array, so we need to iterate through it
+      bank_accounts = nil
+      unless hash['bank_accounts'].nil?
+        bank_accounts = []
+        hash['bank_accounts'].each do |structure|
+          bank_accounts << (BankAccount1.from_hash(structure) if structure)
+        end
+      end
+
+      bank_accounts = nil unless hash.key?('bank_accounts')
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+      template_id = hash.key?('template_id') ? hash['template_id'] : SKIP
+      client_app_id = hash.key?('client_app_id') ? hash['client_app_id'] : SKIP
+      legal_name = hash.key?('legal_name') ? hash['legal_name'] : SKIP
+      website = hash.key?('website') ? hash['website'] : SKIP
+      ec_monthly_volume =
+        hash.key?('ec_monthly_volume') ? hash['ec_monthly_volume'] : SKIP
+      preferred_language =
+        hash.key?('preferred_language') ? hash['preferred_language'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      documents = nil
+      unless hash['documents'].nil?
+        documents = []
+        hash['documents'].each do |structure|
+          documents << (Document.from_hash(structure) if structure)
+        end
+      end
+
+      documents = SKIP unless hash.key?('documents')
+      # Parameter is an array, so we need to iterate through it
+      pricing_elements = nil
+      unless hash['pricing_elements'].nil?
+        pricing_elements = []
+        hash['pricing_elements'].each do |structure|
+          pricing_elements << (PricingElement.from_hash(structure) if structure)
+        end
+      end
+
+      pricing_elements = SKIP unless hash.key?('pricing_elements')
+      # Parameter is an array, so we need to iterate through it
+      kyc_response_objects = nil
+      unless hash['kyc_response_objects'].nil?
+        kyc_response_objects = []
+        hash['kyc_response_objects'].each do |structure|
+          kyc_response_objects << (KycResponseObject.from_hash(structure) if structure)
+        end
+      end
+
+      kyc_response_objects = SKIP unless hash.key?('kyc_response_objects')
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      signer_ip = hash.key?('signer_ip') ? hash['signer_ip'] : SKIP
+      sec_codes = hash.key?('sec_codes') ? hash['sec_codes'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1FullboardingRequest.new(email,
+                                dba_name,
+                                phone_number,
+                                ownership_type,
+                                fed_tax_id,
+                                average_ticket,
+                                high_ticket,
+                                cc_monthly_volume,
+                                mcc_code,
+                                business_description,
+                                swiped_percent,
+                                keyed_percent,
+                                ecommerce_percent,
+                                is_foreign_entity,
+                                personally_guaranteed,
+                                addresses,
+                                owners,
+                                bank_accounts,
+                                parent_id,
+                                template_id,
+                                client_app_id,
+                                legal_name,
+                                website,
+                                ec_monthly_volume,
+                                preferred_language,
+                                documents,
+                                pricing_elements,
+                                kyc_response_objects,
+                                metadata,
+                                signer_ip,
+                                sec_codes,
+                                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} parent_id: #{@parent_id}, template_id: #{@template_id}, client_app_id:"\
+      " #{@client_app_id}, email: #{@email}, dba_name: #{@dba_name}, legal_name: #{@legal_name},"\
+      " website: #{@website}, phone_number: #{@phone_number}, ownership_type: #{@ownership_type},"\
+      " fed_tax_id: #{@fed_tax_id}, average_ticket: #{@average_ticket}, high_ticket:"\
+      " #{@high_ticket}, cc_monthly_volume: #{@cc_monthly_volume}, ec_monthly_volume:"\
+      " #{@ec_monthly_volume}, mcc_code: #{@mcc_code}, business_description:"\
+      " #{@business_description}, swiped_percent: #{@swiped_percent}, keyed_percent:"\
+      " #{@keyed_percent}, ecommerce_percent: #{@ecommerce_percent}, is_foreign_entity:"\
+      " #{@is_foreign_entity}, personally_guaranteed: #{@personally_guaranteed},"\
+      " preferred_language: #{@preferred_language}, addresses: #{@addresses}, owners: #{@owners},"\
+      " bank_accounts: #{@bank_accounts}, documents: #{@documents}, pricing_elements:"\
+      " #{@pricing_elements}, kyc_response_objects: #{@kyc_response_objects}, metadata:"\
+      " #{@metadata}, signer_ip: #{@signer_ip}, sec_codes: #{@sec_codes}, 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} parent_id: #{@parent_id.inspect}, template_id: #{@template_id.inspect},"\
+      " client_app_id: #{@client_app_id.inspect}, email: #{@email.inspect}, dba_name:"\
+      " #{@dba_name.inspect}, legal_name: #{@legal_name.inspect}, website: #{@website.inspect},"\
+      " phone_number: #{@phone_number.inspect}, ownership_type: #{@ownership_type.inspect},"\
+      " fed_tax_id: #{@fed_tax_id.inspect}, average_ticket: #{@average_ticket.inspect},"\
+      " high_ticket: #{@high_ticket.inspect}, cc_monthly_volume: #{@cc_monthly_volume.inspect},"\
+      " ec_monthly_volume: #{@ec_monthly_volume.inspect}, mcc_code: #{@mcc_code.inspect},"\
+      " business_description: #{@business_description.inspect}, swiped_percent:"\
+      " #{@swiped_percent.inspect}, keyed_percent: #{@keyed_percent.inspect}, ecommerce_percent:"\
+      " #{@ecommerce_percent.inspect}, is_foreign_entity: #{@is_foreign_entity.inspect},"\
+      " personally_guaranteed: #{@personally_guaranteed.inspect}, preferred_language:"\
+      " #{@preferred_language.inspect}, addresses: #{@addresses.inspect}, owners:"\
+      " #{@owners.inspect}, bank_accounts: #{@bank_accounts.inspect}, documents:"\
+      " #{@documents.inspect}, pricing_elements: #{@pricing_elements.inspect},"\
+      " kyc_response_objects: #{@kyc_response_objects.inspect}, metadata: #{@metadata.inspect},"\
+      " signer_ip: #{@signer_ip.inspect}, sec_codes: #{@sec_codes.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end