mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/{controllers/expected_payment_controller.rb → apis/expected_payment_api.rb}

@@ -4,19 +4,20 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # ExpectedPaymentController
-  class ExpectedPaymentController < BaseController
+  # ExpectedPaymentApi
+  class ExpectedPaymentApi < 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 [Status20Enum] status Optional parameter: One of unreconciled,
+    # @param [Status20] status Optional parameter: One of unreconciled,
     # reconciled, or archived.
     # @param [String] internal_account_id Optional parameter: Specify
     # internal_account_id to see expected_payments for a specific account.
-    # @param [Direction15Enum] direction Optional parameter: One of credit,
-    # debit
-    # @param [Type13Enum] type Optional parameter: One of: ach, au_becs, bacs,
-    # book, check, eft, interac, provxchange, rtp,sen, sepa, signet, wire
+    # @param [Direction15] direction Optional parameter: One of credit, debit
+    # @param [Type13] type Optional parameter: One of: ach, au_becs, bacs, book,
+    # check, eft, interac, provxchange, rtp,sen, sepa, signet, wire
     # @param [String] counterparty_id Optional parameter: Specify
     # counterparty_id to see expected_payments for a specific account.
     # @param [Hash[String, String]] metadata Optional parameter: For example, if
@@ -27,10 +28,9 @@ module ModernTreasury
     # return expected payments created after some datetime
     # @param [DateTime] created_at_upper_bound Optional parameter: Used to
     # return expected payments created before some datetime
-    # @param [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[ExpectedPayment]] Response from the API call.
-    def list_expected_payments(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_expected_payments(after_cursor: nil,
+                               per_page: nil,
                                status: nil,
                                internal_account_id: nil,
                                direction: nil,
@@ -38,12 +38,12 @@ module ModernTreasury
                                counterparty_id: 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/expected_payments',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(status, key: 'status'))
                    .query_param(new_parameter(internal_account_id, key: 'internal_account_id'))
@@ -53,12 +53,12 @@ module ModernTreasury
                    .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(ExpectedPayment.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true)
                     .local_error('401',
                                  'unsuccessful',
@@ -71,7 +71,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [ExpectedPaymentCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ExpectedPayment] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_expected_payment(idempotency_key: nil,
                                 body: nil)
       @api_call
@@ -87,6 +87,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ExpectedPayment.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'unsuccessful',
                                  ErrorMessageException))
@@ -95,19 +96,21 @@ module ModernTreasury
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: id
-    # @return [ExpectedPayment] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_expected_payment(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/expected_payments/{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(ExpectedPayment.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -118,7 +121,7 @@ module ModernTreasury
     # @param [String] id Required parameter: id
     # @param [ExpectedPaymentUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ExpectedPayment] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_expected_payment(id,
                                 body: nil)
       @api_call
@@ -126,6 +129,7 @@ module ModernTreasury
                                      '/api/expected_payments/{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))
@@ -134,25 +138,28 @@ module ModernTreasury
                    .auth(Single.new('basic_auth')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(ExpectedPayment.method(:from_hash)))
+                    .deserialize_into(ExpectedPayment.method(:from_hash))
+                    .is_api_response(true))
         .execute
     end
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: id
-    # @return [ExpectedPayment] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_expected_payment(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/expected_payments/{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(ExpectedPayment.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'parameter_invalid',
                                  ErrorMessageException))

data/lib/modern_treasury/{controllers/external_account_controller.rb → apis/external_account_api.rb}

@@ -4,15 +4,15 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # ExternalAccountController
-  class ExternalAccountController < BaseController
+  # ExternalAccountApi
+  class ExternalAccountApi < BaseApi
     # TODO: type endpoint description here
     # @param [String] id Required parameter: external account id
     # @param [String] idempotency_key Optional parameter: This key should be
     # something unique, preferably something like an UUID.
     # @param [ExternalAccountVerifyRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ExternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def verify_external_account(id,
                                 idempotency_key: nil,
                                 body: nil)
@@ -21,6 +21,7 @@ module ModernTreasury
                                      '/api/external_accounts/{id}/verify',
                                      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(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'unsuccessful',
                                  ErrorMessageException))
@@ -43,7 +45,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [ExternalAccountCompleteVerificationRequest] body Optional
     # parameter: TODO: type description here
