ifeelgoods 0.0.1

data/docs/RewardDetails.md

@@ -0,0 +1,76 @@
+# Ifeelgoods::RewardDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Reward name (eg. `$10 iTunes® Code`). | [optional] |
+| **sku** | **String** | Unique identifier that represents the reward (eg. `APP-ITC-10USD-US`). It must be used with the redeem APIs. | [optional] |
+| **denomination** | **String** | Reward formatted value with currency (eg. `$10`). | [optional] |
+| **display_value** | **String** |  | [optional] |
+| **free_value** | **Boolean** | Indicates whether the reward should be redeemed with a value. Range can be found in dimensions.available_denominations_range. | [optional] |
+| **cost** | **Float** | Reward cost for your account (eg. `9.0`). You need to query the API with the `client_id` parameter to retrieve the acutal cost, otherwise it will return `face_value`. | [optional] |
+| **cost_currency** | **String** | Reward cost currency (eg. `USD`, `EUR`). | [optional] |
+| **face_value** | **String** | Reward face value, actual reward amount (e.g. `10.00`). | [optional] |
+| **face_value_currency** | **String** | Reward face value currency. (eg. `EUR`). | [optional] |
+| **in_stock** | **Boolean** | Boolean that represent reward availability. | [optional] |
+| **stock_quantity** | **Integer** | Stock quantity. Can be `null` (if `stock_quantity` is `null`, `in_stock` is always `true`). | [optional] |
+| **brand** | [**RewardDetailsBrand**](RewardDetailsBrand.md) |  | [optional] |
+| **product** | [**RewardDetailsProduct**](RewardDetailsProduct.md) |  | [optional] |
+| **product_type** | [**RewardDetailsProductType**](RewardDetailsProductType.md) |  | [optional] |
+| **usages** | **Array<String>** | Reward code format | [optional] |
+| **expiration_date** | **String** | Expiration date (eg. `2023-03-31`) | [optional] |
+| **categories** | **Array<String>** | Reward categories (eg. `['Games & Entertainment', 'Sports']`) (not maintained). | [optional] |
+| **description** | **String** | Reward description. | [optional] |
+| **country** | **Array<String>** | Reward country list (eg. `[\"US\", \"CA\"]` or `[\"WW\"]` if worldwide). If the reward is not specific to a country, it will be considered as worldwide. | [optional] |
+| **conditions_of_sale** | **String** |  | [optional] |
+| **dimensions** | [**RewardDetailsDimensions**](RewardDetailsDimensions.md) |  | [optional] |
+| **tags** | **Array<String>** | Reward tags (not maintained). | [optional] |
+| **targeting** | [**RewardDetailsTargeting**](RewardDetailsTargeting.md) |  | [optional] |
+| **catalog_badge_url** | **String** | Reward image, without scheme (eg. `//cdn.ifeelgoods.com/image.png`). | [optional] |
+| **catalog_card_url** | **String** | (legacy) Reward image (same as catalog_badge_url). | [optional] |
+| **logo_url** | **String** | Brand logo, without scheme (eg. `//cdn.ifeelgoods.com/logo.png`). | [optional] |
+| **terms_and_conditions_url** | **String** | Reward 'Terms and Conditions' URL (when provided by brand, `null` otherwise). | [optional] |
+| **terms_and_conditions** | **String** | Reward 'Terms and Conditions'. | [optional] |
+| **how_to_use_instructions** | **String** | Reward 'How to use' instructions. | [optional] |
+| **important_instructions** | **String** | Reward additional information. | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RewardDetails.new(
+  name: Uggy Gift Card 10€,
+  sku: APP-ITC-10USD-US,
+  denomination: 10€,
+  display_value: null,
+  free_value: null,
+  cost: 9.0,
+  cost_currency: EUR,
+  face_value: 10.00,
+  face_value_currency: EUR,
+  in_stock: null,
+  stock_quantity: 100,
+  brand: null,
+  product: null,
+  product_type: null,
+  usages: ["primary"],
+  expiration_date: 2026-08-03,
+  categories: ["Sports"],
+  description: null,
+  country: ["US","CA"],
+  conditions_of_sale: null,
+  dimensions: null,
+  tags: null,
+  targeting: null,
+  catalog_badge_url: //cdn.ifeelgoods.com/image.png,
+  catalog_card_url: //cdn.ifeelgoods.com/image.png,
+  logo_url: //cdn.ifeelgoods.com/images/logo.png,
+  terms_and_conditions_url: https//ifeelgoods.com/terms_and_conditions,
+  terms_and_conditions: null,
+  how_to_use_instructions: null,
+  important_instructions: null
+)
+```
+

data/docs/RewardDetailsBrand.md

@@ -0,0 +1,24 @@
+# Ifeelgoods::RewardDetailsBrand
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier that represents the brand (eg. `APP`). | [optional] |
+| **name** | **String** | Brand name (eg. `iTunes`). | [optional] |
+| **status** | **String** |  | [optional] |
+| **url** | **String** | Brand URL (eg. `https://www.ifeelgoods.com`). | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RewardDetailsBrand.new(
+  id: APP,
+  name: iTunes,
+  status: null,
+  url: null
+)
+```
+

data/docs/RewardDetailsDimensions.md

@@ -0,0 +1,44 @@
+# Ifeelgoods::RewardDetailsDimensions
+
+## 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::RewardDetailsDimensions.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/RewardDetailsProduct.md

@@ -0,0 +1,26 @@
+# Ifeelgoods::RewardDetailsProduct
+
+## 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::RewardDetailsProduct.new(
+  id: APP-ITC,
+  name: iTunes Code,
+  deliverable_as_pdf: null,
+  vat_rate: 0.19,
+  vat_rule: null
+)
+```
+

