checkout_sdk 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a5d0baf6cbae6fdd117f4d506da563edd5a4b0c34b3d3998502cd44173f06a
-  data.tar.gz: a692c66bed6a04a4c01e33b0e358814ffbc678bb358047fc427fbc53c7398c9a
+  metadata.gz: d4620b28a6309ae0f37d8d881513f93a41d9c4cc30116719c82954212572f6f8
+  data.tar.gz: 99c680456288fe5acf3bf1fd5fb9cb62188ca380f715b9fb61259ad78024f795
 SHA512:
-  metadata.gz: a78beb178c7ecfc877df410cee8a1090a02bde9883a706d3a47a11a26fb49ca4cbd4a8821074530d3a81bc07a9d3fa8cab32d383e6db9668ee5c0b8fe4e7929a
-  data.tar.gz: ce1b9b18e3132c57d9a2e2c520b11c45610e2a5749d53a961f2f41f722396ea6fc2c578ee31ba5f8cfd47b86df397ea97ed04a04fb466985510eaaaa31d70484
+  metadata.gz: 648c9db76507c0aa0e26b307edddb2c0ed615819bf093936cb08fbd204588e6d1398377c9bf6dd84951b82e85c8178c4ca9b3e5f58680960de83c29d163692c7
+  data.tar.gz: ff1713ad04ffd80c8ae5261d1b4f0b0bb8182fb28c0f168fd5ea510d9511df98d2002927cae1d4acc0da66fdb200cc91c3d981d93c693791d169bcc4edd9edf9

data/lib/checkout_sdk/accounts/accounts.rb

@@ -36,3 +36,24 @@ 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'

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/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/invitee.rb

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

data/lib/checkout_sdk/accounts/onboard_entity.rb

@@ -4,23 +4,32 @@ module CheckoutSdk
   module Accounts
     # @!attribute reference
     #   @return [String]
-    # @!attribute contact_details
-    #   @return [ContactDetails]
+    # @!attribute is_draft
+    #   @return [Boolean]
     # @!attribute profile
     #   @return [Profile]
+    # @!attribute contact_details
+    #   @return [ContactDetails]
     # @!attribute company
     #   @return [Company]
+    # @!attribute processing_details
+    #   @return [ProcessingDetails]
     # @!attribute individual
     #   @return [Individual]
     # @!attribute documents
     #   @return [OnboardSubEntityDocuments]
+    # @!attribute additional_info
+    #   @return [AdditionalInfo]
     class OnboardEntity
       attr_accessor :reference,
-                    :contact_details,
+                    :is_draft,
                     :profile,
+                    :contact_details,
                     :company,
+                    :processing_details,
                     :individual,
-                    :documents
+                    :documents,
+                    :additional_info
     end
   end
 end

data/lib/checkout_sdk/accounts/onboard_sub_entity_documents.rb

@@ -2,16 +2,43 @@
 
 module CheckoutSdk
   module Accounts
-    # @!attribute documents
-    #   @return [Document]
+    # @!attribute identity_verification
+    #   @return [EntityIdentificationDocument]
     # @!attribute company_verification
     #   @return [CompanyVerification]
+    # @!attribute articles_of_association
+    #   @return [ArticlesOfAssociationType]
+    # @!attribute bank_verification
+    #   @return [BankVerification]
+    # @!attribute shareholder_structure
+    #   @return [ShareholderStructure]
+    # @!attribute proof_of_legality
+    #   @return [ProofOfLegality]
+    # @!attribute proof_of_principal_address
+    #   @return [ProofOfPrincipalAddress]
+    # @!attribute additional_document1
+    #   @return [AdditionalDocument]
+    # @!attribute additional_document2
+    #   @return [AdditionalDocument]
+    # @!attribute additional_document3
+    #   @return [AdditionalDocument]
     # @!attribute tax_verification
     #   @return [TaxVerification]
+    # @!attribute financial_verification
+    #   @return [FinancialVerification]
     class OnboardSubEntityDocuments
-      attr_accessor :documents,
+      attr_accessor :identity_verification,
                     :company_verification,
-                    :tax_verification
+                    :articles_of_association,
+                    :bank_verification,
+                    :shareholder_structure,
+                    :proof_of_legality,
+                    :proof_of_principal_address,
+                    :additional_document1,
+                    :additional_document2,
+                    :additional_document3,
+                    :tax_verification,
+                    :financial_verification
     end
   end
 end

