checkout_sdk 1.6.0 → 1.8.0

data/lib/checkout_sdk/identities/aml_screening/aml_verification_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module AmlScreening
+      # Request body for POST /aml-verifications.
+      #
+      # @!attribute applicant_id
+      #   @return [String] The applicant's unique identifier (e.g. "aplt_...").
+      # @!attribute search_parameters
+      #   @return [AmlSearchParameters]
+      # @!attribute monitored
+      #   @return [Boolean] Whether to monitor the applicant's AML status.
+      class AmlVerificationRequest
+        attr_accessor :applicant_id, :search_parameters, :monitored
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/applicants/applicants_client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module Applicants
+      # Client for the Identities — Applicants API.
+      class ApplicantsClient < Client
+        APPLICANTS = 'applicants'
+        ANONYMIZE = 'anonymize'
+        private_constant :APPLICANTS, :ANONYMIZE
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        end
+
+        # @param [Hash, CreateApplicantRequest] create_applicant_request
+        def create_applicant(create_applicant_request)
+          api_client.invoke_post(APPLICANTS, sdk_authorization, create_applicant_request)
+        end
+
+        # @param [String] applicant_id
+        def get_applicant(applicant_id)
+          api_client.invoke_get(build_path(APPLICANTS, applicant_id), sdk_authorization)
+        end
+
+        # @param [String] applicant_id
+        # @param [Hash, UpdateApplicantRequest] update_applicant_request
+        def update_applicant(applicant_id, update_applicant_request)
+          api_client.invoke_patch(build_path(APPLICANTS, applicant_id),
+                                  sdk_authorization,
+                                  update_applicant_request)
+        end
+
+        # @param [String] applicant_id
+        def anonymize_applicant(applicant_id)
+          api_client.invoke_post(build_path(APPLICANTS, applicant_id, ANONYMIZE), sdk_authorization)
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/applicants/create_applicant_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module Applicants
+      # Request body for POST /applicants.
+      #
+      # @!attribute external_applicant_id
+      #   @return [String]
+      # @!attribute email
+      #   @return [String]
+      # @!attribute external_applicant_name
+      #   @return [String]
+      class CreateApplicantRequest
+        attr_accessor :external_applicant_id,
+                      :email,
+                      :external_applicant_name
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/applicants/update_applicant_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module Applicants
+      # Request body for PATCH /applicants/{applicant_id}.
+      #
+      # @!attribute email
+      #   @return [String]
+      # @!attribute external_applicant_name
+      #   @return [String]
+      class UpdateApplicantRequest
+        attr_accessor :email,
+                      :external_applicant_name
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/face_authentication/face_authentication_attempt_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module FaceAuthentication
+      # Request body for POST /face-authentications/{id}/attempts.
+      #
+      # @!attribute redirect_url
+      #   @return [String] URL to redirect the applicant after the attempt.
+      # @!attribute client_information
+      #   @return [CheckoutSdk::Identities::IdentityVerification::IdvClientInformation]
+      class FaceAuthenticationAttemptRequest
+        attr_accessor :redirect_url, :client_information
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/face_authentication/face_authentication_client.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module FaceAuthentication
+      # Client for the Identities — Face Authentication API.
+      class FaceAuthenticationClient < Client
+        FACE_AUTHENTICATIONS = 'face-authentications'
+        ANONYMIZE = 'anonymize'
+        ATTEMPTS = 'attempts'
+        ASSETS = 'assets'
+        private_constant :FACE_AUTHENTICATIONS, :ANONYMIZE, :ATTEMPTS, :ASSETS
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        end
+
+        # @param [Hash, FaceAuthenticationRequest] request
+        def create_face_authentication(request)
+          api_client.invoke_post(FACE_AUTHENTICATIONS, sdk_authorization, request)
+        end
+
+        # @param [String] face_authentication_id
+        def get_face_authentication(face_authentication_id)
+          api_client.invoke_get(build_path(FACE_AUTHENTICATIONS, face_authentication_id),
+                                sdk_authorization)
+        end
+
+        # @param [String] face_authentication_id
+        def anonymize_face_authentication(face_authentication_id)
+          api_client.invoke_post(
+            build_path(FACE_AUTHENTICATIONS, face_authentication_id, ANONYMIZE),
+            sdk_authorization
+          )
+        end
+
+        # Create a new attempt for an existing face authentication.
+        # @param [String] face_authentication_id
+        # @param [Hash, FaceAuthenticationAttemptRequest] attempt_request
+        def create_face_authentication_attempt(face_authentication_id, attempt_request)
+          api_client.invoke_post(
+            build_path(FACE_AUTHENTICATIONS, face_authentication_id, ATTEMPTS),
+            sdk_authorization,
+            attempt_request
+          )
+        end
+
+        # @param [String] face_authentication_id
+        def get_face_authentication_attempts(face_authentication_id)
+          api_client.invoke_get(
+            build_path(FACE_AUTHENTICATIONS, face_authentication_id, ATTEMPTS),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] face_authentication_id
+        # @param [String] attempt_id
+        def get_face_authentication_attempt(face_authentication_id, attempt_id)
+          api_client.invoke_get(
+            build_path(FACE_AUTHENTICATIONS, face_authentication_id, ATTEMPTS, attempt_id),
+            sdk_authorization
+          )
+        end
+
+        # Retrieve the assets (face images and videos) captured during a face authentication attempt.
+        # @param [String] face_authentication_id
+        # @param [String] attempt_id
+        # @param [Hash, nil] query pagination query parameters; supports :skip (Integer, default: 0)
+        #   and :limit (Integer, default: 10)
+        def get_face_authentication_attempt_assets(face_authentication_id, attempt_id, query = nil)
+          api_client.invoke_get(
+            build_path(FACE_AUTHENTICATIONS, face_authentication_id, ATTEMPTS, attempt_id, ASSETS),
+            sdk_authorization,
+            query
+          )
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/face_authentication/face_authentication_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module FaceAuthentication
+      # Request body for POST /face-authentications.
+      #
+      # @!attribute applicant_id
+      #   @return [String]
+      # @!attribute external_reference
+      #   @return [String]
+      # @!attribute redirect_url
+      #   @return [String]
+      class FaceAuthenticationRequest
+        attr_accessor :applicant_id,
+                      :external_reference,
+                      :redirect_url
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdDocumentVerification
+      # Client for the Identities — ID Document Verification API.
+      class IdDocumentVerificationClient < Client
+        ID_DOCUMENT_VERIFICATIONS = 'id-document-verifications'
+        ANONYMIZE = 'anonymize'
+        ATTEMPTS = 'attempts'
+        PDF_REPORT = 'pdf-report'
+        private_constant :ID_DOCUMENT_VERIFICATIONS, :ANONYMIZE, :ATTEMPTS, :PDF_REPORT
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        end
+
+        # @param [Hash, IdDocumentVerificationRequest] request
+        def create_id_document_verification(request)
+          api_client.invoke_post(ID_DOCUMENT_VERIFICATIONS, sdk_authorization, request)
+        end
+
+        # @param [String] id_document_verification_id
+        def get_id_document_verification(id_document_verification_id)
+          api_client.invoke_get(build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id),
+                                sdk_authorization)
+        end
+
+        # @param [String] id_document_verification_id
+        def anonymize_id_document_verification(id_document_verification_id)
+          api_client.invoke_post(
+            build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ANONYMIZE),
+            sdk_authorization
+          )
+        end
+
+        # Create a new attempt for an existing ID document verification.
+        # @param [String] id_document_verification_id
+        # @param [Hash] attempt_request Optional body per swagger.
+        def create_id_document_verification_attempt(id_document_verification_id, attempt_request = nil)
+          api_client.invoke_post(
+            build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS),
+            sdk_authorization,
+            attempt_request
+          )
+        end
+
+        # @param [String] id_document_verification_id
+        def get_id_document_verification_attempts(id_document_verification_id)
+          api_client.invoke_get(
+            build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] id_document_verification_id
+        # @param [String] attempt_id
+        def get_id_document_verification_attempt(id_document_verification_id, attempt_id)
+          api_client.invoke_get(
+            build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS, attempt_id),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] id_document_verification_id
+        def get_id_document_verification_pdf_report(id_document_verification_id)
+          api_client.invoke_get(
+            build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, PDF_REPORT),
+            sdk_authorization
+          )
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/id_document_verification/id_document_verification_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdDocumentVerification
+      # Request body for POST /id-document-verifications.
+      #
+      # @!attribute applicant_id
+      #   @return [String]
+      # @!attribute external_reference
+      #   @return [String]
+      # @!attribute document_type
+      #   @return [String]
+      # @!attribute country
+      #   @return [String]
+      # @!attribute redirect_url
+      #   @return [String]
+      class IdDocumentVerificationRequest
+        attr_accessor :applicant_id,
+                      :external_reference,
+                      :document_type,
+                      :country,
+                      :redirect_url
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identities.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Applicants
+require 'checkout_sdk/identities/applicants/create_applicant_request'
+require 'checkout_sdk/identities/applicants/update_applicant_request'
+require 'checkout_sdk/identities/applicants/applicants_client'
+
+# AML Screening
+require 'checkout_sdk/identities/aml_screening/aml_search_parameters'
+require 'checkout_sdk/identities/aml_screening/aml_verification_request'
+require 'checkout_sdk/identities/aml_screening/aml_screening_client'
+
+# ID Document Verification
+require 'checkout_sdk/identities/id_document_verification/id_document_verification_request'
+require 'checkout_sdk/identities/id_document_verification/id_document_verification_client'
+
+# Identity Verification
+require 'checkout_sdk/identities/identity_verification/idv_declared_data'
+require 'checkout_sdk/identities/identity_verification/idv_client_information'
+require 'checkout_sdk/identities/identity_verification/identity_verification_attempt_request'
+require 'checkout_sdk/identities/identity_verification/identity_verification_request'
+require 'checkout_sdk/identities/identity_verification/identity_verification_client'
+
+# Face Authentication
+require 'checkout_sdk/identities/face_authentication/face_authentication_attempt_request'
+require 'checkout_sdk/identities/face_authentication/face_authentication_request'
+require 'checkout_sdk/identities/face_authentication/face_authentication_client'

