talon_one 5.0.0 → 7.0.0

data/docker-compose.yml

@@ -0,0 +1,47 @@
+services:
+  api-service:
+    image: europe-west3-docker.pkg.dev/talon-artifacts/talon-images/talon-service:master
+    depends_on:
+      - database-service
+    ports:
+      - "9000:9000"
+    environment:
+      - TALON_DB_NAME=talon
+      - TALON_DB_USER=talon
+      - TALON_DB_PASSWORD=talon.one.9000
+      - TALON_DB_HOST=database-service
+      - TALON_DB_PORT=5432
+      - TALON_ENABLE_WEBHOOK_WORKER_POOL=false
+      - TZ=UTC
+      - RELEASE_STAGE=ci
+      - TALON_CH_ENABLED=false
+      - TALON_DISABLE_PROFILER=true
+      - USE_REPLICA_DB=false
+    command:
+      - /talon/talon
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:9000/v1/status/health"]
+      interval: 10s
+      timeout: 5s
+      retries: 10
+    restart: "on-failure:10"
+
+  database-service:
+    image: docker.io/bitnami/postgresql:15
+    volumes:
+      - 'postgresql_master_data:/bitnami/postgresql'
+    ports:
+      - "5433:5432"
+    environment:
+      - POSTGRESQL_DATABASE=talon
+      - POSTGRESQL_USERNAME=talon
+      - POSTGRESQL_PASSWORD=talon.one.9000
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U talon -d talon"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: "on-failure:10"
+
+volumes:
+  postgresql_master_data:

data/docs/AccountAnalytics.md

@@ -49,7 +49,7 @@ instance = TalonOne::AccountAnalytics.new(applications: 11,
                                  webhooks: 2,
                                  loyalty_programs: 5,
                                  live_loyalty_programs: 5,
-                                 last_updated_at: null)
+                                 last_updated_at: 2022-12-12T12:12:12Z)
 ```
 
 

data/docs/Achievement.md

@@ -12,6 +12,10 @@ Name | Type | Description | Notes
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | 
 **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period.  | 
 **period_end_override** | [**TimePoint**](TimePoint.md) |  | [optional] 
+**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again.  | [optional] 
+**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.  | [optional] 
+**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
+**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
 **campaign_id** | **Integer** | ID of the campaign, to which the achievement belongs to | 
 **user_id** | **Integer** | ID of the user that created this achievement. | 
 **created_by** | **String** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 
@@ -30,6 +34,10 @@ instance = TalonOne::Achievement.new(id: 6,
                                  target: 50.0,
                                  period: 1Y,
                                  period_end_override: null,
+                                 recurrence_policy: no_recurrence,
+                                 activation_policy: fixed_schedule,
+                                 fixed_start_date: null,
+                                 end_date: null,
                                  campaign_id: 1,
                                  user_id: 1234,
                                  created_by: John Doe,

data/docs/AchievementProgress.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **achievement_id** | **Integer** | The internal ID of the achievement. | 
 **name** | **String** | The internal name of the achievement used in API requests.  | 
 **title** | **String** | The display name of the achievement in the Campaign Manager. | 
+**description** | **String** | The description of the achievement in the Campaign Manager. | 
 **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | 
 **status** | **String** | The status of the achievement. | 
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 
@@ -23,6 +24,7 @@ require 'TalonOne'
 instance = TalonOne::AchievementProgress.new(achievement_id: 3,
                                  name: FreeCoffee10Orders,
                                  title: 50% off on 50th purchase.,
+                                 description: 50% off for every 50th purchase in a year.,
                                  campaign_id: 3,
                                  status: completed,
                                  target: 10.0,

data/docs/AdditionalCampaignProperties.md

@@ -25,7 +25,8 @@ Name | Type | Description | Notes
 **created_by** | **String** | Name of the user who created this campaign if available. | [optional] 
 **updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional] 
 **template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional] 
-**frontend_state** | **String** | A campaign state described exactly as in the Campaign Manager. | 
+**frontend_state** | **String** | The campaign state displayed in the Campaign Manager. | 
+**stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
 
 ## Code Sample
 
@@ -53,7 +54,8 @@ instance = TalonOne::AdditionalCampaignProperties.new(budgets: null,
                                  created_by: John Doe,
                                  updated_by: Jane Doe,
                                  template_id: 3,
-                                 frontend_state: running)
+                                 frontend_state: running,
+                                 stores_imported: true)
 ```
 
 

