ifeelgoods 0.0.1

data/docs/RedemptionsApi.md

@@ -0,0 +1,857 @@
+# Ifeelgoods::RedemptionsApi
+
+All URIs are relative to *https://api-sandbox.ifeelgoods.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activate_redemption**](RedemptionsApi.md#activate_redemption) | **POST** /fulfillment/v2/redemptions/{redemption_id}/actions/activate | Activate |
+| [**book_redemption**](RedemptionsApi.md#book_redemption) | **POST** /fulfillment/v2/promotions/{promotion_id}/rewards/{reward_sku}/redemptions/book | Book |
+| [**cancel_redemption**](RedemptionsApi.md#cancel_redemption) | **POST** /fulfillment/v2/redemptions/{redemption_id}/actions/cancel | Cancel |
+| [**card_consult_redemption**](RedemptionsApi.md#card_consult_redemption) | **GET** /fulfillment/v2/redemptions/{redemption_id}/card_consult | Consult Card |
+| [**create_and_redeem**](RedemptionsApi.md#create_and_redeem) | **POST** /fulfillment/v2/promotions/{promotion_id}/rewards/{reward_sku}/redemptions/redeem | Create and Redeem |
+| [**create_redemption**](RedemptionsApi.md#create_redemption) | **POST** /fulfillment/v2/promotions/{promotion_id}/redemptions | Create a redemption |
+| [**get_redemption_by_id**](RedemptionsApi.md#get_redemption_by_id) | **GET** /fulfillment/v2/redemptions/{redemption_id} | Get a redemption |
+| [**list_redemptions**](RedemptionsApi.md#list_redemptions) | **GET** /fulfillment/v2/promotions/{promotion_id}/redemptions | List all Redemptions |
+| [**redeem_redemption**](RedemptionsApi.md#redeem_redemption) | **POST** /fulfillment/v2/redemptions/{redemption_id}/actions/redeem | Redeem |
+| [**refund_redemption**](RedemptionsApi.md#refund_redemption) | **POST** /fulfillment/v2/redemptions/{redemption_id}/actions/refund | Refund |
+
+
+## activate_redemption
+
+> <CreateRedemption201Response> activate_redemption(redemption_id, opts)
+
+Activate
+
+Use this function to perform an activation from an existing redemption object and retrieve a authenticated link (url key).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | Unique Redemption identifier (eg. ZN7RS-9RNLY)
+opts = {
+  activate_redemption_request: Ifeelgoods::ActivateRedemptionRequest.new({data: Ifeelgoods::ActivateRedemptionRequestData.new}) # ActivateRedemptionRequest | 
+}
+
+begin
+  # Activate
+  result = api_instance.activate_redemption(redemption_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->activate_redemption: #{e}"
+end
+```
+
+#### Using the activate_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> activate_redemption_with_http_info(redemption_id, opts)
+
+```ruby
+begin
+  # Activate
+  data, status_code, headers = api_instance.activate_redemption_with_http_info(redemption_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->activate_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | Unique Redemption identifier (eg. ZN7RS-9RNLY) |  |
+| **activate_redemption_request** | [**ActivateRedemptionRequest**](ActivateRedemptionRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/pdf
+
+
+## book_redemption
+
+> <CreateRedemption201Response> book_redemption(promotion_id, reward_sku, opts)
+
+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). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+promotion_id = 'promotion_id_example' # String | The promotion identifier
+reward_sku = 'reward_sku_example' # String | The reward SKU
+opts = {
+  create_and_redeem_request: Ifeelgoods::CreateAndRedeemRequest.new({data: Ifeelgoods::CreateAndRedeemRequestData.new}) # CreateAndRedeemRequest | 
+}
+
+begin
+  # Book
+  result = api_instance.book_redemption(promotion_id, reward_sku, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->book_redemption: #{e}"
+end
+```
+
+#### Using the book_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> book_redemption_with_http_info(promotion_id, reward_sku, opts)
+
+```ruby
+begin
+  # Book
+  data, status_code, headers = api_instance.book_redemption_with_http_info(promotion_id, reward_sku, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->book_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promotion_id** | **String** | The promotion identifier |  |
+| **reward_sku** | **String** | The reward SKU |  |
+| **create_and_redeem_request** | [**CreateAndRedeemRequest**](CreateAndRedeemRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## cancel_redemption
+
+> <CreateRedemption201Response> cancel_redemption(redemption_id)
+
+Cancel
+
+Use this function to cancel a pending/failed redemption.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | The redemption identifier
+
+begin
+  # Cancel
+  result = api_instance.cancel_redemption(redemption_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->cancel_redemption: #{e}"
+end
+```
+
+#### Using the cancel_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> cancel_redemption_with_http_info(redemption_id)
+
+```ruby
+begin
+  # Cancel
+  data, status_code, headers = api_instance.cancel_redemption_with_http_info(redemption_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->cancel_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | The redemption identifier |  |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## card_consult_redemption
+
+> <CardConsultRedemption200Response> card_consult_redemption(redemption_id)
+
+Consult Card
+
+Use this function to retrieve card information (balance, currency) for a redemption when supported by the reward provider.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | The redemption identifier
+
+begin
+  # Consult Card
+  result = api_instance.card_consult_redemption(redemption_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->card_consult_redemption: #{e}"
+end
+```
+
+#### Using the card_consult_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CardConsultRedemption200Response>, Integer, Hash)> card_consult_redemption_with_http_info(redemption_id)
+
+```ruby
+begin
+  # Consult Card
+  data, status_code, headers = api_instance.card_consult_redemption_with_http_info(redemption_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CardConsultRedemption200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->card_consult_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | The redemption identifier |  |
+
+### Return type
+
+[**CardConsultRedemption200Response**](CardConsultRedemption200Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_and_redeem
+
+> <CreateRedemption201Response> create_and_redeem(promotion_id, reward_sku, opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+promotion_id = 'promotion_id_example' # String | The promotion identifier
+reward_sku = 'reward_sku_example' # String | The reward SKU
+opts = {
+  create_and_redeem_request: Ifeelgoods::CreateAndRedeemRequest.new({data: Ifeelgoods::CreateAndRedeemRequestData.new}) # CreateAndRedeemRequest | 
+}
+
+begin
+  # Create and Redeem
+  result = api_instance.create_and_redeem(promotion_id, reward_sku, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->create_and_redeem: #{e}"
+end
+```
+
+#### Using the create_and_redeem_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> create_and_redeem_with_http_info(promotion_id, reward_sku, opts)
+
+```ruby
+begin
+  # Create and Redeem
+  data, status_code, headers = api_instance.create_and_redeem_with_http_info(promotion_id, reward_sku, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->create_and_redeem_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promotion_id** | **String** | The promotion identifier |  |
+| **reward_sku** | **String** | The reward SKU |  |
+| **create_and_redeem_request** | [**CreateAndRedeemRequest**](CreateAndRedeemRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/pdf
+
+
+## create_redemption
+
+> <CreateRedemption201Response> create_redemption(promotion_id, create_redemption_request)
+
+Create a redemption
+
+Use this function to create a redemption object and initiate a reward delivery.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+promotion_id = 'promotion_id_example' # String | The promotion identifier
+create_redemption_request = Ifeelgoods::CreateRedemptionRequest.new({data: Ifeelgoods::CreateRedemptionRequestData.new({order_id: 'order_id_example', user: Ifeelgoods::User.new, reward: Ifeelgoods::CreateRedemptionRequestDataReward.new})}) # CreateRedemptionRequest | 
+
+begin
+  # Create a redemption
+  result = api_instance.create_redemption(promotion_id, create_redemption_request)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->create_redemption: #{e}"
+end
+```
+
+#### Using the create_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> create_redemption_with_http_info(promotion_id, create_redemption_request)
+
+```ruby
+begin
+  # Create a redemption
+  data, status_code, headers = api_instance.create_redemption_with_http_info(promotion_id, create_redemption_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->create_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promotion_id** | **String** | The promotion identifier |  |
+| **create_redemption_request** | [**CreateRedemptionRequest**](CreateRedemptionRequest.md) |  |  |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/pdf
+
+
+## get_redemption_by_id
+
+> <CreateRedemption201Response> get_redemption_by_id(redemption_id)
+
+Get a redemption
+
+Use this function to retrieve detailed information about a redemption object.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | The redemption identifier
+
+begin
+  # Get a redemption
+  result = api_instance.get_redemption_by_id(redemption_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->get_redemption_by_id: #{e}"
+end
+```
+
+#### Using the get_redemption_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> get_redemption_by_id_with_http_info(redemption_id)
+
+```ruby
+begin
+  # Get a redemption
+  data, status_code, headers = api_instance.get_redemption_by_id_with_http_info(redemption_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->get_redemption_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | The redemption identifier |  |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/pdf
+
+
+## list_redemptions
+
+> <ListRedemptions200Response> list_redemptions(promotion_id, opts)
+
+List all Redemptions
+
+Use this function to list the status of all redemptions created as part of a promotion.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+promotion_id = 'promotion_id_example' # String | The promotion identifier
+opts = {
+  reward_sku: 'reward_sku_example', # String | 
+  email: 'email_example', # String | 
+  order_id: 'order_id_example', # String | 
+  state: 'pending', # String | Redemption state filter (eg. `pending`, `redeemed`, `canceled`, etc.)
+  redeemed_datetime_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions redeemed on or after this datetime (ISO 8601 format, e.g. `2024-01-01T00:00:00Z`)
+  redeemed_datetime_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions redeemed on or before this datetime (ISO 8601 format, e.g. `2024-01-31T23:59:59Z`)
+  activation_datetime_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions activated on or after this datetime (ISO 8601 format, e.g. `2024-01-01T00:00:00Z`)
+  activation_datetime_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions activated on or before this datetime (ISO 8601 format, e.g. `2024-01-31T23:59:59Z`)
+  refund_datetime_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions refunded on or after this datetime (ISO 8601 format, e.g. `2024-01-01T00:00:00Z`)
+  refund_datetime_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter redemptions refunded on or before this datetime (ISO 8601 format, e.g. `2024-01-31T23:59:59Z`)
+  sort: 'activation_datetime', # String | Field to sort by, prefixed with `-` for descending order (e.g. `activation_datetime` or `-activation_datetime`)
+  page: 56, # Integer | 
+  per_page: 56 # Integer | 
+}
+
+begin
+  # List all Redemptions
+  result = api_instance.list_redemptions(promotion_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->list_redemptions: #{e}"
+end
+```
+
+#### Using the list_redemptions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRedemptions200Response>, Integer, Hash)> list_redemptions_with_http_info(promotion_id, opts)
+
+```ruby
+begin
+  # List all Redemptions
+  data, status_code, headers = api_instance.list_redemptions_with_http_info(promotion_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRedemptions200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->list_redemptions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promotion_id** | **String** | The promotion identifier |  |
+| **reward_sku** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **state** | **String** | Redemption state filter (eg. &#x60;pending&#x60;, &#x60;redeemed&#x60;, &#x60;canceled&#x60;, etc.) | [optional] |
+| **redeemed_datetime_start** | **Time** | Filter redemptions redeemed on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;) | [optional] |
+| **redeemed_datetime_end** | **Time** | Filter redemptions redeemed on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;) | [optional] |
+| **activation_datetime_start** | **Time** | Filter redemptions activated on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;) | [optional] |
+| **activation_datetime_end** | **Time** | Filter redemptions activated on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;) | [optional] |
+| **refund_datetime_start** | **Time** | Filter redemptions refunded on or after this datetime (ISO 8601 format, e.g. &#x60;2024-01-01T00:00:00Z&#x60;) | [optional] |
+| **refund_datetime_end** | **Time** | Filter redemptions refunded on or before this datetime (ISO 8601 format, e.g. &#x60;2024-01-31T23:59:59Z&#x60;) | [optional] |
+| **sort** | **String** | Field to sort by, prefixed with &#x60;-&#x60; for descending order (e.g. &#x60;activation_datetime&#x60; or &#x60;-activation_datetime&#x60;) | [optional] |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **per_page** | **Integer** |  | [optional][default to 20] |
+
+### Return type
+
+[**ListRedemptions200Response**](ListRedemptions200Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## redeem_redemption
+
+> <CreateRedemption201Response> redeem_redemption(redemption_id, opts)
+
+Redeem
+
+Use this function to perform a reward delivery from an existing redemption object.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | Unique Redemption identifier (eg. ZN7RS-9RNLY)
+opts = {
+  activate_redemption_request: Ifeelgoods::ActivateRedemptionRequest.new({data: Ifeelgoods::ActivateRedemptionRequestData.new}) # ActivateRedemptionRequest | 
+}
+
+begin
+  # Redeem
+  result = api_instance.redeem_redemption(redemption_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->redeem_redemption: #{e}"
+end
+```
+
+#### Using the redeem_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> redeem_redemption_with_http_info(redemption_id, opts)
+
+```ruby
+begin
+  # Redeem
+  data, status_code, headers = api_instance.redeem_redemption_with_http_info(redemption_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->redeem_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | Unique Redemption identifier (eg. ZN7RS-9RNLY) |  |
+| **activate_redemption_request** | [**ActivateRedemptionRequest**](ActivateRedemptionRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/pdf
+
+
+## refund_redemption
+
+> <CreateRedemption201Response> refund_redemption(redemption_id)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ifeelgoods'
+# setup authorization
+Ifeelgoods.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: api_secret
+  config.api_key['Api-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Api-Secret'] = 'Bearer'
+end
+
+api_instance = Ifeelgoods::RedemptionsApi.new
+redemption_id = 'redemption_id_example' # String | The redemption identifier
+
+begin
+  # Refund
+  result = api_instance.refund_redemption(redemption_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->refund_redemption: #{e}"
+end
+```
+
+#### Using the refund_redemption_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRedemption201Response>, Integer, Hash)> refund_redemption_with_http_info(redemption_id)
+
+```ruby
+begin
+  # Refund
+  data, status_code, headers = api_instance.refund_redemption_with_http_info(redemption_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRedemption201Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RedemptionsApi->refund_redemption_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redemption_id** | **String** | The redemption identifier |  |
+
+### Return type
+
+[**CreateRedemption201Response**](CreateRedemption201Response.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [bearer_auth](../README.md#bearer_auth), [api_secret](../README.md#api_secret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/pdf
+