cybersource-apimatic-sdk 0.0.1

data/lib/cyber_source_merged_spec/controllers/instrument_identifier_controller.rb

@@ -0,0 +1,494 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # InstrumentIdentifierController
+  class InstrumentIdentifierController < BaseController
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing and
+    # account number.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the Instrument Identifier
+    # Id to be used for cross-channel payment tracking.<br>An Instrument
+    # Identifier can exist independently but also be associated with a [Customer
+    # Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).<br><br>**Creating an Instrument Identifier**<br>It is recommended you
+    # [create an Instrument Identifier via a Payment
+    # Authorization](#payments_payments_process-a-payment_samplerequests-dropdow
+    # n_authorization-with-token-create_authorization-with-instrument-identifier
+    # -token-creation_liveconsole-tab-request-body), this can be for a zero
+    # amount.<br>An Instrument Identifier will also be created if you [create a
+    # Customer via a Payment
+    # Authorization](#payments_payments_process-a-payment_samplerequests-dropdow
+    # n_authorization-with-token-create_authorization-with-customer-token-creati
+    # on_liveconsole-tab-request-body)<br>In Europe: You should perform Payer
+    # Authentication alongside the
+    # Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network
+    # Tokens**<br>Network tokens perform better than regular card numbers and
+    # they are not necessarily invalidated when a cardholder loses their card,
+    # or it expires.<br>A Payment Network Token will be automatically created
+    # and used in future payments if you are enabled for the service.<br>A
+    # Payment Network Token can also be [provisioned for an existing Instrument
+    # Identifier](#token-management_instrument-identifier_enroll-an-instrument-i
+    # dentifier-for-payment-network-token).<br>For more information about
+    # Payment Network Tokens see the Developer Guide.<br><br>**Payments with
+    # Instrument Identifiers**<br>To perform a payment with an Instrument
+    # Identifier simply specify the [Instrument Identifier Id in the payments
+    # request along with the expiration date, card type, & billing
+    # address](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-instrument-identifier-token-id_l
+    # iveconsole-tab-request-body).<br>When an Instrument Identifier is used in
+    # a payment the **_previousTransactionId_** and
+    # **_originalAuthorizedAmount_** values are automatically recorded.<br>These
+    # values will be added for you to future Merchant Initiated Transaction
+    # payments.
+    # @param [PostInstrumentIdentifierRequest]
+    # post_instrument_identifier_request Required parameter: Specify either a
+    # Card, Bank Account or Enrollable Card
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @param [TrueClass | FalseClass] retrieve_bin_details Optional parameter:
+    # Retrieve the Bin Details of PAN or network token
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_instrument_identifier(post_instrument_identifier_request,
+                                   profile_id: nil,
+                                   retrieve_bin_details: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tms/v1/instrumentidentifiers',
+                                     Server::DEFAULT)
+                   .body_param(new_parameter(post_instrument_identifier_request)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .query_param(new_parameter(retrieve_bin_details, key: 'retrieveBinDetails'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PostInstrumentIdentifierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 PostInstrumentIdentifierException)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 PostInstrumentIdentifierException2Exception)
+                    .local_error('409',
+                                 'Conflict. The token is linked to a Payment Instrument.',
+                                 PostInstrumentIdentifierException3Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 PostInstrumentIdentifierException4Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 PostInstrumentIdentifierException5Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing and
+    # account number.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the Instrument Identifier
+    # Id to be used for cross-channel payment tracking.<br>An Instrument
+    # Identifier can exist independently but also be associated with a [Customer
+    # Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use
+    # this API to retrieve an Instrument Identifier.<br>**Note: the actual card
+    # data will be masked.**<br>The Instrument Identifier will also be returned
+    # when retrieving a
+    # [Customer](#token-management_customer_retrieve-a-customer), [Customer
+    # Payment
+    # Instrument](#token-management_customer-payment-instrument_retrieve-a-custo
+    # mer-payment-instrument) or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_retrieve-a-payment-instru
+    # ment).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network
+    # Tokens**<br>Network tokens perform better than regular card numbers and
+    # they are not necessarily invalidated when a cardholder loses their card,
+    # or it expires.<br>A Payment Network Token will be automatically created
+    # and used in future payments if you are enabled for the service.<br>A
+    # Payment Network Token can also be [provisioned for an existing Instrument
+    # Identifier](#token-management_instrument-identifier_enroll-an-instrument-i
+    # dentifier-for-payment-network-token).<br>For more information about
+    # Payment Network Tokens see the Developer Guide.<br><br>**Payments with
+    # Instrument Identifiers**<br>To perform a payment with an Instrument
+    # Identifier simply specify the [Instrument Identifier Id in the payments
+    # request along with the expiration date, card type, & billing
+    # address](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-instrument-identifier-token-id_l
+    # iveconsole-tab-request-body).<br>When an Instrument Identifier is used in
+    # a payment the **_previousTransactionId_** and
+    # **_originalAuthorizedAmount_** values are automatically recorded.<br>These
+    # values will be added for you to future Merchant Initiated Transaction
+    # payments.
+    # @param [String] instrument_identifier_id Required parameter: The Id of an
+    # Instrument Identifier.
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @param [TrueClass | FalseClass] retrieve_bin_details Optional parameter:
+    # Retrieve the Bin Details of PAN or network token
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_instrument_identifier(instrument_identifier_id,
+                                  profile_id: nil,
+                                  retrieve_bin_details: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tms/v1/instrumentidentifiers/{instrumentIdentifierId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(instrument_identifier_id, key: 'instrumentIdentifierId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .query_param(new_parameter(retrieve_bin_details, key: 'retrieveBinDetails'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetInstrumentIdentifierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 GetInstrumentIdentifierException)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 GetInstrumentIdentifierException2Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 GetInstrumentIdentifierException3Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 GetInstrumentIdentifierException4Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 GetInstrumentIdentifierException5Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 GetInstrumentIdentifierException6Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing and
+    # account number.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the Instrument Identifier
+    # Id to be used for cross-channel payment tracking.<br>An Instrument
+    # Identifier can exist independently but also be associated with a [Customer
+    # Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating an Instrument
+    # Identifier**<br>When an Instrument Identifier is used in a payment the
+    # **_previousTransactionId_** and **_originalAuthorizedAmount_** values are
+    # automatically recorded.<br>These values will be added for you to future
+    # Merchant Initiated Transaction payments.<br>Your system can use this API
+    # to update these values.
+    # @param [String] instrument_identifier_id Required parameter: The Id of an
+    # Instrument Identifier.
+    # @param [PatchInstrumentIdentifierRequest]
+    # patch_instrument_identifier_request Required parameter: Specify the
+    # previous transaction Id to update.
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @param [TrueClass | FalseClass] retrieve_bin_details Optional parameter:
+    # Retrieve the Bin Details of PAN or network token
+    # @param [String] if_match Optional parameter: Contains an ETag value from a
+    # GET request to make the request conditional.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def patch_instrument_identifier(instrument_identifier_id,
+                                    patch_instrument_identifier_request,
+                                    profile_id: nil,
+                                    retrieve_bin_details: nil,
+                                    if_match: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/tms/v1/instrumentidentifiers/{instrumentIdentifierId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(instrument_identifier_id, key: 'instrumentIdentifierId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_param(new_parameter(patch_instrument_identifier_request)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .query_param(new_parameter(retrieve_bin_details, key: 'retrieveBinDetails'))
+                   .header_param(new_parameter(if_match, key: 'if-match'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PatchInstrumentIdentifierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 PatchInstrumentIdentifierException)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 PatchInstrumentIdentifierException2Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 PatchInstrumentIdentifierException3Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 PatchInstrumentIdentifierException4Exception)
+                    .local_error('412',
+                                 'Precondition Failed: The If-Match request header value does'\
+                                  ' not match the current resources ETag',
+                                 PatchInstrumentIdentifierException5Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 PatchInstrumentIdentifierException6Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 PatchInstrumentIdentifierException7Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing <br>and
+    # account numbers.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the <br>Instrument
+    # Identifier Id to be used for cross-channel payment tracking.<br>An
+    # Instrument Identifier can exist independently but also be associated with
+    # a [Customer Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) <br>or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting an Instrument
+    # Identifier**<br>Your system can use this API to delete an existing
+    # Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it
+    # is linked to any Payment Instruments.<br>You can [retrieve all Payment
+    # Instruments associated with an Instrument
+    # Identifier](#token-management_instrument-identifier_list-payment-instrumen
+    # ts-for-an-instrument-identifier).
+    # @param [String] instrument_identifier_id Required parameter: The Id of an
+    # Instrument Identifier.
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_instrument_identifier(instrument_identifier_id,
+                                     profile_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/tms/v1/instrumentidentifiers/{instrumentIdentifierId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(instrument_identifier_id, key: 'instrumentIdentifierId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 DeleteInstrumentIdentifierException)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 DeleteInstrumentIdentifierException2Exception)
+                    .local_error('409',
+                                 'Conflict. The token is linked to a Payment Instrument.',
+                                 DeleteInstrumentIdentifierException3Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 DeleteInstrumentIdentifierException4Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 DeleteInstrumentIdentifierException5Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 DeleteInstrumentIdentifierException6Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing <br>and
+    # account numbers.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the <br>Instrument
+    # Identifier Id to be used for cross-channel payment tracking.<br>An
+    # Instrument Identifier can exist independently but also be associated with
+    # a [Customer Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) <br>or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Payment
+    # Instruments associated with an Instrument Identifier**<br>Your system can
+    # use this API to retrieve all Payment Instruments linked to an Instrument
+    # Identifier.
+    # @param [String] instrument_identifier_id Required parameter: The Id of an
+    # Instrument Identifier.
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @param [TrueClass | FalseClass] retrieve_bin_details Optional parameter:
+    # Retrieve the Bin Details of PAN or network token
+    # @param [Integer] offset Optional parameter: Starting record in zero-based
+    # dataset that should be returned as the first object in the array. Default
+    # is 0.
+    # @param [Integer] limit Optional parameter: The maximum number that can be
+    # returned in the array starting from the offset record in zero-based
+    # dataset. Default is 20, maximum is 100.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_instrument_identifier_payment_instruments_list(instrument_identifier_id,
+                                                           profile_id: nil,
+                                                           retrieve_bin_details: nil,
+                                                           offset: 0,
+                                                           limit: 20)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/paymentinstruments',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(instrument_identifier_id, key: 'instrumentIdentifierId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .query_param(new_parameter(retrieve_bin_details, key: 'retrieveBinDetails'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInstrumentList.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException2Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException3Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException4Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException5Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 GetInstrumentIdentifierPaymentInstrumentsListException6Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Instrument Identifiers**<br>An Instrument Identifier represents either
+    # a card number, or in the case of an ACH bank account, the routing and
+    # account number.<br>The same token Id is returned for a specific card
+    # number or bank account & routing number allowing the Instrument Identifier
+    # Id to be used for cross-channel payment tracking.<br>An Instrument
+    # Identifier can exist independently but also be associated with a [Customer
+    # Payment
+    # Instrument](#token-management_customer-payment-instrument_create-a-custome
+    # r-payment-instrument) or [Standalone Payment
+    # Instrument](#token-management_payment-instrument_create-a-payment-instrume
+    # nt).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Enroll an Instrument
+    # Identifier for a Payment Network Token**<br>Your system can use this API
+    # to provision a Network token for an existing Instrument
+    # Identifier.<br>Network tokens perform better than regular card numbers and
+    # they are not necessarily invalidated when a cardholder loses their card,
+    # or it expires.<br>A Network token can be [provisioned when creating an
+    # Instrument
+    # Identifier](#token-management_instrument-identifier_create-an-instrument-i
+    # dentifier_samplerequests-dropdown_create-instrument-identifier-card-enroll
+    # -for-network-token_liveconsole-tab-request-body).This will occur
+    # automatically when creating a
+    # [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_au
+    # thorization-with-token-create_authorization-with-customer-token-creation_l
+    # iveconsole-tab-request-body), [Payment
+    # Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_a
+    # uthorization-with-token-create_authorization-create-default-payment-instru
+    # ment-shipping-address-for-existing-customer_liveconsole-tab-request-body)
+    # or [Instrument
+    # Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_a
+    # uthorization-with-token-create_authorization-with-instrument-identifier-to
+    # ken-creation_liveconsole-tab-request-body) via the Payments API.<br>For
+    # more information about Payment Network Tokens see the Developer Guide.
+    # @param [String] instrument_identifier_id Required parameter: The Id of an
+    # Instrument Identifier.
+    # @param [PostInstrumentIdentifierEnrollmentRequest]
+    # post_instrument_identifier_enrollment_request Required parameter: Specify
+    # Enrollable Card details
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_instrument_identifier_enrollment(instrument_identifier_id,
+                                              post_instrument_identifier_enrollment_request,
+                                              profile_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/enrollment',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(instrument_identifier_id, key: 'instrumentIdentifierId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_param(new_parameter(post_instrument_identifier_enrollment_request)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 PostInstrumentIdentifierEnrollmentException)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 PostInstrumentIdentifierEnrollmentException2Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 PostInstrumentIdentifierEnrollmentException3Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 PostInstrumentIdentifierEnrollmentException4Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 PostInstrumentIdentifierEnrollmentException5Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 PostInstrumentIdentifierEnrollmentException6Exception))
+        .execute
+    end
+  end
+end

data/lib/cyber_source_merged_spec/controllers/interchange_clearing_level_details_controller.rb

@@ -0,0 +1,45 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # InterchangeClearingLevelDetailsController
+  class InterchangeClearingLevelDetailsController < BaseController
+    # Interchange Clearing Level data for an account or a merchant
+    # @param [DateTime] start_time Required parameter: Valid report Start Time
+    # in **ISO 8601 format** Please refer the following link to know more about
+    # ISO 8601 format.[Rfc Date
+    # Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor
+    # 14)  **Example date format:**   - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g.
+    # 2018-01-01T00:00:00.000Z)
+    # @param [DateTime] end_time Required parameter: Valid report End Time in
+    # **ISO 8601 format** Please refer the following link to know more about ISO
+    # 8601 format.[Rfc Date
+    # Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor
+    # 14)  **Example date format:**   - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g.
+    # 2018-01-01T00:00:00.000Z)
+    # @param [String] organization_id Optional parameter: Valid Organization
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_interchange_clearing_level_details(start_time,
+                                               end_time,
+                                               organization_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reporting/v3/interchange-clearing-level-details',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(start_time, key: 'startTime')
+                                 .is_required(true))
+                   .query_param(new_parameter(end_time, key: 'endTime')
+                                 .is_required(true))
+                   .query_param(new_parameter(organization_id, key: 'organizationId'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReportingV3InterchangeClearingLevelDetailsGet200Response.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/cyber_source_merged_spec/controllers/invoice_settings_controller.rb

@@ -0,0 +1,71 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # InvoiceSettingsController
+  class InvoiceSettingsController < BaseController
+    # Allows you to customize the payment page, the checkout experience, email
+    # communication and payer authentication. You can customize the invoice to
+    # match your brand with your business name, logo and brand colors, and a VAT
+    # Tax number. You can choose to capture the payers shipping details, phone
+    # number and email during the checkout process. You can add a custom message
+    # to all invoice emails and enable or disable payer authentication for
+    # invoice payments.
+    # @param [InvoiceSettingsRequest] invoice_settings_request Required
+    # parameter: TODO: type description here
+    # @param [ProductType] product_type Optional parameter: Allows you to choose
+    # which product type settings you want to update.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_invoice_settings(invoice_settings_request,
+                                product_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/invoicing/v2/invoiceSettings',
+                                     Server::DEFAULT)
+                   .body_param(new_parameter(invoice_settings_request)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .query_param(new_parameter(product_type, key: 'productType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoicingV2InvoiceSettingsPut200Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Could not update the invoice settings for this merchant.',
+                                 InvoicingV2InvoiceSettingsPut400ResponseException)
+                    .local_error('default',
+                                 'Unexpected error.',
+                                 InvoicingV2InvoiceSettingsPut502ResponseException))
+        .execute
+    end
+
+    # Allows you to retrieve the invoice settings for the payment page.
+    # @param [ProductType] product_type Optional parameter: Allows you to choose
+    # which product type settings you want to update.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_invoice_settings(product_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/invoicing/v2/invoiceSettings',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .query_param(new_parameter(product_type, key: 'productType'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoicingV2InvoiceSettingsGet200Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Could not get the invoice settings for this merchant.',
+                                 InvoicingV2InvoiceSettingsGet400ResponseException)
+                    .local_error('default',
+                                 'Unexpected error.',
+                                 InvoicingV2InvoiceSettingsGet502ResponseException))
+        .execute
+    end
+  end
+end