data/docs/AnalyticsDataPoint.md

@@ -0,0 +1,19 @@
+# TalonOne::AnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** |  | 
+**influenced** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPoint.new(total: 12.0,
+                                 influenced: 12.0)
+```
+
+

data/docs/AnalyticsDataPointWithTrend.md

@@ -0,0 +1,19 @@
+# TalonOne::AnalyticsDataPointWithTrend
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrend.new(value: 12.0,
+                                 trend: 3.25)
+```
+
+

data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md

@@ -0,0 +1,21 @@
+# TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**influenced_rate** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate.new(value: 12.0,
+                                 influenced_rate: 12.0,
+                                 trend: 3.25)
+```
+
+

data/docs/AnalyticsDataPointWithTrendAndUplift.md

@@ -0,0 +1,21 @@
+# TalonOne::AnalyticsDataPointWithTrendAndUplift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**uplift** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrendAndUplift.new(value: 12.0,
+                                 uplift: 3.25,
+                                 trend: 3.25)
+```
+
+

data/docs/AnalyticsProduct.md

@@ -0,0 +1,23 @@
+# TalonOne::AnalyticsProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the analytics-level product. | 
+**is_preliminary** | **Boolean** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. | 
+**name** | **String** | The name of the analytics-level product. | 
+**catalog_id** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsProduct.new(id: 1,
+                                 is_preliminary: false,
+                                 name: MyProduct,
+                                 catalog_id: 1)
+```
+
+

data/docs/AnalyticsProductSKU.md

@@ -0,0 +1,21 @@
+# TalonOne::AnalyticsProductSKU
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the SKU linked to the analytics-level product. | 
+**sku** | **String** | The SKU linked to the analytics-level product. | 
+**last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the analytics-level product was last updated. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsProductSKU.new(id: 1,
+                                 sku: SKU-123,
+                                 last_updated: 2024-02-01T00:00Z)
+```
+
+

data/docs/Application.md

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] 
 **default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect.  | [optional] 
 **default_evaluation_group_id** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional] 
+**default_cart_item_filter_id** | **Integer** | The ID of the default Cart-Item-Filter for this application. | [optional] 
+**enable_campaign_state_management** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  | [optional] 
 **loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 
 ## Code Sample
@@ -49,6 +51,8 @@ instance = TalonOne::Application.new(id: 6,
                                  enable_partial_discounts: false,
                                  default_discount_additional_cost_per_item_scope: price,
                                  default_evaluation_group_id: 3,
+                                 default_cart_item_filter_id: 3,
+                                 enable_campaign_state_management: false,
                                  loyalty_programs: null)
 ```
 

data/docs/ApplicationAnalyticsDataPoint.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | [optional] 
-**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | [optional] 
-**total_revenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) |  | [optional] 
-**sessions_count** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) |  | [optional] 
-**avg_items_per_session** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) |  | [optional] 
-**avg_session_value** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) |  | [optional] 
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**total_revenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**sessions_count** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avg_items_per_session** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avg_session_value** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
 **total_discounts** | **Float** | The total value of discounts given for cart items in influenced sessions. | [optional] 
 **coupons_count** | **Float** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional] 
 

data/docs/ApplicationCIF.md

@@ -0,0 +1,33 @@
+# TalonOne::ApplicationCIF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**name** | **String** | The name of the Application cart item filter used in API requests. | 
+**description** | **String** | A short description of the Application cart item filter. | [optional] 
+**active_expression_id** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCIF.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 name: Filter items by product,
+                                 description: This filter allows filtering by shoes,
+                                 active_expression_id: 1,
+                                 modified_by: 334,
+                                 created_by: 216,
+                                 modified: null,
+                                 application_id: 322)
+```
+
+

data/docs/ApplicationCIFExpression.md

