apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/apis/payment_instrument_api.rb

@@ -0,0 +1,768 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # PaymentInstrumentApi
+  class PaymentInstrumentApi < BaseApi
+    # Get Payment Instrument Details
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account whose payment instrument is being
+    # retrieved.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument to retrieve details
+    # for.
+    # @param [String] baa_s_version Optional parameter: The BaaS API version to
+    # use for the request. Supported values: "1.0" or "2.0".
+    # @param [String] extend Optional parameter: Optional. If set to
+    # "privatePaymentInstrumentData", includes sensitive payment instrument data
+    # in the response.
+    # @param [String] usage Optional parameter: Optional. Specifies the intended
+    # usage context for the payment instrument. Expected values: "cardholder" or
+    # "partner".
+    # @param [String] pci_data Optional parameter: Optional. Comma-separated
+    # list of PCI data fields to include in the response. Supported values:
+    # "pan", "cvv", "exp".
+    # @param [String] ip_address Optional parameter: Optional. The IPv4 or IPv6
+    # address of the client making the request.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payment_instrument(x_gd_request_id,
+                               program_code,
+                               account_identifier,
+                               payment_instrument_identifier,
+                               baa_s_version: nil,
+                               extend: nil,
+                               usage: nil,
+                               pci_data: nil,
+                               ip_address: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(baa_s_version, key: 'BaaS-Version'))
+                   .query_param(new_parameter(extend, key: 'extend'))
+                   .query_param(new_parameter(usage, key: 'usage'))
+                   .query_param(new_parameter(pci_data, key: 'pciData'))
+                   .query_param(new_parameter(ip_address, key: 'ipAddress'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetPaymentInstrumentResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetPaymentInstrumentResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetPaymentInstrumentResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetPaymentInstrumentResponseErrorException))
+        .execute
+    end
+
+    # Set and Reset an ATM Pin This endpoint gives the partner the ability to
+    # update the ATM pin data of a payment instrument.
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @param [SetPinRequestEncrypted] body Optional parameter: The request
+    # object containing the encrypted PIN and related data.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def set_pin(x_gd_request_id,
+                program_code,
+                account_identifier,
+                payment_instrument_identifier,
+                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SetPinResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 SetPinResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 SetPinResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 SetPinResponseErrorException))
+        .execute
+    end
+
+    # Retrieves a List of Payment Instruments for a Specific Account
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account whose payment instruments are being
+    # retrieved.
+    # @param [String] user_identifier Optional parameter: Optional. Unique
+    # identifier for the user to filter payment instruments.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payment_instrument_list(x_gd_request_id,
+                                    program_code,
+                                    account_identifier,
+                                    user_identifier: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(user_identifier, key: 'userIdentifier'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetPaymentInstrumentListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetPaymentInstrumentListResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetPaymentInstrumentListResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetPaymentInstrumentListResponseErrorException))
+        .execute
+    end
+
+    # Create a New Payment Instrument This endpoint may be called after an
+    # enrollment is cured using the kycGates/IDV endpoint.
+    # If the parameter "upgradeFlag" is true,it will be upgrade flow.It should
+    # insert new product terms, update the history data, send webhook and return
+    # upgrade success when upgrade success.
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [CompleteRegistrationRequest] body Optional parameter: The request
+    # object containing registration details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def complete_registration(x_gd_request_id,
+                              program_code,
+                              account_identifier,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CompleteRegistrationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 CompleteRegistrationResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 CompleteRegistrationResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 CompleteRegistrationResponseErrorException))
+        .execute
+    end
+
+    # Verify ATM Pin for Payment Instrument
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @param [VerifyPinRequestEncrypted] body Optional parameter: The request
+    # object containing the encrypted PIN to verify.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def verify_pin(x_gd_request_id,
+                   program_code,
+                   account_identifier,
+                   payment_instrument_identifier,
+                   body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/verifyPin',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(VerifyPinResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 VerifyPinResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 VerifyPinResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 VerifyPinResponseErrorException))
+        .execute
+    end
+
+    # Validate Card CVV
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [ValidateCardRequestEncrypted] body Optional parameter: The request
+    # object containing encrypted card data for validation.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def validate_card(x_gd_request_id,
+                      program_code,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/validateCard',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ValidateCardResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ValidateCardResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ValidateCardResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 ValidateCardResponseErrorException))
+        .execute
+    end
+
+    # Activate a Card This endpoint gives the partner the ability to activate a
+    # card, if the customer (user) has the PAN, Expiration Date, and CVV. Once
+    # activated, the payment instrument identifier is returned. Also, the pan
+    # must be exactly 16 digits for the card to be activated. Things to
+    # Remember:
+    # * There are no limits on activateCard attempts.
+    # * If there is more than one “notActivated” Payment Instrument, when a
+    # newer Payment Instrument is “activated”, all older “notActivated” Payment
+    # Instruments will be set to “deactivated”.
+    # * Partners who accept Matricula Identification will be allowed to use the
+    # last four digits of the ID to activate a customer’s payment instrument(s)
+    # (cards). This allows the successful activation of their payment instrument
+    # and validation of their card verification value (CVV).
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [ActivateCardRequestEncrypted] body Optional parameter: The request
+    # object containing encrypted card activation data.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def activate_card_via_account_identifier(x_gd_request_id,
+                                             program_code,
+                                             account_identifier,
+                                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/activateCard',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ActivateCardResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ActivateCardResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ActivateCardResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 ActivateCardResponseErrorException))
+        .execute
+    end
+
+    # Activate Card via Payment Instrument Identifier
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @param [ActivateCardWithIdentifierRequest] body Optional parameter: The
+    # request object containing encrypted card activation data.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def activate_card_via_payment_instrument_identifier(x_gd_request_id,
+                                                        program_code,
+                                                        account_identifier,
+                                                        payment_instrument_identifier,
+                                                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/ActivateCard',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ActivateCardResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ActivateCardResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ActivateCardResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 ActivateCardResponseErrorException))
+        .execute
+    end
+
+    # Activate Card for Pre-Login
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [ActivateCardRequestEncrypted] body Optional parameter: The request
+    # object containing encrypted card activation data for pre-login.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def activate_card_for_prelogin(x_gd_request_id,
+                                   program_code,
+                                   account_identifier,
+                                   body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/activatecardforprelogin',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ActivateCardResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ActivateCardResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ActivateCardResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 ActivateCardResponseErrorException))
+        .execute
+    end
+
+    # Update Lifecycle Event
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @param [UpdatePaymentInstrumentRequest] body Optional parameter: The
+    # request object containing lifecycle event details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_payment_instrument(x_gd_request_id,
+                                  program_code,
+                                  account_identifier,
+                                  payment_instrument_identifier,
+                                  body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/lifecycleEvent',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdatePaymentInstrumentResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdatePaymentInstrumentResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdatePaymentInstrumentResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdatePaymentInstrumentResponseErrorException))
+        .execute
+    end
+
+    # Get Delivery Status
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_mail_tracking_info(x_gd_request_id,
+                               program_code,
+                               account_identifier,
+                               payment_instrument_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/deliveryStatus',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TrackMyMailResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 TrackMyMailResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 TrackMyMailResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 TrackMyMailResponseErrorException))
+        .execute
+    end
+
+    # Get Replace Card Eligibility
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [String] account_identifier Required parameter: Unique identifier
+    # (UID or GUID) for the account.
+    # @param [String] payment_instrument_identifier Required parameter: Unique
+    # identifier (UID or GUID) for the payment instrument.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def replace_card_eligibility(x_gd_request_id,
+                                 program_code,
+                                 account_identifier,
+                                 payment_instrument_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/replaceCardEligibility',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReplaceCardEligibilityResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ReplaceCardEligibilityResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ReplaceCardEligibilityResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 ReplaceCardEligibilityResponseErrorException))
+        .execute
+    end
+
+    # Validate Card CVV
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # for tracking the request, provided in the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the account.
+    # @param [GetPreloginValidationRequest] body Optional parameter: The request
+    # object containing encrypted card data for pre-login validation.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_prelogin_validation(x_gd_request_id,
+                                program_code,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/getpreloginvalidation',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetPreloginValidationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetPreloginValidationResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetPreloginValidationResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetPreloginValidationResponseErrorException))
+        .execute
+    end
+
+    # Create wallet OnePay
+    # @param [String] x_gd_request_id Required parameter: TODO: type description
+    # here
+    # @param [String] program_code Required parameter: TODO: type description
+    # here
+    # @param [String] account_identifier Required parameter: TODO: type
+    # description here
+    # @param [String] payment_instrument_identifier Required parameter: TODO:
+    # type description here
+    # @param [CreateWalletPushProvisionRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_wallet_push_provision(x_gd_request_id,
+                                     program_code,
+                                     account_identifier,
+                                     payment_instrument_identifier,
+                                     body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/pushProvisionData/onepay',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_instrument_identifier, key: 'paymentInstrumentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json-patch+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('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateWalletPushProvisionResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 CreateWalletPushProvisionResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 CreateWalletPushProvisionResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 CreateWalletPushProvisionResponseErrorException))
+        .execute
+    end
+  end
+end