ifeelgoods 0.0.1

data/lib/ifeelgoods/api/redemptions_api.rb

@@ -0,0 +1,762 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Ifeelgoods
+  class RedemptionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Activate
+    # Use this function to perform an activation from an existing redemption object and retrieve a authenticated link (url key).
+    # @param redemption_id [String] Unique Redemption identifier (eg. ZN7RS-9RNLY)
+    # @param [Hash] opts the optional parameters
+    # @option opts [ActivateRedemptionRequest] :activate_redemption_request 
+    # @return [CreateRedemption201Response]
+    def activate_redemption(redemption_id, opts = {})
+      data, _status_code, _headers = activate_redemption_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Activate
+    # Use this function to perform an activation from an existing redemption object and retrieve a authenticated link (url key).
+    # @param redemption_id [String] Unique Redemption identifier (eg. ZN7RS-9RNLY)
+    # @param [Hash] opts the optional parameters
+    # @option opts [ActivateRedemptionRequest] :activate_redemption_request 
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def activate_redemption_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.activate_redemption ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.activate_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}/actions/activate'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'activate_redemption_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.activate_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#activate_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Book
+    # Use this function to book a reward code before redeem it.  This action will do the same as in Create a Redemption API but will also book a reward code for a duration of 30 minutes.  You can then redeem the redemption using Create and Redeem or Redeem APIs using the same parameters (eg. same order_id and user email). 
+    # @param promotion_id [String] The promotion identifier
+    # @param reward_sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateAndRedeemRequest] :create_and_redeem_request 
+    # @return [CreateRedemption201Response]
+    def book_redemption(promotion_id, reward_sku, opts = {})
+      data, _status_code, _headers = book_redemption_with_http_info(promotion_id, reward_sku, opts)
+      data
+    end
+
+    # Book
+    # Use this function to book a reward code before redeem it.  This action will do the same as in Create a Redemption API but will also book a reward code for a duration of 30 minutes.  You can then redeem the redemption using Create and Redeem or Redeem APIs using the same parameters (eg. same order_id and user email). 
+    # @param promotion_id [String] The promotion identifier
+    # @param reward_sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateAndRedeemRequest] :create_and_redeem_request 
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def book_redemption_with_http_info(promotion_id, reward_sku, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.book_redemption ...'
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling RedemptionsApi.book_redemption"
+      end
+      # verify the required parameter 'reward_sku' is set
+      if @api_client.config.client_side_validation && reward_sku.nil?
+        fail ArgumentError, "Missing the required parameter 'reward_sku' when calling RedemptionsApi.book_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/promotions/{promotion_id}/rewards/{reward_sku}/redemptions/book'.sub('{promotion_id}', CGI.escape(promotion_id.to_s)).sub('{reward_sku}', CGI.escape(reward_sku.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_and_redeem_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.book_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#book_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel
+    # Use this function to cancel a pending/failed redemption.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRedemption201Response]
+    def cancel_redemption(redemption_id, opts = {})
+      data, _status_code, _headers = cancel_redemption_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Cancel
+    # Use this function to cancel a pending/failed redemption.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def cancel_redemption_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.cancel_redemption ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.cancel_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}/actions/cancel'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.cancel_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#cancel_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Consult Card
+    # Use this function to retrieve card information (balance, currency) for a redemption when supported by the reward provider.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [CardConsultRedemption200Response]
+    def card_consult_redemption(redemption_id, opts = {})
+      data, _status_code, _headers = card_consult_redemption_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Consult Card
+    # Use this function to retrieve card information (balance, currency) for a redemption when supported by the reward provider.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CardConsultRedemption200Response, Integer, Hash)>] CardConsultRedemption200Response data, response status code and response headers
+    def card_consult_redemption_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.card_consult_redemption ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.card_consult_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}/card_consult'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CardConsultRedemption200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.card_consult_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#card_consult_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create and Redeem
+    # Use this function to create a redemption object and perform a reward delivery. Calling this endpoint on an existing order_id with the exact same parameters will return the existing order. 
+    # @param promotion_id [String] The promotion identifier
+    # @param reward_sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateAndRedeemRequest] :create_and_redeem_request 
+    # @return [CreateRedemption201Response]
+    def create_and_redeem(promotion_id, reward_sku, opts = {})
+      data, _status_code, _headers = create_and_redeem_with_http_info(promotion_id, reward_sku, opts)
+      data
+    end
+
+    # Create and Redeem
+    # Use this function to create a redemption object and perform a reward delivery. Calling this endpoint on an existing order_id with the exact same parameters will return the existing order. 
+    # @param promotion_id [String] The promotion identifier
+    # @param reward_sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateAndRedeemRequest] :create_and_redeem_request 
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def create_and_redeem_with_http_info(promotion_id, reward_sku, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.create_and_redeem ...'
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling RedemptionsApi.create_and_redeem"
+      end
+      # verify the required parameter 'reward_sku' is set
+      if @api_client.config.client_side_validation && reward_sku.nil?
+        fail ArgumentError, "Missing the required parameter 'reward_sku' when calling RedemptionsApi.create_and_redeem"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/promotions/{promotion_id}/rewards/{reward_sku}/redemptions/redeem'.sub('{promotion_id}', CGI.escape(promotion_id.to_s)).sub('{reward_sku}', CGI.escape(reward_sku.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_and_redeem_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.create_and_redeem",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#create_and_redeem\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a redemption
+    # Use this function to create a redemption object and initiate a reward delivery.
+    # @param promotion_id [String] The promotion identifier
+    # @param create_redemption_request [CreateRedemptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRedemption201Response]
+    def create_redemption(promotion_id, create_redemption_request, opts = {})
+      data, _status_code, _headers = create_redemption_with_http_info(promotion_id, create_redemption_request, opts)
+      data
+    end
+
+    # Create a redemption
+    # Use this function to create a redemption object and initiate a reward delivery.
+    # @param promotion_id [String] The promotion identifier
+    # @param create_redemption_request [CreateRedemptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def create_redemption_with_http_info(promotion_id, create_redemption_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.create_redemption ...'
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling RedemptionsApi.create_redemption"
+      end
+      # verify the required parameter 'create_redemption_request' is set
+      if @api_client.config.client_side_validation && create_redemption_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_redemption_request' when calling RedemptionsApi.create_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/promotions/{promotion_id}/redemptions'.sub('{promotion_id}', CGI.escape(promotion_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_redemption_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.create_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#create_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a redemption
+    # Use this function to retrieve detailed information about a redemption object.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRedemption201Response]
+    def get_redemption_by_id(redemption_id, opts = {})
+      data, _status_code, _headers = get_redemption_by_id_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Get a redemption
+    # Use this function to retrieve detailed information about a redemption object.
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def get_redemption_by_id_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.get_redemption_by_id ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.get_redemption_by_id"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.get_redemption_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#get_redemption_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all Redemptions
+    # Use this function to list the status of all redemptions created as part of a promotion.
+    # @param promotion_id [String] The promotion identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :reward_sku 
+    # @option opts [String] :email 
+    # @option opts [String] :order_id 
+    # @option opts [String] :state Redemption state filter (eg. &#x60;pending&#x60;, &#x60;redeemed&#x60;, &#x60;canceled&#x60;, etc.)
+    # @option opts [Time] :redeemed_datetime_start Filter redemptions redeemed on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :redeemed_datetime_end Filter redemptions redeemed on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [Time] :activation_datetime_start Filter redemptions activated on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :activation_datetime_end Filter redemptions activated on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [Time] :refund_datetime_start Filter redemptions refunded on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :refund_datetime_end Filter redemptions refunded on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [String] :sort Field to sort by, prefixed with &#x60;-&#x60; for descending order (e.g. &#x60;activation_datetime&#x60; or &#x60;-activation_datetime&#x60;)
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [ListRedemptions200Response]
+    def list_redemptions(promotion_id, opts = {})
+      data, _status_code, _headers = list_redemptions_with_http_info(promotion_id, opts)
+      data
+    end
+
+    # List all Redemptions
+    # Use this function to list the status of all redemptions created as part of a promotion.
+    # @param promotion_id [String] The promotion identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :reward_sku 
+    # @option opts [String] :email 
+    # @option opts [String] :order_id 
+    # @option opts [String] :state Redemption state filter (eg. &#x60;pending&#x60;, &#x60;redeemed&#x60;, &#x60;canceled&#x60;, etc.)
+    # @option opts [Time] :redeemed_datetime_start Filter redemptions redeemed on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :redeemed_datetime_end Filter redemptions redeemed on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [Time] :activation_datetime_start Filter redemptions activated on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :activation_datetime_end Filter redemptions activated on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [Time] :refund_datetime_start Filter redemptions refunded on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;)
+    # @option opts [Time] :refund_datetime_end Filter redemptions refunded on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;)
+    # @option opts [String] :sort Field to sort by, prefixed with &#x60;-&#x60; for descending order (e.g. &#x60;activation_datetime&#x60; or &#x60;-activation_datetime&#x60;)
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [Array<(ListRedemptions200Response, Integer, Hash)>] ListRedemptions200Response data, response status code and response headers
+    def list_redemptions_with_http_info(promotion_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.list_redemptions ...'
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling RedemptionsApi.list_redemptions"
+      end
+      allowable_values = ["pending", "booked", "redeemed", "denied", "failed", "refunded", "blocked", "canceled", "expired"]
+      if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
+        fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["activation_datetime", "-activation_datetime", "updated_datetime", "-updated_datetime", "redeem_datetime", "-redeem_datetime", "refund_datetime", "-refund_datetime"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling RedemptionsApi.list_redemptions, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RedemptionsApi.list_redemptions, must be smaller than or equal to 10000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RedemptionsApi.list_redemptions, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/fulfillment/v2/promotions/{promotion_id}/redemptions'.sub('{promotion_id}', CGI.escape(promotion_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'reward_sku'] = opts[:'reward_sku'] if !opts[:'reward_sku'].nil?
+      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
+      query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'redeemed_datetime_start'] = opts[:'redeemed_datetime_start'] if !opts[:'redeemed_datetime_start'].nil?
+      query_params[:'redeemed_datetime_end'] = opts[:'redeemed_datetime_end'] if !opts[:'redeemed_datetime_end'].nil?
+      query_params[:'activation_datetime_start'] = opts[:'activation_datetime_start'] if !opts[:'activation_datetime_start'].nil?
+      query_params[:'activation_datetime_end'] = opts[:'activation_datetime_end'] if !opts[:'activation_datetime_end'].nil?
+      query_params[:'refund_datetime_start'] = opts[:'refund_datetime_start'] if !opts[:'refund_datetime_start'].nil?
+      query_params[:'refund_datetime_end'] = opts[:'refund_datetime_end'] if !opts[:'refund_datetime_end'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListRedemptions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.list_redemptions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#list_redemptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Redeem
+    # Use this function to perform a reward delivery from an existing redemption object.
+    # @param redemption_id [String] Unique Redemption identifier (eg. ZN7RS-9RNLY)
+    # @param [Hash] opts the optional parameters
+    # @option opts [ActivateRedemptionRequest] :activate_redemption_request 
+    # @return [CreateRedemption201Response]
+    def redeem_redemption(redemption_id, opts = {})
+      data, _status_code, _headers = redeem_redemption_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Redeem
+    # Use this function to perform a reward delivery from an existing redemption object.
+    # @param redemption_id [String] Unique Redemption identifier (eg. ZN7RS-9RNLY)
+    # @param [Hash] opts the optional parameters
+    # @option opts [ActivateRedemptionRequest] :activate_redemption_request 
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def redeem_redemption_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.redeem_redemption ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.redeem_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}/actions/redeem'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'activate_redemption_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.redeem_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#redeem_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Refund
+    # Refunds a redemption if it is redeemed, or if debited = true and the state is booked, failed, or pending. Only redemptions from the current month are refundable. 
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRedemption201Response]
+    def refund_redemption(redemption_id, opts = {})
+      data, _status_code, _headers = refund_redemption_with_http_info(redemption_id, opts)
+      data
+    end
+
+    # Refund
+    # Refunds a redemption if it is redeemed, or if debited &#x3D; true and the state is booked, failed, or pending. Only redemptions from the current month are refundable. 
+    # @param redemption_id [String] The redemption identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRedemption201Response, Integer, Hash)>] CreateRedemption201Response data, response status code and response headers
+    def refund_redemption_with_http_info(redemption_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RedemptionsApi.refund_redemption ...'
+      end
+      # verify the required parameter 'redemption_id' is set
+      if @api_client.config.client_side_validation && redemption_id.nil?
+        fail ArgumentError, "Missing the required parameter 'redemption_id' when calling RedemptionsApi.refund_redemption"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/redemptions/{redemption_id}/actions/refund'.sub('{redemption_id}', CGI.escape(redemption_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRedemption201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RedemptionsApi.refund_redemption",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RedemptionsApi#refund_redemption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end