ifeelgoods 0.0.1

data/docs/Redemption.md

@@ -0,0 +1,58 @@
+# Ifeelgoods::Redemption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **testing** | **Boolean** |  | [optional] |
+| **cancelable** | **Boolean** | When a redemption is redeemed, indicates whether the code is cancelable or not | [optional] |
+| **reversed** | **Boolean** | When a redemption is refunded, indicates whether the code was reversed or not | [optional] |
+| **client** | [**PromotionDetailsClient**](PromotionDetailsClient.md) |  | [optional] |
+| **promotion** | [**RedemptionPromotion**](RedemptionPromotion.md) |  | [optional] |
+| **authentication_systems** | **Array<String>** | List of authentication systems used for the campaign (eg. `[\"email\", \"sms\"]`). | [optional] |
+| **notification_channels** | **Array<String>** |  | [optional] |
+| **activation_notification_channels** | **Array<String>** |  | [optional] |
+| **can_consult** | **Boolean** |  | [optional] |
+| **reward_format** | [**RedemptionRewardFormat**](RedemptionRewardFormat.md) |  | [optional] |
+| **reward** | [**RedemptionReward**](RedemptionReward.md) |  | [optional] |
+| **value** | [**RedemptionValue**](RedemptionValue.md) |  | [optional] |
+| **activation_datetime** | **Time** |  | [optional] |
+| **expiration_datetime** | **Time** | Redemption expiration date (when the redemption is in pending state, it may have a date after which it is no longer redeemable). | [optional] |
+| **redeemed_datetime** | **Time** | Available when redemption has reached a redeemed state. | [optional] |
+| **refunded_datetime** | **Time** | Available when redemption has reached a refunded state. | [optional] |
+| **updated_datetime** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::Redemption.new(
+  id: ABCDE-12345,
+  url: null,
+  state: null,
+  order_id: null,
+  testing: null,
+  cancelable: null,
+  reversed: null,
+  client: null,
+  promotion: null,
+  authentication_systems: ["facebook_connect","google","email","sms"],
+  notification_channels: ["email","sms"],
+  activation_notification_channels: ["email","sms"],
+  can_consult: null,
+  reward_format: null,
+  reward: null,
+  value: null,
+  activation_datetime: null,
+  expiration_datetime: null,
+  redeemed_datetime: null,
+  refunded_datetime: null,
+  updated_datetime: null
+)
+```
+

data/docs/RedemptionPromotion.md

@@ -0,0 +1,24 @@
+# Ifeelgoods::RedemptionPromotion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RedemptionPromotion.new(
+  id: null,
+  status: null,
+  name: null,
+  state: null
+)
+```
+

data/docs/RedemptionReward.md

@@ -0,0 +1,24 @@
+# Ifeelgoods::RedemptionReward
+
+## 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] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RedemptionReward.new(
+  name: Uggy Gift Card 10€,
+  sku: APP-ITC-10USD-US,
+  status: enabled,
+  state: ready
+)
+```
+

data/docs/RedemptionRewardFormat.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::RedemptionRewardFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usages** | **Array<String>** |  | [optional] |
+| **barcode_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RedemptionRewardFormat.new(
+  usages: null,
+  barcode_type: null
+)
+```
+

data/docs/RedemptionValue.md

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