adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/apis/terminal_orders_merchant_level_api.rb

@@ -0,0 +1,573 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # TerminalOrdersMerchantLevelApi
+  class TerminalOrdersMerchantLevelApi < BaseApi
+    # Returns the billing entities of the merchant account identified in the
+    # path.
+    # A billing entity is a legal entity where we charge orders to. An order for
+    # terminal products must contain the ID of a billing entity.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] name Optional parameter: The name of the billing entity.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_billing_entities(merchant_id,
+                                                   name: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/billingEntities',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BillingEntitiesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns the shipping locations for the merchant account identified in the
+    # path.
+    # A shipping location includes the address where orders can be delivered,
+    # and an ID which you need to specify when ordering terminal products.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] name Optional parameter: The name of the shipping
+    # location.
+    # @param [Integer] offset Optional parameter: The number of locations to
+    # skip.
+    # @param [Integer] limit Optional parameter: The number of locations to
+    # return.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_shipping_locations(merchant_id,
+                                                     name: nil,
+                                                     offset: nil,
+                                                     limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/shippingLocations',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingLocationsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Creates a shipping location for the merchant account identified in the
+    # path. A shipping location defines an address where orders can be shipped
+    # to.
+    # To make this request, your API credential must have the following
+    # [role](https://docs.adyen.com/development-resources/api-credentials#api-pe
+    # rmissions):
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [ShippingLocation] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_merchants_merchant_id_shipping_locations(merchant_id,
+                                                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/merchants/{merchantId}/shippingLocations',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingLocation.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns the payment terminal models that the merchant account identified
+    # in the path has access to. The response includes the terminal model ID,
+    # which can be used as a query parameter when getting a list of terminals or
+    # a list of products for ordering.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_terminal_models(merchant_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/terminalModels',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalModelsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns a list of terminal products orders for the merchant account
+    # identified in the path.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: TODO: type description
+    # here
+    # @param [String] customer_order_reference Optional parameter: Your purchase
+    # order number.
+    # @param [String] status Optional parameter: The order status. Possible
+    # values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped,
+    # Delivered.
+    # @param [Integer] offset Optional parameter: The number of orders to
+    # skip.
+    # @param [Integer] limit Optional parameter: The number of orders to
+    # return.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_terminal_orders(merchant_id,
+                                                  customer_order_reference: nil,
+                                                  status: nil,
+                                                  offset: nil,
+                                                  limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/terminalOrders',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(customer_order_reference, key: 'customerOrderReference'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalOrdersResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Creates an order for payment terminal products for the merchant account
+    # identified in the path.
+    # To make this request, your API credential must have the following
+    # [role](https://docs.adyen.com/development-resources/api-credentials#api-pe
+    # rmissions):
+    # * Management API—Terminal ordering read and write
+    # >Requests to the Management API test endpoint do not create actual orders
+    # for test terminals. To order test terminals, you need to [submit a sales
+    # order](https://docs.adyen.com/point-of-sale/managing-terminals/order-termi
+    # nals/#sales-order-steps) in your Customer Area.
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [TerminalOrderRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_merchants_merchant_id_terminal_orders(merchant_id,
+                                                   body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/merchants/{merchantId}/terminalOrders',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalOrder.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns the details of the terminal products order identified in the path.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] order_id Required parameter: The unique identifier of the
+    # order.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_terminal_orders_order_id(merchant_id,
+                                                           order_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/terminalOrders/{orderId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalOrder.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Updates the terminal products order identified in the path.
+    # Updating is only possible while the order has the status **Placed**.
+    # The request body only needs to contain what you want to change.
+    # However, to update the products in the `items` array, you must provide the
+    # entire array. For example, if the array has three items:
+    #  To remove one item, the array must include the remaining two items. Or to
+    # add one item, the array must include all four items.
+    # To make this request, your API credential must have the following
+    # [role](https://docs.adyen.com/development-resources/api-credentials#api-pe
+    # rmissions):
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] order_id Required parameter: The unique identifier of the
+    # order.
+    # @param [TerminalOrderRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def patch_merchants_merchant_id_terminal_orders_order_id(merchant_id,
+                                                             order_id,
+                                                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/merchants/{merchantId}/terminalOrders/{orderId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalOrder.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Cancels the terminal products order identified in the path.
+    # Cancelling is only possible while the order has the status **Placed**.
+    # To cancel an order, make a POST call without a request body. The response
+    # returns the full order details, but with the status changed to
+    # **Cancelled**.
+    # To make this request, your API credential must have the following
+    # [role](https://docs.adyen.com/development-resources/api-credentials#api-pe
+    # rmissions):
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] order_id Required parameter: The unique identifier of the
+    # order.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_merchants_merchant_id_terminal_orders_order_id_cancel(merchant_id,
+                                                                   order_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/merchants/{merchantId}/terminalOrders/{orderId}/cancel',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalOrder.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns a country-specific list of payment terminal packages and parts
+    # that the merchant account identified in the path has access to.
+    # To make this request, your API credential must have one of the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Terminal ordering read
+    # * Management API—Terminal ordering read and write
+    # In the live environment, requests to this endpoint are subject to [rate
+    # limits](https://docs.adyen.com/point-of-sale/automating-terminal-managemen
+    # t#rate-limits-in-the-live-environment).
+    # @param [String] merchant_id Required parameter: The unique identifier of
+    # the merchant account.
+    # @param [String] country Required parameter: The country to return products
+    # for, in [ISO 3166-1
+    # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For
+    # example, **US**
+    # @param [String] terminal_model_id Optional parameter: The terminal model
+    # to return products for. Use the ID returned in the [GET
+    # `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService
+    # /latest/get/merchants/{merchantId}/terminalModels) response. For example,
+    # **Verifone.M400**
+    # @param [Integer] offset Optional parameter: The number of products to
+    # skip.
+    # @param [Integer] limit Optional parameter: The number of products to
+    # return.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_merchant_id_terminal_products(merchant_id,
+                                                    country,
+                                                    terminal_model_id: nil,
+                                                    offset: nil,
+                                                    limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/merchants/{merchantId}/terminalProducts',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(merchant_id, key: 'merchantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(country, key: 'country')
+                                 .is_required(true))
+                   .query_param(new_parameter(terminal_model_id, key: 'terminalModelId'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TerminalProductsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+  end
+end