checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/issuing/update_cardholder_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Issuing
+    # Request body for PATCH /issuing/cardholders/{cardholderId}.
+    # Maps swagger `update-cardholder-request`.
+    #
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute middle_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [String] ISO-8601 date.
+    # @!attribute phone_number
+    #   @return [IssuingPhoneNumber]
+    # @!attribute email
+    #   @return [String] Email address (rfc6530). Max 254 characters.
+    # @!attribute billing_address
+    #   @return [IssuingAddress]
+    # @!attribute residency_address
+    #   @return [IssuingAddress]
+    class UpdateCardholderRequest
+      attr_accessor :first_name, :middle_name, :last_name, :date_of_birth,
+                    :phone_number, :email, :billing_address, :residency_address
+    end
+  end
+end

data/lib/checkout_sdk/issuing/update_control_profile_request.rb

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

data/lib/checkout_sdk/metadata/metadata_client.rb

@@ -10,7 +10,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
       end
 
       # @param [Hash, MetadataRequest] metadata_request

data/lib/checkout_sdk/metadata/source/bin_metadata_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :bin
 
       def initialize
-        super MetadataSourceType::BIN
+        super(MetadataSourceType::BIN)
       end
     end
   end

data/lib/checkout_sdk/metadata/source/card_metadata_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :number
 
       def initialize
-        super MetadataSourceType::CARD
+        super(MetadataSourceType::CARD)
       end
     end
   end

data/lib/checkout_sdk/metadata/source/id_metadata_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :id
 
       def initialize
-        super MetadataSourceType::ID
+        super(MetadataSourceType::ID)
       end
     end
   end

data/lib/checkout_sdk/metadata/source/token_metadata_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :token
 
       def initialize
-        super MetadataSourceType::TOKEN
+        super(MetadataSourceType::TOKEN)
       end
     end
   end

data/lib/checkout_sdk/network_tokens/network_token_cryptogram_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module NetworkTokens
+    # Request body for POST /network-tokens/{network_token_id}/cryptograms.
+    #
+    # @!attribute transaction_type
+    #   @return [String] One of "ecom", "recurring", "pos", "aft".
+    class NetworkTokenCryptogramRequest
+      attr_accessor :transaction_type
+    end
+  end
+end

data/lib/checkout_sdk/network_tokens/network_token_source_card.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module NetworkTokens
+    # Card-based source for provisioning a network token. Set `type = "card"`.
+    #
+    # @!attribute type
+    #   @return [String] Always "card".
+    # @!attribute number
+    #   @return [String] The card number.
+    # @!attribute cvv
+    #   @return [String]
+    # @!attribute expiry_month
+    #   @return [String] 1- or 2-digit month.
+    # @!attribute expiry_year
+    #   @return [String] Four-digit year.
+    class NetworkTokenSourceCard
+      attr_accessor :type, :number, :cvv, :expiry_month, :expiry_year
+
+      def initialize
+        @type = 'card'
+      end
+    end
+  end
+end

data/lib/checkout_sdk/network_tokens/network_token_source_id.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module NetworkTokens
+    # Existing-instrument source for provisioning a network token. Set `type = "id"`.
+    #
+    # @!attribute type
+    #   @return [String] Always "id".
+    # @!attribute id
+    #   @return [String] The source instrument id (e.g. "src_...").
+    class NetworkTokenSourceId
+      attr_accessor :type, :id
+
+      def initialize
+        @type = 'id'
+      end
+    end
+  end
+end

data/lib/checkout_sdk/network_tokens/network_tokens.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/network_tokens/network_token_source_card'
+require 'checkout_sdk/network_tokens/network_token_source_id'
+require 'checkout_sdk/network_tokens/provision_network_token_request'
+require 'checkout_sdk/network_tokens/network_token_cryptogram_request'
+require 'checkout_sdk/network_tokens/network_tokens_client'

