ifeelgoods 0.0.1

data/docs/GetClientBudgetHistory200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::GetClientBudgetHistory200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ClientDetails>**](ClientDetails.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::GetClientBudgetHistory200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/GetClientById200Response.md

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

data/docs/GetCurrentAccount200Response.md

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

data/docs/GetPromotionByID200Response.md

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

data/docs/GetPromotionByID401Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::GetPromotionByID401Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_name** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::GetPromotionByID401Response.new(
+  error_name: forbidden,
+  error_message: The authenticated user does not have permission to access this resource.
+)
+```
+

data/docs/GetPromotionByID404Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::GetPromotionByID404Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_name** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::GetPromotionByID404Response.new(
+  error_name: not_found,
+  error_message: The requested resource could not be found.
+)
+```
+

data/docs/GetRedemptionStats200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::GetRedemptionStats200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Stats>**](Stats.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::GetRedemptionStats200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/GetRewardBySKU200Response.md

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

data/docs/ListClientDiscounts200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListClientDiscounts200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<DiscountSummary>**](DiscountSummary.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClientDiscounts200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListClientPromotions200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListClientPromotions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<PromotionDetails>**](PromotionDetails.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClientPromotions200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListClientPromotions200ResponsePaging.md

@@ -0,0 +1,22 @@
+# Ifeelgoods::ListClientPromotions200ResponsePaging
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClientPromotions200ResponsePaging.new(
+  page: 1,
+  per_page: 20,
+  total: 100
+)
+```
+

data/docs/ListClientPromotions401Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListClientPromotions401Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_name** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClientPromotions401Response.new(
+  error_name: unauthorized,
+  error_message: Authentication credentials are missing or invalid.
+)
+```
+

data/docs/ListClientVendorPlaces200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListClientVendorPlaces200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<VendorPlace>**](VendorPlace.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClientVendorPlaces200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListClients200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListClients200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ClientSummary>**](ClientSummary.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListClients200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListRedemptions200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListRedemptions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Redemption>**](Redemption.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListRedemptions200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListRewards200Response.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ListRewards200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<RewardDetails>**](RewardDetails.md) |  | [optional] |
+| **paging** | [**ListClientPromotions200ResponsePaging**](ListClientPromotions200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ListRewards200Response.new(
+  data: null,
+  paging: null
+)
+```
+

data/docs/ProductSummary.md

@@ -0,0 +1,26 @@
+# Ifeelgoods::ProductSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the product (eg. `APP-ITC`). | [optional] |
+| **name** | **String** | The product name (eg. `iTunes Code`). | [optional] |
+| **deliverable_as_pdf** | **Boolean** | Indicates whether the product can be delivered as PDF or not. | [optional] |
+| **vat_rate** | **Float** | Indicates product VAT rate. | [optional] |
+| **vat_rule** | **String** | Indicates product VAT rule (BUU or BUM). | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ProductSummary.new(
+  id: APP-ITC,
+  name: iTunes Code,
+  deliverable_as_pdf: null,
+  vat_rate: 0.19,
+  vat_rule: null
+)
+```
+

data/docs/ProductType.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::ProductType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the product type. | [optional] |
+| **name** | **String** | The product type name. | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::ProductType.new(
+  id: gift_card,
+  name: Gift Card
+)
+```
+

data/docs/PromotionDetails.md

@@ -0,0 +1,46 @@
+# Ifeelgoods::PromotionDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **ui_id** | **String** |  | [optional] |
+| **locale** | **String** |  | [optional] |
+| **name** | **String** | Campaign name. | [optional] |
+| **start_datetime** | **Time** |  | [optional] |
+| **end_datetime** | **Time** |  | [optional] |
+| **client** | [**PromotionDetailsClient**](PromotionDetailsClient.md) |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **rewards** | [**Array<PromotionDetailsRewardsInner>**](PromotionDetailsRewardsInner.md) |  | [optional] |
+| **fraud_level** | **String** |  | [optional] |
+| **redeem_frequency** | **String** |  | [optional] |
+| **authentication_systems** | **Array<String>** | List of authentication systems used for the campaign (eg. `[\"email\", \"sms\"]`). | [optional] |
+| **secured_order_ids** | **Boolean** | Indicates whether the campaign stores secured order ids. | [optional] |
+| **allow_pdf** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::PromotionDetails.new(
+  id: null,
+  ui_id: null,
+  locale: en,
+  name: Holiday Campaign,
+  start_datetime: null,
+  end_datetime: null,
+  client: null,
+  status: null,
+  state: null,
+  rewards: null,
+  fraud_level: null,
+  redeem_frequency: null,
+  authentication_systems: ["facebook_connect","google","email","sms"],
+  secured_order_ids: null,
+  allow_pdf: null
+)
+```
+

data/docs/PromotionDetailsClient.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::PromotionDetailsClient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::PromotionDetailsClient.new(
+  id: 237,
+  name: Ifeelgoods, Inc.
+)
+```
+

data/docs/PromotionDetailsRewardsInner.md

@@ -0,0 +1,28 @@
+# Ifeelgoods::PromotionDetailsRewardsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Uggy Gift Card 10€ | [optional] |
+| **sku** | **String** | Unique identifier that represents the reward (eg. `APP-ITC-10USD-US`). It must be used with the redeem APIs. | [optional] |
+| **status** | **String** | Current lifecycle status of the offer (enabled, paused, disabled).               Use this field to understand whether the offer is currently intended to be active for your program. | [optional] |
+| **state** | **String** | Current availability outcome of the offer based on its setup and availability checks.               This field explains why an offer can or cannot be used at the moment. | [optional] |
+| **variable_value** | **Boolean** | Indicates whether the reward should be redeemed with a value. Range can be found in dimensions.available_denominations_range. | [optional] |
+| **usages** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::PromotionDetailsRewardsInner.new(
+  name: Uggy Gift Card 10€,
+  sku: APP-ITC-10USD-US,
+  status: enabled,
+  state: ready,
+  variable_value: null,
+  usages: ["primary"]
+)
+```
+

data/docs/PromotionsApi.md

@@ -0,0 +1,173 @@
+# Ifeelgoods::PromotionsApi
+
+All URIs are relative to *https://api-sandbox.ifeelgoods.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_promotion_by_id**](PromotionsApi.md#get_promotion_by_id) | **GET** /fulfillment/v2/promotions/{promotion_id} | Get a promotion |
+| [**list_client_promotions**](PromotionsApi.md#list_client_promotions) | **GET** /fulfillment/v2/clients/{client_id}/promotions | List all Promotions |
+
+
+## get_promotion_by_id
+
+> <GetPromotionByID200Response> get_promotion_by_id(promotion_id)
+
+Get a promotion
+
+Use this function to retrieve detailed information about a promotion and the list of the rewards available for delivery as part of this operation
+
+### 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::PromotionsApi.new
+promotion_id = 'promotion_id_example' # String | The promotion identifier
+
+begin
+  # Get a promotion
+  result = api_instance.get_promotion_by_id(promotion_id)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling PromotionsApi->get_promotion_by_id: #{e}"
+end
+```
+
+#### Using the get_promotion_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPromotionByID200Response>, Integer, Hash)> get_promotion_by_id_with_http_info(promotion_id)
+
+```ruby
+begin
+  # Get a promotion
+  data, status_code, headers = api_instance.get_promotion_by_id_with_http_info(promotion_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPromotionByID200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling PromotionsApi->get_promotion_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promotion_id** | **String** | The promotion identifier |  |
+
+### Return type
+
+[**GetPromotionByID200Response**](GetPromotionByID200Response.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_promotions
+
+> <ListClientPromotions200Response> list_client_promotions(client_id, opts)
+
+List all Promotions
+
+Use this function to list all the promotions 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::PromotionsApi.new
+client_id = 'client_id_example' # String | The client identifier
+opts = {
+  page: 56, # Integer | 
+  per_page: 56 # Integer | 
+}
+
+begin
+  # List all Promotions
+  result = api_instance.list_client_promotions(client_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling PromotionsApi->list_client_promotions: #{e}"
+end
+```
+
+#### Using the list_client_promotions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListClientPromotions200Response>, Integer, Hash)> list_client_promotions_with_http_info(client_id, opts)
+
+```ruby
+begin
+  # List all Promotions
+  data, status_code, headers = api_instance.list_client_promotions_with_http_info(client_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListClientPromotions200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling PromotionsApi->list_client_promotions_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] |
+
+### Return type
+
+[**ListClientPromotions200Response**](ListClientPromotions200Response.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
+