data/lib/checkout_sdk/identities/identity_verification/identity_verification_attempt_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdentityVerification
+      # Request body for POST /identity-verifications/{id}/attempts.
+      #
+      # @!attribute redirect_url
+      #   @return [String] URL to redirect the applicant after the attempt.
+      # @!attribute client_information
+      #   @return [IdvClientInformation]
+      class IdentityVerificationAttemptRequest
+        attr_accessor :redirect_url, :client_information
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdentityVerification
+      # Client for the Identities — Identity Verification API.
+      class IdentityVerificationClient < Client
+        IDENTITY_VERIFICATIONS = 'identity-verifications'
+        CREATE_AND_OPEN_IDV = 'create-and-open-idv'
+        ANONYMIZE = 'anonymize'
+        ATTEMPTS = 'attempts'
+        PDF_REPORT = 'pdf-report'
+        ASSETS = 'assets'
+        private_constant :IDENTITY_VERIFICATIONS, :CREATE_AND_OPEN_IDV, :ANONYMIZE, :ATTEMPTS, :PDF_REPORT, :ASSETS
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        end
+
+        # Create an identity verification and immediately receive its hosted URL.
+        # @param [Hash, IdentityVerificationRequest] request
+        def create_and_open_idv(request)
+          api_client.invoke_post(CREATE_AND_OPEN_IDV, sdk_authorization, request)
+        end
+
+        # @param [Hash, IdentityVerificationRequest] request
+        def create_identity_verification(request)
+          api_client.invoke_post(IDENTITY_VERIFICATIONS, sdk_authorization, request)
+        end
+
+        # @param [String] identity_verification_id
+        def get_identity_verification(identity_verification_id)
+          api_client.invoke_get(build_path(IDENTITY_VERIFICATIONS, identity_verification_id),
+                                sdk_authorization)
+        end
+
+        # @param [String] identity_verification_id
+        def anonymize_identity_verification(identity_verification_id)
+          api_client.invoke_post(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ANONYMIZE),
+            sdk_authorization
+          )
+        end
+
+        # Create a new attempt for an existing identity verification.
+        # @param [String] identity_verification_id
+        # @param [Hash, IdentityVerificationAttemptRequest] attempt_request
+        def create_identity_verification_attempt(identity_verification_id, attempt_request)
+          api_client.invoke_post(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS),
+            sdk_authorization,
+            attempt_request
+          )
+        end
+
+        # @param [String] identity_verification_id
+        def get_identity_verification_attempts(identity_verification_id)
+          api_client.invoke_get(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] identity_verification_id
+        # @param [String] attempt_id
+        def get_identity_verification_attempt(identity_verification_id, attempt_id)
+          api_client.invoke_get(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS, attempt_id),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] identity_verification_id
+        def get_identity_verification_pdf_report(identity_verification_id)
+          api_client.invoke_get(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, PDF_REPORT),
+            sdk_authorization
+          )
+        end
+
+        # Retrieve the assets (face images, videos, and document images) captured during an
+        # identity verification attempt.
+        # @param [String] identity_verification_id
+        # @param [String] attempt_id
+        # @param [Hash, nil] query pagination query parameters; supports :skip (Integer, default: 0)
+        #   and :limit (Integer, default: 10)
+        def get_identity_verification_attempt_assets(identity_verification_id, attempt_id, query = nil)
+          api_client.invoke_get(
+            build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS, attempt_id, ASSETS),
+            sdk_authorization,
+            query
+          )
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identity_verification/identity_verification_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdentityVerification
+      # Request body for POST /identity-verifications and POST /create-and-open-idv.
+      #
+      # @!attribute applicant_id
+      #   @return [String] The applicant's unique identifier (e.g. "aplt_...").
+      # @!attribute user_journey_id
+      #   @return [String] Your configuration ID (e.g. "usj_...").
+      # @!attribute declared_data
+      #   @return [IdvDeclaredData]
+      # @!attribute risk_labels
+      #   @return [Array<String>]
+      class IdentityVerificationRequest
+        attr_accessor :applicant_id, :user_journey_id, :declared_data, :risk_labels
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identity_verification/idv_client_information.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdentityVerification
+      # Pre-populated client information for an identity-verification attempt.
+      #
+      # @!attribute pre_selected_residence_country
+      #   @return [String] ISO alpha-2 country code.
+      # @!attribute pre_selected_language
+      #   @return [String] IETF BCP 47 language tag.
+      class IdvClientInformation
+        attr_accessor :pre_selected_residence_country, :pre_selected_language
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identity_verification/idv_declared_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module IdentityVerification
+      # The personal details provided by the applicant for an identity verification.
+      #
+      # @!attribute name
+      #   @return [String] The applicant's name (max 255 characters).
+      class IdvDeclaredData
+        attr_accessor :name
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/base_instruments_client.rb