data/lib/checkout_sdk/accounts/processing_details.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute settlement_country
+    #   @return [String]
+    # @!attribute target_countries
+    #   @return [Array(String)]
+    # @!attribute annual_processing_volume
+    #   @return [Integer]
+    # @!attribute average_transaction_value
+    #   @return [Integer]
+    # @!attribute highest_transaction_value
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [CheckoutSdk::Common::Currency]
+    class ProcessingDetails
+      attr_accessor :settlement_country,
+                    :target_countries,
+                    :annual_processing_volume,
+                    :average_transaction_value,
+                    :highest_transaction_value,
+                    :currency
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_legality.rb

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

data/lib/checkout_sdk/accounts/proof_of_legality_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ProofOfLegalityType
+      PROOF_OF_LEGALITY = 'proof_of_legality'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_principal_address.rb

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

data/lib/checkout_sdk/accounts/proof_of_principal_address_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ProofOfPrincipalAddressType
+      PROOF_OF_ADDRESS = 'proof_of_address'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/shareholder_structure.rb

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

data/lib/checkout_sdk/accounts/shareholder_structure_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ShareholderStructureType
+      CERTIFIED_SHAREHOLDER_STRUCTURE = 'certified_shareholder_structure'
+    end
+  end
+end

data/lib/checkout_sdk/api_client.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module CheckoutSdk
   class ApiClient
     attr_accessor :client, :multipart_client, :log
 
-    # @param [CheckoutConfiguration] configuration
-    # @param [String] uri
     def initialize(configuration, uri)
       @client = configuration.http_client.clone
       @client.url_prefix = uri
@@ -14,42 +14,27 @@ module CheckoutSdk
       @log = configuration.logger
     end
 
-    # @param [String] path
-    # @param [SdkAuthorization] authorization
-    # @param [Object] params
-    def invoke_get(path,
-                   authorization,
-                   params = nil)
+    def invoke_get(path, authorization, params = nil)
       invoke(:get, path, authorization, params: params)
     end
 
-    def invoke_post(path,
-                    authorization,
-                    request = nil,
-                    idempotency_key = nil)
+    def invoke_post(path, authorization, request = nil, idempotency_key = nil)
       invoke(:post, path, authorization, request, idempotency_key)
     end
 
-    def invoke_put(path,
-                   authorization,
-                   request)
+    def invoke_put(path, authorization, request)
       invoke(:put, path, authorization, request)
     end
 
-    def invoke_patch(path,
-                     authorization,
-                     request = nil)
+    def invoke_patch(path, authorization, request = nil)
       invoke(:patch, path, authorization, request)
     end
 
-    def invoke_delete(path,
-                      authorization)
+    def invoke_delete(path, authorization)
       invoke(:delete, path, authorization)
     end
 
-    def submit_file(path,
-                    authorization,
-                    request)
+    def submit_file(path, authorization, request)
       upload(path, authorization, request)
     end
 
@@ -58,7 +43,7 @@ module CheckoutSdk
     def invoke(method, path, authorization, body = nil, idempotency_key = nil, params: nil)
       path = append_params(path, params) unless params.nil?
 
-      headers = get_default_headers authorization
+      headers = default_headers(authorization)
       headers[:'Content-Type'] = 'application/json'
       headers[:'Cko-Idempotency-Key'] = idempotency_key unless idempotency_key.nil?
 
@@ -71,26 +56,23 @@ module CheckoutSdk
         raise CheckoutApiException, e.response
       end
 
-      parse_response response
+      parse_response(response)
     end
 
-    def get_default_headers(authorization)
-      {
-        'User-Agent': "checkout-sdk-ruby/#{VERSION}",
-        Accept: 'application/json',
-        Authorization: authorization.authorization_header
-      }
+    def default_headers(authorization)
+      { 'User-Agent': "checkout-sdk-ruby/#{VERSION}", Accept: 'application/json',
+        Authorization: authorization.authorization_header }
     end
 
     def append_params(path, input_params)
       raise CheckoutArgumentException, 'Query parameters were not provided' if input_params.nil?
 
-      if input_params.is_a? String
-        params = input_params
-      else
-        hash = CheckoutSdk::JsonSerializer.to_custom_hash(input_params)
-        params = URI.encode_www_form(hash)
-      end
+      params = if input_params.is_a? String
+                 input_params
+               else
+                 hash = CheckoutSdk::JsonSerializer.to_custom_hash(input_params)
+                 URI.encode_www_form(hash)
+               end
 
       "#{path}?#{params}"
     end
@@ -103,16 +85,16 @@ module CheckoutSdk
           MIME::Types.type_for(file_request.file).first,
           File.basename(file_request.file)
         ),
-        :purpose => file_request.purpose
+        purpose: file_request.purpose
       }
     end
 
     def upload(path, authorization, file_request)
