mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/{controllers/routing_detail_controller.rb → apis/routing_detail_api.rb}

@@ -4,16 +4,16 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # RoutingDetailController
-  class RoutingDetailController < BaseController
+  # RoutingDetailApi
+  class RoutingDetailApi < BaseApi
     # Get a list of routing details for a single internal or external account.
-    # @param [AccountsTypeEnum] accounts_type Required parameter: Example:
+    # @param [AccountsType] accounts_type Required parameter: Example:
     # @param [String] account_id Required parameter: The ID of the account.
     # @param [String] after_cursor Optional parameter: TODO: type description
     # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
-    # @return [Array[RoutingDetail]] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def list_routing_details(accounts_type,
                              account_id,
                              after_cursor: nil,
@@ -23,8 +23,10 @@ module ModernTreasury
                                      '/api/{accounts_type}/{account_id}/routing_details',
                                      Server::DEFAULT)
                    .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(account_id, key: 'account_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
@@ -33,18 +35,19 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(RoutingDetail.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
 
     # Create a routing detail for a single external account.
-    # @param [AccountsType1Enum] accounts_type Required parameter: Example:
+    # @param [AccountsType1] accounts_type Required parameter: Example:
     # @param [String] account_id Required parameter: The ID of the account.
     # @param [String] idempotency_key Optional parameter: This key should be
     # something unique, preferably something like an UUID.
     # @param [RoutingDetailCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [RoutingDetail] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_routing_detail(accounts_type,
                               account_id,
                               idempotency_key: nil,
@@ -54,8 +57,10 @@ module ModernTreasury
                                      '/api/{accounts_type}/{account_id}/routing_details',
                                      Server::DEFAULT)
                    .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(account_id, key: 'account_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'))
@@ -66,6 +71,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(RoutingDetail.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'unsuccessful',
                                  ErrorMessageException)
@@ -76,10 +82,10 @@ module ModernTreasury
     end
 
     # Get a single routing detail for a single internal or external account.
-    # @param [AccountsTypeEnum] accounts_type Required parameter: Example:
+    # @param [AccountsType] accounts_type Required parameter: Example:
     # @param [String] account_id Required parameter: The ID of the account.
     # @param [String] id Required parameter: The ID of the routing detail.
-    # @return [RoutingDetail] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_routing_detail(accounts_type,
                            account_id,
                            id)
@@ -88,16 +94,20 @@ module ModernTreasury
                                      '/api/{accounts_type}/{account_id}/routing_details/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(account_id, key: 'account_id')
+                                    .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(RoutingDetail.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -105,10 +115,10 @@ module ModernTreasury
     end
 
     # Delete a routing detail for a single external account.
-    # @param [AccountsType1Enum] accounts_type Required parameter: Example:
+    # @param [AccountsType1] accounts_type Required parameter: Example:
     # @param [String] account_id Required parameter: The ID of the account.
     # @param [String] id Required parameter: The ID of the routing detail.
-    # @return [void] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_routing_detail(accounts_type,
                               account_id,
                               id)
@@ -117,14 +127,18 @@ module ModernTreasury
                                      '/api/{accounts_type}/{account_id}/routing_details/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .is_required(true)
                                     .should_encode(true))
                    .template_param(new_parameter(account_id, key: 'account_id')
+                                    .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_response_void(true)
+                    .is_api_response(true))
         .execute
     end
   end

data/lib/modern_treasury/{controllers/transaction_controller.rb → apis/transaction_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # TransactionController
-  class TransactionController < BaseController
+  # TransactionApi
+  class TransactionApi < BaseApi
     # Get a list of all transactions.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [UUID | String] internal_account_id Optional parameter: Specify
@@ -38,10 +40,9 @@ module ModernTreasury
     # 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 [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[Transaction]] Response from the API call.
-    def list_transactions(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_transactions(after_cursor: nil,
+                          per_page: nil,
                           internal_account_id: nil,
                           virtual_account_id: nil,
                           posted: nil,
@@ -53,12 +54,12 @@ module ModernTreasury
                           transactable_type: nil,
                           description: nil,
                           vendor_id: nil,
-                          metadata: nil,
-                          after_cursor: nil)
+                          metadata: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/transactions',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(internal_account_id, key: 'internal_account_id'))
                    .query_param(new_parameter(virtual_account_id, key: 'virtual_account_id'))
@@ -72,31 +73,33 @@ module ModernTreasury
                    .query_param(new_parameter(description, key: 'description'))
                    .query_param(new_parameter(vendor_id, key: 'vendor_id'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
-                   .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(Transaction.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
 
     # Get details on a single transaction.
     # @param [String] id Required parameter: Transaction ID
-    # @return [Transaction] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_transaction(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/transactions/{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(Transaction.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -107,7 +110,7 @@ module ModernTreasury
     # @param [String] id Required parameter: Transaction ID
     # @param [IncomingPaymentDetailUpdateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [Transaction] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_transaction(id,
                            body: nil)
       @api_call
@@ -115,6 +118,7 @@ module ModernTreasury
                                      '/api/transactions/{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))
@@ -124,6 +128,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Transaction.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))

data/lib/modern_treasury/{controllers/transaction_line_item_controller.rb → apis/transaction_line_item_api.rb}

@@ -4,16 +4,16 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # TransactionLineItemController
-  class TransactionLineItemController < BaseController
+  # TransactionLineItemApi
+  class TransactionLineItemApi < BaseApi
     # TODO: type endpoint description here
     # @param [String] transaction_id Required parameter: transaction_id
     # @param [String] after_cursor Optional parameter: TODO: type description
     # here
-    # @param [Type16Enum] type Optional parameter: Example:
+    # @param [Type16] type Optional parameter: Example:
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
-    # @return [Array[TransactionLineItem]] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def list_transaction_line_items(transaction_id,
                                     after_cursor: nil,
                                     type: nil,
@@ -23,6 +23,7 @@ module ModernTreasury
                                      '/api/transactions/{transaction_id}/line_items',
                                      Server::DEFAULT)
                    .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(type, key: 'type'))