@@ -15,6 +15,15 @@ module CheckoutSdk
       def delete(instrument_id)
         api_client.invoke_delete(build_path(INSTRUMENTS, instrument_id), sdk_authorization)
       end
+
+      # Revoke a payment instrument. The instrument status is set to INVALID
+      # with the reason `revoked_by_merchant`. The instrument record is
+      # retained for audit purposes.
+      # @param [String] instrument_id Pattern: ^(src_)[a-z0-9]{26}$
+      def revoke(instrument_id)
+        api_client.invoke_patch(build_path(INSTRUMENTS, instrument_id, 'revoke'),
+                                sdk_authorization)
+      end
     end
   end
 end

data/lib/checkout_sdk/issuing/add_control_group_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Request body for POST /issuing/controls/control-groups.
+    #
+    # @!attribute description
+    #   @return [String]
+    # @!attribute target_id
+    #   @return [String] Card / cardholder / account / profile id.
+    # @!attribute fail_if
+    #   @return [String] Control-group condition (e.g. "all", "any").
+    # @!attribute controls
+    #   @return [Array<Hash>] Array of card controls.
+    class AddControlGroupRequest
+      attr_accessor :description, :target_id, :fail_if, :controls
+    end
+  end
+end

data/lib/checkout_sdk/issuing/add_control_profile_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Request body for POST /issuing/controls/control-profiles.
+    #
+    # @!attribute name
+    #   @return [String] Required.
+    class AddControlProfileRequest
+      attr_accessor :name
+    end
+  end
+end