data/docs/RewardDetailsProductType.md

@@ -0,0 +1,20 @@
+# Ifeelgoods::RewardDetailsProductType
+
+## 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::RewardDetailsProductType.new(
+  id: gift_card,
+  name: Gift Card
+)
+```
+

data/docs/RewardDetailsTargeting.md

@@ -0,0 +1,22 @@
+# Ifeelgoods::RewardDetailsTargeting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gender** | **Array<String>** |  | [optional] |
+| **age_range** | **Array<String>** |  | [optional] |
+| **reach** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::RewardDetailsTargeting.new(
+  gender: null,
+  age_range: ["18-24","25-34"],
+  reach: null
+)
+```
+

data/docs/RewardFormat.md

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

data/docs/RewardsApi.md

@@ -0,0 +1,175 @@
+# Ifeelgoods::RewardsApi
+
+All URIs are relative to *https://api-sandbox.ifeelgoods.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_reward_by_sku**](RewardsApi.md#get_reward_by_sku) | **GET** /fulfillment/v2/rewards/{sku} | Get a Reward |
+| [**list_rewards**](RewardsApi.md#list_rewards) | **GET** /fulfillment/v2/rewards | List all Rewards |
+
+
+## get_reward_by_sku
+
+> <GetRewardBySKU200Response> get_reward_by_sku(sku)
+
+Get a Reward
+
+Use this function to retrieve detailed description about a reward
+
+### 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::RewardsApi.new
+sku = 'sku_example' # String | The reward SKU
+
+begin
+  # Get a Reward
+  result = api_instance.get_reward_by_sku(sku)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RewardsApi->get_reward_by_sku: #{e}"
+end
+```
+
+#### Using the get_reward_by_sku_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRewardBySKU200Response>, Integer, Hash)> get_reward_by_sku_with_http_info(sku)
+
+```ruby
+begin
+  # Get a Reward
+  data, status_code, headers = api_instance.get_reward_by_sku_with_http_info(sku)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRewardBySKU200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RewardsApi->get_reward_by_sku_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** | The reward SKU |  |
+
+### Return type
+
+[**GetRewardBySKU200Response**](GetRewardBySKU200Response.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_rewards
+
+> <ListRewards200Response> list_rewards(opts)
+
+List all Rewards
+
+Use this function to list all the rewards from the Ifeelgoods Catalog
+
+### 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::RewardsApi.new
+opts = {
+  sku: 'sku1,sku2,sku3', # String | Comma-separated list of reward SKUs to filter by
+  client_id: 'client_id_example', # String | Unique Client identifier (used to retrieve cost with discount)
+  page: 56, # Integer | 
+  per_page: 56 # Integer | 
+}
+
+begin
+  # List all Rewards
+  result = api_instance.list_rewards(opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RewardsApi->list_rewards: #{e}"
+end
+```
+
+#### Using the list_rewards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRewards200Response>, Integer, Hash)> list_rewards_with_http_info(opts)
+
+```ruby
+begin
+  # List all Rewards
+  data, status_code, headers = api_instance.list_rewards_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRewards200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling RewardsApi->list_rewards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** | Comma-separated list of reward SKUs to filter by | [optional] |
+| **client_id** | **String** | Unique Client identifier (used to retrieve cost with discount) | [optional] |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **per_page** | **Integer** |  | [optional][default to 20] |
+
+### Return type
+
+[**ListRewards200Response**](ListRewards200Response.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/Stats.md

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

data/docs/StatsApi.md

@@ -0,0 +1,101 @@
+# Ifeelgoods::StatsApi
+
+All URIs are relative to *https://api-sandbox.ifeelgoods.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_redemption_stats**](StatsApi.md#get_redemption_stats) | **GET** /fulfillment/v2/clients/{client_id}/stats | Get Redemption Stats |
+
+
+## get_redemption_stats
+
+> <GetRedemptionStats200Response> get_redemption_stats(client_id, opts)
+
+Get Redemption Stats
+
+Use this function to access data relative to the reward delivery activity for 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::StatsApi.new
+client_id = 'client_id_example' # String | The client identifier
+opts = {
+  promotion_id: 'promotion_id_example', # String | 
+  reward_sku: 'reward_sku_example', # String | 
+  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | ISO-8601 String representing the start date for the date range for which activity stats are extracted
+  end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | ISO-8601 String representing the end date for the date range for which activity stats are extracted
+  interval: 'daily', # String | Aggregation granularity - daily, monthly and yearly
+  states: 'all' # String | Filter to specify the state of the redemptions to include in the stats
+}
+
+begin
+  # Get Redemption Stats
+  result = api_instance.get_redemption_stats(client_id, opts)
+  p result
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling StatsApi->get_redemption_stats: #{e}"
+end
+```
+
+#### Using the get_redemption_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRedemptionStats200Response>, Integer, Hash)> get_redemption_stats_with_http_info(client_id, opts)
+
+```ruby
+begin
+  # Get Redemption Stats
+  data, status_code, headers = api_instance.get_redemption_stats_with_http_info(client_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRedemptionStats200Response>
+rescue Ifeelgoods::ApiError => e
+  puts "Error when calling StatsApi->get_redemption_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client identifier |  |
+| **promotion_id** | **String** |  | [optional] |
+| **reward_sku** | **String** |  | [optional] |
+| **start_date** | **Time** | ISO-8601 String representing the start date for the date range for which activity stats are extracted | [optional] |
+| **end_date** | **Time** | ISO-8601 String representing the end date for the date range for which activity stats are extracted | [optional] |
+| **interval** | **String** | Aggregation granularity - daily, monthly and yearly | [optional] |
+| **states** | **String** | Filter to specify the state of the redemptions to include in the stats | [optional] |
+
+### Return type
+
+[**GetRedemptionStats200Response**](GetRedemptionStats200Response.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/StatsTimeframe.md

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

data/docs/StatsValuesInner.md

@@ -0,0 +1,24 @@
+# Ifeelgoods::StatsValuesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_by** | [**Array<StatsValuesInnerGroupByInner>**](StatsValuesInnerGroupByInner.md) |  | [optional] |
+| **states** | [**StatsValuesInnerStates**](StatsValuesInnerStates.md) |  | [optional] |
+| **selling_price** | **Float** |  | [optional] |
+| **total_face_value** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::StatsValuesInner.new(
+  group_by: {},
+  states: null,
+  selling_price: 76,
+  total_face_value: 80
+)
+```
+

data/docs/StatsValuesInnerGroupByInner.md

@@ -0,0 +1,26 @@
+# Ifeelgoods::StatsValuesInnerGroupByInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **iso_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::StatsValuesInnerGroupByInner.new(
+  resource_type: product,
+  id: GIF-GIFTCOOL,
+  name: Gift Cool,
+  value: 40,
+  iso_code: EUR
+)
+```
+

data/docs/StatsValuesInnerStates.md

@@ -0,0 +1,34 @@
+# Ifeelgoods::StatsValuesInnerStates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pending** | **Integer** |  | [optional] |
+| **booked** | **Integer** |  | [optional] |
+| **redeemed** | **Integer** |  | [optional] |
+| **denied** | **Integer** |  | [optional] |
+| **failed** | **Integer** |  | [optional] |
+| **refunded** | **Integer** |  | [optional] |
+| **blocked** | **Integer** |  | [optional] |
+| **canceled** | **Integer** |  | [optional] |
+| **expired** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::StatsValuesInnerStates.new(
+  pending: 5,
+  booked: 2,
+  redeemed: 7,
+  denied: 4,
+  failed: 0,
+  refunded: 6,
+  blocked: 9,
+  canceled: 6,
+  expired: 3
+)
+```
+

data/docs/User.md

@@ -0,0 +1,26 @@
+# Ifeelgoods::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **phone_number** | **String** | International format (eg. +336xxxxxxxx) | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ifeelgoods'
+
+instance = Ifeelgoods::User.new(
+  email: james.brown@ifeelgoods.com,
+  phone_number: +33611111111,
+  first_name: James,
+  last_name: Brown,
+  address: null
+)
+```
+