data/lib/checkout_sdk/network_tokens/network_tokens_client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module NetworkTokens
+    # Client for the Network Tokens API.
+    class NetworkTokensClient < Client
+      NETWORK_TOKENS = 'network-tokens'
+      CRYPTOGRAMS = 'cryptograms'
+      DELETE = 'delete'
+      private_constant :NETWORK_TOKENS, :CRYPTOGRAMS, :DELETE
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+      end
+
+      # Provision a Network Token.
+      # @param [Hash, ProvisionNetworkTokenRequest] provision_request
+      def provision_network_token(provision_request)
+        api_client.invoke_post(NETWORK_TOKENS, sdk_authorization, provision_request)
+      end
+
+      # Retrieve a Network Token.
+      # @param [String] network_token_id
+      def get_network_token(network_token_id)
+        api_client.invoke_get(build_path(NETWORK_TOKENS, network_token_id), sdk_authorization)
+      end
+
+      # Request a fresh cryptogram for a Network Token (for SCA / fresh payment flows).
+      # @param [String] network_token_id
+      # @param [Hash, NetworkTokenCryptogramRequest] cryptogram_request
+      def request_cryptograms(network_token_id, cryptogram_request = nil)
+        api_client.invoke_post(
+          build_path(NETWORK_TOKENS, network_token_id, CRYPTOGRAMS),
+          sdk_authorization,
+          cryptogram_request
+        )
+      end
+
+      # Soft-delete a Network Token. The API uses PATCH on .../delete.
+      # @param [String] network_token_id
+      def delete_network_token(network_token_id)
+        api_client.invoke_patch(
+          build_path(NETWORK_TOKENS, network_token_id, DELETE),
+          sdk_authorization
+        )
+      end
+    end
+  end
+end

data/lib/checkout_sdk/network_tokens/provision_network_token_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module NetworkTokens
+    # Request body for POST /network-tokens.
+    # `source` must be either a NetworkTokenSourceCard or a NetworkTokenSourceId.
+    #
+    # @!attribute source
+    #   @return [NetworkTokenSourceCard, NetworkTokenSourceId]
+    class ProvisionNetworkTokenRequest
+      attr_accessor :source
+    end
+  end
+end

data/lib/checkout_sdk/oauth_access_token.rb

@@ -3,17 +3,22 @@
 module CheckoutSdk
   # @!attribute token
   #   @return [String]
+  # @!attribute token_type
+  #   @return [String]
   # @!attribute expiration_date
   #   @return [Time]
   class OAuthAccessToken
     attr_accessor :token,
+                  :token_type,
                   :expiration_date
 
     # @param [String] token
+    # @param [String] token_type
     # @param [Time] expiration_date
     # @return [OAuthAccessToken]
-    def initialize(token, expiration_date)
+    def initialize(token, token_type, expiration_date)
       @token = token
+      @token_type = token_type
       @expiration_date = expiration_date
     end
 

data/lib/checkout_sdk/oauth_scopes.rb

@@ -3,6 +3,7 @@
 module CheckoutSdk
   module OAuthScopes
     VAULT = 'vault'
+    VAULT_APME_ENROLLMENT = 'vault:apme-enrollment'
     VAULT_INSTRUMENTS = 'vault:instruments'
     VAULT_TOKENIZATION = 'vault:tokenization'
     GATEWAY = 'gateway'
@@ -47,5 +48,8 @@ module CheckoutSdk
     ISSUING_CARD_MGMT = 'issuing:card-mgmt'
     ISSUING_CONTROLS_READ = 'issuing:controls-read'
     ISSUING_CONTROLS_WRITE = 'issuing:controls-write'
+    FORWARD = 'forward'
+    FORWARD_SECRETS = 'forward:secrets'
+    IDENTITY_VERIFICATION = 'identity-verification'
   end
 end

data/lib/checkout_sdk/oauth_sdk_credentials.rb

@@ -59,9 +59,9 @@ module CheckoutSdk
       return @access_token unless @access_token.nil? || @access_token.token.nil? || !@access_token.valid?
 
       data = {
+        grant_type: 'client_credentials',
         client_id: @client_id,
         client_secret: @client_secret,
-        grant_type: 'client_credentials',
         scope: @scopes.join(' ')
       }
 
@@ -81,6 +81,7 @@ module CheckoutSdk
         oauth_response = JSON.parse(response.body, object_class: OpenStruct)
 
         @access_token = OAuthAccessToken.new(oauth_response.access_token,
+                                             oauth_response.token_type,
                                              Time.now + oauth_response.expires_in)
       end
 

data/lib/checkout_sdk/onboarding_simulator/onboarding_simulator.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/onboarding_simulator/simulator_entity_status'
+require 'checkout_sdk/onboarding_simulator/simulator_set_requirements_due_request'
+require 'checkout_sdk/onboarding_simulator/simulator_set_status_request'
+require 'checkout_sdk/onboarding_simulator/onboarding_simulator_client'

