payabli 3.0.19 → 3.0.20

data/lib/payabli/types/business_detail_response_legal_structure.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module BusinessDetailResponseLegalStructure
+      extend Payabli::Internal::Types::Enum
+
+      LIMITED_LIABILITY_COMPANY = "LimitedLiabilityCompany"
+      CORPORATION = "Corporation"
+      PARTNERSHIP = "Partnership"
+      SOLE_PROPRIETORSHIP = "SoleProprietorship"
+      NON_PROFIT = "NonProfit"
+      GOVERNMENT = "Government"
+      S_CORPORATION = "SCorporation"
+    end
+  end
+end

data/lib/payabli/types/business_detail_response_operating_seasons_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module BusinessDetailResponseOperatingSeasonsItem
+      extend Payabli::Internal::Types::Enum
+
+      SPRING = "Spring"
+      SUMMER = "Summer"
+      FALL = "Fall"
+      WINTER = "Winter"
+    end
+  end
+end

data/lib/payabli/types/business_links.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Hypermedia links for a business resource.
+    class BusinessLinks < Internal::Types::Model
+      field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
+    end
+  end
+end

data/lib/payabli/types/business_payment_method.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A bank account or card attached to a business.
+    class BusinessPaymentMethod < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+
+      field :account_owner, -> { String }, optional: true, nullable: false, api_name: "accountOwner"
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :financial_institution, -> { String }, optional: true, nullable: false, api_name: "financialInstitution"
+
+      field :owner_type, -> { String }, optional: true, nullable: false, api_name: "ownerType"
+
+      field :account_type, -> { String }, optional: true, nullable: false, api_name: "accountType"
+
+      field :account_number, -> { String }, optional: true, nullable: false, api_name: "accountNumber"
+
+      field :routing_number, -> { String }, optional: true, nullable: false, api_name: "routingNumber"
+
+      field :card_number, -> { String }, optional: true, nullable: false, api_name: "cardNumber"
+
+      field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
+
+      field :cvv, -> { String }, optional: true, nullable: false
+
+      field :card_type, -> { String }, optional: true, nullable: false, api_name: "cardType"
+
+      field :usage, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :is_default, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isDefault"
+    end
+  end
+end

