mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/{controllers/ledger_account_payout_controller.rb → apis/ledger_account_payout_api.rb}

@@ -4,14 +4,14 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # LedgerAccountPayoutController
-  class LedgerAccountPayoutController < BaseController
+  # LedgerAccountPayoutApi
+  class LedgerAccountPayoutApi < BaseApi
     # Create a ledger account payout.
     # @param [String] idempotency_key Optional parameter: This key should be
     # something unique, preferably something like an UUID.
     # @param [LedgerAccountPayoutCreateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [LedgerAccountPayout] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_ledger_account_payout(idempotency_key: nil,
                                      body: nil)
       @api_call
@@ -27,6 +27,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(LedgerAccountPayout.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -37,6 +38,8 @@ module ModernTreasury
     end
 
     # Get a list of ledger account payouts.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [Hash[String, String]] metadata Optional parameter: For example, if
@@ -45,45 +48,46 @@ module ModernTreasury
     # parameters.
     # @param [String] payout_ledger_account_id Optional parameter: TODO: type
     # description here
-    # @param [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[LedgerAccountPayout]] Response from the API call.
-    def list_ledger_account_payouts(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_ledger_account_payouts(after_cursor: nil,
+                                    per_page: nil,
                                     metadata: nil,
-                                    payout_ledger_account_id: nil,
-                                    after_cursor: nil)
+                                    payout_ledger_account_id: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_account_payouts',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
                    .query_param(new_parameter(payout_ledger_account_id, key: 'payout_ledger_account_id'))
-                   .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(LedgerAccountPayout.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
 
     # Get details on a single ledger account payout.
     # @param [String] id Required parameter: id
-    # @return [LedgerAccountPayout] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_ledger_account_payout(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_account_payouts/{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(LedgerAccountPayout.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -94,7 +98,7 @@ module ModernTreasury
     # @param [String] id Required parameter: id
     # @param [LedgerAccountPayoutUpdateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [LedgerAccountPayout] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_ledger_account_payout(id,
                                      body: nil)
       @api_call
@@ -102,6 +106,7 @@ module ModernTreasury
                                      '/api/ledger_account_payouts/{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))
@@ -111,6 +116,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(LedgerAccountPayout.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)

data/lib/modern_treasury/{controllers/ledger_account_statement_controller.rb → apis/ledger_account_statement_api.rb}

@@ -4,14 +4,14 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # LedgerAccountStatementController
-  class LedgerAccountStatementController < BaseController
+  # LedgerAccountStatementApi
+  class LedgerAccountStatementApi < BaseApi
     # Create a ledger account statement.
     # @param [String] idempotency_key Optional parameter: This key should be
     # something unique, preferably something like an UUID.
     # @param [LedgerAccountStatementCreateRequest] body Optional parameter:
     # TODO: type description here
-    # @return [LedgerAccountStatement] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_ledger_account_statement(idempotency_key: nil,
                                         body: nil)
       @api_call
@@ -27,6 +27,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(LedgerAccountStatement.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -38,19 +39,21 @@ module ModernTreasury
 
     # Get details on a single ledger account statement.
     # @param [String] id Required parameter: id
-    # @return [LedgerAccountStatement] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_ledger_account_statement(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_account_statements/{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(LedgerAccountStatement.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))

data/lib/modern_treasury/{controllers/ledger_controller.rb → apis/ledger_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # LedgerController
-  class LedgerController < BaseController
+  # LedgerApi
+  class LedgerApi < BaseApi
     # Get a list of ledgers.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [Hash[String, String]] metadata Optional parameter: For example, if
@@ -17,26 +19,25 @@ module ModernTreasury
     # (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted
     # at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
     # updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
-    # @param [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[Ledger]] Response from the API call.
-    def list_ledgers(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_ledgers(after_cursor: nil,
+                     per_page: nil,
                      metadata: nil,
-                     updated_at: nil,
-                     after_cursor: nil)
+                     updated_at: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledgers',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
                    .query_param(new_parameter(updated_at, key: 'updated_at'))
-                   .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(Ledger.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
@@ -46,7 +47,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [LedgerCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [Ledger] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_ledger(idempotency_key: nil,
                       body: nil)
       @api_call
@@ -62,6 +63,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Ledger.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -73,19 +75,21 @@ module ModernTreasury
 
     # Get details on a single ledger.
     # @param [String] id Required parameter: id
-    # @return [Ledger] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_ledger(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledgers/{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(Ledger.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -96,7 +100,7 @@ module ModernTreasury
     # @param [String] id Required parameter: id
     # @param [LedgerUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [Ledger] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_ledger(id,
                       body: nil)
       @api_call
@@ -104,6 +108,7 @@ module ModernTreasury
                                      '/api/ledgers/{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))
@@ -113,6 +118,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(Ledger.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)
@@ -127,19 +133,21 @@ module ModernTreasury
 
     # Delete a ledger.
     # @param [String] id Required parameter: id
-    # @return [Ledger] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_ledger(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/ledgers/{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(Ledger.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('403',
                                  'forbidden',
                                  ErrorMessageException)

data/lib/modern_treasury/{controllers/ledger_entry_controller.rb → apis/ledger_entry_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # LedgerEntryController
-  class LedgerEntryController < BaseController
+  # LedgerEntryApi
+  class LedgerEntryApi < BaseApi
     # Get a list of all ledger entries.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [Hash[String, String]] id Optional parameter: TODO: type
@@ -44,13 +46,12 @@ module ModernTreasury
     # response will include ledger entries that were deleted. When you update a
     # ledger transaction to specify a new set of entries, the previous entries
     # are deleted.
-    # @param [Direction15Enum] direction Optional parameter: If true, response
-    # will include ledger entries that were deleted. When you update a ledger
+    # @param [Direction15] direction Optional parameter: If true, response will
+    # include ledger entries that were deleted. When you update a ledger
     # transaction to specify a new set of entries, the previous entries are
     # deleted.
-    # @param [Status22Enum] status Optional parameter: Get all ledger entries
-    # that match the status specified. One of `pending`, `posted`, or
-    # `archived`.
+    # @param [Status22] status Optional parameter: Get all ledger entries that
+    # match the status specified. One of `pending`, `posted`, or `archived`.
     # @param [OrderBy] order_by Optional parameter: Order by `created_at` or
     # `effective_at` in `asc` or `desc` order. For example, to order by
     # `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering by only
@@ -62,10 +63,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[LedgerEntry]] Response from the API call.
-    def list_ledger_entries(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_ledger_entries(after_cursor: nil,
+                            per_page: nil,
                             id: nil,
                             ledger_account_id: nil,
                             ledger_transaction_id: nil,
@@ -82,12 +82,12 @@ module ModernTreasury
                             status: nil,
                             order_by: nil,
                             show_balances: nil,
-                            metadata: nil,
-                            after_cursor: nil)
+                            metadata: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_entries',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(id, key: 'id'))
                    .query_param(new_parameter(ledger_account_id, key: 'ledger_account_id'))
@@ -106,12 +106,12 @@ module ModernTreasury
                    .query_param(new_parameter(order_by, key: 'order_by'))
                    .query_param(new_parameter(show_balances, key: 'show_balances'))
                    .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(LedgerEntry.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true)
                     .local_error('422',
                                  'unsuccessful',
@@ -124,7 +124,7 @@ module ModernTreasury
     # @param [TrueClass | FalseClass] show_balances Optional parameter: If true,
     # response will include the balances attached to the ledger entry. If there
     # is no balance available, null will be returned instead.
-    # @return [LedgerEntry] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_ledger_entry(id,
                          show_balances: nil)
       @api_call
@@ -132,6 +132,7 @@ module ModernTreasury
                                      '/api/ledger_entries/{id}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(show_balances, key: 'show_balances'))
                    .header_param(new_parameter('application/json', key: 'accept'))
@@ -139,6 +140,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(LedgerEntry.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))

data/lib/modern_treasury/{controllers/ledger_event_handler_controller.rb → apis/ledger_event_handler_api.rb}

@@ -4,9 +4,11 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # LedgerEventHandlerController
-  class LedgerEventHandlerController < BaseController
+  # LedgerEventHandlerApi
+  class LedgerEventHandlerApi < BaseApi
     # Get a list of ledger event handlers.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
     # @param [Hash[String, String]] metadata Optional parameter: For example, if
@@ -18,28 +20,27 @@ module ModernTreasury
     # (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted
     # at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
     # created_at%5Bgt%5D=2000-01-01T12:00:00Z.
-    # @param [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[LedgerEventHandler]] Response from the API call.
-    def list_ledger_event_handlers(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_ledger_event_handlers(after_cursor: nil,
+                                   per_page: nil,
                                    metadata: nil,
                                    name: nil,
-                                   created_at: nil,
-                                   after_cursor: nil)
+                                   created_at: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_event_handlers',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
                    .query_param(new_parameter(name, key: 'name'))
                    .query_param(new_parameter(created_at, key: 'created_at'))
-                   .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(LedgerEventHandler.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
@@ -49,7 +50,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [LedgerEventHandlerCreateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [LedgerEventHandler] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_ledger_event_handler(idempotency_key: nil,
                                     body: nil)
       @api_call
@@ -65,6 +66,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(LedgerEventHandler.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('400',
                                  'parameter_invalid',
                                  APIException)
@@ -76,19 +78,21 @@ module ModernTreasury
 
     # Get details on a single ledger event handler.
     # @param [String] id Required parameter: id
-    # @return [LedgerEventHandler] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_ledger_event_handler(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/ledger_event_handlers/{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(LedgerEventHandler.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -97,19 +101,21 @@ module ModernTreasury
 
     # Archive a ledger event handler.
     # @param [String] id Required parameter: id
-    # @return [LedgerEventHandler] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_ledger_event_handler(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/ledger_event_handlers/{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(LedgerEventHandler.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))