mt-sdk 0.0.1

data/lib/modern_treasury/controllers/counterparty_controller.rb

@@ -0,0 +1,188 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # CounterpartyController
+  class CounterpartyController < BaseController
+    # Send an email requesting account details.
+    # @param [String] id Required parameter: counterparty id
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [CounterpartyCollectAccountRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [CounterpartyCollectAccountResponse] Response from the API call.
+    def collect_account_details(id,
+                                idempotency_key: nil,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/counterparties/{id}/collect_account',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CounterpartyCollectAccountResponse.method(:from_hash))
+                    .local_error('422',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get a paginated list of all counterparties.
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @param [String] name Optional parameter: Performs a partial string match
+    # of the name field. This is also case insensitive.
+    # @param [String] email Optional parameter: Performs a partial string match
+    # of the email field. This is also case insensitive.
+    # @param [Hash[String, String]] metadata Optional parameter: For example, if
+    # you want to query for records with metadata key `Type` and value `Loan`,
+    # the query would be `metadata%5BType%5D=Loan`. This encodes the query
+    # parameters.
+    # @param [DateTime] created_at_lower_bound Optional parameter: Used to
+    # return counterparties created after some datetime.
+    # @param [DateTime] created_at_upper_bound Optional parameter: Used to
+    # return counterparties created before some datetime.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @return [Array[Counterparty]] Response from the API call.
+    def list_counterparties(per_page: nil,
+                            name: nil,
+                            email: nil,
+                            metadata: nil,
+                            created_at_lower_bound: nil,
+                            created_at_upper_bound: nil,
+                            after_cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/counterparties',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(email, key: 'email'))
+                   .query_param(new_parameter(metadata, key: 'metadata'))
+                   .query_param(new_parameter(created_at_lower_bound, key: 'created_at_lower_bound'))
+                   .query_param(new_parameter(created_at_upper_bound, key: 'created_at_upper_bound'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Counterparty.method(:from_hash))
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'bad_request',
+                                 APIException)
+                    .local_error('401',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Create a new counterparty.
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [CounterpartyCreateRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Counterparty] Response from the API call.
+    def create_counterparty(idempotency_key: nil,
+                            body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/counterparties',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Counterparty.method(:from_hash))
+                    .local_error('415',
+                                 'unsuccessful',
+                                 ErrorMessageException)
+                    .local_error('422',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get details on a single counterparty.
+    # @param [String] id Required parameter: The id of an existing
+    # counterparty.
+    # @return [Counterparty] Response from the API call.
+    def get_counterparty(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/counterparties/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Counterparty.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Updates a given counterparty with new information.
+    # @param [String] id Required parameter: The id of an existing
+    # counterparty.
+    # @param [CounterpartyUpdateRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Counterparty] Response from the API call.
+    def update_counterparty(id,
+                            body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/api/counterparties/{id}',
+                                     Server::DEFAULT)
+                   .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('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Counterparty.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Deletes a given counterparty.
+    # @param [String] id Required parameter: The id of an existing
+    # counterparty.
+    # @return [void] Response from the API call.
+    def delete_counterparty(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/api/counterparties/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/modern_treasury/controllers/document_controller.rb

@@ -0,0 +1,285 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # DocumentController
+  class DocumentController < BaseController
+    # Get a list of documents.
+    # @param [String] documentable_id Optional parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType2Enum] documentable_type Optional parameter: The
+    # type of the associated object. Currently can be one of `payment_order`,
+    # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
+    # `organization`, `case`, `internal_account`, `decision`, or
+    # `external_account`.
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @return [Array[Document]] Response from the API call.
+    def list_documents(documentable_id: nil,
+                       documentable_type: nil,
+                       per_page: nil,
+                       after_cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/documents',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(documentable_id, key: 'documentable_id'))
+                   .query_param(new_parameter(documentable_type, key: 'documentable_type'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .is_response_array(true)
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Create a document.
+    # @param [String] documentable_id Required parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType1Enum] documentable_type Required parameter: TODO:
+    # type description here
+    # @param [File | UploadIO] file Required parameter: TODO: type description
+    # here
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [String] document_type Optional parameter: A category given to the
+    # document, can be `null`.
+    # @return [Document] Response from the API call.
+    def create_document(documentable_id,
+                        documentable_type,
+                        file,
+                        idempotency_key: nil,
+                        document_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/documents',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(documentable_id, key: 'documentable_id'))
+                   .form_param(new_parameter(documentable_type, key: 'documentable_type'))
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .form_param(new_parameter(document_type, key: 'document_type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .local_error('403',
+                                 'forbidden',
+                                 ErrorMessageException)
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get a list of documents.
+    # @param [String] documentable_id Required parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType2Enum] documentable_type Required parameter: The
+    # type of the associated object. Currently can be one of `payment_order`,
+    # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
+    # `organization`, `case`, `internal_account`, `decision`, or
+    # `external_account`.
+    # @param [String] document_type Optional parameter: A category given to the
+    # document, can be `null`.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @return [Array[Document]] Response from the API call.
+    def list_documents1(documentable_id,
+                        documentable_type,
+                        document_type: nil,
+                        after_cursor: nil,
+                        per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/{documentable_type}/{documentable_id}/documents',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .should_encode(true))
+                   .query_param(new_parameter(document_type, key: 'document_type'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .is_response_array(true))
+        .execute
+    end
+
+    # Create a document.
+    # @param [String] documentable_id Required parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType2Enum] documentable_type Required parameter: The
+    # type of the associated object. Currently can be one of `payment_order`,
+    # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
+    # `organization`, `case`, `internal_account`, `decision`, or
+    # `external_account`.
+    # @param [File | UploadIO] file Required parameter: TODO: type description
+    # here
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [String] document_type Optional parameter: A category given to the
+    # document, can be `null`.
+    # @return [Document] Response from the API call.
+    def create_document1(documentable_id,
+                         documentable_type,
+                         file,
+                         idempotency_key: nil,
+                         document_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/{documentable_type}/{documentable_id}/documents',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .should_encode(true))
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .form_param(new_parameter(document_type, key: 'document_type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .local_error('403',
+                                 'forbidden',
+                                 ErrorMessageException)
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get an existing document.
+    # @param [String] documentable_id Required parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType2Enum] documentable_type Required parameter: The
+    # type of the associated object. Currently can be one of `payment_order`,
+    # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
+    # `organization`, `case`, `internal_account`, `decision`, or
+    # `external_account`.
+    # @param [UUID | String] id Required parameter: The ID of the document.
+    # @return [Document] Response from the API call.
+    def get_document(documentable_id,
+                     documentable_type,
+                     id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/{documentable_type}/{documentable_id}/documents/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get an existing document.
+    # @param [UUID | String] id Required parameter: The ID of the document.
+    # @return [Document] Response from the API call.
+    def get_document1(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/documents/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Document.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Download an existing document.
+    # @param [String] documentable_id Required parameter: The unique identifier
+    # for the associated object.
+    # @param [DocumentableType2Enum] documentable_type Required parameter: The
+    # type of the associated object. Currently can be one of `payment_order`,
+    # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
+    # `organization`, `case`, `internal_account`, `decision`, or
+    # `external_account`.
+    # @param [UUID | String] id Required parameter: The ID of the document.
+    # @return [void] Response from the API call.
+    def download_document(documentable_id,
+                          documentable_type,
+                          id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/{documentable_type}/{documentable_id}/documents/{id}/download',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('403',
+                                 'forbidden',
+                                 ErrorMessageException)
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Download an existing document.
+    # @param [UUID | String] id Required parameter: The ID of the document.
+    # @return [void] Response from the API call.
+    def download_document1(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/documents/{id}/download',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('403',
+                                 'forbidden',
+                                 ErrorMessageException)
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+  end
+end

data/lib/modern_treasury/controllers/event_controller.rb

@@ -0,0 +1,72 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # EventController
+  class EventController < BaseController
+    # TODO: type endpoint description here
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] event_time_start Optional parameter: An inclusive lower
+    # bound for when the event occurred
+    # @param [DateTime] event_time_end Optional parameter: An inclusive upper
+    # bound for when the event occurred
+    # @param [String] resource Optional parameter: TODO: type description here
+    # @param [String] entity_id Optional parameter: TODO: type description
+    # here
+    # @param [String] event_name Optional parameter: TODO: type description
+    # here
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @return [Array[Event]] Response from the API call.
+    def list_events(per_page: nil,
+                    event_time_start: nil,
+                    event_time_end: nil,
+                    resource: nil,
+                    entity_id: nil,
+                    event_name: nil,
+                    after_cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/events',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(event_time_start, key: 'event_time_start'))
+                   .query_param(new_parameter(event_time_end, key: 'event_time_end'))
+                   .query_param(new_parameter(resource, key: 'resource'))
+                   .query_param(new_parameter(entity_id, key: 'entity_id'))
+                   .query_param(new_parameter(event_name, key: 'event_name'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Event.method(:from_hash))
+                    .is_response_array(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: event id
+    # @return [Event] Response from the API call.
+    def get_event(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/events/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Event.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+  end
+end