payrix-api-sdk 1.0.0

data/lib/payrix/controllers/profit_shares_controller.rb

@@ -0,0 +1,241 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ProfitSharesController
+  class ProfitSharesController < BaseController
+    # Query a ProfitShare resource, which will cause an entity to have its
+    # earnings/expenses shared with another entity.
+    # @param [String] id Required parameter: The ID of this resource, The Profit
+    # Share ID.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ProfitSharesResponseResult] Response from the API call.
+    def get_profit_shares_id(id,
+                             token: nil,
+                             request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/profitShares/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProfitSharesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update a ProfitShare resource, which causes an entity's earnings/expenses
+    # to be shared with another entity.
+    # @param [String] id Required parameter: The ID of this resource, The Profit
+    # Share ID.
+    # @param [ProfitSharesPutRequest] body Required parameter: Update Profit
+    # Share Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ProfitSharesResponseResult] Response from the API call.
+    def put_profit_shares_id(id,
+                             body,
+                             token: nil,
+                             request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/profitShares/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProfitSharesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete a ProfitShare resource, which causes an entity's earnings/expenses
+    # to be shared with another entity.
+    # @param [String] id Required parameter: The ID of this resource, The Profit
+    # Share ID.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ProfitSharesResponseResult] Response from the API call.
+    def delete_profit_shares_id(id,
+                                token: nil,
+                                request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/profitShares/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProfitSharesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a ProfitShare resource.
+    # A ProfitShare resource will cause an entity to have it's earnings/expenses
+    # shared with another entity.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @param [String] search Optional parameter: Set this header to filter or
+    # sort the list of resources that the method returns.  See
+    # [Searches](page:welcome#searches) for detailed information and examples on
+    # how to use search header.
+    # @param [String] totals Optional parameter: To configure a request to
+    # return a total for all instances of a field in a result set,  use the
+    # totals header in the format `totals={operator}[]={key}`.  This will
+    # calculate the desired total and return it in the `details > totals` object
+    # of the response.  For instance, if you want to sum the `total` field of
+    # all transactions,  you would use the `sum` operator. The response will
+    # include the result set,  along with the calculated total in the `details`
+    # section. See [Collection Operators](page:welcome#collection-operators) for
+    # detailed information and examples on how to use totals header.
+    # @param [Integer] page_number Optional parameter: Set this path parameter
+    # to request a specific page of records.  For example, set `?page[number]=2`
+    # to retrieve the second page of records for this request.
+    # @param [Integer] page_limit Optional parameter: Set this path parameter to
+    # request up to a specific amount of records. By default 30 records are
+    # retrieved per page. The maximum limit that can be set is 100. For example,
+    # set `?page[limit]=50` to retrieve up to 50 records for this request.
+    # @return [ProfitSharesResponseResult] Response from the API call.
+    def get_profit_shares(token: nil,
+                          request_token: nil,
+                          search: nil,
+                          totals: nil,
+                          page_number: nil,
+                          page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/profitShares',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter(search, key: 'search'))
+                   .header_param(new_parameter(totals, key: 'totals'))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_limit, key: 'page[limit]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProfitSharesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a ProfitShare resource.
+    # A ProfitShare resource will cause an entity to have it's earnings/expenses
+    # shared with another entity.
+    # @param [ProfitSharesPostRequest] body Required parameter: Create Profit
+    # Share Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ProfitSharesResponseResult] Response from the API call.
+    def post_profit_shares(body,
+                           token: nil,
+                           request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/profitShares',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProfitSharesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/reserve_entry_controller.rb

@@ -0,0 +1,156 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ReserveEntryController
+  class ReserveEntryController < BaseController
+    # Query a Reserve Entry resource that describes a record of funds moving in
+    # or out of reserve and can be associated with either a Transaction, a
+    # Reserve, an entityReserve, or another reserveEntry resource.
+    # @param [String] id Required parameter: The ID of this reserve entry.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReserveEntriesResponseResult] Response from the API call.
+    def get_reserve_entries_id(id,
+                               token: nil,
+                               request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reserveEntries/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReserveEntriesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a reserveEntry resource.
+    # A reserveEntry resource describes a record of funds moving in or out of
+    # reserve. It can be associated with either a Transaction, a Reserve, an
+    # entityReserve, or another reserveEntry resource.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @param [String] search Optional parameter: Set this header to filter or
+    # sort the list of resources that the method returns.  See
+    # [Searches](page:welcome#searches) for detailed information and examples on
+    # how to use search header.
+    # @param [String] totals Optional parameter: To configure a request to
+    # return a total for all instances of a field in a result set,  use the
+    # totals header in the format `totals={operator}[]={key}`.  This will
+    # calculate the desired total and return it in the `details > totals` object
+    # of the response.  For instance, if you want to sum the `total` field of
+    # all transactions,  you would use the `sum` operator. The response will
+    # include the result set,  along with the calculated total in the `details`
+    # section. See [Collection Operators](page:welcome#collection-operators) for
+    # detailed information and examples on how to use totals header.
+    # @param [Integer] page_number Optional parameter: Set this path parameter
+    # to request a specific page of records.  For example, set `?page[number]=2`
+    # to retrieve the second page of records for this request.
+    # @param [Integer] page_limit Optional parameter: Set this path parameter to
+    # request up to a specific amount of records. By default 30 records are
+    # retrieved per page. The maximum limit that can be set is 100. For example,
+    # set `?page[limit]=50` to retrieve up to 50 records for this request.
+    # @return [ReserveEntriesResponseResult] Response from the API call.
+    def get_reserve_entries(token: nil,
+                            request_token: nil,
+                            search: nil,
+                            totals: nil,
+                            page_number: nil,
+                            page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reserveEntries',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter(search, key: 'search'))
+                   .header_param(new_parameter(totals, key: 'totals'))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_limit, key: 'page[limit]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReserveEntriesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a Reserve Entry resource that describes a record of funds moving in
+    # or out of reserve and can be associated with either a Transaction, a
+    # Reserve, an entityReserve, or another reserveEntry resource.
+    # @param [ReserveEntriesPostRequest] body Required parameter: Create Reserve
+    # Entry Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReserveEntriesResponseResult] Response from the API call.
+    def post_reserve_entries(body,
+                             token: nil,
+                             request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reserveEntries',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReserveEntriesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/reserves_controller.rb

@@ -0,0 +1,243 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ReservesController
+  class ReservesController < BaseController
+    # Query a Reserve resource that represents a way to reserve funds from an
+    # Entity or Org automatically and to release them automatically according to
+    # a pre-determined schedule.
+    # @param [String] id Required parameter: The ID of this reserve.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReservesResponseResult] Response from the API call.
+    def get_reserves_id(id,
+                        token: nil,
+                        request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reserves/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update a Reserves or Reserve resource, which represents a way to reserve
+    # funds from an Entity or Org automatically and to release them
+    # automatically according to a pre-determined schedule.
+    # @param [String] id Required parameter: The ID of this reserve.
+    # @param [ReservesPutRequest] body Required parameter: Update a Reserve
+    # Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReservesResponseResult] Response from the API call.
+    def put_reserves_id(id,
+                        body,
+                        token: nil,
+                        request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/reserves/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete a Reserves or Reserve resource that represents a way to reserve
+    # funds from an Entity or Org automatically and to release them
+    # automatically according to a pre-determined schedule.
+    # @param [String] id Required parameter: The ID of this reserve.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReservesResponseResult] Response from the API call.
+    def delete_reserves_id(id,
+                           token: nil,
+                           request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/reserves/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a Reserves resource.
+    # A Reserves resource represents a way to reserve funds from an Entity or
+    # Org automatically and to release them automatically according to a
+    # pre-determined schedule.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @param [String] search Optional parameter: Set this header to filter or
+    # sort the list of resources that the method returns.  See
+    # [Searches](page:welcome#searches) for detailed information and examples on
+    # how to use search header.
+    # @param [String] totals Optional parameter: To configure a request to
+    # return a total for all instances of a field in a result set,  use the
+    # totals header in the format `totals={operator}[]={key}`.  This will
+    # calculate the desired total and return it in the `details > totals` object
+    # of the response.  For instance, if you want to sum the `total` field of
+    # all transactions,  you would use the `sum` operator. The response will
+    # include the result set,  along with the calculated total in the `details`
+    # section. See [Collection Operators](page:welcome#collection-operators) for
+    # detailed information and examples on how to use totals header.
+    # @param [Integer] page_number Optional parameter: Set this path parameter
+    # to request a specific page of records.  For example, set `?page[number]=2`
+    # to retrieve the second page of records for this request.
+    # @param [Integer] page_limit Optional parameter: Set this path parameter to
+    # request up to a specific amount of records. By default 30 records are
+    # retrieved per page. The maximum limit that can be set is 100. For example,
+    # set `?page[limit]=50` to retrieve up to 50 records for this request.
+    # @return [ReservesResponseResult] Response from the API call.
+    def get_reserves(token: nil,
+                     request_token: nil,
+                     search: nil,
+                     totals: nil,
+                     page_number: nil,
+                     page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reserves',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter(search, key: 'search'))
+                   .header_param(new_parameter(totals, key: 'totals'))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_limit, key: 'page[limit]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a Reserves resource.
+    # A Reserves resource represents a way to reserve funds from an Entity or
+    # Org automatically and to release them automatically according to a
+    # pre-determined schedule.
+    # @param [ReservesPostRequest] body Required parameter: Create Reserve
+    # Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [ReservesResponseResult] Response from the API call.
+    def post_reserves(body,
+                      token: nil,
+                      request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reserves',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end