checkout_sdk 1.2.2 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a5d0baf6cbae6fdd117f4d506da563edd5a4b0c34b3d3998502cd44173f06a
-  data.tar.gz: a692c66bed6a04a4c01e33b0e358814ffbc678bb358047fc427fbc53c7398c9a
+  metadata.gz: 6fe0b38907019a7e5de79c5bef1cd96bcd3486b9bdb2097a5577fb9a57f009cd
+  data.tar.gz: 6d9f5b05f436e8025b4381157c096cb31e9d141fa4f43e0d87cb69b9da705c5e
 SHA512:
-  metadata.gz: a78beb178c7ecfc877df410cee8a1090a02bde9883a706d3a47a11a26fb49ca4cbd4a8821074530d3a81bc07a9d3fa8cab32d383e6db9668ee5c0b8fe4e7929a
-  data.tar.gz: ce1b9b18e3132c57d9a2e2c520b11c45610e2a5749d53a961f2f41f722396ea6fc2c578ee31ba5f8cfd47b86df397ea97ed04a04fb466985510eaaaa31d70484
+  metadata.gz: 62c16a1f6cb31ba02338f4ac7cfae9dbd2f2b34a571b810bb66a8399e9a959c25f07c5ec8482ec0d0ccd5e6f2e3f3a61d816348b680881e935e1c31a072d9fc8
+  data.tar.gz: f128bee96ea6ca4593f82d871b61d74577760ed036e76b298a881bc7af9fded0e8eb7e4049606117127eb1c9a25ec8017409c37c505c8c917c1f8ce0c575cbcc

data/.overcommit.yml

@@ -0,0 +1,30 @@
+# Overcommit configuration
+# See https://github.com/sds/overcommit for more information
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail
+    command: ['bundle', 'exec', 'rubocop']
+    flags: ['--format', 'emacs', '--force-exclusion', '--display-cop-names']
+    include:
+      - 'lib/**/*.rb'
+      - '**/Gemfile'
+      - '**/Rakefile'
+
+  ALL:
+    problem_on_unmodified_line: ignore
+    requires_stash: true
+    quiet: false
+
+PostCheckout:
+  ALL:
+    enabled: false
+
+PostMerge:
+  ALL:
+    enabled: false
+
+PostRewrite:
+  ALL:
+    enabled: false

data/.rubocop.yml

@@ -18,12 +18,21 @@ Metrics/ModuleLength:
 
 Metrics/MethodLength:
   Max: 25
+  Exclude:
+    # Aggregator that wires up every product client; grows with each new product.
+    - "**/checkout_api.rb"
 
 Metrics/ParameterLists:
   Max: 10
 
 Metrics/ClassLength:
-  Max: 120
+  # Raised from 120: SDK classes (e.g. ApiClient, response DTOs) grow as new
+  # API conventions and fields are adopted upstream.
+  Max: 150
+  Exclude:
+    # Endpoint-collection clients: one method per REST endpoint, grow with the API.
+    - "**/issuing_client.rb"
+    - "**/accounts_client.rb"
 
 Metrics/CyclomaticComplexity:
   Max: 10
@@ -37,6 +46,11 @@ Style/Documentation:
 Style/OpenStructUse:
   Enabled: false
 
+Naming/AccessorMethodName:
+  # The SDK consistently prefixes read endpoints with get_ to mirror the REST API
+  # (e.g. get_cardholder, get_card_details). Zero-arg variants would otherwise flag.
+  Enabled: false
+
 Naming/MethodName:
   Exclude:
     - "**/google_pay_token_data*"

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/Gemfile

@@ -3,4 +3,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in checkout_sdk.gemspec
-gemspec
+gemspec
+
+gem 'overcommit', '~> 0.60'

data/README.md

@@ -15,6 +15,13 @@
 > We improved the initialization of SDK making it easier to understand the available options. <br/>
 > Now `NAS` accounts are the default instance for the SDK and `ABC` structure was moved to a `previous` prefixes. <br/>
 
