acceptance-api-sdk 0.0.1

data/lib/visa_acceptance_merged_spec/apis/customer_api.rb

@@ -0,0 +1,325 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CustomerApi
+  class CustomerApi < BaseApi
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Customers**<br>A Customer represents your tokenized customer
+    # information.<br>You should associate the Customer Id with the customer
+    # account on your systems.<br>A Customer can have one or more [Payment
+    # Instruments](#token-management_customer-payment-instrument_create-a-custom
+    # er-payment-instrumentl) or [Shipping
+    # Addresses](#token-management_customer-shipping-address_create-a-customer-s
+    # hipping-address) with one allocated as the Customers
+    # default.<br><br>**Creating a Customer**<br>It is recommended 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), this can be for a zero amount.<br>The
+    # Customer will be created with a Payment Instrument and Shipping
+    # Address.<br>You can also [add additional Payment Instruments to a Customer
+    # via a Payment
+    # Authorization](#payments_payments_process-a-payment_samplerequests-dropdow
+    # n_authorization-with-token-create_authorization-create-default-payment-ins
+    # trument-shipping-address-for-existing-customer_liveconsole-tab-request-bod
+    # y).<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
+    # Customers**<br>To perform a payment with the Customers default details
+    # specify the [Customer Id in the payments
+    # request](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-customer-token-id_liveconsole-ta
+    # b-request-body).<br>To perform a payment with a particular Payment
+    # Instrument or Shipping Address <br>specify the [Payment Instrument or
+    # Shipping Address Ids in the payments
+    # request](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-customer-payment-instrument-and-
+    # shipping-address-token-id_liveconsole-tab-request-body).
+    # The availability of API features for a merchant may depend on the
+    # portfolio configuration and may need to be enabled at the portfolio level
+    # before they can be added to merchant accounts.
+    # @param [PostCustomerRequest] body Required parameter: TODO: type
+    # description here
+    # @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_customer(body,
+                      profile_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tms/v2/customers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .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)
+                   .auth(And.new('BearerAuth', 'Accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TmsV2CustomersResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 PostCustomerException1Exception)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 PostCustomerException21Exception)
+                    .local_error('409',
+                                 'Conflict. The token is linked to a Payment Instrument.',
+                                 PostCustomerException31Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 PostCustomerException41Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 PostCustomerException51Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Customers**<br>A Customer represents your tokenized customer
+    # information.<br>You should associate the Customer Id with the customer
+    # account on your systems.<br>A Customer can have one or more [Payment
+    # Instruments](#token-management_customer-payment-instrument_create-a-custom
+    # er-payment-instrumentl) or [Shipping
+    # Addresses](#token-management_customer-shipping-address_create-a-customer-s
+    # hipping-address) with one allocated as the Customers
+    # default.<br><br>**Retrieving a Customer**<br>When your customer signs into
+    # their account, your system can use this API to retrieve the Customers
+    # default Payment Instrument and Shipping Address.<br>**Note: the actual
+    # card data will be masked.**<br>If your customer wants to see other
+    # available Payment Instruments, your system can [retrieve all Payment
+    # Instruments](#token-management_customer-payment-instrument_list-payment-in
+    # struments-for-a-customer) associated with the Customer.<br>The same
+    # applies to [Shipping
+    # Addresses](#token-management_customer-shipping-address_list-shipping-addre
+    # sses-for-a-customer).|&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
+    # Customers**<br>To perform a payment with the Customers default details
+    # specify the [Customer Id in the payments
+    # request](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-customer-token-id_liveconsole-ta
+    # b-request-body).<br>To perform a payment with a particular Payment
+    # Instrument or Shipping Address <br>specify the [Payment Instrument or
+    # Shipping Address Ids in the payments
+    # request](#payments_payments_process-a-payment_samplerequests-dropdown_auth
+    # orization-using-tokens_authorization-with-customer-payment-instrument-and-
+    # shipping-address-token-id_liveconsole-tab-request-body).
+    # @param [String] customer_id Required parameter: The Id of a Customer.
+    # @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 get_customer(customer_id,
+                     profile_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tms/v2/customers/{customerId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customerId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('BearerAuth', 'Accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetCustomerResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 GetCustomerException1Exception)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 GetCustomerException21Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 GetCustomerException31Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 GetCustomerException41Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 GetCustomerException31Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 GetCustomerException61Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Customers**<br>A Customer represents your tokenized customer
+    # information.<br>You should associate the Customer Id with the customer
+    # account on your systems.<br>A Customer can have one or more [Payment
+    # Instruments](#token-management_customer-payment-instrument_create-a-custom
+    # er-payment-instrumentl) or [Shipping
+    # Addresses](#token-management_customer-shipping-address_create-a-customer-s
+    # hipping-address) with one allocated as the Customers
+    # default.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a
+    # Customer**<br>Your system can use this API to update a Customers details
+    # including selecting a  [default Payment
+    # Instrument](#token-management_customer_update-a-customer_samplerequests-dr
+    # opdown_update-customers-default-payment-instrument_liveconsole-tab-request
+    # -body) or [default Shipping
+    # Address](#token-management_customer_update-a-customer_samplerequests-dropd
+    # own_update-customers-default-shipping-address_liveconsole-tab-request-body
+    # ) for use in payments.<br>Note: Updating a Customers [Payment
+    # Instrument](#token-management_customer-payment-instrument_update-a-custome
+    # r-payment-instrument) or [Shipping
+    # Address](#token-management_customer-shipping-address_update-a-customer-shi
+    # pping-address) details is performed using their own dedicated API
+    # resources.
+    # @param [String] customer_id Required parameter: The Id of a Customer.
+    # @param [PatchCustomerRequest] body Required parameter: TODO: type
+    # description here
+    # @param [String] profile_id Optional parameter: The Id of a profile
+    # containing user specific TMS configuration.
+    # @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_customer(customer_id,
+                       body,
+                       profile_id: nil,
+                       if_match: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/tms/v2/customers/{customerId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customerId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json;charset=utf-8', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .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)
+                   .auth(And.new('BearerAuth', 'Accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PatchCustomerResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request: e.g. A required header value could be missing.',
+                                 PatchCustomerException1Exception)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 PatchCustomerException21Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 PatchCustomerException31Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 PatchCustomerException41Exception)
+                    .local_error('412',
+                                 'Precondition Failed: The If-Match request header value does'\
+                                  ' not match the current resources ETag',
+                                 PatchCustomerException51Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 PatchCustomerException31Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 PatchCustomerException71Exception))
+        .execute
+    end
+
+    # |  |  |  |
+    # | --- | --- | --- |
+    # |**Customers**<br>A Customer represents your tokenized customer
+    # information.<br>You should associate the Customer Id with the customer
+    # account on your systems.<br>A Customer can have one or more [Payment
+    # Instruments](#token-management_customer-payment-instrument_create-a-custom
+    # er-payment-instrumentl) or [Shipping
+    # Addresses](#token-management_customer-shipping-address_create-a-customer-s
+    # hipping-address) with one allocated as the Customers
+    # default.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a
+    # Customer**<br>Your system can use this API to delete a complete
+    # Customer.<br>When a Customer is deleted all associated Payment Instruments
+    # & Shipping Addresses are deleted.<br>Any Instrument Identifiers
+    # representing the card number will also be deleted if they are not
+    # associated with any other Payment Instruments.<br>Note: Individual
+    # [Payment
+    # Instruments](#token-management_customer-payment-instrument_delete-a-custom
+    # er-payment-instrument) or [Shipping
+    # Addresses](#token-management_customer-shipping-address_delete-a-customer-s
+    # hipping-address) can be deleted via their own dedicated API resources.
+    # @param [String] customer_id Required parameter: The Id of a Customer.
+    # @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_customer(customer_id,
+                        profile_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/tms/v2/customers/{customerId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customerId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(profile_id, key: 'profile-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('BearerAuth', 'Accept')))
+        .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.',
+                                 DeleteCustomerException1Exception)
+                    .local_error('403',
+                                 'Forbidden: e.g. The profile might not have permission to'\
+                                  ' perform the operation.',
+                                 DeleteCustomerException21Exception)
+                    .local_error('404',
+                                 'Token Not Found. The Id may not exist or was entered'\
+                                  ' incorrectly.',
+                                 DeleteCustomerException31Exception)
+                    .local_error('410',
+                                 'Token Not Available. The token has been deleted.',
+                                 DeleteCustomerException41Exception)
+                    .local_error('424',
+                                 'Failed Dependency: e.g. The profile represented by the'\
+                                  ' profile-id may not exist or the profile-id was entered'\
+                                  ' incorrectly.',
+                                 DeleteCustomerException31Exception)
+                    .local_error('500',
+                                 'Unexpected error.',
+                                 DeleteCustomerException61Exception))
+        .execute
+    end
+  end
+end