data/lib/checkout_sdk/onboarding_simulator/onboarding_simulator_client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module OnboardingSimulator
+    # Client for the Onboarding Simulator API (Sandbox only).
+    #
+    # All endpoints require OAuth with the `accounts` scope. Calling these
+    # endpoints in Production returns 404.
+    class OnboardingSimulatorClient < Client
+      SIMULATE = 'simulate'
+      ENTITIES = 'entities'
+      REQUIREMENTS_DUE = 'requirements-due'
+      SCENARIOS = 'scenarios'
+      STATUS = 'status'
+      private_constant :SIMULATE, :ENTITIES, :REQUIREMENTS_DUE, :SCENARIOS, :STATUS
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
+      end
+
+      # Marks the specified requirement fields as due on an entity.
+      # @param [String] entity_id
+      # @param [Hash, SimulatorSetRequirementsDueRequest] request
+      def set_requirements_due(entity_id, request)
+        api_client.invoke_post(
+          build_path(SIMULATE, ENTITIES, entity_id, REQUIREMENTS_DUE),
+          sdk_authorization,
+          request
+        )
+      end
+
+      # Executes a pre-defined scenario against an entity.
+      # @param [String] entity_id
+      # @param [String] scenario_id
+      def run_scenario(entity_id, scenario_id)
+        api_client.invoke_post(
+          build_path(SIMULATE, ENTITIES, entity_id, SCENARIOS, scenario_id),
+          sdk_authorization
+        )
+      end
+
+      # Forces the entity to the specified status.
+      # @param [String] entity_id
+      # @param [Hash, SimulatorSetStatusRequest] request
+      def set_entity_status(entity_id, request)
+        api_client.invoke_post(
+          build_path(SIMULATE, ENTITIES, entity_id, STATUS),
+          sdk_authorization,
+          request
+        )
+      end
+
+      # Returns all requirement fields that can be set as due on an entity.
+      def list_available_requirements
+        api_client.invoke_get(
+          build_path(SIMULATE, REQUIREMENTS_DUE),
+          sdk_authorization
+        )
+      end
+
+      # Returns all pre-defined scenarios available.
+      def list_scenarios
+        api_client.invoke_get(
+          build_path(SIMULATE, SCENARIOS),
+          sdk_authorization
+        )
+      end
+    end
+  end
+end

data/lib/checkout_sdk/onboarding_simulator/simulator_entity_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module OnboardingSimulator
+    # Statuses accepted by POST /simulate/entities/{entityId}/status.
+    module SimulatorEntityStatus
+      DRAFT = 'draft'
+      REQUIREMENTS_DUE = 'requirements_due'
+      PENDING = 'pending'
+      ACTIVE = 'active'
+      RESTRICTED = 'restricted'
+      REJECTED = 'rejected'
+      INACTIVE = 'inactive'
+    end
+  end
+end

data/lib/checkout_sdk/onboarding_simulator/simulator_set_requirements_due_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module OnboardingSimulator
+    # Request body for POST /simulate/entities/{entityId}/requirements-due.
+    #
+    # @!attribute fields
+    #   @return [Array(String)] Requirement field paths to mark as due
+    #     (e.g. ["individual.identification.document"]).
+    class SimulatorSetRequirementsDueRequest
+      attr_accessor :fields
+    end
+  end
+end

data/lib/checkout_sdk/onboarding_simulator/simulator_set_status_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module OnboardingSimulator
+    # Request body for POST /simulate/entities/{entityId}/status.
+    #
+    # @!attribute status
+    #   @return [String] {SimulatorEntityStatus}
+    class SimulatorSetStatusRequest
+      attr_accessor :status
+    end
+  end
+end

data/lib/checkout_sdk/payment_methods/payment_methods.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/payment_methods/payment_methods_query'
+require 'checkout_sdk/payment_methods/payment_methods_client'

data/lib/checkout_sdk/payment_methods/payment_methods_client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module PaymentMethods
+    # Client for the Payment Methods configuration API.
+    # GET /payment-methods returns the configured payment methods for a processing channel.
+    class PaymentMethodsClient < Client
+      PAYMENT_METHODS = 'payment-methods'
+      private_constant :PAYMENT_METHODS
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+      end
+
+      # Get available payment methods.
+      # @param [Hash, PaymentMethodsQuery] payment_methods_query
+      def get_payment_methods(payment_methods_query)
+        api_client.invoke_get(PAYMENT_METHODS, sdk_authorization, payment_methods_query)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payment_methods/payment_methods_query.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module PaymentMethods
+    # Query params for GET /payment-methods.
+    #
+    # @!attribute processing_channel_id
+    #   @return [String] (required) Pattern: ^(pc)_(\w{26})$
+    class PaymentMethodsQuery
+      attr_accessor :processing_channel_id
+    end
+  end
+end

data/lib/checkout_sdk/payments/apple_pay/apple_pay_certificate_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /applepay/certificates.
+    #
+    # @!attribute content
+    #   @return [String] PEM-encoded certificate content.
+    class ApplePayCertificateRequest
+      attr_accessor :content
+    end
+  end
+end

