ifeelgoods 0.0.1

data/docs/ClientsApi.md

@@ -0,0 +1,341 @@
+# Ifeelgoods::ClientsApi
+
+All URIs are relative to *https://api-sandbox.ifeelgoods.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_client_budget_history**](ClientsApi.md#get_client_budget_history) | **GET** /fulfillment/v2/clients/{client_id}/budget/history | Get a Client budget history |
+| [**get_client_by_id**](ClientsApi.md#get_client_by_id) | **GET** /fulfillment/v2/clients/{client_id} | Get a Client |
+| [**list_client_discounts**](ClientsApi.md#list_client_discounts) | **GET** /fulfillment/v2/clients/{client_id}/discounts | List all discounts |
+| [**list_clients**](ClientsApi.md#list_clients) | **GET** /fulfillment/v2/clients | List all Clients |
+
+
+## get_client_budget_history
+
+> <GetClientBudgetHistory200Response> get_client_budget_history(client_id, opts)
+
+Get a Client budget history
+
+Use this function to retrieve detailed budget history about a client
+
+### 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::ClientsApi.new
+client_id = 'client_id_example' # String | The client identifier
+opts = {
+  page: 56, # Integer | 
+  per_page: 56, # Integer | 
+  sort: 'creation_datetime', # String | 
+  type: 'credit' # String | 
+}
+
+begin
+  # Get a Client budget history
+  result = api_instance.get_client_budget_history(client_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->get_client_budget_history: #{e}"
+end
+```
+
+#### Using the get_client_budget_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetClientBudgetHistory200Response>, Integer, Hash)> get_client_budget_history_with_http_info(client_id, opts)
+
+```ruby
+begin
+  # Get a Client budget history
+  data, status_code, headers = api_instance.get_client_budget_history_with_http_info(client_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetClientBudgetHistory200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->get_client_budget_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client identifier |  |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **per_page** | **Integer** |  | [optional][default to 20] |
+| **sort** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+### Return type
+
+[**GetClientBudgetHistory200Response**](GetClientBudgetHistory200Response.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
+
+
+## get_client_by_id
+
+> <GetClientById200Response> get_client_by_id(client_id)
+
+Get a Client
+
+Use this function to retrieve detailed information about a client
+
+### 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::ClientsApi.new
+client_id = 'client_id_example' # String | The client identifier
+
+begin
+  # Get a Client
+  result = api_instance.get_client_by_id(client_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->get_client_by_id: #{e}"
+end
+```
+
+#### Using the get_client_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetClientById200Response>, Integer, Hash)> get_client_by_id_with_http_info(client_id)
+
+```ruby
+begin
+  # Get a Client
+  data, status_code, headers = api_instance.get_client_by_id_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetClientById200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->get_client_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client identifier |  |
+
+### Return type
+
+[**GetClientById200Response**](GetClientById200Response.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
+
+
+## list_client_discounts
+
+> <ListClientDiscounts200Response> list_client_discounts(client_id)
+
+List all discounts
+
+Use this function to list all the discounts of a specific client
+
+### 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::ClientsApi.new
+client_id = 'client_id_example' # String | The client identifier
+
+begin
+  # List all discounts
+  result = api_instance.list_client_discounts(client_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->list_client_discounts: #{e}"
+end
+```
+
+#### Using the list_client_discounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListClientDiscounts200Response>, Integer, Hash)> list_client_discounts_with_http_info(client_id)
+
+```ruby
+begin
+  # List all discounts
+  data, status_code, headers = api_instance.list_client_discounts_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListClientDiscounts200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->list_client_discounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client identifier |  |
+
+### Return type
+
+[**ListClientDiscounts200Response**](ListClientDiscounts200Response.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
+
+
+## list_clients
+
+> <ListClients200Response> list_clients(opts)
+
+List all Clients
+
+Use this function to list all the clients your account can manage
+
+### 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::ClientsApi.new
+opts = {
+  page: 56, # Integer | 
+  per_page: 56 # Integer | 
+}
+
+begin
+  # List all Clients
+  result = api_instance.list_clients(opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->list_clients: #{e}"
+end
+```
+
+#### Using the list_clients_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListClients200Response>, Integer, Hash)> list_clients_with_http_info(opts)
+
+```ruby
+begin
+  # List all Clients
+  data, status_code, headers = api_instance.list_clients_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListClients200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling ClientsApi->list_clients_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **per_page** | **Integer** |  | [optional][default to 20] |
+
+### Return type
+
+[**ListClients200Response**](ListClients200Response.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
+

data/docs/CreateAndRedeemRequest.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateAndRedeemRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CreateAndRedeemRequestData**](CreateAndRedeemRequestData.md) |  |  |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateAndRedeemRequest.new(
+  data: null
+)
+```
+

data/docs/CreateAndRedeemRequestData.md

@@ -0,0 +1,24 @@
+# Ifeelgoods::CreateAndRedeemRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** |  | [optional] |
+| **user** | [**User**](User.md) |  | [optional] |
+| **value** | [**CreateRedemptionRequestDataValue**](CreateRedemptionRequestDataValue.md) |  | [optional] |
+| **customization** | [**CreateRedemptionRequestDataCustomization**](CreateRedemptionRequestDataCustomization.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateAndRedeemRequestData.new(
+  order_id: null,
+  user: null,
+  value: null,
+  customization: null
+)
+```
+

data/docs/CreateRedemption201Response.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateRedemption201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Redemption**](Redemption.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemption201Response.new(
+  data: null
+)
+```
+

data/docs/CreateRedemption422Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::CreateRedemption422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_name** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemption422Response.new(
+  error_name: invalid_request,
+  error_message: null
+)
+```
+

data/docs/CreateRedemptionRequest.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateRedemptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CreateRedemptionRequestData**](CreateRedemptionRequestData.md) |  |  |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequest.new(
+  data: null
+)
+```
+

data/docs/CreateRedemptionRequestData.md

@@ -0,0 +1,26 @@
+# Ifeelgoods::CreateRedemptionRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | Must be unique for each redemption |  |
+| **user** | [**User**](User.md) |  |  |
+| **reward** | [**CreateRedemptionRequestDataReward**](CreateRedemptionRequestDataReward.md) |  |  |
+| **value** | [**CreateRedemptionRequestDataValue**](CreateRedemptionRequestDataValue.md) |  | [optional] |
+| **customization** | [**CreateRedemptionRequestDataCustomization**](CreateRedemptionRequestDataCustomization.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequestData.new(
+  order_id: null,
+  user: null,
+  reward: null,
+  value: null,
+  customization: null
+)
+```
+

data/docs/CreateRedemptionRequestDataCustomization.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateRedemptionRequestDataCustomization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pdf** | [**CreateRedemptionRequestDataCustomizationPdf**](CreateRedemptionRequestDataCustomizationPdf.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequestDataCustomization.new(
+  pdf: null
+)
+```
+

data/docs/CreateRedemptionRequestDataCustomizationPdf.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::CreateRedemptionRequestDataCustomizationPdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **sender_name** | **String** | The reward sender name to be printed on the PDF (if applicable) | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequestDataCustomizationPdf.new(
+  message: I hope you enjoy this reward!,
+  sender_name: Martina
+)
+```
+

data/docs/CreateRedemptionRequestDataReward.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateRedemptionRequestDataReward
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequestDataReward.new(
+  sku: APP-ITC-10USD-US
+)
+```
+

data/docs/CreateRedemptionRequestDataValue.md

@@ -0,0 +1,18 @@
+# Ifeelgoods::CreateRedemptionRequestDataValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **String** | optional - only needed for \"free value\" rewards | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::CreateRedemptionRequestDataValue.new(
+  amount: 10
+)
+```
+

data/docs/Dimension.md

@@ -0,0 +1,44 @@
+# Ifeelgoods::Dimension
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available_denominations_range** | **String** | Indicates the range of values that can be used with open value reward (when free_value is true) (eg. 5..250). | [optional] |
+| **custom_offer** | **String** | When a custom offer has been configured for this product (eg. buy one get one, $20 off the second article, etc.). | [optional] |
+| **validity_period** | **String** | Duration during which the reward code remains valid after delivery. Expressed as a number followed by a unit: d for days, m for months, y for years (eg. 30d for 30 days, 12m for 12 months, 1y for 1 year). Returns null if no validity period applies. | [optional] |
+| **available_denominations** | **String** | List of specific monetary amounts available for this reward. | [optional] |
+| **breakable** | **String** | Indicates whether the reward code can be broken into smaller values. | [optional] |
+| **cumulable** | **String** | Indicates whether multiple reward codes can be combined. | [optional] |
+| **denomination** | [**DimensionDenomination**](DimensionDenomination.md) |  | [optional] |
+| **denomination_currency** | **String** | Currency of the denomination amount (eg. EUR, USD, etc.). | [optional] |
+| **duration** | **String** | Duration of a subscription or service (eg. 2 months). | [optional] |
+| **duration_unit** | **String** | Unit of the duration dimension. Possible values: minute, hour, day, week, month, year, varying_duration. | [optional] |
+| **people** | **String** | Number of people concerned by the reward. | [optional] |
+| **quantity** | **String** | Virtual currency amount associated with the reward (eg. 300 points, 200 miles, etc.). | [optional] |
+| **quantity_unit** | **String** | Unit of the quantity dimension. Possible values: points, miles, facebook_credits, minutes, movie, meal, e_magazine, e_ticket, song, lesson, box, subscription. | [optional] |
+| **redemption_channel** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::Dimension.new(
+  available_denominations_range: 5..250,
+  custom_offer: Buy one get one,
+  validity_period: 30d,
+  available_denominations: null,
+  breakable: null,
+  cumulable: null,
+  denomination: null,
+  denomination_currency: EUR,
+  duration: 2,
+  duration_unit: month,
+  people: 2,
+  quantity: 300,
+  quantity_unit: points,
+  redemption_channel: null
+)
+```
+

data/docs/DimensionDenomination.md

@@ -0,0 +1,49 @@
+# Ifeelgoods::DimensionDenomination
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ifeelgoods'
+
+Ifeelgoods::DimensionDenomination.openapi_one_of
+# =>
+# [
+#   :'Float',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ifeelgoods'
+
+Ifeelgoods::DimensionDenomination.build(data)
+# => #<Float:0x00007fdd4aab02a0>
+
+Ifeelgoods::DimensionDenomination.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Float`
+- `String`
+- `nil` (if no type matches)
+

data/docs/DiscountSummary.md

@@ -0,0 +1,28 @@
+# Ifeelgoods::DiscountSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **sku** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **discount** | **Float** |  | [optional] |
+| **brand_sku** | **String** |  | [optional] |
+| **brand_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::DiscountSummary.new(
+  id: null,
+  sku: null,
+  label: null,
+  discount: null,
+  brand_sku: null,
+  brand_name: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_name** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ErrorResponse.new(
+  error_name: null,
+  error_message: null
+)
+```
+