checkout_sdk 2.4.0 → 2.6.0

data/lib/checkout_sdk/accounts/file_purpose.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The purpose of an onboarding document upload ({AccountsClient#upload_file} and
+    # {AccountsClient#upload_entity_file}): the values PlatformsFileUpload defines.
+    module FilePurpose
+      ADDITIONAL_DOCUMENT = 'additional_document'
+      ARTICLES_OF_ASSOCIATION = 'articles_of_association'
+      BANK_VERIFICATION = 'bank_verification'
+      CERTIFIED_AUTHORISED_SIGNATORY = 'certified_authorised_signatory'
+      COMPANY_OWNERSHIP = 'company_ownership'
+      COMPANY_VERIFICATION = 'company_verification'
+      FINANCIAL_VERIFICATION = 'financial_verification'
+      IDENTITY_VERIFICATION = 'identity_verification'
+      PROOF_OF_LEGALITY = 'proof_of_legality'
+      PROOF_OF_PRINCIPAL_ADDRESS = 'proof_of_principal_address'
+      SHAREHOLDER_STRUCTURE = 'shareholder_structure'
+      TAX_VERIFICATION = 'tax_verification'
+      PROOF_OF_RESIDENTIAL_ADDRESS = 'proof_of_residential_address'
+      PROOF_OF_REGISTRATION = 'proof_of_registration'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/file_request.rb

@@ -2,6 +2,13 @@
 
 module CheckoutSdk
   module Accounts
+    # A file to upload with {AccountsClient#upload_file} (POST /files on the Files host), sent as a
+    # multipart request. The returned ID is what document front and back attributes take.
+    #
+    # The Files host POST /files is not in the API reference: the POST /files it documents is the disputes
+    # upload on the API host (purpose dispute_evidence or arbitration_evidence). For onboarding, set
+    # purpose to one of the PlatformsFileUpload purposes the API reference lists for the sub-entity upload
+    # (POST /entities/{entityId}/files), available as {FilePurpose} values.
     class FileRequest < CheckoutSdk::Common::FileRequest
     end
   end

data/lib/checkout_sdk/accounts/financial_statements.rb

@@ -2,9 +2,17 @@
 
 module CheckoutSdk
   module Accounts
+    # Audited or management-prepared financial statements (when applicable). US ISV Seller variants only.
+    # Not the same document as {FinancialVerification}, whose type is the singular financial_statement.
     # @!attribute type
-    #   @return [FinancialStatementsType]
+    #   The type of document.
+    #   [Required]
+    #   @return [String] {FinancialStatementsType}
     # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
     #   @return [String]
     class FinancialStatements
       attr_accessor :type,

data/lib/checkout_sdk/accounts/financial_statements_type.rb

@@ -2,6 +2,8 @@
 
 module CheckoutSdk
   module Accounts
+    # The document type accepted as financial statements (US ISV Seller variants). Note the plural
+    # financial_statements; {FinancialVerificationType} is a different module.
     module FinancialStatementsType
       FINANCIAL_STATEMENTS = 'financial_statements'
     end

data/lib/checkout_sdk/accounts/financial_verification.rb

@@ -2,13 +2,21 @@
 
 module CheckoutSdk
   module Accounts
+    # Financial statement document. Becomes mandatory depending on the answer provided for
+    # annual_processing_volume; the sub-entity's status changes to requirements_due when it is needed.
     # @!attribute type
-    #   @return [FinancialVerificationType]
+    #   The type of the file.
+    #   [Required]
+    #   @return [String] {FinancialVerificationType}
     # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
     #   @return [String]
     class FinancialVerification
-      attr_reader :type,
-                  :front
+      attr_accessor :type,
+                    :front
     end
   end
 end

data/lib/checkout_sdk/accounts/financial_verification_type.rb

@@ -2,6 +2,8 @@
 
 module CheckoutSdk
   module Accounts
+    # The document type accepted as financial verification. Note the singular financial_statement;
+    # {FinancialStatementsType} is a different module.
     module FinancialVerificationType
       FINANCIAL_STATEMENT = 'financial_statement'
     end

data/lib/checkout_sdk/accounts/identification.rb

@@ -2,9 +2,16 @@
 
 module CheckoutSdk
   module Accounts
+    # The identification of a representative or individual on the Accounts API v2.0 US variants.
     # @!attribute national_id_number
+    #   Social Security Number (SSN), or Individual Taxpayer Identification Number (ITIN) for non-US
+    #   citizens.
+    #   [Required]
+    #   ^\d{9}$
+    #   9 characters
     #   @return [String]
     # @!attribute document
+    #   @deprecated Not defined by the Accounts API: the identification object carries national_id_number only.
     #   @return [Document]
     class Identification
       attr_accessor :national_id_number,

data/lib/checkout_sdk/accounts/individual.rb

@@ -2,27 +2,53 @@
 
 module CheckoutSdk
   module Accounts
+    # The top-level individual of the Accounts API v2.0 sole trader variants. On v3.0 a sole trader is
+    # onboarded as a {Company} with one {Representative}.
     # @!attribute first_name
+    #   The individual's first name.
+    #   [Required]
+    #   min 2 characters, max 50 characters
     #   @return [String]
     # @!attribute middle_name
+    #   The individual's middle name. Required if it appears in official documents.
+    #   [Optional]
+    #   min 2 characters, max 50 characters
     #   @return [String]
     # @!attribute last_name
+    #   The individual's last name.
+    #   [Required]
+    #   min 2 characters, max 50 characters
     #   @return [String]
     # @!attribute legal_name
+    #   @deprecated Not defined by the Accounts API for an individual; legal_name exists on the company only.
     #   @return [String]
     # @!attribute trading_name
+    #   The trading name of the sub-entity, also referred to as 'doing business as'.
+    #   [Required]
+    #   min 2 characters, max 300 characters
     #   @return [String]
     # @!attribute national_tax_id
+    #   @deprecated Not defined by any Accounts API schema; the API does not read it.
     #   @return [String]
     # @!attribute registered_address
+    #   The registered address of the sole trader's business.
+    #   [Required]
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute date_of_birth
+    #   The date of birth of the person according to the Gregorian calendar.
+    #   [Required], except on GB Sole Trader Lite (2.0) where it is [Optional].
     #   @return [DateOfBirth]
     # @!attribute place_of_birth
+    #   The place of birth of the person.
+    #   [Required] for EEA Sole Trader Full and Lite (2.0); not part of the other v2.0 variants.
     #   @return [PlaceOfBirth]
     # @!attribute identification
+    #   The individual's identification. US Sole Trader (2.0) only.
+    #   [Required] for US Sole Trader Full (2.0); [Optional] for US Sole Trader Lite (2.0).
     #   @return [Identification]
     # @!attribute financial_details
+    #   Seller financial questions. US Sole Trader (2.0) only.
+    #   [Required] for US Sole Trader Full (2.0); [Optional] for US Sole Trader Lite (2.0).
     #   @return [EntityFinancialDetails]
     class Individual
       attr_accessor :first_name,

data/lib/checkout_sdk/accounts/invitee.rb

@@ -2,7 +2,13 @@
 
 module CheckoutSdk
   module Accounts
+    # The details of the user responsible for onboarding the sub-entity.
     # @!attribute email
+    #   The main email address for this sub-entity. Despite the spec's wording, this is the address of the
+    #   invitee, the user responsible for onboarding the sub-entity.
+    #   [Required] in the hosted onboarding invite request; [Optional] in the Full and Lite onboarding
+    #   variants; not part of the US ISV Seller variants.
+    #   Format: email
     #   @return [String]
     class Invitee
       attr_accessor :email

data/lib/checkout_sdk/accounts/national_id_type.rb

@@ -2,6 +2,7 @@
 
 module CheckoutSdk
   module Accounts
+    # The classification of a representative's national identification number (US ISV Seller variants).
     module NationalIdType
       SSN = 'ssn'
       ITIN = 'itin'

data/lib/checkout_sdk/accounts/onboard_entity.rb

@@ -2,33 +2,60 @@
 
 module CheckoutSdk
   module Accounts
+    # The request body of POST /accounts/entities and PUT /accounts/entities/{id}. Which attributes are
+    # required depends on the onboarding variant.
     # @!attribute reference
+    #   A unique reference you can later use to identify the sub-entity.
+    #   [Required]
+    #   min 1 character, max 50 characters
     #   @return [String]
     # @!attribute is_draft
+    #   Whether the sub-entity should remain in draft on PUT, skipping due diligence checks. POST always
+    #   creates the entity in draft.
+    #   [Optional]
     #   @return [Boolean]
     # @!attribute profile
+    #   Information about the profile of the sub-entity.
+    #   [Required]
     #   @return [Profile]
     # @!attribute contact_details
+    #   Contact details of this sub-entity.
+    #   [Required], except on EEA Company Full (3.0) where it is [Optional].
     #   @return [ContactDetails]
     # @!attribute company
+    #   Information about the company represented by the sub-entity.
+    #   [Required] for every company and v3.0 sole trader variant.
     #   @return [Company]
     # @!attribute processing_details
+    #   Information about the sub-entity's expected processing.
+    #   [Required] for every v3.0 variant.
     #   @return [ProcessingDetails]
     # @!attribute individual
+    #   Information about the individual represented by the sub-entity. Accounts API v2.0 sole traders only.
+    #   [Required] for the v2.0 sole trader variants.
+    #   @deprecated Not used by the Accounts API v3.0 schema, where a sole trader is onboarded as a company with a
+    #     representative.
     #   @return [Individual]
     # @!attribute documents
+    #   The top-level documents used to support the verification of the sub-entity's details.
+    #   [Required] on the EEA, GB and US Company and Sole Trader Full (3.0) variants, EEA Company Full (2.0)
+    #   and EEA Sole Trader Full (2.0); [Optional] otherwise.
     #   @return [OnboardSubEntityDocuments]
     # @!attribute additional_info
+    #   @deprecated Not defined by any Accounts API schema; the API does not read it.
     #   @return [AdditionalInfo]
     # @!attribute seller_category
+    #   The identifier of a seller category set up for your platform. Seller categories define the pricing,
+    #   capabilities and risk profile applied to sub-entities.
+    #   [Required] for the US ISV Seller variants only.
     #   @return [String] Identifier of a seller category configured on the platform
-    #     during onboarding. Used for US ISV onboarding variants.
     # @!attribute agreed_terms
+    #   Details of the person who agreed to the terms and conditions on behalf of the sub-entity.
+    #   [Required] for the US ISV Seller variants only.
     #   @return [AgreedTerms] Details of the person who agreed to the terms and
-    #     conditions (Accounts API v3.0 SaaS onboarding).
     # @!attribute submitter
+    #   @deprecated Not defined by any Accounts API schema; the API does not read it.
     #   @return [Submitter] Captures evidence of the end-user's consent to onboarding.
-    #     Used for US ISV onboarding variants.
     class OnboardEntity
       attr_accessor :reference,
                     :is_draft,

data/lib/checkout_sdk/accounts/onboard_sub_entity_documents.rb

@@ -2,31 +2,68 @@
 
 module CheckoutSdk
   module Accounts
+    # The top-level request documents ({OnboardEntity#documents}). The API ignores keys it does not
+    # recognise here rather than rejecting them, so a misplaced document is dropped silently. The
+    # representative's own documents go on {Representative#documents} ({RepresentativeDocuments}).
     # @!attribute identity_verification
-    #   @return [EntityIdentificationDocument]
+    #   The document to use to confirm the individual's identity.
+    #   [Required] for the six sole trader variants of Accounts API v2.0 (EEA, GB and US, Full and Lite), the
+    #   only variants that take it at this level. On v3.0 it belongs on the representative.
+    #   @return [Document]
     # @!attribute company_verification
+    #   The document to use to confirm the company's identity (certified by a power of attorney within the
+    #   last 3 months).
+    #   [Required] for EEA Company Full (2.0 and 3.0) and GB Company Full (2.0); [Optional] for the other
+    #   company variants and the US ISV Seller variants.
     #   @return [CompanyVerification]
     # @!attribute articles_of_association
+    #   Memorandum or Articles of Association document.
+    #   [Required] for EEA and GB Company Full (3.0); [Optional] for US Company Full (3.0) and the US ISV
+    #   Seller variants.
     #   @return [ArticlesOfAssociation]
     # @!attribute bank_verification
+    #   A document showing transactions from the last 3 months.
+    #   [Required] for EEA Company Full (3.0) and the EEA, GB and US Sole Trader Full (3.0) variants;
+    #   [Optional] for GB and US Company Full (3.0) and EEA Company Full and Lite (2.0).
     #   @return [BankVerification]
     # @!attribute shareholder_structure
+    #   Shareholder structure chart (including % of shares) certified by a competent authority individual and
+    #   dated within the last 3 months.
+    #   [Required] for EEA and GB Company Full (3.0); [Optional] for US Company Full (3.0) and US ISV Seller
+    #   Company (3.0).
     #   @return [ShareholderStructure]
     # @!attribute proof_of_legality
+    #   A regulatory licence document required for the company to operate (when applicable).
+    #   [Optional] (EEA, GB and US Company Full (3.0) and the US ISV Seller variants)
     #   @return [ProofOfLegality]
     # @!attribute proof_of_principal_address
+    #   Proof of the company's principal place of business.
+    #   [Optional] (EEA, GB and US Company Full (3.0) and the US ISV Seller variants)
     #   @return [ProofOfPrincipalAddress]
     # @!attribute additional_document1
+    #   Additional space for documents to be provided when requested.
+    #   [Optional] (EEA, GB and US Company and Sole Trader Full (3.0); not the US ISV Seller variants)
     #   @return [AdditionalDocument]
     # @!attribute additional_document2
+    #   Additional space for documents to be provided when requested.
+    #   [Optional] (EEA, GB and US Company and Sole Trader Full (3.0); not the US ISV Seller variants)
     #   @return [AdditionalDocument]
     # @!attribute additional_document3
+    #   Additional space for documents to be provided when requested.
+    #   [Optional] (EEA, GB and US Company and Sole Trader Full (3.0); not the US ISV Seller variants)
     #   @return [AdditionalDocument]
     # @!attribute tax_verification
+    #   IRS-issued Employer Identification Number document used to verify the entity's tax identification.
+    #   [Optional] (US Company variants and the US ISV Seller variants only)
     #   @return [TaxVerification]
     # @!attribute financial_verification
+    #   Financial statement document. Becomes mandatory depending on the answer provided for
+    #   annual_processing_volume.
+    #   [Optional] (EEA Company Full and Lite (2.0) only)
     #   @return [FinancialVerification]
     # @!attribute financial_statements
+    #   Audited or management-prepared financial statements (when applicable).
+    #   [Optional] (US ISV Seller variants only)
     #   @return [FinancialStatements]
     class OnboardSubEntityDocuments
       attr_accessor :identity_verification,

data/lib/checkout_sdk/accounts/phone.rb

@@ -2,9 +2,15 @@
 
 module CheckoutSdk
   module Accounts
+    # A phone number on the Accounts API: the sub-entity's contact phone, or a representative's phone. See
+    # {ContactDetails#phone} for the per-variant number format.
     # @!attribute country_code
-    #   @return [String] ISO 3166-1 alpha-2 country code (Accounts API v3.0), e.g. "GB".
+    #   The ISO 3166-1 alpha-2 country where the number is registered, not the dialling code.
+    #   [Required] on Accounts API v3.0; not part of the v2.0 schemas.
+    #   @return [String]
     # @!attribute number
+    #   The phone number, without the country calling code.
+    #   [Required]
     #   @return [String]
     class Phone
       attr_accessor :country_code,

data/lib/checkout_sdk/accounts/place_of_birth.rb

@@ -2,7 +2,11 @@
 
 module CheckoutSdk
   module Accounts
+    # The place of birth of the person.
     # @!attribute country
+    #   The country code (iso-3166-1 alpha-2).
+    #   [Required]
+    #   Format: iso-3166-1-alpha-2
     #   @return [String] {CheckoutSdk::Common::Country}
     class PlaceOfBirth
       attr_accessor :country

data/lib/checkout_sdk/accounts/processing_details.rb

@@ -2,21 +2,48 @@
 
 module CheckoutSdk
   module Accounts
+    # The sub-entity's expected processing (processing_details, Accounts API v3.0).
     # @!attribute settlement_country
+    #   The country code (iso-3166-1 alpha-2) where the settlement bank account is located.
+    #   [Required] on the EEA, GB and US Company and Sole Trader Full (3.0) variants; not part of the US ISV
+    #   Seller variants.
+    #   Format: iso-3166-1-alpha-2
+    #   2 characters
     #   @return [String]
     # @!attribute target_countries
+    #   Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with
+    #   Checkout.com.
+    #   [Required]
+    #   min 1 item, max 10 items
     #   @return [Array(String)]
     # @!attribute annual_processing_volume
+    #   The estimated annual processing volume. In minor units without decimals.
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     # @!attribute average_transaction_value
+    #   The expected average transaction value. In minor units without decimals.
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     # @!attribute average_order_fulfillment_time
+    #   The average time in days between accepting payment and fulfilling the order.
+    #   [Required] on the US ISV Seller variants only.
+    #   min 0
     #   @return [Integer]
     # @!attribute highest_transaction_value
+    #   The expected highest transaction value. In minor units without decimals.
+    #   [Required] on the EEA, GB and US Company and Sole Trader Full (3.0) variants; not part of the US ISV
+    #   Seller variants.
+    #   min 0
     #   @return [Integer]
     # @!attribute currency
+    #   The currency used for the processing details provided.
+    #   [Required]
     #   @return [CheckoutSdk::Common::Currency]
     # @!attribute payments
+    #   Payment method-specific processing details.
+    #   [Required] on the US ISV Seller variants only.
     #   @return [ProcessingDetailsPayments]
     class ProcessingDetails
       attr_accessor :settlement_country,

data/lib/checkout_sdk/accounts/processing_details_ach.rb

@@ -2,14 +2,27 @@
 
 module CheckoutSdk
   module Accounts
-    # ACH-specific processing details (Accounts API v3.0). All values in minor units without decimals.
+    # The expected ACH processing (US ISV Seller variants). All amounts are in minor units without
+    # decimals.
     # @!attribute annual_ach_volume
+    #   The estimated annual ACH processing volume.
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     # @!attribute average_ach_transaction_size
+    #   The expected average ACH transaction size.
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     # @!attribute estimated_monthly_credit_volume
+    #   The estimated monthly volume of ACH credit transactions (for example, refunds issued to customers).
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     # @!attribute average_credit_amount
+    #   The average value of an ACH credit transaction (for example, a refund).
+    #   [Required]
+    #   min 0
     #   @return [Integer]
     class ProcessingDetailsAch
       attr_accessor :annual_ach_volume,

data/lib/checkout_sdk/accounts/processing_details_payments.rb

@@ -2,8 +2,10 @@
 
 module CheckoutSdk
   module Accounts
-    # Payment method-specific processing details (Accounts API v3.0).
+    # Payment method-specific processing details (US ISV Seller variants).
     # @!attribute ach
+    #   The ACH processing details.
+    #   [Required]
     #   @return [ProcessingDetailsAch]
     class ProcessingDetailsPayments
       attr_accessor :ach

data/lib/checkout_sdk/accounts/profile.rb

@@ -2,13 +2,27 @@
 
 module CheckoutSdk
   module Accounts
+    # Information about the profile of the sub-entity, primarily regarding the products and services
+    # offered.
     # @!attribute urls
+    #   A collection of website URLs the sub-entity accepts payments on.
+    #   [Required]
+    #   max 100 items; each ^(http|https):\/\/\S{2,293}$, Format: uri
     #   @return [Array(String)]
     # @!attribute mccs
+    #   The merchant category codes (4-digit ISO 18245) that most closely describe the business.
+    #   [Required]
+    #   min 1 item, max 5 items; each ^[0-9]{4}$
     #   @return [Array(String)]
     # @!attribute default_holding_currency
+    #   The default holding currency (ISO 4217).
+    #   [Required] on every v3.0 variant; [Optional] on the v2.0 variants.
+    #   Format: iso-4217
     #   @return [String] {CheckoutSdk::Common::Currency}
     # @!attribute holding_currencies
+    #   The currencies incoming funds are held in.
+    #   [Required] on every v3.0 variant; [Optional] on the v2.0 variants.
+    #   min 1 item on v3.0; USD only on the US variants
     #   @return [Array(CheckoutSdk::Common::Currency)]
     class Profile
       attr_accessor :urls,

data/lib/checkout_sdk/accounts/proof_of_legality.rb

@@ -2,9 +2,16 @@
 
 module CheckoutSdk
   module Accounts
+    # A regulatory licence document required for the company to operate (when applicable).
     # @!attribute type
-    #   @return [ProofOfLegalityType]
+    #   The type of document used for proof of legality.
+    #   [Required]
+    #   @return [String] {ProofOfLegalityType}
     # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
     #   @return [String]
     class ProofOfLegality
       attr_accessor :type,

data/lib/checkout_sdk/accounts/proof_of_legality_type.rb

@@ -2,6 +2,7 @@
 
 module CheckoutSdk
   module Accounts
+    # The document type accepted as proof of legality.
     module ProofOfLegalityType
       PROOF_OF_LEGALITY = 'proof_of_legality'
     end

data/lib/checkout_sdk/accounts/proof_of_principal_address.rb

@@ -2,13 +2,20 @@
 
 module CheckoutSdk
   module Accounts
+    # Proof of the company's principal place of business.
     # @!attribute type
-    #   @return [ProofOfPrincipalAddressType]
+    #   The type of document being used as address verification.
+    #   [Required]
+    #   @return [String] {ProofOfPrincipalAddressType}
     # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
     #   @return [String]
     class ProofOfPrincipalAddress
-      attr_reader :type,
-                  :front
+      attr_accessor :type,
+                    :front
     end
   end
 end

data/lib/checkout_sdk/accounts/proof_of_principal_address_type.rb

@@ -2,6 +2,9 @@
 
 module CheckoutSdk
   module Accounts
+    # The document type accepted as proof of the company's principal place of business. Same
+    # proof_of_address value as {ProofOfResidentialAddressType}, but the API defines the two as separate
+    # enums on separate documents.
     module ProofOfPrincipalAddressType
       PROOF_OF_ADDRESS = 'proof_of_address'
     end

data/lib/checkout_sdk/accounts/proof_of_registration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Proof of the sole trader's registration, for example an extract from a trade register.
+    # Representative documents only (company.representatives[].documents), EEA Sole Trader Full (3.0).
+    # @!attribute type
+    #   The type of document being used as proof of registration.
+    #   [Required]
+    #   @return [String] {ProofOfRegistrationType}
+    # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
+    #   @return [String]
+    class ProofOfRegistration
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_registration_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The document types accepted as a sole trader's proof of registration (EEA Sole Trader Full (3.0)).
+    module ProofOfRegistrationType
+      EXTRACT_FROM_TRADE_REGISTER = 'extract_from_trade_register'
+      OTHER = 'other'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_residential_address.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Proof of residential address of the representative. Representative documents only
+    # (company.representatives[].documents), EEA Sole Trader Full (3.0).
+    # @!attribute type
+    #   The type of document being used as address verification.
+    #   [Required]
+    #   @return [String] {ProofOfResidentialAddressType}
+    # @!attribute front
+    #   The ID of the front side of the document as represented within Checkout.com systems.
+    #   [Required]
+    #   ^file_[a-z2-7]{26}$
+    #   31 characters
+    #   @return [String]
+    class ProofOfResidentialAddress
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_residential_address_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The document type accepted as a representative's proof of residential address (EEA Sole Trader Full
+    # (3.0)). Same proof_of_address value as {ProofOfPrincipalAddressType}, but the API defines the two as
+    # separate enums on separate documents.
+    module ProofOfResidentialAddressType
+      PROOF_OF_ADDRESS = 'proof_of_address'
+    end
+  end
+end