@@ -0,0 +1,27 @@
+# TalonOne::ApplicationCIFExpression
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**expression** | **Array<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCIFExpression.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 cart_item_filter_id: 216,
+                                 created_by: 216,
+                                 expression: {expr=[filter, [., Session, CartItems], [[Item], [catch, false, [=, [., Item, Category], Kitchen]]]]},
+                                 application_id: 322)
+```
+
+

data/docs/ApplicationCampaignAnalytics.md

@@ -4,21 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | [optional] 
-**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | [optional] 
-**campaign_id** | **Integer** | The ID of the campaign. | [optional] 
-**campaign_name** | **String** | The name of the campaign. | [optional] 
-**campaign_tags** | **Array<String>** | A list of tags for the campaign. | [optional] 
-**campaign_state** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | [optional] [default to 'enabled']
-**campaign_active_ruleset_id** | **Integer** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.  | [optional] 
-**campaign_start_time** | **DateTime** | Date and time when the campaign becomes active. | [optional] 
-**campaign_end_time** | **DateTime** | Date and time when the campaign becomes inactive. | [optional] 
-**total_revenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) |  | [optional] 
-**sessions_count** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) |  | [optional] 
-**avg_items_per_session** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) |  | [optional] 
-**avg_session_value** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) |  | [optional] 
-**total_discounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) |  | [optional] 
-**coupons_count** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) |  | [optional] 
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**campaign_id** | **Integer** | The ID of the campaign. | 
+**campaign_name** | **String** | The name of the campaign. | 
+**campaign_tags** | **Array<String>** | A list of tags for the campaign. | 
+**campaign_state** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | 
+**total_revenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**sessions_count** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**avg_items_per_session** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**avg_session_value** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**total_discounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+**coupons_count** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
 
 ## Code Sample
 
@@ -30,10 +27,7 @@ instance = TalonOne::ApplicationCampaignAnalytics.new(start_time: 2024-02-01T00:
                                  campaign_id: 1,
                                  campaign_name: Summer promotions,
                                  campaign_tags: [summer],
-                                 campaign_state: enabled,
-                                 campaign_active_ruleset_id: 2,
-                                 campaign_start_time: 2021-07-20T22:00Z,
-                                 campaign_end_time: 2021-10-01T02:00Z,
+                                 campaign_state: running,
                                  total_revenue: null,
                                  sessions_count: null,
                                  avg_items_per_session: null,

data/docs/ApplicationCampaignStats.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**draft** | **Integer** | Number of draft campaigns. | 
 **disabled** | **Integer** | Number of disabled campaigns. | 
+**staged** | **Integer** | Number of staged campaigns. | 
 **scheduled** | **Integer** | Number of scheduled campaigns. | 
 **running** | **Integer** | Number of running campaigns. | 
 **expired** | **Integer** | Number of expired campaigns. | 
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::ApplicationCampaignStats.new(draft: null,
-                                 disabled: null,
+instance = TalonOne::ApplicationCampaignStats.new(disabled: null,
+                                 staged: null,
                                  scheduled: null,
                                  running: null,
                                  expired: null,

data/docs/ApplicationCustomer.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. | 
-**integration_id** | **String** | The integration ID set by your integration layer. The integration ID set by your integration layer. | 
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**integration_id** | **String** | The integration ID set by your integration layer. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | 
-**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | 
+**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. | 
 **closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied.  The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items.  | 
 **loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  | [optional] 
@@ -22,11 +22,11 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::ApplicationCustomer.new(id: null,
-                                 created: null,
-                                 integration_id: null,
+instance = TalonOne::ApplicationCustomer.new(id: 6,
+                                 created: 2020-02-07T08:15:22Z,
+                                 integration_id: URNGV8294NV,
                                  attributes: {"Language":"english","ShippingCountry":"DE"},
-                                 account_id: null,
+                                 account_id: 31,
                                  closed_sessions: 3,
                                  total_sales: 299.99,
                                  loyalty_memberships: null,

data/docs/ApplicationSession.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. The time this entity was created. | 
+**created** | **DateTime** | The time this entity was created. | 
 **integration_id** | **String** | The integration ID set by your integration layer. | 
 **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::ApplicationSession.new(id: 6,
-                                 created: null,
+                                 created: 2020-02-07T08:15:22Z,
                                  integration_id: URNGV8294NV,
                                  store_integration_id: STORE-001,
                                  application_id: 322,

data/docs/AsyncCouponDeletionJobResponse.md

@@ -0,0 +1,17 @@
+# TalonOne::AsyncCouponDeletionJobResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AsyncCouponDeletionJobResponse.new(id: 6)
+```
+
+

