apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/apis/adjustment_api.rb

@@ -0,0 +1,128 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # AdjustmentApi
+  class AdjustmentApi < BaseApi
+    # The following adjustment types must be specifically configured for a
+    # program code in order to be used by a partner.
+    # - promo and promoReversal
+    # - instructionCredit and instructionDebit
+    # - disbursement, disbursementReversal
+    # - anyDebitOut, anyDebitOutReversal
+    # - achOut, achOutReversal
+    #  If an adjustmentType has not been configured for a program code, then the
+    # request will be rejected.
+    #  If you have any further questions, please contact your Green Dot Product
+    # liaisons. Request Parameters.
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # (GUID) for tracking the request.
+    # @param [String] program_code Required parameter: The program code for the
+    # partner implementation.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account to adjust.
+    # @param [String] x_gd_max_retry_duration Optional parameter: The maximum
+    # retry duration for the adjustment operation (optional).
+    # @param [String] x_gd_call_mode Optional parameter: The call mode for AB
+    # testing or routing (optional).
+    # @param [AdjustBalanceRequest] body Optional parameter: The
+    # Gd.Bos.DataTransfer.Request.AdjustBalanceRequest containing adjustment
+    # details such as amount, type, and description.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def adjust_balance(x_gd_request_id,
+                       program_code,
+                       account_identifier,
+                       x_gd_max_retry_duration: nil,
+                       x_gd_call_mode: nil,
+                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/adjustments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .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('application/json-patch+json', key: 'Content-Type'))
+                   .header_param(new_parameter(x_gd_max_retry_duration, key: 'X-GD-MaxRetryDuration'))
+                   .header_param(new_parameter(x_gd_call_mode, key: 'X-GD-CallMode'))
+                   .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(AdjustBalanceResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 AdjustBalanceResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 AdjustBalanceResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 AdjustBalanceResponseErrorException))
+        .execute
+    end
+
+    # Check the Status of Adjustments to BaaS Account Balances
+    # @param [String] x_gd_request_id Required parameter: A unique identifier
+    # (GUID) for tracking the request.
+    # @param [String] program_code Required parameter: The program code for the
+    # partner implementation.
+    # @param [String] account_identifier Required parameter: The unique
+    # identifier for the account.
+    # @param [String] adjustment_identifier Required parameter: The unique
+    # identifier for the adjustment request.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_adjust_balance_status(x_gd_request_id,
+                                  program_code,
+                                  account_identifier,
+                                  adjustment_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/adjustments/{adjustmentIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .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(adjustment_identifier, key: 'adjustmentIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(GetAdjustAccountBalanceStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAdjustAccountBalanceStatusResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAdjustAccountBalanceStatusResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAdjustAccountBalanceStatusResponseErrorException))
+        .execute
+    end
+  end
+end

data/lib/gd_bos_v1/apis/affiliate_api.rb

@@ -0,0 +1,412 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # AffiliateApi
+  class AffiliateApi < BaseApi
+    # Creates a new affiliate for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code to
+    # associate the affiliate with.
+    # @param [CreateAffiliateRequest] body Optional parameter: The affiliate
+    # creation request payload.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_affiliate(x_gd_request_id,
+                         program_code,
+                         body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/affiliates',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(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(CreateAffiliateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 CreateAffiliateResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 CreateAffiliateResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 CreateAffiliateResponseErrorException))
+        .execute
+    end
+
+    # Retrieves the list of affiliates for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code to
+    # retrieve affiliates for.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_affiliates_list(x_gd_request_id,
+                            program_code)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/affiliates',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(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(GetAffiliatesListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAffiliatesListResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAffiliatesListResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAffiliatesListResponseErrorException))
+        .execute
+    end
+
+    # Updates an existing affiliate for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate.
+    # @param [String] affiliate_identifier Required parameter: The identifier of
+    # the affiliate to update.
+    # @param [UpdateAffiliateRequest] body Optional parameter: The affiliate
+    # update request payload.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_affiliate(x_gd_request_id,
+                         program_code,
+                         affiliate_identifier,
+                         body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/affiliates/{affiliateIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_identifier, key: 'affiliateIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(UpdateAffiliateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateAffiliateResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateAffiliateResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateAffiliateResponseErrorException))
+        .execute
+    end
+
+    # Retrieves the details of a specific affiliate for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate.
+    # @param [String] affiliate_identifier Required parameter: The identifier of
+    # the affiliate to retrieve.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_affiliate(x_gd_request_id,
+                      program_code,
+                      affiliate_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/affiliates/{affiliateIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_identifier, key: 'affiliateIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(GetAffiliateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAffiliateResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAffiliateResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAffiliateResponseErrorException))
+        .execute
+    end
+
+    # Deletes a specific affiliate for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate.
+    # @param [String] affiliate_identifier Required parameter: The identifier of
+    # the affiliate to delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_affiliate(x_gd_request_id,
+                         program_code,
+                         affiliate_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/programs/{programCode}/affiliates/{affiliateIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_identifier, key: 'affiliateIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(DeleteAffiliateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 DeleteAffiliateResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 DeleteAffiliateResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 DeleteAffiliateResponseErrorException))
+        .execute
+    end
+
+    # Creates a new affiliate settlement for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code to
+    # associate the affiliate settlement with.
+    # @param [CreateAffiliateSettlementRequest] body Optional parameter: The
+    # affiliate settlement creation request payload.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_affiliate_settlement(x_gd_request_id,
+                                    program_code,
+                                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/affiliate/settlements',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(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(CreateAffiliateSettlementResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 CreateAffiliateSettlementResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 CreateAffiliateSettlementResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 CreateAffiliateSettlementResponseErrorException))
+        .execute
+    end
+
+    # Updates an existing affiliate settlement for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate settlement.
+    # @param [String] affiliate_settlements_identifier Required parameter: The
+    # identifier of the affiliate settlement to update.
+    # @param [UpdateAffiliateSettlementRequest] body Optional parameter: The
+    # affiliate settlement update request payload.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_affiliate_settlement(x_gd_request_id,
+                                    program_code,
+                                    affiliate_settlements_identifier,
+                                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/affiliate/settlements/{affiliateSettlementsIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_settlements_identifier, key: 'affiliateSettlementsIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(UpdateAffiliateSettlementResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateAffiliateSettlementResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateAffiliateSettlementResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateAffiliateSettlementResponseErrorException))
+        .execute
+    end
+
+    # Retrieves the details of a specific affiliate settlement for the specified
+    # program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate settlement.
+    # @param [String] affiliate_settlement_identifier Required parameter: The
+    # identifier of the affiliate settlement to retrieve.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_affiliate_settlement(x_gd_request_id,
+                                 program_code,
+                                 affiliate_settlement_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/affiliate/settlements/{affiliateSettlementIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_settlement_identifier, key: 'affiliateSettlementIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(GetAffiliateSettlementResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAffiliateSettlementResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAffiliateSettlementResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAffiliateSettlementResponseErrorException))
+        .execute
+    end
+
+    # Deletes a specific affiliate settlement for the specified program.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier for tracking.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the affiliate settlement.
+    # @param [String] affiliate_settlement_identifier Required parameter: The
+    # identifier of the affiliate settlement to delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_affiliate_settlement(x_gd_request_id,
+                                    program_code,
+                                    affiliate_settlement_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/programs/{programCode}/affiliate/settlements/{affiliateSettlementIdentifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(affiliate_settlement_identifier, key: 'affiliateSettlementIdentifier')
+                                    .is_required(true)
+                                    .should_encode(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(DeleteAffiliateSettlementResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 DeleteAffiliateSettlementResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 DeleteAffiliateSettlementResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 DeleteAffiliateSettlementResponseErrorException))
+        .execute
+    end
+  end
+end