-      headers = get_default_headers authorization
+      headers = default_headers(authorization)
 
       file = File.open(file_request.file)
 
-      form = build_multipart_request file_request, file
+      form = build_multipart_request(file_request, file)
 
       begin
         @log.info "post: /#{path}"
@@ -123,28 +105,55 @@ module CheckoutSdk
         file.close
       end
 
-      parse_response response
+      parse_response(response)
     end
 
     def parse_response(response)
-      raise CheckoutApiException, response if response.status < 200 || response.status >= 400
+      raise CheckoutApiException, response if response.status < 200 || response.status >= 300
 
       metadata = CheckoutUtils.map_to_http_metadata(response)
-      body = parse_json_or_contents(response)
-      body = OpenStruct.new if body.nil?
-      body = OpenStruct.new(items: body) if body.is_a? Array
-      body.http_metadata = metadata if body.is_a? OpenStruct
+      body = parse_body(response)
+
+      if body.is_a?(Array)
+        body = OpenStruct.new(items: body)
+      elsif !body.is_a?(OpenStruct)
+        body = OpenStruct.new(contents: body)
+      end
+
+      body.http_metadata = metadata if body.is_a?(OpenStruct)
+
       body
+    rescue JSON::ParserError => e
+      raise CheckoutApiException.new(response, "Error parsing JSON: #{e.message}")
+    rescue StandardError => e
+      @log&.error("Unexpected error occurred: #{e.message}")
+      raise
     end
 
-    def parse_json_or_contents(response)
-      return if response.body.nil? || response.body == ''
+    def parse_body(response)
+      content_type = response.headers['Content-Type']
+      return OpenStruct.new if response.body.nil? || response.body.empty?
 
-      if response.body.start_with?('{', '[')
-        JSON.parse(response.body, object_class: OpenStruct)
+      if content_type&.include?('application/json')
+        parsed_value = JSON.parse(response.body)
+        deep_convert_to_ostruct(parsed_value)
+      elsif content_type&.include?('text/csv')
+        csv_data = CSV.parse(response.body, headers: true)
+        OpenStruct.new(csv: csv_data)
       else
         OpenStruct.new(contents: response.body)
       end
     end
+
+    def deep_convert_to_ostruct(obj)
+      case obj
+      when Hash
+        OpenStruct.new(obj.transform_values { |value| deep_convert_to_ostruct(value) })
+      when Array
+        obj.map { |item| deep_convert_to_ostruct(item) }
+      else
+        obj
+      end
+    end
   end
 end

data/lib/checkout_sdk/client.rb

@@ -11,7 +11,8 @@ module CheckoutSdk
     attr_reader :api_client,
                 :authorization_type,
                 :configuration
-    protected :api_client, :authorization_type, :configuration
+
+    protected
 
     # @param [CheckoutSdk::ApiClient] api_client
     # @param [CheckoutConfiguration] configuration
@@ -22,8 +23,6 @@ module CheckoutSdk
       @configuration = configuration
     end
 
-    protected
-
     # @param [Array] args
     def build_path(*args)
       args.join('/')

data/lib/checkout_sdk/common/account_change_indicator_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    class AccountChangeIndicatorType
+      THIS_TRANSACTION = 'this_transaction'
+      LESS_THAN_THIRTY_DAYS = 'less_than_thirty_days'
+      THIRTY_TO_SIXTY_DAYS = 'thirty_to_sixty_days'
+      MORE_THAN_SIXTY_DAYS = 'more_than_sixty_days'
+    end
+  end
+end

data/lib/checkout_sdk/common/account_holder.rb

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Common
     # @!attribute type
     #   @return [String] {AccountHolderType}
-    # @!attribute title
+    # @!attribute full_name
     #   @return [String]
     # @!attribute first_name
     #   @return [String]
@@ -21,7 +21,7 @@ module CheckoutSdk
     # @!attribute country_of_birth
     #   @return [Country]
     # @!attribute residential_status
-    #   @return [String]
+    #   @return [String] {ResidentialStatusType}
     # @!attribute billing_address
     #   @return [Address]
     # @!attribute phone
@@ -32,9 +32,11 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute gender
     #   @return [String]
+    # @!attribute account_name_inquiry
+    #   @return [Boolean]
     class AccountHolder
       attr_accessor :type,
-                    :title,
+                    :full_name,
                     :first_name,
                     :middle_name,
                     :last_name,
@@ -47,7 +49,8 @@ module CheckoutSdk
                     :phone,
                     :identification,
                     :email,
-                    :gender
+                    :gender,
+                    :account_name_inquiry
     end
   end
 end