payrix-api-sdk 1.0.0

data/lib/payrix/models/merchants_post_request.rb

@@ -0,0 +1,1031 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # MerchantsPostRequest Model.
+  class MerchantsPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Show the total approved amount to this merchant.
+    # @return [Integer]
+    attr_accessor :total_approved_sales
+
+    # Show the total approved amount to this merchant.
+    # @return [Object]
+    attr_accessor :entity
+
+    # The name under which the Merchant is doing business, if applicable. This
+    # field is stored as a text string and must be between 0 and 50 characters
+    # long.
+    # @return [String]
+    attr_accessor :dba
+
+    # An indicator that specifies whether the Merchant is new to credit card
+    # processing, where merchants are considered to be new by default and can
+    # have a valid value of either '0' (Not new) or '1' (New).
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not new**
+    # - `1` - **New**
+    # </details>
+    # @return [NewEnum]
+    attr_accessor :new
+
+    # Indicates whether the merchant accepts pre-purchase for products that are
+    # shipped at a later date or not currently available, specifying advanced
+    # billing as either disabled (0) or enabled (1).
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **AdvancedBilling is disabled.**
+    # - `1` - **AdvancedBilling is enabled.**
+    # </details>
+    # @return [AdvancedBillingEnum]
+    attr_accessor :advanced_billing
+
+    # Indicates if the merchant is a seasonal merchant or operates year-round.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Year-Round Merchant**
+    # - `1` - **Seasonal Merchant**
+    # </details>
+    # @return [SeasonalEnum]
+    attr_accessor :seasonal
+
+    # The date on which the Merchant was established. The date is specified as
+    # an eight digit string in YYYYMMDD format, for example, '20160120' for
+    # January 20, 2016.
+    # **Note:** Include the `established` date value to ensure successful
+    # underwriting and new Merchant onboarding to the VCore platform.
+    # @return [Integer]
+    attr_accessor :established
+
+    # The value of the annual credit card sales of this Merchant. 
+    # This field is specified as an integer in cents. For example, $25.30 is
+    # expressed as '2530'.
+    # @return [Integer]
+    attr_accessor :annual_cc_sales
+
+    # The value of the annual credit card sale volume of this Merchant. 
+    # This field is specified as an integer in cents. For example, $25.30 is
+    # expressed as '2530'.
+    # @return [Integer]
+    attr_accessor :annual_cc_sale_volume
+
+    # The value of the annual direct deposit sale volume of this Merchant. 
+    # This field is specified as an integer in cents. For example, $25.30 is
+    # expressed as '2530'.
+    # @return [Integer]
+    attr_accessor :annual_ach_sale_volume
+
+    # Indicates the Annual AMEX Sales Volume for the outlet.
+    # @return [Integer]
+    attr_accessor :amex_volume
+
+    # The value of the average credit card sales of this Merchant. 
+    # This field is specified as an integer in cents. For example, $25.30 is
+    # expressed as '2530'.
+    # @return [Integer]
+    attr_accessor :avg_ticket
+
+    # The American Express merchant identifier for this Merchant, if applicable.
+    # 
+    # This field is stored as a string and must be between 1 and 15 characters
+    # long.
+    # @return [String]
+    attr_accessor :amex
+
+    # The Discover merchant identifier for this Merchant, if applicable. 
+    # This field is stored as a string and must be between 1 and 15 characters
+    # long.
+    # @return [String]
+    attr_accessor :discover
+
+    # The Merchant Category Code (MCC) for this Merchant. This code is not
+    # required to create a Merchant, but it is required to successfully board a
+    # Merchant.
+    # @return [String]
+    attr_accessor :mcc
+
+    # Merchant Verification Value. A value assigned by Visa to identify
+    # participation in select merchant programs.
+    # @return [String]
+    attr_accessor :visa_mvv
+
+    # Whether or not the merchant has acknowledged and accepted the Visa
+    # Disclosure.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Accepted**
+    # - `1` - **Accepted**
+    # </details>
+    # @return [VisaDisclosureEnum]
+    attr_accessor :visa_disclosure
+
+    # The IP address where the Merchant platform disclosure is hosted.
+    # @return [String]
+    attr_accessor :disclosure_ip
+
+    # The date the Merchant platform disclosure is reviewed by the Merchant. The
+    # format should be YYYYMMDD
+    # @return [Integer]
+    attr_accessor :disclosure_date
+
+    # The environment which the Merchant is in, if applicable.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `supermarket` - **Supermarkets / Grocery**
+    # - `moto` - **Mail Order / Telephone Order**
+    # - `cardPresent` - **Card Present Environment**
+    # - `fuel` - **Fuel / Gas Stations**
+    # - `serviceStation` - **Service Stations**
+    # - `restaurant` - **Restaurants**
+    # - `ecommerce` - **eCommerce / Online Sales**
+    # </details>
+    # @return [MerchantEnvironmentEnum]
+    attr_accessor :environment
+
+    # The status of the Merchant.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not ready**. Occurs when a new Merchant is created. Unable to
+    # process payments.
+    # - `1` - **Ready**. New Merchant submitted for underwriting approval after
+    # submitting a signup form.
+    # - `2` - **Boarded**. Merchant has been approved and boarded to the
+    # platform. Payment processing now available.
+    # - `3` - **Manual**. Set internally by platform underwriting. New Merchant
+    # is pending manual verification.
+    # - `4` - **Closed**. Set internally by platform underwriting. New Merchant
+    # was declined and cannot access the platform.
+    # - `5` - **Incomplete**. Set by user boarding the merchant. Can be manually
+    # set to "save" an incomplete Merchant boarding request for a later time.
+    # - `6` - **Pending**. New Merchant was submitted for boarding, platform
+    # access pending review.
+    # </details>
+    # @return [MerchantStatusEnum]
+    attr_accessor :status
+
+    # This field allows the ability to submit merchant registration files with a
+    # MasterCard (MC) Auth Integrity value.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Incremental Auth Not Supported**
+    # - `1` - **Incremental Auth Supported**
+    # </details>
+    # @return [IncrementalAuthSupportedEnum]
+    attr_accessor :incremental_auth_supported
+
+    # Whether the merchant auto-boarded.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Auto-Boarded**
+    # - `1` - **Auto-Boarded**
+    # </details>
+    # @return [AutoBoardedEnum]
+    attr_accessor :auto_boarded
+
+    # The reason for manual or closure status. 
+    # <details>
+    # <summary>Valid Values</summary>
+    #  `rejected` - **Merchant account rejected for servicing.**
+    # `fraud` - **Merchant or submission was determined to be fraudulent.**
+    # `noResponse` - **No response given in expected time frame for
+    # verification/validation inquiry.**
+    # `withdrawn` - **Merchant submission withdrawn.**
+    # </details>
+    # @return [StatusReasonEnum]
+    attr_accessor :status_reason
+
+    # Description of the type of address that the business operates at.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `77` - **Retail Storefront**
+    # - `78` - **Warehouse**
+    # - `79` - **Private Residence**
+    # - `80` - **Others**
+    # - `81` - **P. RES-PROF/Construction**
+    # </details>
+    # @return [MerchantLocationTypeEnum]
+    attr_accessor :location_type
+
+    # This field indicates what percentage are internet originated transactions.
+    # @return [Integer]
+    attr_accessor :percent_ecomm
+
+    # The merchant percentage of transactions that are Card Not Present
+    # (Includes MOTO and eCommerce).
+    # @return [Integer]
+    attr_accessor :percent_keyed
+
+    # This field indicates what percentage of the transactions are Business to
+    # Business.
+    # @return [Integer]
+    attr_accessor :percent_business
+
+    # The expected total volume for all credit card and ACH payments that the
+    # merchant will process for the current year.
+    # @return [Integer]
+    attr_accessor :total_volume
+
+    # The denial or account closure reason code.
+    # @return [String]
+    attr_accessor :account_closure_reason_code
+
+    # The date the account closure reason code was provided. The format should
+    # be YYYMMDD.
+    # @return [Integer]
+    attr_accessor :account_closure_reason_date
+
+    # The risk level which the Merchant is in, if applicable.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `restricted` - **Restricted from processing transactions.**
+    # - `prohibited` - **Prohibited business use category.**
+    # - `high` - **High merchant risk score.**
+    # - `medium` - **Medium merchant risk score.**
+    # - `low` - **Low merchant risk score.**
+    # </details>
+    # @return [RiskLevelEnum]
+    attr_accessor :risk_level
+
+    # The credit ratio to use while calculating risk factors for credit, if
+    # applicable.
+    # @return [Integer]
+    attr_accessor :credit_ratio
+
+    # The credit timeliness for the Merchant, if applicable.
+    # @return [Integer]
+    attr_accessor :credit_timeliness
+
+    # Chargeback Ratio.
+    # @return [Integer]
+    attr_accessor :chargeback_ratio
+
+    # The ndx (Non Delivery Exposure) days which the Merchant is in, if
+    # applicable.
+    # @return [Integer]
+    attr_accessor :ndx_days
+
+    # The ndx (Non Delivery Exposure) percentage to be used for the merchant, if
+    # applicable.
+    # @return [Integer]
+    attr_accessor :ndx_percentage
+
+    # Payment Card Industry Data Security Standard (PCI DSS) Self-assessment
+    # questionnaire (SAQ). Details about a merchant's business and the way they
+    # currently accept payments or plan to in the future.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `SAQ-A` - **Card-not-present merchants (e-commerce or
+    # mail/telephone-order) with PCI DSS-validated third-party payments service
+    # provider(s) and does not store cardholder data.**
+    # - `SAQ-A-EP` - **E-commerce merchants with PCI DSS-validated third-party
+    # payments service provider(s) with a website that doesn't directly collect
+    # cardholder data, but may impact it in some way, and does not store
+    # cardholder data.**
+    # - `SAQ-B` - **Merchants with imprint machines or standalone, dial-out
+    # terminals that do not store cardholder data.**
+    # - `SAQ-B-IP` - **Merchants with standalone, PTS-approved payment terminals
+    # that have an IP connection to the payment processor, but do not store
+    # cardholder data.**
+    # - `SAQ-C-VT` - **Merchants that enter single transactions manually into an
+    # internet-based terminal hosted by PCI DSS-validated third-party payments
+    # service provider(s) and does not store cardholder data.**
+    # - `SAQ-C` - **Merchants with payment application systems connected to the
+    # internet that do not store cardholder data.**
+    # - `SAQ-P2PE-HW` - **Merchants with hardware-only payment terminals managed
+    # by a PCI SSC-listed P2PE solution, and does not store cardholder data.**
+    # - `SAQ-D` - **Generic field for all Merchants that do not fall under the
+    # requirements for any above SAQ types.**
+    # </details>
+    # @return [SaqTypeEnum]
+    attr_accessor :saq_type
+
+    # The date of the PCI SAQ assessment. The format should be YYYYMMDD.
+    # @return [Integer]
+    attr_accessor :saq_date
+
+    # Qualified Security Assessor (QSA) companies are independent security
+    # organizations that have been qualified by the PCI Security Standards
+    # Council to validate an entity's adherence to PCI DSS. This is a free-text
+    # field for inputting the QSA's business name.
+    #  The name of the Qualified Security Assessor (QSA) used by the Merchant to
+    # assess, verify and prove their PCI DSS compliance.
+    # @return [String]
+    attr_accessor :qsa
+
+    # Indicates whether the letter status is ON or OFF.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **OFF**
+    # - `1` - **ON**
+    # </details>
+    # @return [LetterStatusEnum]
+    attr_accessor :letter_status
+
+    # The date of letter. The format should be YYYYMMDD.
+    # @return [Integer]
+    attr_accessor :letter_date
+
+    # Notification Email for chargebacks.
+    # @return [String]
+    attr_accessor :chargeback_notification_email
+
+    # Whether or not the merchant has acknowledged and accepted the Terms and
+    # Conditions.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Accepted**
+    # - `1` - **Accepted**
+    # </details>
+    # @return [TcAttestationEnum]
+    attr_accessor :tc_attestation
+
+    # This field indicates if Apple Pay is active for this merchant.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Inactive**
+    # - `1` - **Active**
+    # </details>
+    # @return [ApplePayActiveEnum]
+    attr_accessor :apple_pay_active
+
+    # This field indicates if Google Pay is active for this merchant.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Inactive**
+    # - `1` - **Active**
+    # </details>
+    # @return [GooglePayActiveEnum]
+    attr_accessor :google_pay_active
+
+    # The NAICS sector code that accurately describes the industry the business
+    # operates in.
+    # For more information, see the [NAICS Manual provided by the US Census
+    # Bureau's North American Industry Classification
+    # System.](https://www.census.gov/naics/reference_files_tools/2022_NAICS_Man
+    # ual.pdf)
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `11` - **Agriculture, Forestry, Fishing and Hunting**
+    # - `21` - **Mining, Quarrying, and Oil and Gas Extraction**
+    # - `22` - **Utilities**
+    # - `23` - **Construction**
+    # - `31` / `33` - **Manufacturing**
+    # - `41` - **Wholesale Trade**
+    # - `44` / `45` - **Retail Trade**
+    # - `48` / `49` - **Transportation and Warehousing**
+    # - `51` - **Information**
+    # - `52` - **Finance and Insurance**
+    # - `53` - **Real Estate and Property Rental / Leasing**
+    # - `54` - **Professional, Scientific, and Technical Services**
+    # - `55` - **Management of Companies and Enterprises**
+    # - `56` - **Administrative and Support and Waste Management and Remediation
+    # Services**
+    # - `61` - **Educational Services**
+    # - `62` - **Health Care and Social Assistance**
+    # - `71` - **Arts, Entertainment, and Recreation**
+    # - `72` - **Accommodation and Food Services**
+    # - `81` - **Other Services (except Public Administration)**
+    # - `91` / `92` - **Public Administration**
+    # </details>
+    # @return [NaicsEnum]
+    attr_accessor :naics
+
+    # The NAICS sector description matching the above NAICS sector code. If
+    # "Other", industry description is prefixed with "Other: ".
+    # @return [String]
+    attr_accessor :naics_description
+
+    # Transaction Session Id.
+    # @return [String]
+    attr_accessor :tmx_session_id
+
+    # This field indicates if Pass Token is enabled for this merchant.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [PassTokenEnabledEnum]
+    attr_accessor :pass_token_enabled
+
+    # This field indicates the batch close method for this merchant applicable
+    # to Express platform.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `TimeInitiated` - **Batch close occurs at specific time intervals
+    # (Automated).**
+    # - `MerchantInitiated` - **Batch close occurs when initiated by the
+    # Merchant (Manual).**
+    # </details>
+    # @return [ExpressBatchCloseMethodEnum]
+    attr_accessor :express_batch_close_method
+
+    # This field indicates the batch close time for this merchant applicable to
+    # Express platform.
+    # @return [String]
+    attr_accessor :express_batch_close_time
+
+    # This field indicates if Omni Token is enabled for this merchant.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [OmniTokenEnabledEnum]
+    attr_accessor :omni_token_enabled
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[BatchesPostRequest]]
+    attr_accessor :batches
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[CustomersPostRequest]]
+    attr_accessor :customers
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[MembersPostRequest]]
+    attr_accessor :members
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[PlansPostRequest]]
+    attr_accessor :plans
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[TerminalsPostRequest]]
+    attr_accessor :terminals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_approved_sales'] = 'totalApprovedSales'
+      @_hash['entity'] = 'entity'
+      @_hash['dba'] = 'dba'
+      @_hash['new'] = 'new'
+      @_hash['advanced_billing'] = 'advancedBilling'
+      @_hash['seasonal'] = 'seasonal'
+      @_hash['established'] = 'established'
+      @_hash['annual_cc_sales'] = 'annualCCSales'
+      @_hash['annual_cc_sale_volume'] = 'annualCCSaleVolume'
+      @_hash['annual_ach_sale_volume'] = 'annualACHSaleVolume'
+      @_hash['amex_volume'] = 'amexVolume'
+      @_hash['avg_ticket'] = 'avgTicket'
+      @_hash['amex'] = 'amex'
+      @_hash['discover'] = 'discover'
+      @_hash['mcc'] = 'mcc'
+      @_hash['visa_mvv'] = 'visaMvv'
+      @_hash['visa_disclosure'] = 'visaDisclosure'
+      @_hash['disclosure_ip'] = 'disclosureIP'
+      @_hash['disclosure_date'] = 'disclosureDate'
+      @_hash['environment'] = 'environment'
+      @_hash['status'] = 'status'
+      @_hash['incremental_auth_supported'] = 'incrementalAuthSupported'
+      @_hash['auto_boarded'] = 'autoBoarded'
+      @_hash['status_reason'] = 'statusReason'
+      @_hash['location_type'] = 'locationType'
+      @_hash['percent_ecomm'] = 'percentEcomm'
+      @_hash['percent_keyed'] = 'percentKeyed'
+      @_hash['percent_business'] = 'percentBusiness'
+      @_hash['total_volume'] = 'totalVolume'
+      @_hash['account_closure_reason_code'] = 'accountClosureReasonCode'
+      @_hash['account_closure_reason_date'] = 'accountClosureReasonDate'
+      @_hash['risk_level'] = 'riskLevel'
+      @_hash['credit_ratio'] = 'creditRatio'
+      @_hash['credit_timeliness'] = 'creditTimeliness'
+      @_hash['chargeback_ratio'] = 'chargebackRatio'
+      @_hash['ndx_days'] = 'ndxDays'
+      @_hash['ndx_percentage'] = 'ndxPercentage'
+      @_hash['saq_type'] = 'saqType'
+      @_hash['saq_date'] = 'saqDate'
+      @_hash['qsa'] = 'qsa'
+      @_hash['letter_status'] = 'letterStatus'
+      @_hash['letter_date'] = 'letterDate'
+      @_hash['chargeback_notification_email'] = 'chargebackNotificationEmail'
+      @_hash['tc_attestation'] = 'tcAttestation'
+      @_hash['apple_pay_active'] = 'applePayActive'
+      @_hash['google_pay_active'] = 'googlePayActive'
+      @_hash['naics'] = 'naics'
+      @_hash['naics_description'] = 'naicsDescription'
+      @_hash['tmx_session_id'] = 'tmxSessionId'
+      @_hash['pass_token_enabled'] = 'passTokenEnabled'
+      @_hash['express_batch_close_method'] = 'expressBatchCloseMethod'
+      @_hash['express_batch_close_time'] = 'expressBatchCloseTime'
+      @_hash['omni_token_enabled'] = 'omniTokenEnabled'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['batches'] = 'batches'
+      @_hash['customers'] = 'customers'
+      @_hash['members'] = 'members'
+      @_hash['plans'] = 'plans'
+      @_hash['terminals'] = 'terminals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_approved_sales
+        dba
+        new
+        advanced_billing
+        seasonal
+        established
+        annual_cc_sales
+        annual_cc_sale_volume
+        annual_ach_sale_volume
+        amex_volume
+        avg_ticket
+        amex
+        discover
+        mcc
+        visa_mvv
+        visa_disclosure
+        disclosure_ip
+        disclosure_date
+        status
+        incremental_auth_supported
+        auto_boarded
+        status_reason
+        location_type
+        percent_ecomm
+        percent_keyed
+        percent_business
+        total_volume
+        account_closure_reason_code
+        account_closure_reason_date
+        risk_level
+        credit_ratio
+        credit_timeliness
+        chargeback_ratio
+        ndx_days
+        ndx_percentage
+        saq_type
+        saq_date
+        qsa
+        letter_status
+        letter_date
+        chargeback_notification_email
+        tc_attestation
+        apple_pay_active
+        google_pay_active
+        naics
+        naics_description
+        tmx_session_id
+        pass_token_enabled
+        express_batch_close_method
+        express_batch_close_time
+        omni_token_enabled
+        inactive
+        frozen
+        batches
+        customers
+        members
+        plans
+        terminals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity = nil, environment = nil, total_approved_sales = 0,
+                   dba = SKIP, new = NewEnum::NEW, advanced_billing = SKIP,
+                   seasonal = SKIP, established = SKIP, annual_cc_sales = 0,
+                   annual_cc_sale_volume = SKIP, annual_ach_sale_volume = SKIP,
+                   amex_volume = SKIP, avg_ticket = 0, amex = SKIP,
+                   discover = SKIP, mcc = SKIP, visa_mvv = SKIP,
+                   visa_disclosure = VisaDisclosureEnum::NOTACCEPTED,
+                   disclosure_ip = SKIP, disclosure_date = SKIP,
+                   status = MerchantStatusEnum::NOTREADY,
+                   incremental_auth_supported = SKIP, auto_boarded = SKIP,
+                   status_reason = SKIP, location_type = SKIP,
+                   percent_ecomm = SKIP, percent_keyed = SKIP,
+                   percent_business = SKIP, total_volume = SKIP,
+                   account_closure_reason_code = SKIP,
+                   account_closure_reason_date = SKIP, risk_level = SKIP,
+                   credit_ratio = SKIP, credit_timeliness = SKIP,
+                   chargeback_ratio = SKIP, ndx_days = SKIP,
+                   ndx_percentage = SKIP, saq_type = SKIP, saq_date = SKIP,
+                   qsa = SKIP, letter_status = SKIP, letter_date = SKIP,
+                   chargeback_notification_email = SKIP, tc_attestation = SKIP,
+                   apple_pay_active = SKIP,
+                   google_pay_active = GooglePayActiveEnum::ACTIVE,
+                   naics = SKIP, naics_description = SKIP,
+                   tmx_session_id = SKIP, pass_token_enabled = SKIP,
+                   express_batch_close_method = SKIP,
+                   express_batch_close_time = SKIP, omni_token_enabled = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, batches = SKIP,
+                   customers = SKIP, members = SKIP, plans = SKIP,
+                   terminals = SKIP)
+      @total_approved_sales = total_approved_sales unless total_approved_sales == SKIP
+      @entity = entity
+      @dba = dba unless dba == SKIP
+      @new = new unless new == SKIP
+      @advanced_billing = advanced_billing unless advanced_billing == SKIP
+      @seasonal = seasonal unless seasonal == SKIP
+      @established = established unless established == SKIP
+      @annual_cc_sales = annual_cc_sales unless annual_cc_sales == SKIP
+      @annual_cc_sale_volume = annual_cc_sale_volume unless annual_cc_sale_volume == SKIP
+      @annual_ach_sale_volume = annual_ach_sale_volume unless annual_ach_sale_volume == SKIP
+      @amex_volume = amex_volume unless amex_volume == SKIP
+      @avg_ticket = avg_ticket unless avg_ticket == SKIP
+      @amex = amex unless amex == SKIP
+      @discover = discover unless discover == SKIP
+      @mcc = mcc unless mcc == SKIP
+      @visa_mvv = visa_mvv unless visa_mvv == SKIP
+      @visa_disclosure = visa_disclosure unless visa_disclosure == SKIP
+      @disclosure_ip = disclosure_ip unless disclosure_ip == SKIP
+      @disclosure_date = disclosure_date unless disclosure_date == SKIP
+      @environment = environment
+      @status = status unless status == SKIP
+      unless incremental_auth_supported == SKIP
+        @incremental_auth_supported =
+          incremental_auth_supported
+      end
+      @auto_boarded = auto_boarded unless auto_boarded == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @location_type = location_type unless location_type == SKIP
+      @percent_ecomm = percent_ecomm unless percent_ecomm == SKIP
+      @percent_keyed = percent_keyed unless percent_keyed == SKIP
+      @percent_business = percent_business unless percent_business == SKIP
+      @total_volume = total_volume unless total_volume == SKIP
+      unless account_closure_reason_code == SKIP
+        @account_closure_reason_code =
+          account_closure_reason_code
+      end
+      unless account_closure_reason_date == SKIP
+        @account_closure_reason_date =
+          account_closure_reason_date
+      end
+      @risk_level = risk_level unless risk_level == SKIP
+      @credit_ratio = credit_ratio unless credit_ratio == SKIP
+      @credit_timeliness = credit_timeliness unless credit_timeliness == SKIP
+      @chargeback_ratio = chargeback_ratio unless chargeback_ratio == SKIP
+      @ndx_days = ndx_days unless ndx_days == SKIP
+      @ndx_percentage = ndx_percentage unless ndx_percentage == SKIP
+      @saq_type = saq_type unless saq_type == SKIP
+      @saq_date = saq_date unless saq_date == SKIP
+      @qsa = qsa unless qsa == SKIP
+      @letter_status = letter_status unless letter_status == SKIP
+      @letter_date = letter_date unless letter_date == SKIP
+      unless chargeback_notification_email == SKIP
+        @chargeback_notification_email =
+          chargeback_notification_email
+      end
+      @tc_attestation = tc_attestation unless tc_attestation == SKIP
+      @apple_pay_active = apple_pay_active unless apple_pay_active == SKIP
+      @google_pay_active = google_pay_active unless google_pay_active == SKIP
+      @naics = naics unless naics == SKIP
+      @naics_description = naics_description unless naics_description == SKIP
+      @tmx_session_id = tmx_session_id unless tmx_session_id == SKIP
+      @pass_token_enabled = pass_token_enabled unless pass_token_enabled == SKIP
+      unless express_batch_close_method == SKIP
+        @express_batch_close_method =
+          express_batch_close_method
+      end
+      @express_batch_close_time = express_batch_close_time unless express_batch_close_time == SKIP
+      @omni_token_enabled = omni_token_enabled unless omni_token_enabled == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @batches = batches unless batches == SKIP
+      @customers = customers unless customers == SKIP
+      @members = members unless members == SKIP
+      @plans = plans unless plans == SKIP
+      @terminals = terminals unless terminals == 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.
+      entity = hash.key?('entity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MerchantsPostRequestEntity), hash['entity']
+      ) : nil
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      total_approved_sales = hash['totalApprovedSales'] ||= 0
+      dba = hash.key?('dba') ? hash['dba'] : SKIP
+      new = hash['new'] ||= NewEnum::NEW
+      advanced_billing =
+        hash.key?('advancedBilling') ? hash['advancedBilling'] : SKIP
+      seasonal = hash.key?('seasonal') ? hash['seasonal'] : SKIP
+      established = hash.key?('established') ? hash['established'] : SKIP
+      annual_cc_sales = hash['annualCCSales'] ||= 0
+      annual_cc_sale_volume =
+        hash.key?('annualCCSaleVolume') ? hash['annualCCSaleVolume'] : SKIP
+      annual_ach_sale_volume =
+        hash.key?('annualACHSaleVolume') ? hash['annualACHSaleVolume'] : SKIP
+      amex_volume = hash.key?('amexVolume') ? hash['amexVolume'] : SKIP
+      avg_ticket = hash['avgTicket'] ||= 0
+      amex = hash.key?('amex') ? hash['amex'] : SKIP
+      discover = hash.key?('discover') ? hash['discover'] : SKIP
+      mcc = hash.key?('mcc') ? hash['mcc'] : SKIP
+      visa_mvv = hash.key?('visaMvv') ? hash['visaMvv'] : SKIP
+      visa_disclosure =
+        hash['visaDisclosure'] ||= VisaDisclosureEnum::NOTACCEPTED
+      disclosure_ip = hash.key?('disclosureIP') ? hash['disclosureIP'] : SKIP
+      disclosure_date =
+        hash.key?('disclosureDate') ? hash['disclosureDate'] : SKIP
+      status = hash['status'] ||= MerchantStatusEnum::NOTREADY
+      incremental_auth_supported =
+        hash.key?('incrementalAuthSupported') ? hash['incrementalAuthSupported'] : SKIP
+      auto_boarded = hash.key?('autoBoarded') ? hash['autoBoarded'] : SKIP
+      status_reason = hash.key?('statusReason') ? hash['statusReason'] : SKIP
+      location_type = hash.key?('locationType') ? hash['locationType'] : SKIP
+      percent_ecomm = hash.key?('percentEcomm') ? hash['percentEcomm'] : SKIP
+      percent_keyed = hash.key?('percentKeyed') ? hash['percentKeyed'] : SKIP
+      percent_business =
+        hash.key?('percentBusiness') ? hash['percentBusiness'] : SKIP
+      total_volume = hash.key?('totalVolume') ? hash['totalVolume'] : SKIP
+      account_closure_reason_code =
+        hash.key?('accountClosureReasonCode') ? hash['accountClosureReasonCode'] : SKIP
+      account_closure_reason_date =
+        hash.key?('accountClosureReasonDate') ? hash['accountClosureReasonDate'] : SKIP
+      risk_level = hash.key?('riskLevel') ? hash['riskLevel'] : SKIP
+      credit_ratio = hash.key?('creditRatio') ? hash['creditRatio'] : SKIP
+      credit_timeliness =
+        hash.key?('creditTimeliness') ? hash['creditTimeliness'] : SKIP
+      chargeback_ratio =
+        hash.key?('chargebackRatio') ? hash['chargebackRatio'] : SKIP
+      ndx_days = hash.key?('ndxDays') ? hash['ndxDays'] : SKIP
+      ndx_percentage = hash.key?('ndxPercentage') ? hash['ndxPercentage'] : SKIP
+      saq_type = hash.key?('saqType') ? hash['saqType'] : SKIP
+      saq_date = hash.key?('saqDate') ? hash['saqDate'] : SKIP
+      qsa = hash.key?('qsa') ? hash['qsa'] : SKIP
+      letter_status = hash.key?('letterStatus') ? hash['letterStatus'] : SKIP
+      letter_date = hash.key?('letterDate') ? hash['letterDate'] : SKIP
+      chargeback_notification_email =
+        hash.key?('chargebackNotificationEmail') ? hash['chargebackNotificationEmail'] : SKIP
+      tc_attestation = hash.key?('tcAttestation') ? hash['tcAttestation'] : SKIP
+      apple_pay_active =
+        hash.key?('applePayActive') ? hash['applePayActive'] : SKIP
+      google_pay_active =
+        hash['googlePayActive'] ||= GooglePayActiveEnum::ACTIVE
+      naics = hash.key?('naics') ? hash['naics'] : SKIP
+      naics_description =
+        hash.key?('naicsDescription') ? hash['naicsDescription'] : SKIP
+      tmx_session_id = hash.key?('tmxSessionId') ? hash['tmxSessionId'] : SKIP
+      pass_token_enabled =
+        hash.key?('passTokenEnabled') ? hash['passTokenEnabled'] : SKIP
+      express_batch_close_method =
+        hash.key?('expressBatchCloseMethod') ? hash['expressBatchCloseMethod'] : SKIP
+      express_batch_close_time =
+        hash.key?('expressBatchCloseTime') ? hash['expressBatchCloseTime'] : SKIP
+      omni_token_enabled =
+        hash.key?('omniTokenEnabled') ? hash['omniTokenEnabled'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      # Parameter is an array, so we need to iterate through it
+      batches = nil
+      unless hash['batches'].nil?
+        batches = []
+        hash['batches'].each do |structure|
+          batches << (BatchesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      batches = SKIP unless hash.key?('batches')
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomersPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      customers = SKIP unless hash.key?('customers')
+      # Parameter is an array, so we need to iterate through it
+      members = nil
+      unless hash['members'].nil?
+        members = []
+        hash['members'].each do |structure|
+          members << (MembersPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      members = SKIP unless hash.key?('members')
+      # Parameter is an array, so we need to iterate through it
+      plans = nil
+      unless hash['plans'].nil?
+        plans = []
+        hash['plans'].each do |structure|
+          plans << (PlansPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      plans = SKIP unless hash.key?('plans')
+      # Parameter is an array, so we need to iterate through it
+      terminals = nil
+      unless hash['terminals'].nil?
+        terminals = []
+        hash['terminals'].each do |structure|
+          terminals << (TerminalsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      terminals = SKIP unless hash.key?('terminals')
+
+      # Create object from extracted values.
+      MerchantsPostRequest.new(entity,
+                               environment,
+                               total_approved_sales,
+                               dba,
+                               new,
+                               advanced_billing,
+                               seasonal,
+                               established,
+                               annual_cc_sales,
+                               annual_cc_sale_volume,
+                               annual_ach_sale_volume,
+                               amex_volume,
+                               avg_ticket,
+                               amex,
+                               discover,
+                               mcc,
+                               visa_mvv,
+                               visa_disclosure,
+                               disclosure_ip,
+                               disclosure_date,
+                               status,
+                               incremental_auth_supported,
+                               auto_boarded,
+                               status_reason,
+                               location_type,
+                               percent_ecomm,
+                               percent_keyed,
+                               percent_business,
+                               total_volume,
+                               account_closure_reason_code,
+                               account_closure_reason_date,
+                               risk_level,
+                               credit_ratio,
+                               credit_timeliness,
+                               chargeback_ratio,
+                               ndx_days,
+                               ndx_percentage,
+                               saq_type,
+                               saq_date,
+                               qsa,
+                               letter_status,
+                               letter_date,
+                               chargeback_notification_email,
+                               tc_attestation,
+                               apple_pay_active,
+                               google_pay_active,
+                               naics,
+                               naics_description,
+                               tmx_session_id,
+                               pass_token_enabled,
+                               express_batch_close_method,
+                               express_batch_close_time,
+                               omni_token_enabled,
+                               inactive,
+                               frozen,
+                               batches,
+                               customers,
+                               members,
+                               plans,
+                               terminals)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MerchantsPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:MerchantsPostRequestEntity)
+                         .validate(value.entity) and
+            APIHelper.valid_type?(value.environment,
+                                  ->(val) { MerchantEnvironmentEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:MerchantsPostRequestEntity)
+                       .validate(value['entity']) and
+          APIHelper.valid_type?(value['environment'],
+                                ->(val) { MerchantEnvironmentEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_approved_sales: #{@total_approved_sales}, entity: #{@entity}, dba:"\
+      " #{@dba}, new: #{@new}, advanced_billing: #{@advanced_billing}, seasonal: #{@seasonal},"\
+      " established: #{@established}, annual_cc_sales: #{@annual_cc_sales}, annual_cc_sale_volume:"\
+      " #{@annual_cc_sale_volume}, annual_ach_sale_volume: #{@annual_ach_sale_volume},"\
+      " amex_volume: #{@amex_volume}, avg_ticket: #{@avg_ticket}, amex: #{@amex}, discover:"\
+      " #{@discover}, mcc: #{@mcc}, visa_mvv: #{@visa_mvv}, visa_disclosure: #{@visa_disclosure},"\
+      " disclosure_ip: #{@disclosure_ip}, disclosure_date: #{@disclosure_date}, environment:"\
+      " #{@environment}, status: #{@status}, incremental_auth_supported:"\
+      " #{@incremental_auth_supported}, auto_boarded: #{@auto_boarded}, status_reason:"\
+      " #{@status_reason}, location_type: #{@location_type}, percent_ecomm: #{@percent_ecomm},"\
+      " percent_keyed: #{@percent_keyed}, percent_business: #{@percent_business}, total_volume:"\
+      " #{@total_volume}, account_closure_reason_code: #{@account_closure_reason_code},"\
+      " account_closure_reason_date: #{@account_closure_reason_date}, risk_level: #{@risk_level},"\
+      " credit_ratio: #{@credit_ratio}, credit_timeliness: #{@credit_timeliness},"\
+      " chargeback_ratio: #{@chargeback_ratio}, ndx_days: #{@ndx_days}, ndx_percentage:"\
+      " #{@ndx_percentage}, saq_type: #{@saq_type}, saq_date: #{@saq_date}, qsa: #{@qsa},"\
+      " letter_status: #{@letter_status}, letter_date: #{@letter_date},"\
+      " chargeback_notification_email: #{@chargeback_notification_email}, tc_attestation:"\
+      " #{@tc_attestation}, apple_pay_active: #{@apple_pay_active}, google_pay_active:"\
+      " #{@google_pay_active}, naics: #{@naics}, naics_description: #{@naics_description},"\
+      " tmx_session_id: #{@tmx_session_id}, pass_token_enabled: #{@pass_token_enabled},"\
+      " express_batch_close_method: #{@express_batch_close_method}, express_batch_close_time:"\
+      " #{@express_batch_close_time}, omni_token_enabled: #{@omni_token_enabled}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}, batches: #{@batches}, customers: #{@customers}, members:"\
+      " #{@members}, plans: #{@plans}, terminals: #{@terminals}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_approved_sales: #{@total_approved_sales.inspect}, entity:"\
+      " #{@entity.inspect}, dba: #{@dba.inspect}, new: #{@new.inspect}, advanced_billing:"\
+      " #{@advanced_billing.inspect}, seasonal: #{@seasonal.inspect}, established:"\
+      " #{@established.inspect}, annual_cc_sales: #{@annual_cc_sales.inspect},"\
+      " annual_cc_sale_volume: #{@annual_cc_sale_volume.inspect}, annual_ach_sale_volume:"\
+      " #{@annual_ach_sale_volume.inspect}, amex_volume: #{@amex_volume.inspect}, avg_ticket:"\
+      " #{@avg_ticket.inspect}, amex: #{@amex.inspect}, discover: #{@discover.inspect}, mcc:"\
+      " #{@mcc.inspect}, visa_mvv: #{@visa_mvv.inspect}, visa_disclosure:"\
+      " #{@visa_disclosure.inspect}, disclosure_ip: #{@disclosure_ip.inspect}, disclosure_date:"\
+      " #{@disclosure_date.inspect}, environment: #{@environment.inspect}, status:"\
+      " #{@status.inspect}, incremental_auth_supported: #{@incremental_auth_supported.inspect},"\
+      " auto_boarded: #{@auto_boarded.inspect}, status_reason: #{@status_reason.inspect},"\
+      " location_type: #{@location_type.inspect}, percent_ecomm: #{@percent_ecomm.inspect},"\
+      " percent_keyed: #{@percent_keyed.inspect}, percent_business: #{@percent_business.inspect},"\
+      " total_volume: #{@total_volume.inspect}, account_closure_reason_code:"\
+      " #{@account_closure_reason_code.inspect}, account_closure_reason_date:"\
+      " #{@account_closure_reason_date.inspect}, risk_level: #{@risk_level.inspect}, credit_ratio:"\
+      " #{@credit_ratio.inspect}, credit_timeliness: #{@credit_timeliness.inspect},"\
+      " chargeback_ratio: #{@chargeback_ratio.inspect}, ndx_days: #{@ndx_days.inspect},"\
+      " ndx_percentage: #{@ndx_percentage.inspect}, saq_type: #{@saq_type.inspect}, saq_date:"\
+      " #{@saq_date.inspect}, qsa: #{@qsa.inspect}, letter_status: #{@letter_status.inspect},"\
+      " letter_date: #{@letter_date.inspect}, chargeback_notification_email:"\
+      " #{@chargeback_notification_email.inspect}, tc_attestation: #{@tc_attestation.inspect},"\
+      " apple_pay_active: #{@apple_pay_active.inspect}, google_pay_active:"\
+      " #{@google_pay_active.inspect}, naics: #{@naics.inspect}, naics_description:"\
+      " #{@naics_description.inspect}, tmx_session_id: #{@tmx_session_id.inspect},"\
+      " pass_token_enabled: #{@pass_token_enabled.inspect}, express_batch_close_method:"\
+      " #{@express_batch_close_method.inspect}, express_batch_close_time:"\
+      " #{@express_batch_close_time.inspect}, omni_token_enabled: #{@omni_token_enabled.inspect},"\
+      " inactive: #{@inactive.inspect}, frozen: #{@frozen.inspect}, batches: #{@batches.inspect},"\
+      " customers: #{@customers.inspect}, members: #{@members.inspect}, plans: #{@plans.inspect},"\
+      " terminals: #{@terminals.inspect}>"
+    end
+  end
+end