payrix-api-sdk 1.0.0

data/lib/payrix/controllers/org_flow_rules_controller.rb

@@ -0,0 +1,232 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowRulesController
+  class OrgFlowRulesController < BaseController
+    # Query an Org Flow Rules resource.
+    # @param [String] id Required parameter: The ID of this 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.
+    # @return [OrgFlowRulesResponseResult] Response from the API call.
+    def get_org_flow_rules_id(id,
+                              token: nil,
+                              request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/orgFlowRules/{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(OrgFlowRulesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update an Org Flow Rule.
+    # @param [String] id Required parameter: The ID of this resource or The Org
+    # Flow Rule ID.
+    # @param [OrgFlowRulesPutRequest] body Required parameter: Update an Org
+    # Flow Rule 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 [OrgFlowRulesResponseResult] Response from the API call.
+    def put_org_flow_rules_id(id,
+                              body,
+                              token: nil,
+                              request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/orgFlowRules/{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(OrgFlowRulesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete an Org Flow Rule.
+    # @param [String] id Required parameter: The ID of this 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.
+    # @return [OrgFlowRulesResponseResult] Response from the API call.
+    def delete_org_flow_rules_id(id,
+                                 token: nil,
+                                 request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/orgFlowRules/{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(OrgFlowRulesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query an orgFlowRules 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 [OrgFlowRulesResponseResult] Response from the API call.
+    def get_org_flow_rules(token: nil,
+                           request_token: nil,
+                           search: nil,
+                           totals: nil,
+                           page_number: nil,
+                           page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/orgFlowRules',
+                                     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(OrgFlowRulesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create an Org Flow Rule.
+    # @param [OrgFlowRulesPostRequest] body Required parameter: Create Org Flow
+    # Rule 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 [OrgFlowRulesResponseResult] Response from the API call.
+    def post_org_flow_rules(body,
+                            token: nil,
+                            request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/orgFlowRules',
+                                     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(OrgFlowRulesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/org_flows_controller.rb

@@ -0,0 +1,248 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowsController
+  class OrgFlowsController < BaseController
+    # Query an Org Flow represents a way to trigger the addition or removal of
+    # the Merchants associated with a Login to a particular Org, optionally
+    # setting this addition or removal to be recursive, affecting all Merchants
+    # in any child Logins.
+    # @param [String] id Required parameter: The ID of this resource, also known
+    # as The Org Flow 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 [OrgFlowsResponseResult] Response from the API call.
+    def get_org_flows_id(id,
+                         token: nil,
+                         request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/orgFlows/{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(OrgFlowsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update an Org Flow. An orgFlows resource represents a way to trigger the
+    # addition or removal of the Merchants associated with a Login to a
+    # particular Org, optionally set to be recursive, affecting all Merchants in
+    # any child Logins.
+    # @param [String] id Required parameter: The ID of this resource and The Org
+    # Flow ID.
+    # @param [OrgFlowsPutRequest] body Required parameter: Update an Org Flow
+    # 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 [OrgFlowsResponseResult] Response from the API call.
+    def put_org_flows_id(id,
+                         body,
+                         token: nil,
+                         request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/orgFlows/{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(OrgFlowsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete an Org Flow.
+    # @param [String] id Required parameter: The ID of this resource, also known
+    # as The Org Flow 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 [OrgFlowsResponseResult] Response from the API call.
+    def delete_org_flows_id(id,
+                            token: nil,
+                            request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/orgFlows/{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(OrgFlowsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query an orgFlows resource.
+    # An orgFlows resource represents a way to trigger the addition or removal
+    # of the Merchants associated with a Login to a particular Org.
+    # You can optionally set this addition or removal to be recursive, affecting
+    # all Merchants in any child Logins.
+    # @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 [OrgFlowsResponseResult] Response from the API call.
+    def get_org_flows(token: nil,
+                      request_token: nil,
+                      search: nil,
+                      totals: nil,
+                      page_number: nil,
+                      page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/orgFlows',
+                                     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(OrgFlowsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create an orgFlows resource.
+    # An orgFlows resource represents a way to trigger the addition or removal
+    # of the Merchants associated with a Login to a particular Org.
+    # You can optionally set this addition or removal to be recursive, affecting
+    # all Merchants in any child Logins.
+    # @param [OrgFlowsPostRequest] body Required parameter: Create Org Flow
+    # 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 [OrgFlowsResponseResult] Response from the API call.
+    def post_org_flows(body,
+                       token: nil,
+                       request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/orgFlows',
+                                     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(OrgFlowsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end