mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/{controllers/counterparty_controller.rb → apis/counterparty_api.rb}

@@ -4,15 +4,15 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # CounterpartyController
-  class CounterpartyController < BaseController
+  # CounterpartyApi
+  class CounterpartyApi < BaseApi
     # 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def collect_account_details(id,
                                 idempotency_key: nil,
                                 body: nil)
@@ -21,6 +21,7 @@ module ModernTreasury
                                      '/api/counterparties/{id}/collect_account',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
@@ -31,6 +32,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(CounterpartyCollectAccountResponse.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'unsuccessful',
                                  ErrorMessageException))
@@ -38,6 +40,8 @@ module ModernTreasury
     end
 
     # Get a paginated list of all counterparties.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [String] name Optional parameter: Performs a partial string match
@@ -52,32 +56,31 @@ module ModernTreasury
     # 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,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_counterparties(after_cursor: nil,
+                            per_page: nil,
                             name: nil,
                             email: nil,
                             metadata: nil,
                             created_at_lower_bound: nil,
-                            created_at_upper_bound: nil,
-                            after_cursor: nil)
+                            created_at_upper_bound: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/counterparties',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .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_api_response(true)
                     .is_response_array(true)
                     .local_error('400',
                                  'bad_request',
@@ -93,7 +96,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [CounterpartyCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [Counterparty] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_counterparty(idempotency_key: nil,
                             body: nil)
       @api_call
@@ -109,6 +112,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Counterparty.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('415',
                                  'unsuccessful',
                                  ErrorMessageException)
@@ -121,19 +125,21 @@ module ModernTreasury
     # Get details on a single counterparty.
     # @param [String] id Required parameter: The id of an existing
     # counterparty.
-    # @return [Counterparty] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_counterparty(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/counterparties/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .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))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -145,7 +151,7 @@ module ModernTreasury
     # counterparty.
     # @param [CounterpartyUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [Counterparty] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_counterparty(id,
                             body: nil)
       @api_call
@@ -153,6 +159,7 @@ module ModernTreasury
                                      '/api/counterparties/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .body_param(new_parameter(body))
@@ -162,6 +169,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Counterparty.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -171,17 +179,19 @@ module ModernTreasury
     # Deletes a given counterparty.
     # @param [String] id Required parameter: The id of an existing
     # counterparty.
-    # @return [void] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_counterparty(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/counterparties/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .auth(Single.new('basic_auth')))
         .response(new_response_handler
-                    .is_response_void(true))
+                    .is_response_void(true)
+                    .is_api_response(true))
         .execute
     end
   end

data/lib/modern_treasury/{controllers/document_controller.rb → apis/document_api.rb}

@@ -4,38 +4,39 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # DocumentController
-  class DocumentController < BaseController
+  # DocumentApi
+  class DocumentApi < BaseApi
     # 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`,
+    # @param [DocumentableType2] 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.
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def list_documents(documentable_id: nil,
                        documentable_type: nil,
-                       per_page: nil,
-                       after_cursor: nil)
+                       after_cursor: nil,
+                       per_page: 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'))
+                   .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_api_response(true)
                     .is_response_array(true)
                     .local_error('404',
                                  'not found',
@@ -46,7 +47,7 @@ module ModernTreasury
     # Create a document.
     # @param [String] documentable_id Required parameter: The unique identifier
     # for the associated object.
-    # @param [DocumentableType1Enum] documentable_type Required parameter: TODO:
+    # @param [DocumentableType1] documentable_type Required parameter: TODO:
     # type description here
     # @param [File | UploadIO] file Required parameter: TODO: type description
     # here
@@ -54,7 +55,7 @@ module ModernTreasury
     # 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_document(documentable_id,
                         documentable_type,
                         file,
@@ -64,9 +65,12 @@ module ModernTreasury
         .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'))
+                   .form_param(new_parameter(documentable_id, key: 'documentable_id')
+                                .is_required(true))
+                   .form_param(new_parameter(documentable_type, key: 'documentable_type')
+                                .is_required(true))
                    .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
                                      .default_content_type('application/octet-stream'))
                    .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
                    .form_param(new_parameter(document_type, key: 'document_type'))
@@ -75,6 +79,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Document.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -87,8 +92,8 @@ module ModernTreasury
     # 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`,
+    # @param [DocumentableType2] 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`.
@@ -98,7 +103,7 @@ module ModernTreasury
     # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
-    # @return [Array[Document]] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def list_documents1(documentable_id,
                         documentable_type,
                         document_type: nil,
@@ -109,8 +114,10 @@ module ModernTreasury
                                      '/api/{documentable_type}/{documentable_id}/documents',
                                      Server::DEFAULT)
                    .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(document_type, key: 'document_type'))
                    .query_param(new_parameter(after_cursor, key: 'after_cursor'))
@@ -120,6 +127,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Document.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
@@ -127,8 +135,8 @@ module ModernTreasury
     # 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`,
+    # @param [DocumentableType2] 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`.
@@ -138,7 +146,7 @@ module ModernTreasury
     # 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_document1(documentable_id,
                          documentable_type,
                          file,
@@ -149,10 +157,13 @@ module ModernTreasury
                                      '/api/{documentable_type}/{documentable_id}/documents',
                                      Server::DEFAULT)
                    .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
                                      .default_content_type('application/octet-stream'))
                    .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
                    .form_param(new_parameter(document_type, key: 'document_type'))
@@ -161,6 +172,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Document.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -173,13 +185,13 @@ module ModernTreasury
     # 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`,
+    # @param [DocumentableType2] 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_document(documentable_id,
                      documentable_type,
                      id)
@@ -188,16 +200,20 @@ module ModernTreasury
                                      '/api/{documentable_type}/{documentable_id}/documents/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .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))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -206,19 +222,21 @@ module ModernTreasury
 
     # Get an existing document.
     # @param [UUID | String] id Required parameter: The ID of the document.
-    # @return [Document] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_document1(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/documents/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .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))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -228,13 +246,13 @@ module ModernTreasury
     # 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`,
+    # @param [DocumentableType2] 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def download_document(documentable_id,
                           documentable_type,
                           id)
@@ -243,14 +261,18 @@ module ModernTreasury
                                      '/api/{documentable_type}/{documentable_id}/documents/{id}/download',
                                      Server::DEFAULT)
                    .template_param(new_parameter(documentable_id, key: 'documentable_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(documentable_type, key: 'documentable_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .auth(Single.new('basic_auth')))
         .response(new_response_handler
                     .is_response_void(true)
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -262,17 +284,19 @@ module ModernTreasury
 
     # Download an existing document.
     # @param [UUID | String] id Required parameter: The ID of the document.
-    # @return [void] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     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')
+                                    .is_required(true)
                                     .should_encode(true))
                    .auth(Single.new('basic_auth')))
         .response(new_response_handler
                     .is_response_void(true)
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)

data/lib/modern_treasury/{controllers/event_controller.rb → apis/event_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # EventController
-  class EventController < BaseController
+  # EventApi
+  class EventApi < BaseApi
     # TODO: type endpoint description here
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [DateTime] event_time_start Optional parameter: An inclusive lower
@@ -18,51 +20,52 @@ module ModernTreasury
     # 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,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_events(after_cursor: nil,
+                    per_page: nil,
                     event_time_start: nil,
                     event_time_end: nil,
                     resource: nil,
                     entity_id: nil,
-                    event_name: nil,
-                    after_cursor: nil)
+                    event_name: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/events',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .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_api_response(true)
                     .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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_event(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/events/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .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))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))