payrix-api-sdk 1.0.0

data/lib/payrix/controllers/aggregation_result_groups_controller.rb

@@ -0,0 +1,165 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # AggregationResultGroupsController
+  class AggregationResultGroupsController < BaseController
+    # Query an AggregationResultGroup resource, which holds data regarding a
+    # processed aggregation.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation Result Group 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 [AggregationResultsGroupsResponseResult] Response from the API call.
+    def get_aggregation_result_groups_id(id,
+                                         token: nil,
+                                         request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregationResultGroups/{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(AggregationResultsGroupsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete an Aggregation Result Group, which holds data regarding a processed
+    # aggregation.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation Result Group 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.
+    # @param [String] search_filter Optional parameter: Set this header to
+    # filter or sort the list of resources that the method returns.  For
+    # example, to find all resources that have a property of 'public' set to
+    # '1', set this header to 'public[equals]=1'. You can use the operators
+    # 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the
+    # resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a
+    # descending sort). You may also use explicit 'and/or' querying by passing
+    # arrays of or and arrays of and parameters. For example, to find all
+    # resources that have a property of 'public' set to '1' or a property of
+    # 'active' set to '0', set this header to
+    # 'or[][public][equals]=1&or[][active][equals]=0'.
+    # @return [AggregationResultsGroupsResponseResult] Response from the API call.
+    def delete_aggregation_result_groups_id(id,
+                                            token: nil,
+                                            request_token: nil,
+                                            search_filter: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/aggregationResultGroups/{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(search_filter, key: 'search'))
+                   .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(AggregationResultsGroupsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query an AggregationResultGroup resource, which holds data regarding a
+    # processed aggregation.
+    # @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 [AggregationResultsGroupsResponseResult] Response from the API call.
+    def get_aggregation_result_groups(token: nil,
+                                      request_token: nil,
+                                      search: nil,
+                                      totals: nil,
+                                      page_number: nil,
+                                      page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregationResultGroups',
+                                     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(AggregationResultsGroupsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/aggregation_results_controller.rb

@@ -0,0 +1,151 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # AggregationResultsController
+  class AggregationResultsController < BaseController
+    # Query an AggregationResult.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation Result 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 [AggregationResultsResponseResult] Response from the API call.
+    def get_aggregation_results_id(id,
+                                   token: nil,
+                                   request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregationResults/{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(AggregationResultsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete an Aggregation Result that holds a field totals calculated when
+    # processing an aggregation.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation Result 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 [AggregationResultsResponseResult] Response from the API call.
+    def delete_aggregation_results_id(id,
+                                      token: nil,
+                                      request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/aggregationResults/{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(AggregationResultsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query an AggregationResult resource holding field totals calculated when
+    # processing an aggregation.
+    # @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 [AggregationResultsResponseResult] Response from the API call.
+    def get_aggregation_results(token: nil,
+                                request_token: nil,
+                                search: nil,
+                                totals: nil,
+                                page_number: nil,
+                                page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregationResults',
+                                     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(AggregationResultsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/aggregations_controller.rb

@@ -0,0 +1,275 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # AggregationsController
+  class AggregationsController < BaseController
+    # Query an Aggregation resource that uses a search to query for records on
+    # the given resource and applies the desired calculations (count, sum, min,
+    # and/or max) to the field in question.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation 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.
+    # @param [String] search_filter Optional parameter: Set this header to
+    # filter or sort the list of resources that the method returns.  For
+    # example, to find all resources that have a property of 'public' set to
+    # '1', set this header to 'public[equals]=1'. You can use the operators
+    # 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the
+    # resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a
+    # descending sort). You may also use explicit 'and/or' querying by passing
+    # arrays of or and arrays of and parameters. For example, to find all
+    # resources that have a property of 'public' set to '1' or a property of
+    # 'active' set to '0', set this header to
+    # 'or[][public][equals]=1&or[][active][equals]=0'.
+    # @return [AggregationsResponseResult] Response from the API call.
+    def get_aggregations_id(id,
+                            token: nil,
+                            request_token: nil,
+                            search_filter: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregations/{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(search_filter, key: 'search'))
+                   .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(AggregationsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update an Aggregation resource or Update an Aggregation.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation ID.
+    # @param [AggregationsPutRequest] body Required parameter: Update
+    # Aggregation 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.
+    # @param [String] search_filter Optional parameter: Set this header to
+    # filter or sort the list of resources that the method returns.  For
+    # example, to find all resources that have a property of 'public' set to
+    # '1', set this header to 'public[equals]=1'. You can use the operators
+    # 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the
+    # resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a
+    # descending sort). You may also use explicit 'and/or' querying by passing
+    # arrays of or and arrays of and parameters. For example, to find all
+    # resources that have a property of 'public' set to '1' or a property of
+    # 'active' set to '0', set this header to
+    # 'or[][public][equals]=1&or[][active][equals]=0'.
+    # @return [AggregationsResponseResult] Response from the API call.
+    def put_aggregations_id(id,
+                            body,
+                            token: nil,
+                            request_token: nil,
+                            search_filter: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/aggregations/{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(search_filter, key: 'search'))
+                   .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(AggregationsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete an Aggregation resource or an Aggregation.
+    # @param [String] id Required parameter: The ID of this resource or The
+    # Aggregation 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.
+    # @param [String] search_filter Optional parameter: Set this header to
+    # filter or sort the list of resources that the method returns.  For
+    # example, to find all resources that have a property of 'public' set to
+    # '1', set this header to 'public[equals]=1'. You can use the operators
+    # 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the
+    # resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a
+    # descending sort). You may also use explicit 'and/or' querying by passing
+    # arrays of or and arrays of and parameters. For example, to find all
+    # resources that have a property of 'public' set to '1' or a property of
+    # 'active' set to '0', set this header to
+    # 'or[][public][equals]=1&or[][active][equals]=0'.
+    # @return [AggregationsResponseResult] Response from the API call.
+    def delete_aggregations_id(id,
+                               token: nil,
+                               request_token: nil,
+                               search_filter: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/aggregations/{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(search_filter, key: 'search'))
+                   .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(AggregationsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query an Aggregation resource using the search to query for records on the
+    # given resource and apply desired calculations (count, sum, min, and/or
+    # max) to the specified field.
+    # @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 [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.
+    # @param [String] search_filter Optional parameter: Set this header to
+    # filter or sort the list of resources that the method returns.  For
+    # example, to find all resources that have a property of 'public' set to
+    # '1', set this header to 'public[equals]=1'. You can use the operators
+    # 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the
+    # resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a
+    # descending sort). You may also use explicit 'and/or' querying by passing
+    # arrays of or and arrays of and parameters. For example, to find all
+    # resources that have a property of 'public' set to '1' or a property of
+    # 'active' set to '0', set this header to
+    # 'or[][public][equals]=1&or[][active][equals]=0'.
+    # @return [AggregationsResponseResult] Response from the API call.
+    def get_aggregations(token: nil,
+                         request_token: nil,
+                         page_number: nil,
+                         page_limit: nil,
+                         search_filter: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/aggregations',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_limit, key: 'page[limit]'))
+                   .header_param(new_parameter(search_filter, key: 'search'))
+                   .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(AggregationsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create an Aggregation resource that uses the search to query for records
+    # on a given resource and applies the desired calculations (count, sum, min,
+    # and/or max) to the field in question.
+    # @param [AggregationsPostRequest] body Required parameter: Create
+    # Aggregation 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 [AggregationsResponseResult] Response from the API call.
+    def post_aggregations(body,
+                          token: nil,
+                          request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/aggregations',
+                                     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(AggregationsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end