-    # @return [ExternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def complete_verification_external_account(id,
                                                idempotency_key: nil,
                                                body: nil)
@@ -52,6 +54,7 @@ module ModernTreasury
                                      '/api/external_accounts/{id}/complete_verification',
                                      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'))
@@ -62,6 +65,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'unsuccessful',
                                  ErrorMessageException))
@@ -69,6 +73,8 @@ module ModernTreasury
     end
 
     # 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 [String] party_name Optional parameter: Searches the
@@ -79,28 +85,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[ExternalAccount]] Response from the API call.
-    def list_external_accounts(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_external_accounts(after_cursor: nil,
+                               per_page: nil,
                                party_name: nil,
                                counterparty_id: nil,
-                               metadata: nil,
-                               after_cursor: nil)
+                               metadata: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/external_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(party_name, key: 'party_name'))
                    .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(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true)
                     .local_error('401',
                                  'unsuccessful',
@@ -113,7 +118,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [ExternalAccountCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ExternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_external_account(idempotency_key: nil,
                                 body: nil)
       @api_call
@@ -129,6 +134,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('422',
                                  'unsuccessful',
                                  ErrorMessageException))
@@ -137,19 +143,21 @@ module ModernTreasury
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: external account id
-    # @return [ExternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_external_account(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/external_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(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -160,7 +168,7 @@ module ModernTreasury
     # @param [String] id Required parameter: external account id
     # @param [ExternalAccountUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ExternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_external_account(id,
                                 body: nil)
       @api_call
@@ -168,6 +176,7 @@ module ModernTreasury
                                      '/api/external_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))
@@ -177,6 +186,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ExternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -185,17 +195,19 @@ module ModernTreasury
 
     # TODO: type endpoint description here
     # @param [String] id Required parameter: external account id
-    # @return [void] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def delete_external_account(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/api/external_accounts/{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/incoming_payment_detail_controller.rb → apis/incoming_payment_detail_api.rb}

@@ -4,17 +4,19 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # IncomingPaymentDetailController
-  class IncomingPaymentDetailController < BaseController
+  # IncomingPaymentDetailApi
+  class IncomingPaymentDetailApi < BaseApi
     # Get a list of Incoming Payment Details.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
     # @param [Integer] per_page Optional parameter: TODO: type description
     # here
-    # @param [Direction15Enum] direction Optional parameter: One of `credit` or
+    # @param [Direction15] direction Optional parameter: One of `credit` or
     # `debit`.
-    # @param [Status21Enum] status Optional parameter: The current status of the
+    # @param [Status21] status Optional parameter: The current status of the
     # incoming payment order. One of `pending`, `completed`, or `returned`.
-    # @param [Type14Enum] type Optional parameter: One of: `ach`, `book`,
-    # `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or `wire`.
+    # @param [Type14] type Optional parameter: One of: `ach`, `book`, `check`,
+    # `eft`, `interac`, `rtp`, `sepa`, `signet`, or `wire`.
     # @param [Date] as_of_date_start Optional parameter: Filters incoming
     # payment details with an as_of_date starting on or after the specified date
     # (YYYY-MM-DD).
@@ -27,22 +29,21 @@ module ModernTreasury
     # parameters.
     # @param [String] virtual_account_id Optional parameter: If the incoming
     # payment detail is in a virtual account, the ID of the Virtual Account.