+## Requirements
+
+- **Ruby**: 2.7.0 or higher
+- **Tested on**: Ruby 2.7, 3.1, and 3.3
+
+> **Note**: Ruby 2.6 reached end-of-life in March 2022 and is no longer supported. Please upgrade to Ruby 2.7 or later for security and compatibility.
+
 ### Gem installer
 
 ```sh
@@ -229,6 +236,37 @@ The execution of integration tests require the following environment variables s
 * For default account systems (OAuth): `CHECKOUT_DEFAULT_OAUTH_CLIENT_ID` & `CHECKOUT_DEFAULT_OAUTH_CLIENT_SECRET`
 * For Previous account systems (ABC): `CHECKOUT_PREVIOUS_PUBLIC_KEY` & `CHECKOUT_PREVIOUS_SECRET_KEY`
 
+## Development Setup
+
+### Git Hooks with Overcommit
+
+This project uses [Overcommit](https://github.com/sds/overcommit) to manage Git hooks and ensure code quality.
+
+After cloning the repository, install the hooks:
+
+```bash
+bundle install
+bundle exec overcommit --install
+```
+
+This will automatically run RuboCop on staged Ruby files before each commit. If there are any offenses, the commit will be blocked.
+
+#### Auto-fixing issues
+
+To automatically fix some RuboCop offenses:
+
+```bash
+bundle exec rubocop -a
+```
+
+#### Skipping hooks (not recommended)
+
+If you absolutely need to skip the pre-commit hooks:
+
+```bash
+OVERCOMMIT_DISABLE=1 git commit -m "your message"
+```
+
 ## Code of Conduct
 
 Please refer to [Code of Conduct](CODE_OF_CONDUCT.md)

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/checkout_sdk/accounts/account_holder.rb

@@ -21,8 +21,8 @@ module CheckoutSdk
     # @!attribute email
     #   @return [String]
     class AccountHolder
-      attr_accessor :type,
-                    :tax_id,
+      attr_reader :type
+      attr_accessor :tax_id,
                     :date_of_birth,
                     :country_of_birth,
                     :residential_status,
@@ -30,6 +30,14 @@ module CheckoutSdk
                     :phone,
                     :identification,
                     :email
+
+      protected
+
+      # @abstract
+      # @param [String] type {MetadataSourceType}
+      def initialize(type)
+        @type = type
+      end
     end
   end
 end

data/lib/checkout_sdk/accounts/account_holder_corporate.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute company_name
+    #   @return [String]
+    class AccountHolderCorporate < AccountHolder
+      attr_accessor :company_name
+
+      def initialize
+        super(AccountHolderType::CORPORATE)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/account_holder_individual.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    class AccountHolderIndividual < AccountHolder
+      attr_accessor :first_name,
+                    :last_name
+
+      def initialize
+        super(AccountHolderType::INDIVIDUAL)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/accounts.rb

@@ -8,6 +8,8 @@ require 'checkout_sdk/accounts/document'
 require 'checkout_sdk/accounts/individual'
 require 'checkout_sdk/accounts/business_type'
 require 'checkout_sdk/accounts/account_holder'
+require 'checkout_sdk/accounts/account_holder_corporate'
+require 'checkout_sdk/accounts/account_holder_individual'
 require 'checkout_sdk/accounts/entity_financial_details'
 require 'checkout_sdk/accounts/file_request'
 require 'checkout_sdk/accounts/date_of_birth'
@@ -32,7 +34,38 @@ require 'checkout_sdk/accounts/instrument_details'
 require 'checkout_sdk/accounts/instrument_details_faster_payments'
 require 'checkout_sdk/accounts/instrument_details_sepa'
 require 'checkout_sdk/accounts/instrument_details_card_token'
+require 'checkout_sdk/accounts/instrument_details_ach'
 require 'checkout_sdk/accounts/payment_instrument_request'
 require 'checkout_sdk/accounts/payment_instruments_query'
-require 'checkout_sdk/accounts/headers'
 require 'checkout_sdk/accounts/update_payment_instrument_request'
+require 'checkout_sdk/accounts/additional_document'
+require 'checkout_sdk/accounts/additional_info'
+require 'checkout_sdk/accounts/articles_of_association_type'
+require 'checkout_sdk/accounts/bank_verification'
+require 'checkout_sdk/accounts/bank_verification_type'
+require 'checkout_sdk/accounts/company_verification'
+require 'checkout_sdk/accounts/company_verification_type'
+require 'checkout_sdk/accounts/date_of_incorporation'
+require 'checkout_sdk/accounts/financial_verification'
+require 'checkout_sdk/accounts/financial_verification_type'
+require 'checkout_sdk/accounts/invitee'
+require 'checkout_sdk/accounts/onboard_sub_entity_documents'
+require 'checkout_sdk/accounts/processing_details'
+require 'checkout_sdk/accounts/proof_of_legality'
+require 'checkout_sdk/accounts/proof_of_legality_type'
+require 'checkout_sdk/accounts/proof_of_principal_address'
+require 'checkout_sdk/accounts/proof_of_principal_address_type'
+require 'checkout_sdk/accounts/shareholder_structure'
+require 'checkout_sdk/accounts/shareholder_structure_type'
+require 'checkout_sdk/accounts/tax_verification'
+require 'checkout_sdk/accounts/tax_verification_type'
+require 'checkout_sdk/accounts/submitter'
+require 'checkout_sdk/accounts/entity_requirement_reason'
+require 'checkout_sdk/accounts/entity_requirement_priority'
+require 'checkout_sdk/accounts/entity_requirement_update_status'
+require 'checkout_sdk/accounts/entity_requirement_update_request'
+require 'checkout_sdk/accounts/reserve_rule_holding_duration'
+require 'checkout_sdk/accounts/rolling_reserve_rule'
+require 'checkout_sdk/accounts/reserve_rule_update_request'
+require 'checkout_sdk/accounts/reserve_rule_create_request'
+require 'checkout_sdk/accounts/entity_files_request'

data/lib/checkout_sdk/accounts/accounts_client.rb

@@ -11,7 +11,11 @@ module CheckoutSdk
       PAYOUT_SCHEDULE = 'payout-schedules'
       FILES = 'files'
       PAYMENT_INSTRUMENTS = 'payment-instruments'
-      private_constant :ACCOUNTS, :ENTITIES, :INSTRUMENT, :PAYOUT_SCHEDULE, :FILES, :PAYMENT_INSTRUMENTS
+      REQUIREMENTS = 'requirements'
+      RESERVE_RULES = 'reserve-rules'
+      MEMBERS = 'members'
+      private_constant :ACCOUNTS, :ENTITIES, :INSTRUMENT, :PAYOUT_SCHEDULE, :FILES, :PAYMENT_INSTRUMENTS,
+                       :REQUIREMENTS, :RESERVE_RULES, :MEMBERS
 
       # @param [ApiClient] api_client
       # @param [ApiClient] files_client
@@ -93,6 +97,135 @@ module CheckoutSdk
       def upload_file(file_request)
         files_client.submit_file(FILES, sdk_authorization, file_request)
       end
+
+      # Retrieve the list of pending requirements that a sub-entity must resolve.
+      # @param [String] entity_id
+      def get_entity_requirements(entity_id)
+        api_client.invoke_get(
+          build_path(ACCOUNTS, ENTITIES, entity_id, REQUIREMENTS),
+          sdk_authorization
+        )
+      end
+
+      # Retrieve detailed information for a single requirement.
+      # @param [String] entity_id
+      # @param [String] requirement_id
+      def get_entity_requirement_details(entity_id, requirement_id)
+        api_client.invoke_get(
+          build_path(ACCOUNTS, ENTITIES, entity_id, REQUIREMENTS, requirement_id),
+          sdk_authorization
+        )
+      end
+
+      # Submit a response to resolve a requirement.
+      # @param [String] entity_id
+      # @param [String] requirement_id
+      # @param [Hash, EntityRequirementUpdateRequest] update_request
+      def resolve_entity_requirement(entity_id, requirement_id, update_request)
+        api_client.invoke_put(
+          build_path(ACCOUNTS, ENTITIES, entity_id, REQUIREMENTS, requirement_id),
+          sdk_authorization,
+          update_request
+        )
+      end
+
+      # Add a reserve rule for a sub-entity.
+      # @param [String] entity_id
+      # @param [Hash, ReserveRuleCreateRequest] reserve_rule_request
+      def add_reserve_rule(entity_id, reserve_rule_request)
+        api_client.invoke_post(
+          build_path(ACCOUNTS, ENTITIES, entity_id, RESERVE_RULES),
+          sdk_authorization,
+          reserve_rule_request
+        )
+      end
+
+      # Query reserve rules for a sub-entity.
+      # @param [String] entity_id
+      def query_reserve_rules(entity_id)
+        api_client.invoke_get(
+          build_path(ACCOUNTS, ENTITIES, entity_id, RESERVE_RULES),
+          sdk_authorization
+        )
+      end
+
+      # Retrieve a reserve rule by id.
+      # @param [String] entity_id
+      # @param [String] reserve_rule_id
+      def get_reserve_rule(entity_id, reserve_rule_id)
+        api_client.invoke_get(
+          build_path(ACCOUNTS, ENTITIES, entity_id, RESERVE_RULES, reserve_rule_id),
+          sdk_authorization
+        )
+      end
+
+      # Update a reserve rule.
+      # The API enforces optimistic concurrency: the ETag returned by GET must be
+      # echoed back via {CheckoutSdk::Common::Headers#if_match}, otherwise the
+      # API responds 428 Precondition Required.
+      # @param [String] entity_id
+      # @param [String] reserve_rule_id
+      # @param [String] etag ETag value to forward as the `If-Match` HTTP header.
+      # @param [Hash, ReserveRuleUpdateRequest] reserve_rule_request
+      def update_reserve_rule(entity_id, reserve_rule_id, etag, reserve_rule_request)
+        headers = nil
+        if !etag.nil? && !etag.empty?
+          headers = CheckoutSdk::Common::Headers.new
+          headers.if_match = etag
+        end
+
+        api_client.invoke_put(
+          build_path(ACCOUNTS, ENTITIES, entity_id, RESERVE_RULES, reserve_rule_id),
+          sdk_authorization,
+          reserve_rule_request,
+          headers
+        )
+      end
+
+      # List sub-entity members.
+      # @param [String] entity_id
+      def get_sub_entity_members(entity_id)
+        api_client.invoke_get(
+          build_path(ACCOUNTS, ENTITIES, entity_id, MEMBERS),
+          sdk_authorization
+        )
+      end
+
+      # Reinvite a sub-entity member.
+      # The API marks the request body as required; callers must provide a Hash
+      # (or `PlatformsHostedOnboardReinviteRequest`-shaped object), even if it
+      # is empty `{}` per the current swagger contract.
+      # @param [String] entity_id
+      # @param [String] user_id
+      # @param [Hash] reinvite_request Required body per swagger; pass `{}` if no fields are needed.
+      def reinvite_sub_entity_member(entity_id, user_id, reinvite_request)
+        api_client.invoke_put(
+          build_path(ACCOUNTS, ENTITIES, entity_id, MEMBERS, user_id),
+          sdk_authorization,
+          reinvite_request
+        )
+      end
+
+      # Upload a file scoped to a sub-entity. Hits POST /entities/{entityId}/files.
+      # @param [String] entity_id
+      # @param [Hash, EntityFilesRequest] file_request
+      def upload_entity_file(entity_id, file_request)
+        files_client.submit_file(
+          build_path(ENTITIES, entity_id, FILES),
+          sdk_authorization,
+          file_request
+        )
+      end
+
+      # Retrieve a file scoped to a sub-entity. Hits GET /entities/{entityId}/files/{fileId}.
+      # @param [String] entity_id
+      # @param [String] file_id
+      def get_entity_file(entity_id, file_id)
+        files_client.invoke_get(
+          build_path(ENTITIES, entity_id, FILES, file_id),
+          sdk_authorization
+        )
+      end
     end
   end
 end

data/lib/checkout_sdk/accounts/additional_document.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute front
+    #   @return [String]
+    class AdditionalDocument
+      attr_accessor :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/additional_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute field1
+    #   @return [String]
+    # @!attribute field2
+    #   @return [String]
+    # @!attribute field3
+    #   @return [String]
+    class AdditionalInfo
+      attr_accessor :field1,
+                    :field2,
+                    :field3
+    end
+  end
+end

data/lib/checkout_sdk/accounts/articles_of_association_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ArticlesOfAssociationType
+      MEMORANDUM_OF_ASSOCIATION = 'memorandum_of_association'
+      ARTICLES_OF_ASSOCIATION = 'articles_of_association'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/bank_verification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [BankVerificationType]
+    # @!attribute front
+    #   @return [String]
+    class BankVerification
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/bank_verification_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module BankVerificationType
+      BANK_STATEMENT = 'bank_statement'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/company.rb

@@ -10,12 +10,16 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute trading_name
     #   @return [String]
+    # @!attribute date_of_incorporation
+    #   @return [DateOfIncorporation]
+    # @!attribute regulatory_licence_number
+    #   @return [String]
     # @!attribute principal_address
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute registered_address
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute representatives
-    #   @return [Array(Representative)]
+    #   @return [Array(EntityRepresentative)]
     # @!attribute document
     #   @return [EntityDocument]
     # @!attribute financial_details
@@ -25,6 +29,8 @@ module CheckoutSdk
                     :business_type,
                     :legal_name,
                     :trading_name,
+                    :date_of_incorporation,
+                    :regulatory_licence_number,
                     :principal_address,
                     :registered_address,
                     :representatives,

data/lib/checkout_sdk/accounts/contact_details.rb

@@ -6,9 +6,12 @@ module CheckoutSdk
     #   @return [Phone]
     # @!attribute email_addresses
     #   @return [EntityEmailAddresses]
+    # @!attribute invitee
+    #   @return [Invitee]
     class ContactDetails
       attr_accessor :phone,
-                    :email_addresses
+                    :email_addresses,
+                    :invitee
     end
   end
 end

data/lib/checkout_sdk/accounts/date_of_incorporation.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute month
+    #   @return [Integer]
+    # @!attribute year
+    #   @return [Integer]
+    class DateOfIncorporation
+      attr_reader :month,
+                  :year
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_files_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Request body for POST /entities/{entityId}/files.
+    #
+    # @!attribute purpose
+    #   @return [String] Purpose of the file (e.g. "bank_verification").
+    class EntityFilesRequest
+      attr_accessor :purpose
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_requirement_priority.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Priority of a sub-entity requirement. "critical" if the deadline is within 7 days,
+    # otherwise "high" by default.
+    module EntityRequirementPriority
+      HIGH = 'high'
+      CRITICAL = 'critical'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_requirement_reason.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Reasons why a requirement was raised on a sub-entity.
+    module EntityRequirementReason
+      PERIODIC_REVIEW = 'periodic_review'
+      ATTESTATION = 'attestation'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_requirement_update_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Request body for PUT /accounts/entities/{id}/requirements/{requirementId}.
+    #
+    # The expected shape of `value` is defined by the JSON Schema returned in
+    # the requirement details response. Common shapes include a file reference
+    # (e.g. { "file_id": "file_..." }), a primitive value, or a structured object.
+    #
+    # @!attribute value
+    #   The response to the requirement. Polymorphic per swagger
+    #   (`oneOf [object, array, string, number, boolean]`), so the only valid
+    #   Ruby annotation is `Object`. The concrete shape is dictated at runtime
+    #   by the requirement's `_schema` returned from
+    #   `GET /accounts/entities/{id}/requirements/{requirementId}`.
+    #   @return [Object]
+    class EntityRequirementUpdateRequest
+      attr_accessor :value
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_requirement_update_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Status returned after submitting a requirement response.
+    # While processing, the requirement is no longer retrievable via GET endpoints;
+    # if validation fails downstream the requirement may reappear.
+    module EntityRequirementUpdateStatus
+      PROCESSING = 'processing'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/financial_verification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [FinancialVerificationType]
+    # @!attribute front
+    #   @return [String]
+    class FinancialVerification
+      attr_reader :type,
+                  :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/financial_verification_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module FinancialVerificationType
+      FINANCIAL_STATEMENT = 'financial_statement'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/instrument_details_ach.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # ACH bank-account instrument details. Maps swagger `PlatformsInstrumentDetailsAch`.
+    # All three attributes are required.
+    #
+    # @!attribute account_number
+    #   @return [String] The alphanumeric value that identifies the account.
+    # @!attribute routing_number
+    #   @return [String] The 9-digit American Bankers Association (ABA) routing number that
+    #     identifies the financial institution.
+    # @!attribute account_type
+    #   @return [String] The type of bank account. One of `savings`, `checking`.
+    class InstrumentDetailsAch < InstrumentDetails
+      attr_accessor :account_number,
+                    :routing_number,
+                    :account_type
+    end
+  end
+end