@@ -32,6 +33,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(TransactionLineItem.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end

data/lib/modern_treasury/{controllers/validation_controller.rb → apis/validation_api.rb}

@@ -4,31 +4,34 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # ValidationController
-  class ValidationController < BaseController
+  # ValidationApi
+  class ValidationApi < BaseApi
     # Validates the routing number information supplied without creating a
     # routing detail
     # @param [String] routing_number Required parameter: The routing number that
     # is being validated.
-    # @param [RoutingNumberType8Enum] routing_number_type Required parameter:
-    # One of `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
+    # @param [RoutingNumberType8] routing_number_type Required parameter: One of
+    # `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
     # `in_ifsc`, `my_branch_code`, or `swift`. In sandbox mode we currently only
     # support `aba` and `swift` with routing numbers '123456789' and
     # 'GRINUST0XXX' respectively.
-    # @return [RoutingNumberLookupRequest] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def validate_routing_number(routing_number,
                                 routing_number_type)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/validations/routing_numbers',
                                      Server::DEFAULT)
-                   .query_param(new_parameter(routing_number, key: 'routing_number'))
-                   .query_param(new_parameter(routing_number_type, key: 'routing_number_type'))
+                   .query_param(new_parameter(routing_number, key: 'routing_number')
+                                 .is_required(true))
+                   .query_param(new_parameter(routing_number_type, key: 'routing_number_type')
+                                 .is_required(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(RoutingNumberLookupRequest.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException)

data/lib/modern_treasury/{controllers/virtual_account_controller.rb → apis/virtual_account_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # VirtualAccountController
-  class VirtualAccountController < BaseController
+  # VirtualAccountApi
+  class VirtualAccountApi < BaseApi
     # Get a list of virtual accounts.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [UUID | String] internal_account_id Optional parameter: TODO: type
@@ -17,28 +19,27 @@ module ModernTreasury
     # 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 [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[VirtualAccount]] Response from the API call.
-    def list_virtual_accounts(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_virtual_accounts(after_cursor: nil,
+                              per_page: nil,
                               internal_account_id: nil,
                               counterparty_id: nil,
-                              metadata: nil,
-                              after_cursor: nil)
+                              metadata: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/virtual_accounts',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(internal_account_id, key: 'internal_account_id'))
                    .query_param(new_parameter(counterparty_id, key: 'counterparty_id'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
-                   .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(VirtualAccount.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true)
                     .local_error('401',
                                  'unsuccessful',
@@ -51,7 +52,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [VirtualAccountCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [VirtualAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_virtual_account(idempotency_key: nil,
                                body: nil)
       @api_call
@@ -67,6 +68,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(VirtualAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('401',
                                  'unauthorized',
                                  ErrorMessageException)
@@ -78,19 +80,21 @@ module ModernTreasury
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: Virtual Acccount ID
-    # @return [VirtualAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_virtual_account(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/virtual_accounts/{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(VirtualAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -101,7 +105,7 @@ module ModernTreasury
     # @param [String] id Required parameter: Virtual Acccount ID
     # @param [VirtualAccountUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [VirtualAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_virtual_account(id,
                                body: nil)
       @api_call
@@ -109,6 +113,7 @@ module ModernTreasury
                                      '/api/virtual_accounts/{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))
@@ -117,25 +122,28 @@ module ModernTreasury
                    .auth(Single.new('basic_auth')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(VirtualAccount.method(:from_hash)))
+                    .deserialize_into(VirtualAccount.method(:from_hash))
+                    .is_api_response(true))
         .execute
     end
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: Virtual Acccount ID
-    # @return [VirtualAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_virtual_account(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/virtual_accounts/{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(VirtualAccount.method(:from_hash)))
+                    .deserialize_into(VirtualAccount.method(:from_hash))
+                    .is_api_response(true))
         .execute
     end
   end