-    # @param [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[IncomingPaymentDetail]] Response from the API call.
-    def list_incoming_payment_details(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_incoming_payment_details(after_cursor: nil,
+                                      per_page: nil,
                                       direction: nil,
                                       status: nil,
                                       type: nil,
                                       as_of_date_start: nil,
                                       as_of_date_end: nil,
                                       metadata: nil,
-                                      virtual_account_id: nil,
-                                      after_cursor: nil)
+                                      virtual_account_id: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/incoming_payment_details',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
                    .query_param(new_parameter(per_page, key: 'per_page'))
                    .query_param(new_parameter(direction, key: 'direction'))
                    .query_param(new_parameter(status, key: 'status'))
@@ -51,12 +52,12 @@ module ModernTreasury
                    .query_param(new_parameter(as_of_date_end, key: 'as_of_date_end'))
                    .query_param(new_parameter(metadata, key: 'metadata'))
                    .query_param(new_parameter(virtual_account_id, key: 'virtual_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(IncomingPaymentDetail.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true)
                     .local_error('401',
                                  'unsuccessful',
@@ -67,19 +68,21 @@ module ModernTreasury
     # Get an existing Incoming Payment Detail.
     # @param [String] id Required parameter: The unique identifier of the
     # incoming payment detail.
-    # @return [IncomingPaymentDetail] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_incoming_payment_detail(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/incoming_payment_details/{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(IncomingPaymentDetail.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -91,7 +94,7 @@ module ModernTreasury
     # incoming payment detail.
     # @param [IncomingPaymentDetailUpdateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [IncomingPaymentDetail] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_incoming_payment_detail(id,
                                        body: nil)
       @api_call
@@ -99,6 +102,7 @@ module ModernTreasury
                                      '/api/incoming_payment_details/{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))
@@ -108,6 +112,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(IncomingPaymentDetail.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -119,7 +124,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [IncomingPaymentDetailCreateRequest] body Optional parameter: TODO:
     # type description here
-    # @return [AsyncResponse] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_async_incoming_payment_detail(idempotency_key: nil,
                                              body: nil)
       @api_call
@@ -135,6 +140,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(AsyncResponse.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException)

data/lib/modern_treasury/{controllers/internal_account_controller.rb → apis/internal_account_api.rb}

@@ -4,49 +4,50 @@
 # https://www.apimatic.io ).
 
 module ModernTreasury
-  # InternalAccountController
-  class InternalAccountController < BaseController
+  # InternalAccountApi
+  class InternalAccountApi < 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 [CurrencyEnum] currency Optional parameter: The currency associated
+    # @param [Currency] currency Optional parameter: The currency associated
     # with the internal account.
     # @param [String] counterparty_id Optional parameter: The counterparty
     # associated with the internal account.
-    # @param [PaymentType13Enum] payment_type Optional parameter: The type of
+    # @param [PaymentType13] payment_type Optional parameter: The type of
     # payment that can be made by the internal account.
-    # @param [PaymentDirectionEnum] payment_direction Optional parameter: The
+    # @param [PaymentDirection] payment_direction Optional parameter: The
     # direction of payments that can be made by internal account.
     # @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 [String] after_cursor Optional parameter: TODO: type description
-    # here
-    # @return [Array[InternalAccount]] Response from the API call.
-    def list_internal_accounts(per_page: nil,
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_internal_accounts(after_cursor: nil,
+                               per_page: nil,
                                currency: nil,
                                counterparty_id: nil,
                                payment_type: nil,
                                payment_direction: nil,
-                               metadata: nil,
-                               after_cursor: nil)
+                               metadata: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/internal_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(currency, key: 'currency'))
                    .query_param(new_parameter(counterparty_id, key: 'counterparty_id'))
                    .query_param(new_parameter(payment_type, key: 'payment_type'))
                    .query_param(new_parameter(payment_direction, key: 'payment_direction'))
                    .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(InternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .is_response_array(true))
         .execute
     end
@@ -56,7 +57,7 @@ module ModernTreasury
     # something unique, preferably something like an UUID.
     # @param [InternalAccountCreateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [InternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_internal_account(idempotency_key: nil,
                                 body: nil)
       @api_call
@@ -72,6 +73,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(InternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException)
@@ -84,19 +86,21 @@ module ModernTreasury
     # TODO: type endpoint description here
     # @param [String] id Required parameter: Unique identifier for the
     # account.
-    # @return [InternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_internal_account(id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/api/internal_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(InternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'not found',
                                  ErrorMessageException))
@@ -108,7 +112,7 @@ module ModernTreasury
     # account.
     # @param [InternalAccountUpdateRequest] body Optional parameter: TODO: type
     # description here
-    # @return [InternalAccount] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_internal_account(id,
                                 body: nil)
       @api_call
@@ -116,6 +120,7 @@ module ModernTreasury
                                      '/api/internal_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))
@@ -125,6 +130,7 @@ module ModernTreasury
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(InternalAccount.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('404',
                                  'unsuccessful',
                                  ErrorMessageException))