fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/controllers/account_transactions_controller.rb

@@ -0,0 +1,312 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # AccountTransactionsController
+  class AccountTransactionsController < BaseController
+    # Search for account transactions with rewards. Example:
+    # /accounts/{accountId}/reward-transactions?startDate=date1&endDate=date2
+    # @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] account_id Required parameter: Account 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
+    # @param [Date] start_date Optional parameter: Start date for use in
+    # retrieval of elements (ISO 8601 format). Provider to define the date
+    # ranges and behaviors they will support. Example of defined behavior:   -
+    # Recipients need to either specify both start date and end date or neither.
+    #     If both start date and end date are not specified; default provided.
+    #   Default range: 7 Days of past data. (Today's date - 6 days both dates
+    # are inclusive)   - Recipient can specify the same start date and end date.
+    #     The returned data will reflect transactions from that date   - If
+    # start date and end date both are specified and if start date is later than
+    # end date,     return 'invalid date range' error code: 703, HTTPS 400 per
+    # the FDX spec   - If start Date and end date both are specified and if
+    # start date is older than what the Data Provider supports,     then the
+    # Data Provider should return 'invalid date range' error code: 703, HTTPS
+    # 400 per the FDX spec.     Example: If today is 5/14/2024 and the DP
+    # supports 24 months, the start date should be 5/14/2022 and newer;     it
+    # should not be 5/13/2022 or older   - If start date is specified but end
+    # date is not specified or vice versa;     Data Provider should return
+    # 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    # @param [Date] end_date Optional parameter: End date for use in retrieval
+    # of elements (ISO 8601 format). Provider to define the date ranges and
+    # behaviors they will support. Example of defined behavior:   - Recipients
+    # need to either specify both start date and end date or neither.     If
+    # both start date and end date are not specified; default provided.
+    # Default range: 7 Days of past data. (Today's date - 6 days both dates are
+    # inclusive)   - Recipient can specify the same start date and end date. The
+    # returned data will reflect transactions from that date   - If start date
+    # and end date both are specified and if start date is later than end date,
+    #    return 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    #   - If start Date and end date both are specified and if start date is
+    # older than what the Data Provider supports,     then the Data Provider
+    # should return 'invalid date range' error code: 703, HTTPS 400 per the FDX
+    # spec.     Example: If today is 5/14/2024 and the DP supports 24 months,
+    # the start date should be 5/14/2022 and newer;     it should not be
+    # 5/13/2022 or older   - If start date is specified but end date is not
+    # specified or vice versa;     Data Provider should return 'invalid date
+    # range' error code: 703, HTTPS 400 per the FDX spec   - If end date is
+    # today's date, the most recent transactions from the time the request is
+    # received will be returned
+    # @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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_account_reward_transactions(x_fapi_interaction_id,
+                                               account_id,
+                                               fdx_api_actor_type: nil,
+                                               fdx_api_data_provider_id: nil,
+                                               fdx_api_data_recipient_id: nil,
+                                               start_date: nil,
+                                               end_date: nil,
+                                               page_key: nil,
+                                               limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}/reward-transactions',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .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'))
+                   .query_param(new_parameter(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RewardTransactionsEntity.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',
+                                 'Account with id not found',
+                                 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 account transaction image
+    # @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] account_id Required parameter: Account Identifier
+    # @param [String] image_id Required parameter: Image 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_account_transaction_images(x_fapi_interaction_id,
+                                       account_id,
+                                       image_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,
+                                     '/accounts/{accountId}/transaction-images/{imageId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(image_id, key: 'imageId')
+                                    .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(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Account or image with id not found',
+                                 ErrorException)
+                    .local_error('406',
+                                 'Content Type not Supported',
+                                 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
+
+    # Search for account transactions. Example:
+    # /accounts/{accountId}/transactions?startTime=value1&endTime=value2
+    # @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] account_id Required parameter: Account 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_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @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 [Date] start_time Optional parameter: Start time for use in
+    # retrieval of elements (ISO 8601). Will support filtering by time in a
+    # future major release. To support filtering by date only, see
+    # StartDateQuery
+    # @param [Date] end_time Optional parameter: End time for use in retrieval
+    # of elements (ISO 8601). Will support filtering by time in a future major
+    # release. To support filtering by date only, see EndDateQuery
+    # @param [Date] start_date Optional parameter: Start date for use in
+    # retrieval of elements (ISO 8601 format). Provider to define the date
+    # ranges and behaviors they will support. Example of defined behavior:   -
+    # Recipients need to either specify both start date and end date or neither.
+    #     If both start date and end date are not specified; default provided.
+    #   Default range: 7 Days of past data. (Today's date - 6 days both dates
+    # are inclusive)   - Recipient can specify the same start date and end date.
+    #     The returned data will reflect transactions from that date   - If
+    # start date and end date both are specified and if start date is later than
+    # end date,     return 'invalid date range' error code: 703, HTTPS 400 per
+    # the FDX spec   - If start Date and end date both are specified and if
+    # start date is older than what the Data Provider supports,     then the
+    # Data Provider should return 'invalid date range' error code: 703, HTTPS
+    # 400 per the FDX spec.     Example: If today is 5/14/2024 and the DP
+    # supports 24 months, the start date should be 5/14/2022 and newer;     it
+    # should not be 5/13/2022 or older   - If start date is specified but end
+    # date is not specified or vice versa;     Data Provider should return
+    # 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    # @param [Date] end_date Optional parameter: End date for use in retrieval
+    # of elements (ISO 8601 format). Provider to define the date ranges and
+    # behaviors they will support. Example of defined behavior:   - Recipients
+    # need to either specify both start date and end date or neither.     If
+    # both start date and end date are not specified; default provided.
+    # Default range: 7 Days of past data. (Today's date - 6 days both dates are
+    # inclusive)   - Recipient can specify the same start date and end date. The
+    # returned data will reflect transactions from that date   - If start date
+    # and end date both are specified and if start date is later than end date,
+    #    return 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    #   - If start Date and end date both are specified and if start date is
+    # older than what the Data Provider supports,     then the Data Provider
+    # should return 'invalid date range' error code: 703, HTTPS 400 per the FDX
+    # spec.     Example: If today is 5/14/2024 and the DP supports 24 months,
+    # the start date should be 5/14/2022 and newer;     it should not be
+    # 5/13/2022 or older   - If start date is specified but end date is not
+    # specified or vice versa;     Data Provider should return 'invalid date
+    # range' error code: 703, HTTPS 400 per the FDX spec   - If end date is
+    # today's date, the most recent transactions from the time the request is
+    # received will be returned
+    # @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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_account_transactions(x_fapi_interaction_id,
+                                        account_id,
+                                        fdx_api_actor_type: nil,
+                                        fdx_api_client_public_key: nil,
+                                        fdx_api_data_provider_id: nil,
+                                        fdx_api_data_recipient_id: nil,
+                                        start_time: nil,
+                                        end_time: nil,
+                                        start_date: nil,
+                                        end_date: nil,
+                                        offset: nil,
+                                        page_key: nil,
+                                        limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}/transactions',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .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_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .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(start_time, key: 'startTime'))
+                   .query_param(new_parameter(end_time, key: 'endTime'))
+                   .query_param(new_parameter(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionsEntity.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',
+                                 'Account with id not found',
+                                 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
+  end
+end

data/lib/fdx_v660_api/controllers/base_controller.rb

@@ -0,0 +1,65 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby SDK, Version: 0.0.1, on OS {os-info}'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/data_providers_controller.rb

@@ -0,0 +1,88 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # DataProvidersController
+  class DataProvidersController < BaseController
+    # Search for data providers
+    # @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 [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] 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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_data_providers(x_fapi_interaction_id,
+                                  fdx_api_actor_type: nil,
+                                  fdx_api_data_recipient_id: nil,
+                                  page_key: nil,
+                                  limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/data-providers',
+                                     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_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthFapi1Baseline')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DataProviderRecordsAtEcosystemRegistry.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get a specific data provider
+    # @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] data_provider_id Required parameter: Data Provider
+    # Identifier. Uniquely identifies a Data Provider
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @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_data_provider(x_fapi_interaction_id,
+                          data_provider_id,
+                          fdx_api_actor_type: nil,
+                          fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/data-providers/{dataProviderId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(data_provider_id, key: 'dataProviderId')
+                                    .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_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthFapi1Baseline')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DataProviderAtEcosystemRegistry.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end