data/lib/checkout_sdk/issuing/cardholder_access_token_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Form-encoded body for POST /issuing/access/connect/token.
+    # The api_client encodes this as application/x-www-form-urlencoded.
+    #
+    # @!attribute grant_type
+    #   @return [String] Must be "client_credentials".
+    # @!attribute client_id
+    #   @return [String] Access key ID.
+    # @!attribute client_secret
+    #   @return [String] Access key secret.
+    # @!attribute cardholder_id
+    #   @return [String] The cardholder's unique identifier (e.g. "crh_...").
+    # @!attribute single_use
+    #   @return [Boolean] Whether the request is for a single-use token.
+    class CardholderAccessTokenRequest
+      attr_accessor :grant_type, :client_id, :client_secret, :cardholder_id, :single_use
+
+      def initialize
+        @grant_type = 'client_credentials'
+      end
+    end
+  end
+end

data/lib/checkout_sdk/issuing/create_dispute_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Request body for POST /issuing/disputes.
+    #
+    # @!attribute transaction_id
+    #   @return [String]
+    # @!attribute reason
+    #   @return [String]
+    # @!attribute evidence
+    #   @return [Array<Hash>]
+    # @!attribute amount
+    #   @return [Numeric]
+    # @!attribute presentment_message_id
+    #   @return [String]
+    # @!attribute justification
+    #   @return [String]
+    class CreateDisputeRequest
+      attr_accessor :transaction_id, :reason, :evidence, :amount,
+                    :presentment_message_id, :justification
+    end
+  end
+end

data/lib/checkout_sdk/issuing/escalate_dispute_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Request body for POST /issuing/disputes/{disputeId}/escalate.
+    #
+    # @!attribute additional_evidence
+    #   @return [Array<Hash>]
+    # @!attribute amount
+    #   @return [Numeric]
+    # @!attribute reason_change
+    #   @return [String]
+    # @!attribute justification
+    #   @return [String] Required.
+    class EscalateDisputeRequest
+      attr_accessor :additional_evidence, :amount, :reason_change, :justification
+    end
+  end
+end