data/lib/payabli/types/business_person_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a business-person link.
+    class BusinessPersonEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Payabli::Types::BusinessPersonLink }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/business_person_link.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A person's link to a business, with the relationship's role, ownership, and relationship-scoped contact details.
+    class BusinessPersonLink < Internal::Types::Model
+      field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+      field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+      field :person_type, -> { String }, optional: false, nullable: false, api_name: "personType"
+
+      field :ownership_percentage, -> { Integer }, optional: true, nullable: false, api_name: "ownershipPercentage"
+
+      field :beneficial_owner, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "beneficialOwner"
+
+      field :is_primary_controller, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isPrimaryController"
+
+      field :is_signer, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSigner"
+
+      field :title, -> { String }, optional: false, nullable: true
+
+      field :primary_email, -> { String }, optional: false, nullable: true, api_name: "primaryEmail"
+
+      field :secondary_email, -> { String }, optional: false, nullable: true, api_name: "secondaryEmail"
+
+      field :primary_phone_number, -> { String }, optional: false, nullable: true, api_name: "primaryPhoneNumber"
+
+      field :secondary_phone_number, -> { String }, optional: false, nullable: true, api_name: "secondaryPhoneNumber"
+
+      field :billing_address_uuid, -> { String }, optional: true, nullable: false, api_name: "billingAddressUuid"
+
+      field :mailing_address_uuid, -> { String }, optional: true, nullable: false, api_name: "mailingAddressUuid"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :links, -> { Payabli::Types::BusinessPersonLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/business_person_links.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Hypermedia links for a business-person link.
+    class BusinessPersonLinks < Internal::Types::Model
+      field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
+
+      field :business, -> { String }, optional: true, nullable: false
+
+      field :person, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/business_person_list_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a business's people links.
+    class BusinessPersonListEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Internal::Types::Array[Payabli::Types::BusinessPersonLink] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/business_relationship_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Links the person to a business as part of a person-create request. The
+    # contact fields here are scoped to the business-person relationship and are
+    # distinct from the person's own top-level `primaryEmail`, `primaryPhoneNumber`,
+    # and so on.
+    class BusinessRelationshipRequest < Internal::Types::Model
+      field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+      field :person_type, -> { Payabli::Types::PersonType }, optional: true, nullable: false, api_name: "personType"
+
+      field :ownership_percentage, -> { Integer }, optional: true, nullable: false, api_name: "ownershipPercentage"
+
+      field :is_primary_controller, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isPrimaryController"
+
+      field :is_signer, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSigner"
+
+      field :title, -> { String }, optional: true, nullable: false
+
+      field :primary_email, -> { String }, optional: true, nullable: false, api_name: "primaryEmail"
+
+      field :secondary_email, -> { String }, optional: true, nullable: false, api_name: "secondaryEmail"
+
+      field :primary_phone_number, -> { String }, optional: true, nullable: false, api_name: "primaryPhoneNumber"
+
+      field :secondary_phone_number, -> { String }, optional: true, nullable: false, api_name: "secondaryPhoneNumber"
+
+      field :billing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "billingAddress"
+
+      field :mailing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "mailingAddress"
+    end
+  end
+end

data/lib/payabli/types/business_relationship_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The business-person relationship returned when a person is created with a
+    # `businessRelationship`. Its contact fields are scoped to the relationship and
+    # are distinct from the person's own top-level contact fields.
+    class BusinessRelationshipResponse < Internal::Types::Model
+      field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+      field :person_type, -> { String }, optional: false, nullable: false, api_name: "personType"
+
+      field :ownership_percentage, -> { Integer }, optional: false, nullable: true, api_name: "ownershipPercentage"
+
+      field :beneficial_owner, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "beneficialOwner"
+
+      field :is_primary_controller, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isPrimaryController"
+
+      field :is_signer, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSigner"
+
+      field :title, -> { String }, optional: false, nullable: true
+
+      field :primary_email, -> { String }, optional: false, nullable: true, api_name: "primaryEmail"
+
+      field :secondary_email, -> { String }, optional: false, nullable: true, api_name: "secondaryEmail"
+
+      field :primary_phone_number, -> { String }, optional: false, nullable: true, api_name: "primaryPhoneNumber"
+
+      field :secondary_phone_number, -> { String }, optional: false, nullable: true, api_name: "secondaryPhoneNumber"
+
+      field :billing_address_uuid, -> { String }, optional: false, nullable: true, api_name: "billingAddressUuid"
+
+      field :mailing_address_uuid, -> { String }, optional: false, nullable: true, api_name: "mailingAddressUuid"
+    end
+  end
+end

data/lib/payabli/types/business_summary_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A business as it appears in a list response.
+    class BusinessSummaryResponse < Internal::Types::Model
+      field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
+
+      field :legal_name, -> { String }, optional: false, nullable: true, api_name: "legalName"
+
+      field :business_status, -> { String }, optional: false, nullable: false, api_name: "businessStatus"
+
+      field :parent_reference, -> { String }, optional: false, nullable: true, api_name: "parentReference"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+
+      field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/business_updated_envelope.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping an updated business.
+    class BusinessUpdatedEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Payabli::Types::BusinessUpdatedResponse }, optional: false, nullable: true
+
+      field :warnings, -> { Internal::Types::Array[Payabli::Types::BoardingWarning] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/business_updated_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The reference and updated timestamp after a business update.
+    class BusinessUpdatedResponse < Internal::Types::Model
+      field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+
+      field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/case_management_money_in_service.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CaseManagementMoneyInService
+      extend Payabli::Internal::Types::Enum
+
+      ACH = "Ach"
+      CARD = "Card"
+      CLOUD = "Cloud"
+      DEVICE = "Device"
+      WALLET = "Wallet"
+      CASH = "Cash"
+      CHECK = "Check"
+    end
+  end
+end

data/lib/payabli/types/case_management_money_out_service.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CaseManagementMoneyOutService
+      extend Payabli::Internal::Types::Enum
+
+      ACH = "Ach"
+      V_CARD = "VCard"
+      MANAGED = "Managed"
+      CHECK = "Check"
+      RTP = "Rtp"
+      WIRE = "Wire"
+      GHOST = "Ghost"
+    end
+  end
+end

data/lib/payabli/types/certification_detail.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A certification held by the business.
+    class CertificationDetail < Internal::Types::Model
+      field :certification_type, -> { String }, optional: true, nullable: false, api_name: "certificationType"
+
+      field :issuer, -> { String }, optional: true, nullable: false
+
+      field :certificate_number, -> { String }, optional: true, nullable: false, api_name: "certificateNumber"
+
+      field :issued_date, -> { String }, optional: true, nullable: false, api_name: "issuedDate"
+
+      field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
+    end
+  end
+end

data/lib/payabli/types/create_business_request.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Request body to create a business.
+    class CreateBusinessRequest < Internal::Types::Model
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :legal_name, -> { String }, optional: false, nullable: false, api_name: "legalName"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :legal_structure, -> { Payabli::Types::CreateBusinessRequestLegalStructure }, optional: true, nullable: false, api_name: "legalStructure"
+
+      field :stock_symbol, -> { String }, optional: true, nullable: false, api_name: "stockSymbol"
+
+      field :incorporation_state, -> { String }, optional: true, nullable: false, api_name: "incorporationState"
+
+      field :tax_id_country, -> { String }, optional: true, nullable: false, api_name: "taxIdCountry"
+
+      field :established_date, -> { String }, optional: true, nullable: false, api_name: "establishedDate"
+
+      field :number_of_employees, -> { Integer }, optional: true, nullable: false, api_name: "numberOfEmployees"
+
+      field :annual_revenue, -> { Integer }, optional: true, nullable: false, api_name: "annualRevenue"
+
+      field :website, -> { String }, optional: true, nullable: false
+
+      field :merchant_cat_code, -> { String }, optional: true, nullable: false, api_name: "merchantCatCode"
+
+      field :timezone, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :emails, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :operating_seasons, -> { Internal::Types::Array[Payabli::Types::CreateBusinessRequestOperatingSeasonsItem] }, optional: true, nullable: false, api_name: "operatingSeasons"
+
+      field :address_details, -> { Internal::Types::Array[Payabli::Types::BusinessAddressCreate] }, optional: true, nullable: false, api_name: "addressDetails"
+
+      field :payment_methods, -> { Internal::Types::Array[Payabli::Types::BusinessPaymentMethod] }, optional: true, nullable: false, api_name: "paymentMethods"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+      field :is_foreign_owned, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isForeignOwned"
+
+      field :is_tax_exempt, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isTaxExempt"
+
+      field :tax_exempt_classification, -> { String }, optional: true, nullable: false, api_name: "taxExemptClassification"
+
+      field :processing_metrics, -> { Payabli::Types::ProcessingMetrics }, optional: true, nullable: false, api_name: "processingMetrics"
+
+      field :payout_metrics, -> { Payabli::Types::PayoutMetrics }, optional: true, nullable: false, api_name: "payoutMetrics"
+
+      field :license, -> { String }, optional: true, nullable: false
+
+      field :license_state, -> { String }, optional: true, nullable: false, api_name: "licenseState"
+
+      field :tax_reference, -> { String }, optional: true, nullable: false, api_name: "taxReference"
+
+      field :parent_reference, -> { String }, optional: true, nullable: false, api_name: "parentReference"
+    end
+  end
+end

data/lib/payabli/types/create_business_request_legal_structure.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CreateBusinessRequestLegalStructure
+      extend Payabli::Internal::Types::Enum
+
+      LIMITED_LIABILITY_COMPANY = "limited-liability-company"
+      LLC = "llc"
+      CORPORATION = "corporation"
+      PARTNERSHIP = "partnership"
+      SOLE_PROPRIETORSHIP = "sole-proprietorship"
+      NON_PROFIT = "non-profit"
+      GOVERNMENT = "government"
+      S_CORP = "s-corp"
+      S_CORPORATION = "s-corporation"
+    end
+  end
+end

data/lib/payabli/types/create_business_request_operating_seasons_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CreateBusinessRequestOperatingSeasonsItem
+      extend Payabli::Internal::Types::Enum
+
+      SPRING = "Spring"
+      SUMMER = "Summer"
+      FALL = "Fall"
+      WINTER = "Winter"
+    end
+  end
+end

data/lib/payabli/types/create_payment_method_request.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A single payment method to create.
+    class CreatePaymentMethodRequest < Internal::Types::Model
+      field :type, -> { Payabli::Types::CreatePaymentMethodRequestType }, optional: false, nullable: false
+
+      field :account_owner, -> { String }, optional: false, nullable: false, api_name: "accountOwner"
+
+      field :owner_type, -> { Payabli::Types::PaymentMethodOwnerType }, optional: false, nullable: false, api_name: "ownerType"
+
+      field :nickname, -> { String }, optional: true, nullable: false
+
+      field :financial_institution, -> { String }, optional: true, nullable: false, api_name: "financialInstitution"
+
+      field :account_type, -> { String }, optional: false, nullable: false, api_name: "accountType"
+
+      field :account_number, -> { String }, optional: false, nullable: false, api_name: "accountNumber"
+
+      field :routing_number, -> { String }, optional: false, nullable: false, api_name: "routingNumber"
+
+      field :usage, -> { Internal::Types::Array[Payabli::Types::PaymentMethodUsage] }, optional: false, nullable: false
+
+      field :is_default, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isDefault"
+    end
+  end
+end

data/lib/payabli/types/create_payment_method_request_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CreatePaymentMethodRequestType
+      extend Payabli::Internal::Types::Enum
+
+      BANK_ACCOUNT = "bank_account"
+    end
+  end
+end

data/lib/payabli/types/create_paypoint_all_fields.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # All fields accepted when creating a paypoint. Provide exactly one of `businessReference` or `business`.
+    class CreatePaypointAllFields < Internal::Types::Model
+      field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
+
+      field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+      field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :website, -> { String }, optional: true, nullable: false
+
+      field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
+
+      field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
+
+      field :timezone, -> { String }, optional: true, nullable: false
+
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+      field :business_reference, -> { String }, optional: true, nullable: false, api_name: "businessReference"
+
+      field :business, -> { Payabli::Types::CreateBusinessRequest }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/create_paypoint_with_business_reference.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Create a paypoint under an existing business. Provide `businessReference` plus `doingBusinessAs`; all other fields
+    # are optional.
+    class CreatePaypointWithBusinessReference < Internal::Types::Model
+      field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
+
+      field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+      field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :website, -> { String }, optional: true, nullable: false
+
+      field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
+
+      field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
+
+      field :timezone, -> { String }, optional: true, nullable: false
+
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+      field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+    end
+  end
+end

data/lib/payabli/types/create_paypoint_with_inline_business.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Create a paypoint and its backing business together. Provide `business` plus `doingBusinessAs`; all other fields
+    # are optional.
+    class CreatePaypointWithInlineBusiness < Internal::Types::Model
+      field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
+
+      field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+      field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :website, -> { String }, optional: true, nullable: false
+
+      field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
+
+      field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
+
+      field :timezone, -> { String }, optional: true, nullable: false
+
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+      field :business, -> { Payabli::Types::CreateBusinessRequest }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/document_requirement.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A document the application asks for. A requirement comes from the application's template or from a Payabli
+    # business rule. For example, a business with an annual revenue of $1,000,000 or more needs bank statements.
+    #
+    # A person requirement appears once for each owner of the business, with that owner's `personReference`.
+    class DocumentRequirement < Internal::Types::Model
+      field :field_path, -> { String }, optional: false, nullable: false, api_name: "fieldPath"
+
+      field :label, -> { String }, optional: false, nullable: false
+
+      field :hint, -> { String }, optional: true, nullable: false
+
+      field :source, -> { Payabli::Types::DocumentRequirementSource }, optional: false, nullable: false
+
+      field :subject_types, -> { Internal::Types::Array[Payabli::Types::DocumentSubjectType] }, optional: false, nullable: false, api_name: "subjectTypes"
+
+      field :person_reference, -> { String }, optional: true, nullable: false, api_name: "personReference"
+
+      field :required, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :max_uploads, -> { Integer }, optional: false, nullable: false, api_name: "maxUploads"
+
+      field :allowed_formats, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedFormats"
+
+      field :uploaded_count, -> { Integer }, optional: false, nullable: false, api_name: "uploadedCount"
+    end
+  end
+end

data/lib/payabli/types/document_requirement_list_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping an application's document requirements.
+    class DocumentRequirementListEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Internal::Types::Array[Payabli::Types::DocumentRequirement] }, optional: false, nullable: false
+    end
+  end
+end