apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/apis/hosted_user_experience_api.rb

@@ -0,0 +1,58 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # HostedUserExperienceApi
+  class HostedUserExperienceApi < BaseApi
+    # Retrieves a PCI widget configuration and a hosted user experience URL for
+    # the specified activity and program. Validates the activity, finds the
+    # product code, and returns a secure URL for embedding in client
+    # applications.
+    # @param [String] program_code Required parameter: The program code
+    # identifying the hosted user experience context.
+    # @param [String] x_gd_request_id Required parameter: A unique request
+    # identifier for tracking and logging.
+    # @param [GetConfigurationRequest] body Optional parameter: The request
+    # payload containing the activity name, success and error URLs, and optional
+    # activity data. See Gd.Bos.DataTransfer.Request.GetConfigurationRequest for
+    # details.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_hosted_user_experience_configuration(program_code,
+                                                 x_gd_request_id,
+                                                 body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/hosted/ux',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(program_code, key: 'programCode')
+                                    .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(GetConfigurationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetConfigurationResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetConfigurationResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetConfigurationResponseErrorException))
+        .execute
+    end
+  end
+end

data/lib/gd_bos_v1/apis/interest_rate_api.rb

@@ -0,0 +1,449 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # InterestRateApi
+  class InterestRateApi < BaseApi
+    # Returns a list of all Interest Rate Tiers and Annual Percentage Yields
+    # based on purseIdentifier<br>This endpoint allows Partners to retrieve a
+    # list of all Interest Rate Tiers and Annual Percentage Yields (APYs)
+    # associated with a specific purseIdentifier.<br>Note: Interest Rate Tiers
+    # that are deleted will not be included in responses to this endpoint.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [String] account_identifier Required parameter: The account
+    # identifier (GUID format) for which to retrieve interest rate tiers.
+    # @param [String] purse_identifier Required parameter: The purse identifier
+    # (GUID format) for which to retrieve interest rate tiers.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_interest_rate_tiers_retrieveslistall_interest(x_gd_request_id,
+                                                          program_code,
+                                                          account_identifier,
+                                                          purse_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestRateTier',
+                                     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(purse_identifier, key: 'purseIdentifier')
+                                    .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(GetPurseInterestRateTiersResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetPurseInterestRateTiersResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetPurseInterestRateTiersResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetPurseInterestRateTiersResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to add Interest Rate Tiers to an existing
+    # primary and savings purses.<br><br>Notes: <br>• The interestYieldStartDate
+    # will be set to the current date, if you are adding an interestRateTier to
+    # the purse for the first time.
+    # <br>• If the interestYieldStartDate is not provided, the accountCycleDay
+    # will be on or after the current date of the request.
+    #  <br>• If the purse already has an interestRateTier applied, then the
+    # interestYieldStartDate will be set to the next anniversary of the billing
+    # cycle.
+    # <br>• The next anniversary of the billing cycle will be returned as the
+    # accountCycleDay in the POST /enrollments, GET /accounts, and GET
+    # /enrollments endpoint responses.
+    # <br>• The interestYieldEndDate of the previous Interest Rate Tier on the
+    # purse is automatically set to the day before the new Interest Rate.
+    # <br>• If the purse has no Interest Rate Tiers applied yet, and
+    # autoAlignStartDate is False then the interestYieldStartDate is set to the
+    # current date of the request, otherwise it is set to the date provided in
+    # the request. On the new additional tiers, when the autoAlignStartDate is
+    # True, the interestYieldStartDate is set to start on the next
+    # accountCycleDay (Bill Cycle Date).
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [String] account_identifier Required parameter: The account
+    # identifier (GUID format) for which to add the interest rate tier.
+    # @param [String] purse_identifier Required parameter: The purse identifier
+    # (GUID format) for which to add the interest rate tier.
+    # @param [AddInterestRateTierRequest] body Optional parameter: The request
+    # object containing details of the interest rate tier to add.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_interest_rate_tier(x_gd_request_id,
+                               program_code,
+                               account_identifier,
+                               purse_identifier,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestRateTier',
+                                     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(purse_identifier, key: 'purseIdentifier')
+                                    .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(AddInterestRateTierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 AddInterestRateTierResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 AddInterestRateTierResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 AddInterestRateTierResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to:
+    # - Add an end date to an interest rate tier
+    # - Remove an end date from an interest rate tier
+    # - Update an interest rate tier end date
+    # - End an interest rate tier on a user’s account by adding an end date.
+    # - Remove an end date from an interest rate tier and return it to active on
+    # a user’s account.
+    # - Update an interest rate tier end date to the day before the next bill
+    # cycle date.
+    # How to add an end date to an interest rate tier:
+    # - An interestRateTier can be ended or closed by adding an end date to it.
+    # Simply call PUT
+    # /purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier}
+    # with:
+    # 	- A valid interestRateTierIdentifier
+    # 	- A valid end date (must be in the future and the last day of a monthly
+    # cycle for the account)
+    # 	-  Note: The interestRateTier that the end date is being applied to,
+    # cannot have an end date already and it must have the most recent start
+    # date if there are multiple tiers on the account.
+    # -  An interestRateTier that is scheduled to start at a future date can be
+    # updated if it has a valid interestRateTierIdentifier and a valid
+    # interestRateTier enum.
+    # 	-  Simply call PUT
+    # /purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier} to
+    # update.
+    # 	-  Note: Adding an end date to an interestRateTier and updating an
+    # interestRateTier that is scheduled to start at a future date can both be
+    # done in a single call. So, submitting a valid end date AND a new
+    # interestRateTier will update both fields.
+    # How to remove an end date from an interest rate tier:
+    # - Partner calls PUT
+    # …/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier}
+    # and the following is true:
+    # 	- Current interest rate tier has an end date that is today or in the
+    # future
+    # 	- No interest rate tier is scheduled to follow the current interest rate
+    # tier
+    # 	- removeEndDateFlag is true
+    # 	- Optional interestYieldEndDate is provided – Ignored if
+    # removeEndDateFlag is true
+    # - The end date is removed, and the interest rate tier remains active.
+    # How to update an end date on an interest rate tier:
+    # - Partner calls PUT
+    # …/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier}
+    # and the following is true:
+    # 	- Current interest rate tier has an end date that is today or in the
+    # future
+    # 	- Provided interest rate tier has an end date that is today or in the
+    # future
+    # 	- No interest rate tier is scheduled to follow the current interest rate
+    # tier
+    # - The interest rate tier end date is updated to:
+    # 	- The day before the next bill cycle on or after the new
+    # interestYieldEndDate
+    # 	- If no interestYieldEndDate is provided, the day before the very next
+    # bill cycle date occurs
+    # - The updated end date is included in the response.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [String] account_identifier Required parameter: The account
+    # identifier (GUID format) for which to update the interest rate tier.
+    # @param [String] purse_identifier Required parameter: The purse identifier
+    # (GUID format) for which to update the interest rate tier.
+    # @param [String] interest_rate_tier_identifier Required parameter: The
+    # interest rate tier identifier (GUID format) to update.
+    # @param [UpdateInterestRateTierRequest] body Optional parameter: The
+    # request object containing details of the interest rate tier update.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_interest_rate_tier(x_gd_request_id,
+                                  program_code,
+                                  account_identifier,
+                                  purse_identifier,
+                                  interest_rate_tier_identifier,
+                                  body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier}',
+                                     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(purse_identifier, key: 'purseIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(interest_rate_tier_identifier, key: 'interestRateTierIdentifier')
+                                    .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(UpdateInterestRateTierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateInterestRateTierResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateInterestRateTierResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateInterestRateTierResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to delete interest rate tiers.
+    # - Delete Interest Rate Tier
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [String] account_identifier Required parameter: The account
+    # identifier (GUID format) for which to delete the interest rate tier.
+    # @param [String] purse_identifier Required parameter: The purse identifier
+    # (GUID format) for which to delete the interest rate tier.
+    # @param [String] interest_rate_tier_identifier Required parameter: The
+    # interest rate tier identifier (GUID format) to delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_interest_rate_tier(x_gd_request_id,
+                                  program_code,
+                                  account_identifier,
+                                  purse_identifier,
+                                  interest_rate_tier_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier}',
+                                     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(purse_identifier, key: 'purseIdentifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(interest_rate_tier_identifier, key: 'interestRateTierIdentifier')
+                                    .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(DeleteInterestRateTierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 DeleteInterestRateTierResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 DeleteInterestRateTierResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 DeleteInterestRateTierResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to create a new interest rate tier.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [AddProgramInterestRateTierRequest] body Optional parameter: The
+    # request object containing details of the program interest rate tier to
+    # add.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_program_interest_rate_tier(x_gd_request_id,
+                                       program_code,
+                                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/InterestRateTiers',
+                                     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(AddProgramInterestRateTierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 AddProgramInterestRateTierResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 AddProgramInterestRateTierResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 AddProgramInterestRateTierResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to update an existing interest rate tier.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [UpdateProgramInterestRateTierRequest] body Optional parameter: The
+    # request object containing details of the program interest rate tier to
+    # update.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_program_interest_rate_tier(x_gd_request_id,
+                                          program_code,
+                                          body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/programs/{programCode}/InterestRateTiers',
+                                     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(UpdateProgramInterestRateTierResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 UpdateProgramInterestRateTierResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 UpdateProgramInterestRateTierResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 UpdateProgramInterestRateTierResponseErrorException))
+        .execute
+    end
+
+    # This endpoint allows Partners to create a new interest rate change
+    # request.
+    # @param [String] x_gd_request_id Required parameter: The unique request
+    # identifier from the X-GD-RequestId header.
+    # @param [String] program_code Required parameter: The program code
+    # associated with the request.
+    # @param [AddInterestRateChangeRequest] body Optional parameter: The request
+    # object containing details of the interest rate change request.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_interest_rate_change_request(x_gd_request_id,
+                                         program_code,
+                                         body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/programs/{programCode}/InterestRate/ChangeRequest',
+                                     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(AddInterestRateChangeRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 AddInterestRateChangeRequestResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 AddInterestRateChangeRequestResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 AddInterestRateChangeRequestResponseErrorException))
+        .execute
+    end
+  end
+end