payrix-api-sdk 1.0.0

data/lib/payrix/models/entities_post_request.rb

@@ -0,0 +1,1282 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # EntitiesPostRequest Model.
+  class EntitiesPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The client IP address from which the Entity was created. Valid values are
+    # any IPv4 or IPv6 address.
+    # @return [String]
+    attr_accessor :client_ip
+
+    # The Login that owns this resource.
+    # @return [String]
+    attr_accessor :login
+
+    # The type of Entity.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Sole Proprietorship**
+    # - `1` - **Corporation**
+    # - `2` - **Limited Liability Company**
+    # - `3` - **Partnership**
+    # - `4` - **Association**
+    # - `5` - **Non-Profit Organization**
+    # - `6` - **Government Organization**
+    # - `7` - **C Corporation**
+    # - `8` - **S Corporation**
+    # </details>
+    # @return [EntityTypeEnum]
+    attr_accessor :type
+
+    # The name of this Entity. 
+    # This field is stored as a string and must be between 1 and 100 characters
+    # long.
+    # @return [String]
+    attr_accessor :name
+
+    # The display name of this Entity. 
+    # This field is stored as a string and must be between 1 and 1,000
+    # characters long.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The first line of the address associated with this Entity. 
+    # This field is stored as a string and must be between 1 and 500 characters
+    # long.
+    # @return [String]
+    attr_accessor :address1
+
+    # The second line of the address associated with this Entity. 
+    # This field is stored as a string and must be between 1 and 500 characters
+    # long.
+    # @return [String]
+    attr_accessor :address2
+
+    # The name of the city in the address associated with this Entity. 
+    # This field is stored as a string and must be between 1 and 500 characters
+    # long.
+    # @return [String]
+    attr_accessor :city
+
+    # The U.S. state or Canadian province relevant to the address provided here.
+    # If the location is within the U.S. and Canada, specify the 2-character
+    # postal abbreviation for the state. If the location is outside of the U.S.
+    # and Canada, provide the full state name. This field is stored as a text
+    # string and must be between 2 and 100 characters long.
+    #  
+    # <details>
+    # <summary>U.S. States</summary>
+    #  
+    #  - `AK` - **Alaska (US)**
+    #  
+    #  - `AR` - **Arkansas (US)**
+    #  
+    #  - `AL` - **Alabama (US)**
+    #  
+    #  - `AZ` - **Arizona (US)**
+    #  
+    #  - `CA` - **California (US)**
+    #  
+    #  - `CO` - **Colorado (US)**
+    #  
+    #  - `CT` - **Connecticut (US)**
+    #  
+    #  - `DE` - **Delaware (US)**
+    #  
+    #  - `FL` - **Florida (US)**
+    #  
+    #  - `GA` - **Georgia (US)**
+    #  
+    #  - `HI` - **Hawaii (US)**
+    #  
+    #  - `IA` - **Iowa (US)**
+    #  
+    #  - `ID` - **Idaho (US)**
+    #  
+    #  - `IL` - **Illinois (US)**
+    #  
+    #  - `IN` - **Indiana (US)**
+    #  
+    #  - `KY` - **Kentucky (US)**
+    #  
+    #  - `KS` - **Kansas (US)**
+    #  
+    #  - `LA` - **Louisiana (US)**
+    #  
+    #  - `MA` - **Massachusetts (US)**
+    #  
+    #  - `MD` - **Maryland (US)**
+    #  
+    #  - `ME` - **Maine (US)**
+    #  
+    #  - `MI` - **Michigan (US)**
+    #  
+    #  - `MN` - **Minnesota (US)**
+    #  
+    #  - `MO` - **Missouri (US)**
+    #  
+    #  - `MS` - **Mississippi (US)**
+    #  
+    #  - `MT` - **Montana (US)**
+    #  
+    #  - `NC` - **North Carolina (US)**
+    #  
+    #  - `ND` - **North Dakota (US)**
+    #  
+    #  - `NE` - **Nebraska (US)**
+    #  
+    #  - `NH` - **New Hampshire (US)**
+    #  
+    #  - `NJ` - **New Jersey (US)**
+    #  
+    #  - `NM` - **New Mexico (US)**
+    #  
+    #  - `NV` - **Nevada (US)**
+    #  
+    #  - `NY` - **New York (US)**
+    #  
+    #  - `OH` - **Ohio (US)**
+    #  
+    #  - `OK`- **Oklahoma (US)**
+    #  
+    #  - `OR` - **Oregon (US)**
+    #  
+    #  - `PA` - **Pennsylvania (US)**
+    #  
+    #  - `RI` - **Rhode Island (US)**
+    #  
+    #  - `SC`- **South Carolina (US)**
+    #  
+    #  - `SD` - **South Dakota (US)**
+    #  
+    #  - `TN` - **Tennessee (US)**
+    #  
+    #  - `TX` - **Texas (US)**
+    #  
+    #  - `UT` - **Utah (US)**
+    #  
+    #  - `VA` - **Virginia (US)**
+    #  
+    #  - `VT` - **Vermont (US)**
+    #  
+    #  - `WA` - **Washington (US)**
+    #  
+    #  - `WI` - **Wisconsin (US)**
+    #  
+    #  - `WV` - **West Virginia (US)**
+    #  
+    #  - `WY` - **Wyoming (US)**
+    #  </details>
+    #  <details>
+    # <summary>Canada Provinces and Territories</summary>
+    #  
+    #  - `AB` - **Alberta (CAN)**
+    #  
+    #  - `BC` - **British Columbia (CAN)**
+    #  
+    #  - `MB` - **Manitoba (CAN)**
+    #  
+    #  - `ON` - **Ontario (CAN)**
+    #  
+    #  - `NS` - **Nova Scotia (CAN)**
+    #  
+    #  - `NB` - **New Brunswick (CAN)**
+    #  
+    #  - `NL` - **Newfoundland and Labrador (CAN)**
+    #  
+    #  - `NT` - **Northwest Territories (CAN)**
+    #  
+    #  - `NU` - **Nunavut (CAN)**
+    #  
+    #  - `PE` - **Prince Edward Island (CAN)**
+    #  
+    #  - `QC` - **Quebec (CAN)**
+    #  
+    #  - `SK` - **Saskatchewan (CAN)**
+    #  
+    #  - `YT` - **Yukon (CAN)**
+    #  </details>
+    # @return [String]
+    attr_accessor :state
+
+    # The ZIP code in the address associated with this Entity. 
+    # This field is stored as a text string and must be between 1 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :zip
+
+    # The country in the address associated with the Entity, currently accepting
+    # values including `USA` and `CAN`.
+    # @return [EntityCountryEnum]
+    attr_accessor :country
+
+    # The timezone for the address associated with the terminal's location.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `est` - **Eastern Standard Time**
+    # - `cst` - **Central Standard Time**
+    # - `pst` - **Pacific Standard Time**
+    # - `mst` - **Mountain Standard Time**
+    # - `akst` - **Alaska Standard Time**
+    # - `hst` - **Hawaii Standard Time**
+    # - `sst` - **Samoa Standard Time**
+    # - `chst` - **Chamorro Standard Time**
+    # - `ast` - **Atlantic Standard Time**
+    # - `pwt` - **Palau Time**
+    # - `mht` - **Marshall Islands Time**
+    # - `chut` - **Chuuk Time**
+    # - `nst` - **Newfoundland Standard Time**
+    # </details>
+    # @return [TimezoneEnum]
+    attr_accessor :timezone
+
+    # The phone number associated with this Entity. 
+    # This field is stored as a text string and must be between 5 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :phone
+
+    # The customer service phone number associated with this Entity. For
+    # Merchants, this number will be displayed on the customer's credit card
+    # statement. 
+    # This field is stored as a text string and must be between 5 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :customer_phone
+
+    # The fax number associated with this Entity. 
+    # This field is stored as a text string and must be between 5 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :fax
+
+    # The email address associated with this Entity. 
+    # This field is stored as a text string and must be between 1 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :email
+
+    # The web site URL associated with this Entity. 
+    # This field is stored as a text string and must be between 0 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :website
+
+    # The web sites URL associated with this Entity. 
+    # This field is stored as a text string; must be between 0 and 1,000
+    # characters long and separated by comma.
+    # @return [String]
+    attr_accessor :apple_domain
+
+    # Indicates if the TIN being used is an EIN, SSN, or other/unknown number.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `ssn` - **Social Security Number.**
+    # - `tin` - **Employer Identification Number.**
+    # - `other` - **Other/Unknown TIN.**
+    # </details>
+    # @return [EinTypeEnum]
+    attr_accessor :ein_type
+
+    # The IRS Legal Filing Name. This must match what has been provided to the
+    # IRS when filing taxes.
+    # @return [String]
+    attr_accessor :irs_filing_name
+
+    # The IRS Employer Identification Number (EIN) for the Entity. 
+    # This field is stored as an integer and must be 9 characters long.
+    # @return [String]
+    attr_accessor :ein
+
+    # The number of locations at which this Entity does business. 
+    # This field is stored as an integer and must be between 1 and 1,000,000
+    # characters long.
+    # @return [Integer]
+    attr_accessor :locations
+
+    # Indicates whether this is a publicly held entity.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Private entity**
+    # - `1` - **Public entity**
+    # </details>
+    # @return [EntitiesPublicEnum]
+    attr_accessor :public
+
+    # An indicator showing the version of the terms and conditions that this
+    # Entity has accepted. The API indicates the version as a string. 
+    # This field is stored as a text string and must be between 0 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :tc_version
+
+    # Date and time on which this Entity accepted the Terms and Conditions, if
+    # different than `tcDate`. 
+    # The date is specified as a 12-digit string in YYYYMMDDHHII format, for
+    # example, `201601201528` for January 20, 2016, at 15:28 (3:28 PM).
+    # @return [String]
+    attr_accessor :tc_accept_date
+
+    # IP address from which this Entity accepted the Terms and Conditions, if
+    # different than `tcIp`.
+    # @return [String]
+    attr_accessor :tc_accept_ip
+
+    # Custom, free-form field for client-supplied text; must be between 0 and
+    # 1,000 characters long.
+    # @return [String]
+    attr_accessor :custom
+
+    # The secondary billing descriptor to appear on the bank statements for
+    # funds transfer for the entity.
+    # @return [String]
+    attr_accessor :payout_secondary_descriptor
+
+    # This field is stored as a text string and must be between 0 and 1,000
+    # characters long.
+    # @return [String]
+    attr_accessor :industry
+
+    # The business registration type for the entity
+    # <details>
+    # <summary>Valid Values for country USA</summary>
+    # - `ssn` - **Social Security Number.**
+    # - `tin` - **Employer Identification Number.**
+    # - `other` - **Other/Unknown TIN.**
+    # </details>
+    # <details>
+    # <summary>Valid Values for country Canada</summary>
+    # - `CD` - **Federal**
+    # - `AB` - **Alberta**
+    # - `BC` - **British Columbia**
+    # - `MB` - **Manitoba**
+    # - `NB` - **New Brunswick**
+    # - `NL` - **Newfoundland and Labrador**
+    # - `NT` - **Northwest Territories**
+    # - `NS` - **Nova Scotia**
+    # - `NU` - **Nunavut**
+    # - `ON` - **Ontario**
+    # - `PE` - **Prince Edward Island**
+    # - `QC` - **Quebec**
+    # - `SK` - **Saskatchewan**
+    # - `YT` - **Yukon**
+    # </details>
+    # @return [GlobalBusinessTypeEnum]
+    attr_accessor :global_business_type
+
+    # The business registration number for the entity. 
+    # This field is stored as an alphanumeric and must be between 9 to 10
+    # characters long
+    # @return [String]
+    attr_accessor :global_business_id
+
+    # The business registration number for the entity. 
+    # This field is stored as an alphanumeric and must be between 9 to 10
+    # characters long
+    # @return [Array[AccountsPostRequest]]
+    attr_accessor :accounts
+
+    # 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 inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[BillingsPostRequest]]
+    attr_accessor :billings
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[ContactsPostRequest]]
+    attr_accessor :contacts
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[CredentialsPostRequest]]
+    attr_accessor :credentials
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EmbeddedFinancePostRequest]]
+    attr_accessor :embedded_finance
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EntityCustomFieldsPostRequest]]
+    attr_accessor :entity_custom_fields
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EntityDataPostRequest]]
+    attr_accessor :entity_data
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EntityRefsPostRequest]]
+    attr_accessor :entity_refs
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EntityRoutesPostRequest]]
+    attr_accessor :entity_routes
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[EntityTermsPostRequest]]
+    attr_accessor :entity_terms
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[OrgEntitiesPostRequest]]
+    attr_accessor :org_entities
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[OmniTokensPostRequest]]
+    attr_accessor :omni_tokens
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[ProfitSharesPostRequest]]
+    attr_accessor :forentity_profit_shares
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[HoldsPostRequest]]
+    attr_accessor :holds
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[NotesPostRequest]]
+    attr_accessor :notes
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[PayoutPostRequest]]
+    attr_accessor :payouts
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[PinlessDebitConversionsPostRequest]]
+    attr_accessor :pinless_debit_conversions
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[ProfitSharesPostRequest]]
+    attr_accessor :profit_shares
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[ReservesPostRequest]]
+    attr_accessor :reserves
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[RevenueBoostsPostRequest]]
+    attr_accessor :revenue_boosts
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [VendorsPostRequest]
+    attr_accessor :vendor
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[FeesPostRequest]]
+    attr_accessor :fees
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[FeesPostRequest]]
+    attr_accessor :forentity_fees
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[SaferPaymentsPostRequest]]
+    attr_accessor :safer_payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_ip'] = 'clientIp'
+      @_hash['login'] = 'login'
+      @_hash['type'] = 'type'
+      @_hash['name'] = 'name'
+      @_hash['display_name'] = 'displayName'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['timezone'] = 'timezone'
+      @_hash['phone'] = 'phone'
+      @_hash['customer_phone'] = 'customerPhone'
+      @_hash['fax'] = 'fax'
+      @_hash['email'] = 'email'
+      @_hash['website'] = 'website'
+      @_hash['apple_domain'] = 'appleDomain'
+      @_hash['ein_type'] = 'einType'
+      @_hash['irs_filing_name'] = 'irsFilingName'
+      @_hash['ein'] = 'ein'
+      @_hash['locations'] = 'locations'
+      @_hash['public'] = 'public'
+      @_hash['tc_version'] = 'tcVersion'
+      @_hash['tc_accept_date'] = 'tcAcceptDate'
+      @_hash['tc_accept_ip'] = 'tcAcceptIp'
+      @_hash['custom'] = 'custom'
+      @_hash['payout_secondary_descriptor'] = 'payoutSecondaryDescriptor'
+      @_hash['industry'] = 'industry'
+      @_hash['global_business_type'] = 'globalBusinessType'
+      @_hash['global_business_id'] = 'globalBusinessId'
+      @_hash['accounts'] = 'accounts'
+      @_hash['frozen'] = 'frozen'
+      @_hash['inactive'] = 'inactive'
+      @_hash['billings'] = 'billings'
+      @_hash['contacts'] = 'contacts'
+      @_hash['credentials'] = 'credentials'
+      @_hash['embedded_finance'] = 'embeddedFinance'
+      @_hash['entity_custom_fields'] = 'entityCustomFields'
+      @_hash['entity_data'] = 'entityData'
+      @_hash['entity_refs'] = 'entityRefs'
+      @_hash['entity_routes'] = 'entityRoutes'
+      @_hash['entity_terms'] = 'entityTerms'
+      @_hash['org_entities'] = 'orgEntities'
+      @_hash['omni_tokens'] = 'omniTokens'
+      @_hash['forentity_profit_shares'] = 'forentityProfitShares'
+      @_hash['holds'] = 'holds'
+      @_hash['notes'] = 'notes'
+      @_hash['payouts'] = 'payouts'
+      @_hash['pinless_debit_conversions'] = 'pinlessDebitConversions'
+      @_hash['profit_shares'] = 'profitShares'
+      @_hash['reserves'] = 'reserves'
+      @_hash['revenue_boosts'] = 'revenueBoosts'
+      @_hash['vendor'] = 'vendor'
+      @_hash['fees'] = 'fees'
+      @_hash['forentity_fees'] = 'forentityFees'
+      @_hash['safer_payments'] = 'saferPayments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        address2
+        customer_phone
+        fax
+        website
+        apple_domain
+        ein_type
+        irs_filing_name
+        locations
+        public
+        tc_version
+        tc_accept_date
+        tc_accept_ip
+        custom
+        payout_secondary_descriptor
+        industry
+        global_business_type
+        accounts
+        frozen
+        inactive
+        billings
+        contacts
+        credentials
+        embedded_finance
+        entity_custom_fields
+        entity_data
+        entity_refs
+        entity_routes
+        entity_terms
+        org_entities
+        omni_tokens
+        forentity_profit_shares
+        holds
+        notes
+        payouts
+        pinless_debit_conversions
+        profit_shares
+        reserves
+        revenue_boosts
+        vendor
+        fees
+        forentity_fees
+        safer_payments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        client_ip
+        ein
+        tc_version
+        tc_accept_date
+        tc_accept_ip
+        global_business_id
+      ]
+    end
+
+    def initialize(client_ip = nil, login = nil, type = nil, name = nil,
+                   address1 = nil, city = nil, state = nil, zip = nil,
+                   country = nil, timezone = nil, phone = nil, email = nil,
+                   ein = nil, global_business_id = nil, display_name = SKIP,
+                   address2 = SKIP, customer_phone = SKIP, fax = SKIP,
+                   website = SKIP, apple_domain = SKIP, ein_type = SKIP,
+                   irs_filing_name = SKIP, locations = 1,
+                   public = EntitiesPublicEnum::PRIVATEENTITY,
+                   tc_version = SKIP, tc_accept_date = SKIP,
+                   tc_accept_ip = SKIP, custom = SKIP,
+                   payout_secondary_descriptor = SKIP, industry = SKIP,
+                   global_business_type = SKIP, accounts = SKIP,
+                   frozen = FrozenEnum::NOTFROZEN,
+                   inactive = InactiveEnum::ACTIVE, billings = SKIP,
+                   contacts = SKIP, credentials = SKIP, embedded_finance = SKIP,
+                   entity_custom_fields = SKIP, entity_data = SKIP,
+                   entity_refs = SKIP, entity_routes = SKIP,
+                   entity_terms = SKIP, org_entities = SKIP, omni_tokens = SKIP,
+                   forentity_profit_shares = SKIP, holds = SKIP, notes = SKIP,
+                   payouts = SKIP, pinless_debit_conversions = SKIP,
+                   profit_shares = SKIP, reserves = SKIP, revenue_boosts = SKIP,
+                   vendor = SKIP, fees = SKIP, forentity_fees = SKIP,
+                   safer_payments = SKIP)
+      @client_ip = client_ip
+      @login = login
+      @type = type
+      @name = name
+      @display_name = display_name unless display_name == SKIP
+      @address1 = address1
+      @address2 = address2 unless address2 == SKIP
+      @city = city
+      @state = state
+      @zip = zip
+      @country = country
+      @timezone = timezone
+      @phone = phone
+      @customer_phone = customer_phone unless customer_phone == SKIP
+      @fax = fax unless fax == SKIP
+      @email = email
+      @website = website unless website == SKIP
+      @apple_domain = apple_domain unless apple_domain == SKIP
+      @ein_type = ein_type unless ein_type == SKIP
+      @irs_filing_name = irs_filing_name unless irs_filing_name == SKIP
+      @ein = ein
+      @locations = locations unless locations == SKIP
+      @public = public unless public == SKIP
+      @tc_version = tc_version unless tc_version == SKIP
+      @tc_accept_date = tc_accept_date unless tc_accept_date == SKIP
+      @tc_accept_ip = tc_accept_ip unless tc_accept_ip == SKIP
+      @custom = custom unless custom == SKIP
+      unless payout_secondary_descriptor == SKIP
+        @payout_secondary_descriptor =
+          payout_secondary_descriptor
+      end
+      @industry = industry unless industry == SKIP
+      @global_business_type = global_business_type unless global_business_type == SKIP
+      @global_business_id = global_business_id
+      @accounts = accounts unless accounts == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @billings = billings unless billings == SKIP
+      @contacts = contacts unless contacts == SKIP
+      @credentials = credentials unless credentials == SKIP
+      @embedded_finance = embedded_finance unless embedded_finance == SKIP
+      @entity_custom_fields = entity_custom_fields unless entity_custom_fields == SKIP
+      @entity_data = entity_data unless entity_data == SKIP
+      @entity_refs = entity_refs unless entity_refs == SKIP
+      @entity_routes = entity_routes unless entity_routes == SKIP
+      @entity_terms = entity_terms unless entity_terms == SKIP
+      @org_entities = org_entities unless org_entities == SKIP
+      @omni_tokens = omni_tokens unless omni_tokens == SKIP
+      @forentity_profit_shares = forentity_profit_shares unless forentity_profit_shares == SKIP
+      @holds = holds unless holds == SKIP
+      @notes = notes unless notes == SKIP
+      @payouts = payouts unless payouts == SKIP
+      unless pinless_debit_conversions == SKIP
+        @pinless_debit_conversions =
+          pinless_debit_conversions
+      end
+      @profit_shares = profit_shares unless profit_shares == SKIP
+      @reserves = reserves unless reserves == SKIP
+      @revenue_boosts = revenue_boosts unless revenue_boosts == SKIP
+      @vendor = vendor unless vendor == SKIP
+      @fees = fees unless fees == SKIP
+      @forentity_fees = forentity_fees unless forentity_fees == SKIP
+      @safer_payments = safer_payments unless safer_payments == 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.
+      client_ip = hash.key?('clientIp') ? hash['clientIp'] : nil
+      login = hash.key?('login') ? hash['login'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      address1 = hash.key?('address1') ? hash['address1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      zip = hash.key?('zip') ? hash['zip'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      timezone = hash.key?('timezone') ? hash['timezone'] : nil
+      phone = hash.key?('phone') ? hash['phone'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      ein = hash.key?('ein') ? hash['ein'] : nil
+      global_business_id =
+        hash.key?('globalBusinessId') ? hash['globalBusinessId'] : nil
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      customer_phone = hash.key?('customerPhone') ? hash['customerPhone'] : SKIP
+      fax = hash.key?('fax') ? hash['fax'] : SKIP
+      website = hash.key?('website') ? hash['website'] : SKIP
+      apple_domain = hash.key?('appleDomain') ? hash['appleDomain'] : SKIP
+      ein_type = hash.key?('einType') ? hash['einType'] : SKIP
+      irs_filing_name =
+        hash.key?('irsFilingName') ? hash['irsFilingName'] : SKIP
+      locations = hash['locations'] ||= 1
+      public = hash['public'] ||= EntitiesPublicEnum::PRIVATEENTITY
+      tc_version = hash.key?('tcVersion') ? hash['tcVersion'] : SKIP
+      tc_accept_date = hash.key?('tcAcceptDate') ? hash['tcAcceptDate'] : SKIP
+      tc_accept_ip = hash.key?('tcAcceptIp') ? hash['tcAcceptIp'] : SKIP
+      custom = hash.key?('custom') ? hash['custom'] : SKIP
+      payout_secondary_descriptor =
+        hash.key?('payoutSecondaryDescriptor') ? hash['payoutSecondaryDescriptor'] : SKIP
+      industry = hash.key?('industry') ? hash['industry'] : SKIP
+      global_business_type =
+        hash.key?('globalBusinessType') ? hash['globalBusinessType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      # Parameter is an array, so we need to iterate through it
+      billings = nil
+      unless hash['billings'].nil?
+        billings = []
+        hash['billings'].each do |structure|
+          billings << (BillingsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      billings = SKIP unless hash.key?('billings')
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (ContactsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+      # Parameter is an array, so we need to iterate through it
+      credentials = nil
+      unless hash['credentials'].nil?
+        credentials = []
+        hash['credentials'].each do |structure|
+          credentials << (CredentialsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      credentials = SKIP unless hash.key?('credentials')
+      # Parameter is an array, so we need to iterate through it
+      embedded_finance = nil
+      unless hash['embeddedFinance'].nil?
+        embedded_finance = []
+        hash['embeddedFinance'].each do |structure|
+          embedded_finance << (EmbeddedFinancePostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      embedded_finance = SKIP unless hash.key?('embeddedFinance')
+      # Parameter is an array, so we need to iterate through it
+      entity_custom_fields = nil
+      unless hash['entityCustomFields'].nil?
+        entity_custom_fields = []
+        hash['entityCustomFields'].each do |structure|
+          entity_custom_fields << (EntityCustomFieldsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entity_custom_fields = SKIP unless hash.key?('entityCustomFields')
+      # Parameter is an array, so we need to iterate through it
+      entity_data = nil
+      unless hash['entityData'].nil?
+        entity_data = []
+        hash['entityData'].each do |structure|
+          entity_data << (EntityDataPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entity_data = SKIP unless hash.key?('entityData')
+      # Parameter is an array, so we need to iterate through it
+      entity_refs = nil
+      unless hash['entityRefs'].nil?
+        entity_refs = []
+        hash['entityRefs'].each do |structure|
+          entity_refs << (EntityRefsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entity_refs = SKIP unless hash.key?('entityRefs')
+      # Parameter is an array, so we need to iterate through it
+      entity_routes = nil
+      unless hash['entityRoutes'].nil?
+        entity_routes = []
+        hash['entityRoutes'].each do |structure|
+          entity_routes << (EntityRoutesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entity_routes = SKIP unless hash.key?('entityRoutes')
+      # Parameter is an array, so we need to iterate through it
+      entity_terms = nil
+      unless hash['entityTerms'].nil?
+        entity_terms = []
+        hash['entityTerms'].each do |structure|
+          entity_terms << (EntityTermsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entity_terms = SKIP unless hash.key?('entityTerms')
+      # Parameter is an array, so we need to iterate through it
+      org_entities = nil
+      unless hash['orgEntities'].nil?
+        org_entities = []
+        hash['orgEntities'].each do |structure|
+          org_entities << (OrgEntitiesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      org_entities = SKIP unless hash.key?('orgEntities')
+      # Parameter is an array, so we need to iterate through it
+      omni_tokens = nil
+      unless hash['omniTokens'].nil?
+        omni_tokens = []
+        hash['omniTokens'].each do |structure|
+          omni_tokens << (OmniTokensPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      omni_tokens = SKIP unless hash.key?('omniTokens')
+      # Parameter is an array, so we need to iterate through it
+      forentity_profit_shares = nil
+      unless hash['forentityProfitShares'].nil?
+        forentity_profit_shares = []
+        hash['forentityProfitShares'].each do |structure|
+          forentity_profit_shares << (ProfitSharesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      forentity_profit_shares = SKIP unless hash.key?('forentityProfitShares')
+      # Parameter is an array, so we need to iterate through it
+      holds = nil
+      unless hash['holds'].nil?
+        holds = []
+        hash['holds'].each do |structure|
+          holds << (HoldsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      holds = SKIP unless hash.key?('holds')
+      # Parameter is an array, so we need to iterate through it
+      notes = nil
+      unless hash['notes'].nil?
+        notes = []
+        hash['notes'].each do |structure|
+          notes << (NotesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      notes = SKIP unless hash.key?('notes')
+      # Parameter is an array, so we need to iterate through it
+      payouts = nil
+      unless hash['payouts'].nil?
+        payouts = []
+        hash['payouts'].each do |structure|
+          payouts << (PayoutPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      payouts = SKIP unless hash.key?('payouts')
+      # Parameter is an array, so we need to iterate through it
+      pinless_debit_conversions = nil
+      unless hash['pinlessDebitConversions'].nil?
+        pinless_debit_conversions = []
+        hash['pinlessDebitConversions'].each do |structure|
+          pinless_debit_conversions << (PinlessDebitConversionsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      pinless_debit_conversions = SKIP unless hash.key?('pinlessDebitConversions')
+      # Parameter is an array, so we need to iterate through it
+      profit_shares = nil
+      unless hash['profitShares'].nil?
+        profit_shares = []
+        hash['profitShares'].each do |structure|
+          profit_shares << (ProfitSharesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      profit_shares = SKIP unless hash.key?('profitShares')
+      # Parameter is an array, so we need to iterate through it
+      reserves = nil
+      unless hash['reserves'].nil?
+        reserves = []
+        hash['reserves'].each do |structure|
+          reserves << (ReservesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      reserves = SKIP unless hash.key?('reserves')
+      # Parameter is an array, so we need to iterate through it
+      revenue_boosts = nil
+      unless hash['revenueBoosts'].nil?
+        revenue_boosts = []
+        hash['revenueBoosts'].each do |structure|
+          revenue_boosts << (RevenueBoostsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      revenue_boosts = SKIP unless hash.key?('revenueBoosts')
+      vendor = VendorsPostRequest.from_hash(hash['vendor']) if hash['vendor']
+      # Parameter is an array, so we need to iterate through it
+      fees = nil
+      unless hash['fees'].nil?
+        fees = []
+        hash['fees'].each do |structure|
+          fees << (FeesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      fees = SKIP unless hash.key?('fees')
+      # Parameter is an array, so we need to iterate through it
+      forentity_fees = nil
+      unless hash['forentityFees'].nil?
+        forentity_fees = []
+        hash['forentityFees'].each do |structure|
+          forentity_fees << (FeesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      forentity_fees = SKIP unless hash.key?('forentityFees')
+      # Parameter is an array, so we need to iterate through it
+      safer_payments = nil
+      unless hash['saferPayments'].nil?
+        safer_payments = []
+        hash['saferPayments'].each do |structure|
+          safer_payments << (SaferPaymentsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      safer_payments = SKIP unless hash.key?('saferPayments')
+
+      # Create object from extracted values.
+      EntitiesPostRequest.new(client_ip,
+                              login,
+                              type,
+                              name,
+                              address1,
+                              city,
+                              state,
+                              zip,
+                              country,
+                              timezone,
+                              phone,
+                              email,
+                              ein,
+                              global_business_id,
+                              display_name,
+                              address2,
+                              customer_phone,
+                              fax,
+                              website,
+                              apple_domain,
+                              ein_type,
+                              irs_filing_name,
+                              locations,
+                              public,
+                              tc_version,
+                              tc_accept_date,
+                              tc_accept_ip,
+                              custom,
+                              payout_secondary_descriptor,
+                              industry,
+                              global_business_type,
+                              accounts,
+                              frozen,
+                              inactive,
+                              billings,
+                              contacts,
+                              credentials,
+                              embedded_finance,
+                              entity_custom_fields,
+                              entity_data,
+                              entity_refs,
+                              entity_routes,
+                              entity_terms,
+                              org_entities,
+                              omni_tokens,
+                              forentity_profit_shares,
+                              holds,
+                              notes,
+                              payouts,
+                              pinless_debit_conversions,
+                              profit_shares,
+                              reserves,
+                              revenue_boosts,
+                              vendor,
+                              fees,
+                              forentity_fees,
+                              safer_payments)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EntitiesPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.client_ip,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.login,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { EntityTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.address1,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.city,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.state,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.zip,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country,
+                                  ->(val) { EntityCountryEnum.validate(val) }) and
+            APIHelper.valid_type?(value.timezone,
+                                  ->(val) { TimezoneEnum.validate(val) }) and
+            APIHelper.valid_type?(value.phone,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.email,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ein,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.global_business_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['clientIp'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['login'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { EntityTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['address1'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['city'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['state'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['zip'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['country'],
+                                ->(val) { EntityCountryEnum.validate(val) }) and
+          APIHelper.valid_type?(value['timezone'],
+                                ->(val) { TimezoneEnum.validate(val) }) and
+          APIHelper.valid_type?(value['phone'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['email'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ein'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['globalBusinessId'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_ip: #{@client_ip}, login: #{@login}, type: #{@type}, name: #{@name},"\
+      " display_name: #{@display_name}, address1: #{@address1}, address2: #{@address2}, city:"\
+      " #{@city}, state: #{@state}, zip: #{@zip}, country: #{@country}, timezone: #{@timezone},"\
+      " phone: #{@phone}, customer_phone: #{@customer_phone}, fax: #{@fax}, email: #{@email},"\
+      " website: #{@website}, apple_domain: #{@apple_domain}, ein_type: #{@ein_type},"\
+      " irs_filing_name: #{@irs_filing_name}, ein: #{@ein}, locations: #{@locations}, public:"\
+      " #{@public}, tc_version: #{@tc_version}, tc_accept_date: #{@tc_accept_date}, tc_accept_ip:"\
+      " #{@tc_accept_ip}, custom: #{@custom}, payout_secondary_descriptor:"\
+      " #{@payout_secondary_descriptor}, industry: #{@industry}, global_business_type:"\
+      " #{@global_business_type}, global_business_id: #{@global_business_id}, accounts:"\
+      " #{@accounts}, frozen: #{@frozen}, inactive: #{@inactive}, billings: #{@billings},"\
+      " contacts: #{@contacts}, credentials: #{@credentials}, embedded_finance:"\
+      " #{@embedded_finance}, entity_custom_fields: #{@entity_custom_fields}, entity_data:"\
+      " #{@entity_data}, entity_refs: #{@entity_refs}, entity_routes: #{@entity_routes},"\
+      " entity_terms: #{@entity_terms}, org_entities: #{@org_entities}, omni_tokens:"\
+      " #{@omni_tokens}, forentity_profit_shares: #{@forentity_profit_shares}, holds: #{@holds},"\
+      " notes: #{@notes}, payouts: #{@payouts}, pinless_debit_conversions:"\
+      " #{@pinless_debit_conversions}, profit_shares: #{@profit_shares}, reserves: #{@reserves},"\
+      " revenue_boosts: #{@revenue_boosts}, vendor: #{@vendor}, fees: #{@fees}, forentity_fees:"\
+      " #{@forentity_fees}, safer_payments: #{@safer_payments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_ip: #{@client_ip.inspect}, login: #{@login.inspect}, type:"\
+      " #{@type.inspect}, name: #{@name.inspect}, display_name: #{@display_name.inspect},"\
+      " address1: #{@address1.inspect}, address2: #{@address2.inspect}, city: #{@city.inspect},"\
+      " state: #{@state.inspect}, zip: #{@zip.inspect}, country: #{@country.inspect}, timezone:"\
+      " #{@timezone.inspect}, phone: #{@phone.inspect}, customer_phone:"\
+      " #{@customer_phone.inspect}, fax: #{@fax.inspect}, email: #{@email.inspect}, website:"\
+      " #{@website.inspect}, apple_domain: #{@apple_domain.inspect}, ein_type:"\
+      " #{@ein_type.inspect}, irs_filing_name: #{@irs_filing_name.inspect}, ein: #{@ein.inspect},"\
+      " locations: #{@locations.inspect}, public: #{@public.inspect}, tc_version:"\
+      " #{@tc_version.inspect}, tc_accept_date: #{@tc_accept_date.inspect}, tc_accept_ip:"\
+      " #{@tc_accept_ip.inspect}, custom: #{@custom.inspect}, payout_secondary_descriptor:"\
+      " #{@payout_secondary_descriptor.inspect}, industry: #{@industry.inspect},"\
+      " global_business_type: #{@global_business_type.inspect}, global_business_id:"\
+      " #{@global_business_id.inspect}, accounts: #{@accounts.inspect}, frozen:"\
+      " #{@frozen.inspect}, inactive: #{@inactive.inspect}, billings: #{@billings.inspect},"\
+      " contacts: #{@contacts.inspect}, credentials: #{@credentials.inspect}, embedded_finance:"\
+      " #{@embedded_finance.inspect}, entity_custom_fields: #{@entity_custom_fields.inspect},"\
+      " entity_data: #{@entity_data.inspect}, entity_refs: #{@entity_refs.inspect}, entity_routes:"\
+      " #{@entity_routes.inspect}, entity_terms: #{@entity_terms.inspect}, org_entities:"\
+      " #{@org_entities.inspect}, omni_tokens: #{@omni_tokens.inspect}, forentity_profit_shares:"\
+      " #{@forentity_profit_shares.inspect}, holds: #{@holds.inspect}, notes: #{@notes.inspect},"\
+      " payouts: #{@payouts.inspect}, pinless_debit_conversions:"\
+      " #{@pinless_debit_conversions.inspect}, profit_shares: #{@profit_shares.inspect}, reserves:"\
+      " #{@reserves.inspect}, revenue_boosts: #{@revenue_boosts.inspect}, vendor:"\
+      " #{@vendor.inspect}, fees: #{@fees.inspect}, forentity_fees: #{@forentity_fees.inspect},"\
+      " safer_payments: #{@safer_payments.inspect}>"
+    end
+  end
+end