data/lib/checkout_sdk/payments/apple_pay/apple_pay_client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Client for the Apple Pay endpoints.
+    class ApplePayClient < Client
+      APPLEPAY = 'applepay'
+      CERTIFICATES = 'certificates'
+      ENROLLMENTS = 'enrollments'
+      SIGNING_REQUESTS = 'signing-requests'
+      private_constant :APPLEPAY, :CERTIFICATES, :ENROLLMENTS, :SIGNING_REQUESTS
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::PUBLIC_KEY)
+      end
+
+      # Upload a payment processing certificate. Public key auth per swagger.
+      # @param [Hash, ApplePayCertificateRequest] certificate_request
+      def upload_certificate(certificate_request)
+        api_client.invoke_post(build_path(APPLEPAY, CERTIFICATES),
+                               sdk_authorization,
+                               certificate_request)
+      end
+
+      # Enroll a domain to the Apple Pay Service. OAuth required.
+      # @param [Hash, ApplePayEnrollmentRequest] enrollment_request
+      def enroll_domain(enrollment_request)
+        api_client.invoke_post(build_path(APPLEPAY, ENROLLMENTS),
+                               sdk_authorization(CheckoutSdk::AuthorizationType::OAUTH),
+                               enrollment_request)
+      end
+
+      # Generate a certificate signing request. Public key auth per swagger.
+      # @param [Hash, ApplePaySigningRequest] signing_request
+      def generate_signing_request(signing_request)
+        api_client.invoke_post(build_path(APPLEPAY, SIGNING_REQUESTS),
+                               sdk_authorization,
+                               signing_request)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/apple_pay/apple_pay_enrollment_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /applepay/enrollments.
+    #
+    # @!attribute domain
+    #   @return [String] Domain to enroll with Apple Pay.
+    class ApplePayEnrollmentRequest
+      attr_accessor :domain
+    end
+  end
+end

data/lib/checkout_sdk/payments/apple_pay/apple_pay_signing_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /applepay/signing-requests.
+    #
+    # @!attribute protocol_version
+    #   @return [String] CSR protocol version.
+    class ApplePaySigningRequest
+      attr_accessor :protocol_version
+    end
+  end
+end

data/lib/checkout_sdk/payments/applepay.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute store_payment_details
+    #   @return [String] {StorePaymentDetailsType}
+    class Applepay
+      attr_accessor :account_holder,
+                    :store_payment_details
+    end
+  end
+end

data/lib/checkout_sdk/payments/base_payments_client.rb

@@ -51,6 +51,25 @@ module CheckoutSdk
                                reverse_request,
                                idempotency_key)
       end
+
+      # Search payments. POST /payments/search.
+      # @param [Hash, PaymentsSearchRequest] search_request
+      def search_payments(search_request)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, 'search'),
+                               sdk_authorization,
+                               search_request)
+      end
+
+      # Cancel a scheduled retry. POST /payments/{id}/cancellations.
+      # @param [String] payment_id
+      # @param [Hash, CancellationRequest] cancellation_request
+      # @param [String, nil] idempotency_key
+      def cancel_payment(payment_id, cancellation_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'cancellations'),
+                               sdk_authorization,
+                               cancellation_request,
+                               idempotency_key)
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/cancellation_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /payments/{id}/cancellations.
+    #
+    # @!attribute reference
+    #   @return [String] Optional merchant reference (max 80 chars).
+    class CancellationRequest
+      attr_accessor :reference
+    end
+  end
+end

data/lib/checkout_sdk/payments/{sessions/card.rb → card.rb}

@@ -2,10 +2,13 @@
 
 module CheckoutSdk
   module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     # @!attribute store_payment_details
     #   @return [String] {StorePaymentDetailsType}
     class Card
-      attr_accessor :store_payment_details
+      attr_accessor :account_holder,
+                    :store_payment_details
     end
   end
 end

data/lib/checkout_sdk/payments/contexts/payment_contexts_client.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
       end
 
       # @param [Hash] payment_contexts

data/lib/checkout_sdk/payments/destination/bank_account_destination.rb

@@ -35,7 +35,7 @@ module CheckoutSdk
                     :bank
 
       def initialize
-        super CheckoutSdk::Payments::DestinationType::BANK_ACCOUNT
+        super(CheckoutSdk::Payments::DestinationType::BANK_ACCOUNT)
       end
     end
   end

data/lib/checkout_sdk/payments/destination/card_destination.rb

@@ -17,7 +17,7 @@ module CheckoutSdk
                     :account_holder
 
       def initialize
-        super CheckoutSdk::Payments::DestinationType::CARD
+        super(CheckoutSdk::Payments::DestinationType::CARD)
       end
     end
   end