payrix-api-sdk 1.0.0

data/lib/payrix/controllers/messages_controller.rb

@@ -0,0 +1,196 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # MessagesController
+  class MessagesController < BaseController
+    # Query a Message for a messageThreads.
+    # @param [String] id Required parameter: The ID of this message.
+    # @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 [MessagesResponseResult] Response from the API call.
+    def get_messages_id(id,
+                        token: nil,
+                        request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/messages/{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(MessagesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update a messages or Message resource, which represents a message for a
+    # messageThread.
+    # @param [String] id Required parameter: The ID of this message.
+    # @param [MessagesPutRequest] body Required parameter: Update Message
+    # 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 [MessagesResponseResult] Response from the API call.
+    def put_messages_id(id,
+                        body,
+                        token: nil,
+                        request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/messages/{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(MessagesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a Message or query a messages resource that represents a message for
+    # a messageThreads.
+    # @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 [MessagesResponseResult] Response from the API call.
+    def get_messages(token: nil,
+                     request_token: nil,
+                     search: nil,
+                     totals: nil,
+                     page_number: nil,
+                     page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/messages',
+                                     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(MessagesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a Messages resource, which represents a message for a
+    # messageThread.
+    # @param [MessagesPostRequest] body Required parameter: Create Message
+    # 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 [MessagesPostResponseResult] Response from the API call.
+    def post_messages(body,
+                      token: nil,
+                      request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/messages',
+                                     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(MessagesPostResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/note_documents_controller.rb

@@ -0,0 +1,236 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # NoteDocumentsController
+  class NoteDocumentsController < BaseController
+    # Query a Note Document that represents a file that is related to a specific
+    # note record.
+    # @param [String] id Required parameter: The ID of this note document.
+    # @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 [NoteDocumentsResponseResult] Response from the API call.
+    def get_note_documents_id(id,
+                              token: nil,
+                              request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/noteDocuments/{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(NoteDocumentsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update a note document, which represents a file related to a specific note
+    # record.
+    # @param [String] id Required parameter: The ID of this note document.
+    # @param [NoteDocumentsPutRequest] body Required parameter: Update Note
+    # Document 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 [NoteDocumentsResponseResult] Response from the API call.
+    def put_note_documents_id(id,
+                              body,
+                              token: nil,
+                              request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/noteDocuments/{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(NoteDocumentsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete a Note Document, which represents a file related to a specific note
+    # record.
+    # @param [String] id Required parameter: The ID of this note document.
+    # @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 [NoteDocumentsResponseResult] Response from the API call.
+    def delete_note_documents_id(id,
+                                 token: nil,
+                                 request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/noteDocuments/{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(NoteDocumentsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a Note Document, which represents a file that is related to a
+    # specific note record and documents resources.
+    # @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 [NoteDocumentsResponseResult] Response from the API call.
+    def get_note_documents(token: nil,
+                           request_token: nil,
+                           search: nil,
+                           totals: nil,
+                           page_number: nil,
+                           page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/noteDocuments',
+                                     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(NoteDocumentsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a note document, representing a file related to a specific note
+    # record.
+    # @param [NoteDocumentsPostRequest] body Required parameter: Create Note
+    # Document 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 [NoteDocumentsResponseResult] Response from the API call.
+    def post_note_documents(body,
+                            token: nil,
+                            request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/noteDocuments',
+                                     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(NoteDocumentsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/controllers/notes_controller.rb

@@ -0,0 +1,232 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # NotesController
+  class NotesController < BaseController
+    # Query a Notes resource that represents risk management notes, reviews, and
+    # releases for a Hold, Txn, and Entity specific data.
+    # @param [String] id Required parameter: The ID of this note.
+    # @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 [NotesResponseResult] Response from the API call.
+    def get_notes_id(id,
+                     token: nil,
+                     request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/notes/{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(NotesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Update a Note.
+    # @param [String] id Required parameter: The ID of this note.
+    # @param [NotesPutRequest] body Required parameter: Update Note 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 [NotesResponseResult] Response from the API call.
+    def put_notes_id(id,
+                     body,
+                     token: nil,
+                     request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/notes/{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(NotesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete a Note.
+    # @param [String] id Required parameter: The ID of this note.
+    # @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 [NotesResponseResult] Response from the API call.
+    def delete_notes_id(id,
+                        token: nil,
+                        request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/notes/{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(NotesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a Notes resource that represents risk management notes, reviews, and
+    # releases for a Hold, Txn, and Entity specific data.
+    # @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 [NotesResponseResult] Response from the API call.
+    def get_notes(token: nil,
+                  request_token: nil,
+                  search: nil,
+                  totals: nil,
+                  page_number: nil,
+                  page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/notes',
+                                     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(NotesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Create a Notes resource that represents risk management notes, reviews,
+    # and releases for a Hold, Txn, and Entity-specific data.
+    # @param [NotesPostRequest] body Required parameter: Create Note 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 [NotesResponseResult] Response from the API call.
+    def post_notes(body,
+                   token: nil,
+                   request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/notes',
+                                     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(NotesResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end