apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/apis/amm_rule_api.rb

@@ -0,0 +1,391 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # AmmRuleApi
+  class AmmRuleApi < BaseApi
+    # Adds a new Auto Money Movement (AMM) rule to the specified account. Once
+    # applied, money can be automatically moved based on the rule parameters.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account to which the rule will be applied.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [CreateAmmRuleRequest] body Optional parameter: The request payload
+    # containing AMM rule details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_rule(program_code,
+                    account_identifier,
+                    x_gd_request_id,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRule',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateAmmRuleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 CreateAmmRuleResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 CreateAmmRuleResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 CreateAmmRuleResponseErrorException))
+        .execute
+    end
+
+    # Deletes an Auto Money Movement (AMM) rule for the specified account and
+    # rule ID.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account associated with the rule.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [DeleteAmmRuleRequest] body Optional parameter: The request payload
+    # containing the rule ID to delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_rule(program_code,
+                    account_identifier,
+                    x_gd_request_id,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRule',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeleteAmmRuleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 DeleteAmmRuleResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 DeleteAmmRuleResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 DeleteAmmRuleResponseErrorException))
+        .execute
+    end
+
+    # Updates the details of an existing Auto Money Movement (AMM) rule for the
+    # specified account and rule ID.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account associated with the rule.
+    # @param [Integer] rule_id Required parameter: The unique identifier for the
+    # rule to update.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [UpdateAmmRuleRequest] body Optional parameter: The request payload
+    # containing updated AMM rule details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_rule(program_code,
+                    account_identifier,
+                    rule_id,
+                    x_gd_request_id,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRule/{ruleId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(rule_id, key: 'ruleId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdateAmmRuleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateAmmRuleResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateAmmRuleResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateAmmRuleResponseErrorException))
+        .execute
+    end
+
+    # Updates the priorities of multiple Auto Money Movement (AMM) rules for the
+    # specified account.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account associated with the rules.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [UpdateAmmRulePriorityRequest] body Optional parameter: The request
+    # payload containing rule priorities to update.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_rule_priority(program_code,
+                             account_identifier,
+                             x_gd_request_id,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRulePriority',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdateAmmRulePriorityResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateAmmRulePriorityResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateAmmRulePriorityResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateAmmRulePriorityResponseErrorException))
+        .execute
+    end
+
+    # Retrieves the Auto Money Movement (AMM) rules for the specified account
+    # and rule status.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account whose rules are being retrieved.
+    # @param [String] rule_status Required parameter: The status of the rules to
+    # filter by (e.g., Active, Inactive).
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_rules_by_account_id(program_code,
+                                account_identifier,
+                                rule_status,
+                                x_gd_request_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRule/{ruleStatus}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(rule_status, key: 'ruleStatus')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAmmRuleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAmmRuleResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAmmRuleResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAmmRuleResponseErrorException))
+        .execute
+    end
+
+    # Retrieves the Auto Money Movement (AMM) rules for the specified target
+    # account, with optional filters for rule status, transfer type, and rule
+    # IDs.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the target account whose rules are being retrieved.
+    # @param [String] rule_status Required parameter: The status of the rules to
+    # filter by (e.g., Active, Inactive).
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [TrueClass | FalseClass] include_transactions Optional parameter:
+    # Whether to include transactions in the response.
+    # @param [String] transfer_type Optional parameter: The transfer type to
+    # filter by (optional).
+    # @param [String] rule_ids Optional parameter: A comma-separated list of
+    # rule IDs to filter by (optional).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_rules_by_target_account_id(program_code,
+                                       account_identifier,
+                                       rule_status,
+                                       x_gd_request_id,
+                                       include_transactions: nil,
+                                       transfer_type: nil,
+                                       rule_ids: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRuleByTargetAccount/{ruleStatus}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(rule_status, key: 'ruleStatus')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .query_param(new_parameter(include_transactions, key: 'includeTransactions'))
+                   .query_param(new_parameter(transfer_type, key: 'transferType'))
+                   .query_param(new_parameter(rule_ids, key: 'ruleIds'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAmmRuleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAmmRuleResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAmmRuleResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAmmRuleResponseErrorException))
+        .execute
+    end
+
+    # Updates the status, name, maximum cap amount, or fixed transfer amount for
+    # a specific Auto Money Movement (AMM) rule based on rule ID.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the BaaS program context.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account associated with the rule.
+    # @param [Integer] rule_id Required parameter: The unique identifier for the
+    # rule to update.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging. Should be a GUID.
+    # @param [UpdateAmmRuleStatusRequest] body Optional parameter: The request
+    # payload containing the rule ID and new status.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_rule_status(program_code,
+                           account_identifier,
+                           rule_id,
+                           x_gd_request_id,
+                           body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/ammRuleStatus/{ruleId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_identifier, key: 'accountIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(rule_id, key: 'ruleId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdateAmmRuleStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateAmmRuleStatusResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateAmmRuleStatusResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateAmmRuleStatusResponseErrorException))
+        .execute
+    end
+  end
+end

data/lib/gd_bos_v1/apis/authentication_api.rb

@@ -0,0 +1,47 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # AuthenticationApi
+  class AuthenticationApi < BaseApi
+    # Create New User
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the header.
+    # @param [AuthenticationRequest] body Optional parameter: The authentication
+    # request payload.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def authentication(x_gd_request_id,
+                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/authentication',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .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)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuthenticationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 AuthenticationResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 AuthenticationResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 AuthenticationResponseErrorException))
+        .execute
+    end
+  end
+end

data/lib/gd_bos_v1/apis/base_api.rb

@@ -0,0 +1,65 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # BaseApi.
+  class BaseApi
+    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