data/docs/AudienceCustomer.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. The time this entity was created. | 
+**created** | **DateTime** | The time this entity was created. | 
 **integration_id** | **String** | The integration ID set by your integration layer. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. | 
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::AudienceCustomer.new(id: 6,
-                                 created: null,
+                                 created: 2020-02-07T08:15:22Z,
                                  integration_id: URNGV8294NV,
                                  attributes: {"Language":"english","ShippingCountry":"DE"},
                                  account_id: 31,

data/docs/BaseLoyaltyProgram.md

@@ -12,10 +12,13 @@ Name | Type | Description | Notes
 **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional] 
 **users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.  | [optional] 
 **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional] 
-**tiers_expiration_policy** | **String** | The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.  | [optional] 
-**tiers_expire_in** | **String** | The amount of time after which the tier expires.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
-**tiers_downgrade_policy** | **String** | Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.  | [optional] 
 **program_join_policy** | **String** | The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.  | [optional] 
+**tiers_expiration_policy** | **String** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.  | [optional] 
+**tier_cycle_start_date** | **DateTime** | Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.  | [optional] 
+**tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
+**tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
+**card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative.  | [optional] 
 
 ## Code Sample
 
@@ -30,10 +33,13 @@ instance = TalonOne::BaseLoyaltyProgram.new(title: Point collection,
                                  allow_subledger: false,
                                  users_per_card_limit: 111,
                                  sandbox: true,
+                                 program_join_policy: null,
                                  tiers_expiration_policy: null,
+                                 tier_cycle_start_date: 2021-09-12T10:12:42Z,
                                  tiers_expire_in: 27W_U,
                                  tiers_downgrade_policy: null,
-                                 program_join_policy: null)
+                                 card_code_settings: null,
+                                 return_policy: null)
 ```
 
 

data/docs/BaseNotification.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | Indicates which notification properties to apply. | 
 **enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
 **webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) |  | 
 **id** | **Integer** | Unique ID for this entity. | 

data/docs/BaseNotificationEntity.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | Indicates which notification properties to apply. | 
 **enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
 
 ## Code Sample

data/docs/BulkOperationOnCampaigns.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **operation** | **String** | The operation to perform on the specified campaign IDs.  | 
 **campaign_ids** | **Array<Integer>** | The list of campaign IDs on which the operation will be performed. | 
+**activate_at** | **DateTime** | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::BulkOperationOnCampaigns.new(operation: null,
-                                 campaign_ids: [1, 2, 3])
+                                 campaign_ids: [1, 2, 3],
+                                 activate_at: null)
 ```
 
 

data/docs/Campaign.md

@@ -44,7 +44,15 @@ Name | Type | Description | Notes
 **created_by** | **String** | Name of the user who created this campaign if available. | [optional] 
 **updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional] 
 **template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional] 
-**frontend_state** | **String** | A campaign state described exactly as in the Campaign Manager. | 
+**frontend_state** | **String** | The campaign state displayed in the Campaign Manager. | 
+**stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
+**revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional] 
+**active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign.  | [optional] 
+**active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign.  | [optional] 
+**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.  | [optional] 
+**current_revision_id** | **Integer** | ID of the revision currently being modified for the campaign.  | [optional] 
+**current_revision_version_id** | **Integer** | ID of the latest version applied on the current revision.  | [optional] 
+**stage_revision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key.  | [optional] [default to false]
 
 ## Code Sample
 
@@ -91,7 +99,15 @@ instance = TalonOne::Campaign.new(id: 4,
                                  created_by: John Doe,
                                  updated_by: Jane Doe,
                                  template_id: 3,
-                                 frontend_state: running)
+                                 frontend_state: running,
+                                 stores_imported: true,
+                                 revision_frontend_state: revised,
+                                 active_revision_id: 6,
+                                 active_revision_version_id: 6,
+                                 version: 6,
+                                 current_revision_id: 6,
+                                 current_revision_version_id: 6,
+                                 stage_revision: false)
 ```