fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/controllers/internal_transfers_controller.rb

@@ -0,0 +1,326 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # InternalTransfersController
+  class InternalTransfersController < BaseController
+    # Search for transfers
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [String] updated_since Optional parameter: Return items that have
+    # been created or updated since the nextUpdateId
+    # @param [String] offset Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Deprecated in favor of
+    # PageKeyQuery, will be removed with a future major release
+    # @param [String] page_key Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Pagination can be implemented
+    # per provider's preference
+    # @param [Integer] limit Optional parameter: Number of elements that the
+    # consumer wishes to receive. Providers should implement reasonable
+    # default/maximum/minimum values based on their internal architecture and
+    # update their documentation accordingly
+    # @param [Date] search_start_transfer_date Optional parameter: Start time
+    # for use in retrieval of transfers by transfer date
+    # @param [Date] search_end_transfer_date Optional parameter: End time for
+    # use in retrieval of transfers by transfer date
+    # @param [Array[String]] search_from_account_ids Optional parameter: Search
+    # for transfers by source account(s)
+    # @param [Array[String]] search_to_account_ids Optional parameter: Search
+    # for transfers by target account(s)
+    # @param [Array[PaymentStatus]] search_statuses Optional parameter: Search
+    # for transfers by current statuses
+    # @param [Array[String]] search_transfer_ids Optional parameter: Search for
+    # transfers by id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_transfers(x_fapi_interaction_id,
+                             fdx_api_actor_type: nil,
+                             fdx_api_data_provider_id: nil,
+                             fdx_api_data_recipient_id: nil,
+                             updated_since: nil,
+                             offset: nil,
+                             page_key: nil,
+                             limit: nil,
+                             search_start_transfer_date: nil,
+                             search_end_transfer_date: nil,
+                             search_from_account_ids: nil,
+                             search_to_account_ids: nil,
+                             search_statuses: nil,
+                             search_transfer_ids: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transfers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .query_param(new_parameter(updated_since, key: 'updatedSince'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(search_start_transfer_date, key: 'searchStartTransferDate'))
+                   .query_param(new_parameter(search_end_transfer_date, key: 'searchEndTransferDate'))
+                   .query_param(new_parameter(search_from_account_ids, key: 'searchFromAccountIds'))
+                   .query_param(new_parameter(search_to_account_ids, key: 'searchToAccountIds'))
+                   .query_param(new_parameter(search_statuses, key: 'searchStatuses'))
+                   .query_param(new_parameter(search_transfer_ids, key: 'searchTransferIds'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransfersEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Start or end date value is not in the ISO 8601 format',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Data not found for request parameters',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Create a transfer between accounts
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] idempotency_key Required parameter: Used to de-duplicate
+    # requests
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [TransferForCreateEntity1] body Optional parameter: Data of the
+    # transfer request
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def request_account_transfer(x_fapi_interaction_id,
+                                 idempotency_key,
+                                 fdx_api_actor_type: nil,
+                                 fdx_api_data_provider_id: nil,
+                                 fdx_api_data_recipient_id: nil,
+                                 body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/transfers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(idempotency_key, key: 'idempotency-key')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransferEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Source account does not have sufficient funds',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Account not authorized for transfer',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Requested transfer is invalid',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Duplicate transfer request',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Get a transfer between accounts
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] transfer_id Required parameter: Transfer identifier
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_transfer(x_fapi_interaction_id,
+                     transfer_id,
+                     fdx_api_actor_type: nil,
+                     fdx_api_data_provider_id: nil,
+                     fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transfers/{transferId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(transfer_id, key: 'transferId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransferEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update a transfer between accounts
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] transfer_id Required parameter: Transfer identifier
+    # @param [String] idempotency_key Required parameter: Used to de-duplicate
+    # requests
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [TransferForCreateEntity2] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_account_transfer(x_fapi_interaction_id,
+                                transfer_id,
+                                idempotency_key,
+                                fdx_api_actor_type: nil,
+                                fdx_api_data_provider_id: nil,
+                                fdx_api_data_recipient_id: nil,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/transfers/{transferId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(transfer_id, key: 'transferId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(idempotency_key, key: 'idempotency-key')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransferEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Source account does not have sufficient funds',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Account not authorized for transfer',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Requested transfer change is invalid',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Duplicate transfer request',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Cancel a transfer between accounts
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] transfer_id Required parameter: Transfer identifier
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_transfer(x_fapi_interaction_id,
+                        transfer_id,
+                        fdx_api_actor_type: nil,
+                        fdx_api_data_provider_id: nil,
+                        fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/transfers/{transferId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(transfer_id, key: 'transferId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransferEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/meta_controller.rb

@@ -0,0 +1,131 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # MetaController
+  class MetaController < BaseController
+    # Get information about this API's availability
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [FdxResourceOperationId] operation_id Optional parameter: Specific
+    # operationId for which to get the metrics. Optional
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_availability(x_fapi_interaction_id,
+                         fdx_api_actor_type: nil,
+                         fdx_api_data_provider_id: nil,
+                         operation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/availability',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .query_param(new_parameter(operation_id, key: 'operationId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthFapi1Baseline')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AvailabilityListEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get information about this API's capability
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [FdxResourceOperationId] operation_id Optional parameter: Specific
+    # operationId for which to get the metrics. Optional
+    # @param [FdxVersion] fdx_version Optional parameter: Specific FDX version
+    # for which to get the capability. Optional. Deprecated in v6.5 and replaced
+    # with `FdxApiVersionQuery` in components
+    # @param [FdxVersion] fdx_api_version Optional parameter: Specific FDX
+    # version for which to request the API response. Optional
+    # @param [ResultType] result_type Optional parameter: Flag to indicate if
+    # you want a lightweight array of metadata (AccountDescriptor or Tax or
+    # Operations) or full item details (Account or a Tax subclass or
+    # Availability details). If set to 'lightweight', should only return the
+    # fields associated with the metadata entity. This field is not required,
+    # defaults to lightweight
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_capability(x_fapi_interaction_id,
+                       fdx_api_actor_type: nil,
+                       fdx_api_data_provider_id: nil,
+                       operation_id: nil,
+                       fdx_version: nil,
+                       fdx_api_version: nil,
+                       result_type: ResultType::LIGHTWEIGHT)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/capability',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .query_param(new_parameter(operation_id, key: 'operationId'))
+                   .query_param(new_parameter(fdx_version, key: 'fdxVersion'))
+                   .query_param(new_parameter(fdx_api_version, key: 'FDX-API-Version'))
+                   .query_param(new_parameter(result_type, key: 'resultType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthFapi1Baseline')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CapabilityEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get certification performance metrics for this implementer's APIs
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [FdxResourceOperationId] operation_id Optional parameter: Specific
+    # operationId for which to get the metrics. Optional
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_certification_metrics(x_fapi_interaction_id,
+                                  fdx_api_actor_type: nil,
+                                  fdx_api_data_provider_id: nil,
+                                  operation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/certification-metrics',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .query_param(new_parameter(operation_id, key: 'operationId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthFapi1Baseline')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CertificationMetricsEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end