apimatic-cp-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 167bee40294a08e1b16d78e5f7ad38beacf1caac8a95e59ebfb20ee7565a67a4
+  data.tar.gz: 7b9586af540a9a7ef14ec73e391b853f828801a087c7339b95b71ded605d4566
+SHA512:
+  metadata.gz: b3095dec4714f6fd8b940b270749e45b1399c94594f60b809f9559ad8a8e83f48dbe1c47838f798cc0e8130182cc09bf7f47101ede372d7202fc2048fb228bb9
+  data.tar.gz: '0812e8e68f94d8b1b98244e449e3ff417ee2c534bead530add3f84b6df0eb9e2b240ef7c45551f1a1c278e30571be36e5bb27380fcd0af4fa004a6c86949fee8'

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,178 @@
+
+# Getting Started with CellPoint API
+
+## Introduction
+
+Service for interacting with CellPoint Digital's Payment Orchestration Platform (POP).
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-cp-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-cp-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-cp-sdk gem](https://rubygems.org/gems/apimatic-cp-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'cell_point_api'
+include CellPointApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/cell_point_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| cpd_issued_jwt_credentials | [`CpdIssuedJwtCredentials`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| merchant_issued_jwt_credentials | [`MerchantIssuedJwtCredentials`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'cell_point_api'
+include CellPointApi
+
+client = Client.new(
+  cpd_issued_jwt_credentials: CpdIssuedJwtCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_client_secret: 'OAuthClientSecret',
+    oauth_scopes: [
+      OauthScopeCpdIssuedJwt::BUYER,
+      OauthScopeCpdIssuedJwt::DASHBOARDSVIEW
+    ]
+  ),
+  merchant_issued_jwt_credentials: MerchantIssuedJwtCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'cell_point_api'
+include CellPointApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`cpdIssuedJWT (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)
+* [`merchantIssuedJWT (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Apple Pay](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/apple-pay.md)
+* [Payment Methods](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/payment-methods.md)
+* [Authentication](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/authentication.md)
+* [Bulk](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/bulk.md)
+* [Cards](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/cards.md)
+* [Notes](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/notes.md)
+* [Orders](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/orders.md)
+* [Proxy](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/proxy.md)
+* [Transactions](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/transactions.md)
+* [Wallet](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/controllers/wallet.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-cp-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'cell_point_api'
+
+puts 'CellPointApi SDK loaded!'
+puts 'You can now create a client with: client = CellPointApi::Client.new'
+puts 'Or use from_env: client = CellPointApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/cell_point_api/api_helper.rb

@@ -0,0 +1,10 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/cell_point_api/apis/apple_pay_api.rb

@@ -0,0 +1,51 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # ApplePayApi
+  class ApplePayApi < BaseApi
+    # Stores an Apple Pay token for later use.
+    # @param [String] order_id Required parameter: The order to store the Apple
+    # Pay token against.
+    # @param [UUID | String] idempotency_key Optional parameter: A unique
+    # identifier.  If you don't receive a response (for example, in case of a
+    # timeout), you can safely retry the request with the same header.  If the
+    # system already processed the request, the response to the first attempt
+    # will be returned without duplication.  Idempotency-Keys will last for
+    # 24hrs. After this time, please do a GET call to the resource to check the
+    # status.  > This is used only in `POST` requests, so they have the same
+    # idempotency guarantees as `PUT`.
+    # @param [SavePkPaymentTokenRequest] body Optional parameter: RequestBody
+    # containing the encrypted Apple Pay token.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def apple_pay_store_encrypted_token(order_id,
+                                        idempotency_key: nil,
+                                        body: nil)
+      warn 'Endpoint apple_pay_store_encrypted_token in ApplePayApi is depreca'\
+           'ted'
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments/v1/orders/{orderId}/apple-pay-tokens',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AppleTokenizedToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException))
+        .execute
+    end
+  end
+end

data/lib/cell_point_api/apis/authentication_api.rb

@@ -0,0 +1,81 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # AuthenticationApi
+  class AuthenticationApi < BaseApi
+    # Retrieve an Access Token for desired scope using Private Key JWT Flow.
+    # Prerequisites for Private Key JWT Flow:
+    # 1. CellPoint must be configured to use merchant's `jwks` (JSON Web Key
+    # Set) endpoint to validate Private JWT.
+    # ***Flow Diagram***
+    # ![diagram_001](media/diagram_001.png)
+    # For more details, see Authorizations for this endpoint below:
+    # @param [String] grant_type Optional parameter: The type of grant
+    # requested. This must be `client_credentials`.
+    # @param [String] client_assertion_type Optional parameter: The type of
+    # client assertion. This must be
+    # `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
+    # @param [String] client_id Optional parameter: The client ID, as provided
+    # by Cellpoint.
+    # @param [Audience] audience Optional parameter: The intended audience for
+    # the client assertion.
+    # @param [String] scope Optional parameter: The requested permissions for
+    # the client. A space separated list of permissions.
+    # @param [String] client_assertion Optional parameter: A JWT signed by the
+    # caller. The JWT must contain the following claims: - `iss`: The client ID,
+    # as provided by Cellpoint. - `sub`: The client ID, as provided by
+    # Cellpoint. - `aud`: The appropriate auth server, example:
+    # https://auth.api.test.cellpoint.app/
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_access_token(grant_type: nil,
+                         client_assertion_type: nil,
+                         client_id: nil,
+                         audience: nil,
+                         scope: nil,
+                         client_assertion: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/oauth2/token',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(grant_type, key: 'grant_type'))
+                   .form_param(new_parameter(client_assertion_type, key: 'client_assertion_type'))
+                   .form_param(new_parameter(client_id, key: 'client_id'))
+                   .form_param(new_parameter(audience, key: 'audience'))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .form_param(new_parameter(client_assertion, key: 'client_assertion'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('merchantIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TokenPost200Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException)
+                    .local_error('401',
+                                 'Authorization Required',
+                                 APIException)
+                    .local_error('404',
+                                 'Resource Not Found',
+                                 APIException)
+                    .local_error('406',
+                                 'Cannot generate content acceptable according to the `Accept`'\
+                                  ' headers in the request',
+                                 ProblemException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ProblemException)
+                    .local_error('502',
+                                 'Bad Gateway',
+                                 APIException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/cell_point_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/cell_point_api/apis/bulk_api.rb

@@ -0,0 +1,93 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # BulkApi
+  class BulkApi < BaseApi
+    # Get summary information about a bulk.
+    # @param [String] bulk_id Required parameter: Bulk to retrieve
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_bulk_by_id(bulk_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payments/v1/bulks/{bulkId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(bulk_id, key: 'bulkId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Summary.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException)
+                    .local_error('401',
+                                 'Authorization Required',
+                                 APIException)
+                    .local_error('404',
+                                 'Resource Not Found',
+                                 APIException)
+                    .local_error('406',
+                                 'Cannot generate content acceptable according to the `Accept`'\
+                                  ' headers in the request',
+                                 ProblemException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ProblemException)
+                    .local_error('502',
+                                 'Bad Gateway',
+                                 APIException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 APIException))
+        .execute
+    end
+
+    # Trigger a bulk.
+    # @param [TriggerBulkRequest] request Required parameter: Bulk request to
+    # trigger.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def trigger_bulk(request)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments/v1/bulks',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(request, key: 'request')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentsV1BulksResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException)
+                    .local_error('401',
+                                 'Authorization Required',
+                                 APIException)
+                    .local_error('404',
+                                 'Resource Not Found',
+                                 APIException)
+                    .local_error('406',
+                                 'Cannot generate content acceptable according to the `Accept`'\
+                                  ' headers in the request',
+                                 ProblemException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ProblemException)
+                    .local_error('502',
+                                 'Bad Gateway',
+                                 APIException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/cell_point_api/apis/cards_api.rb

@@ -0,0 +1,104 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # CardsApi
+  class CardsApi < BaseApi
+    # Tokenize a card to use for a later authorization.
+    # Tokenization is useful to prevent other parts system from having to
+    # interact with PCI information.
+    # Tokens are single-use and will expire after 15 minutes.
+    # @param [String] order_id Required parameter: Order to retrieve the payment
+    # methods that the buyer has available to pay for it with.
+    # @param [Card] body Optional parameter: Request body containing the card
+    # details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def card_tokenize(order_id,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments/v1/orders/{orderId}/card-tokens',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TokenizedCard.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException))
+        .execute
+    end
+
+    # Tokenize an externally tokenized data to use for a later authorization.
+    # Tokenization is useful to prevent other parts system from having to
+    # interact with PCI information.
+    # Tokens are single-use and will expire after 15 minutes.
+    # Unlike the regular tokenization, this endpoint is used to tokenize data
+    # that has already been tokenized by a third party,
+    # such as a payment gateway or a wallet provider. Such data typically
+    # billing details too.
+    # This endpoint will return these billing details.
+    # @param [String] order_id Required parameter: Order to retrieve the payment
+    # methods that the buyer has available to pay for it with.
+    # @param [ExternallyTokenizedCard] body Optional parameter: Request body
+    # containing the card details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def external_card_tokenize(order_id,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments/v1/orders/{orderId}/external-card-tokens',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TokenizedCardWithContactData.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException))
+        .execute
+    end
+
+    # Lookup the card scheme via BIN data.
+    # @param [Bin] body Optional parameter: Request body containing the card
+    # BIN.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def card_scheme_lookup(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments/v1/schemes',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('cpdIssuedJWT')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentsV1SchemesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemException))
+        .execute
+    end
+  end
+end