talon_one 6.0.0 → 8.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

@@ -10,12 +10,17 @@ Name | Type | Description | Notes
 **title** | **String** | The display name for the achievement in the Campaign Manager. | 
 **description** | **String** | A description of the achievement. | 
 **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** | **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.  | [optional] 
 **period_end_override** | [**TimePoint**](TimePoint.md) |  | [optional] 
-**campaign_id** | **Integer** | ID of the campaign, to which the achievement belongs to | 
+**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** | The ID of the campaign 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.  | 
+**created_by** | **String** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | [optional] 
 **has_progress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] 
+**status** | **String** | The status of the achievement. | [optional] 
 
 ## Code Sample
 
@@ -30,10 +35,15 @@ 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,
-                                 has_progress: null)
+                                 has_progress: null,
+                                 status: inprogress)
 ```
 
 

data/docs/AchievementAdditionalProperties.md

@@ -4,10 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign_id** | **Integer** | ID of the campaign, to which the achievement belongs to | 
+**campaign_id** | **Integer** | The ID of the campaign 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.  | 
+**created_by** | **String** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | [optional] 
 **has_progress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] 
+**status** | **String** | The status of the achievement. | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'TalonOne'
 instance = TalonOne::AchievementAdditionalProperties.new(campaign_id: 1,
                                  user_id: 1234,
                                  created_by: John Doe,
-                                 has_progress: null)
+                                 has_progress: null,
+                                 status: inprogress)
 ```
 
 

data/docs/AchievementProgress.md

@@ -4,30 +4,18 @@
 
 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] 
 **progress** | **Float** | The current progress of the customer in the achievement. | 
-**start_date** | **DateTime** | Timestamp at which the customer started the achievement. | 
+**start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional] 
 **completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional] 
-**end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | 
+**end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional] 
 
 ## Code Sample
 
 ```ruby
 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,
+instance = TalonOne::AchievementProgress.new(status: completed,
                                  progress: 10.0,
                                  start_date: null,
                                  completion_date: null,

data/docs/AddFreeItemEffectProps.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sku** | **String** | SKU of the item that needs to be added. | 
 **name** | **String** | The name / description of the effect | 
+**desired_quantity** | **Integer** | The original quantity in case a partial reward was applied. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::AddFreeItemEffectProps.new(sku: SKU1241028,
-                                 name: null)
+                                 name: null,
+                                 desired_quantity: null)
 ```
 
 

data/docs/AdditionalCampaignProperties.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage.  **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.  | 
+**budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage.  **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.  | [optional] 
 **coupon_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.  | [optional] 
 **referral_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.  | [optional] 
 **discount_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.  | [optional] 
@@ -25,8 +25,9 @@ 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. | 
+**value_maps_ids** | **Array<Integer>** | A list of value map IDs for the campaign. | [optional] 
 
 ## Code Sample
 
@@ -55,7 +56,8 @@ instance = TalonOne::AdditionalCampaignProperties.new(budgets: null,
                                  updated_by: Jane Doe,
                                  template_id: 3,
                                  frontend_state: running,
-                                 stores_imported: true)
+                                 stores_imported: true,
+                                 value_maps_ids: [100, 215])
 ```
 
 

data/docs/AnalyticsProduct.md

@@ -0,0 +1,23 @@
+# TalonOne::AnalyticsProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the product. | 
+**name** | **String** | The name of the product. | 
+**catalog_id** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.  | 
+**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsProduct.new(id: 1,
+                                 name: MyProduct,
+                                 catalog_id: 1,
+                                 units_sold: null)
+```
+
+

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/ApplicationCIF.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **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. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 
 ## Code Sample
 

data/docs/ApplicationCIFExpression.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **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. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 
 ## Code Sample
 

data/docs/ApplicationCampaignStats.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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,6 +17,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 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/ApplicationEntity.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 
 ## Code Sample
 

data/docs/ApplicationEvent.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
 **store_id** | **Integer** | The ID of the store. | [optional] 
 **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 

data/docs/ApplicationReferee.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **session_id** | **String** | Integration ID of the session in which the customer redeemed the referral. | 
 **advocate_integration_id** | **String** | Integration ID of the Advocate's Profile. | 
 **friend_integration_id** | **String** | Integration ID of the Friend's Profile. | 

data/docs/ApplicationSession.md

@@ -5,10 +5,10 @@
 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. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
 **profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional] 
 **coupon** | **String** | Any coupon code entered. | 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are:  1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled`  For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).  | 
 **cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | 
 **discounts** | **Hash<String, Float>** | **API V1 only.** A map of labeled discount values, in the same currency as the session.  If you are using the V2 endpoints, refer to the `totalDiscounts` property instead.  | 
-**total_discounts** | **Float** | The total sum of the discounts applied to this session. | 
+**total_discounts** | **Float** | The total sum of the discounts applied to this session.  **Note:** If more than one session is returned, this value is displayed as `0`.  | 
 **total** | **Float** | The total sum of the session before any discounts applied. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 
 
@@ -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/Audience.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **name** | **String** | The human-friendly display name for this audience. | 
 **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] 
 **description** | **String** | A description of the audience. | [optional] 
-**integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in.  For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`.  **Note:** If you do not integrate with any of these platforms, do not use this property.  | [optional] 
+**integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in.  For example, `mParticle`, `Segment`, `Shopify`, `Braze`, or `Iterable`.  **Note:** If you do not integrate with any of these platforms, do not use this property.  | [optional] 
 **integration_id** | **String** | The ID of this audience in the third-party integration.  **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property.  | [optional] 
 **created_in3rd_party** | **Boolean** | Determines if this audience is a 3rd party audience or not. | [optional] 
 **last_update** | **DateTime** | The last time that the audience memberships changed. | [optional] 

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

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **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. - `unlimited`: Allows negative balance without any limit.  | [optional] 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = TalonOne::BaseLoyaltyProgram.new(title: Point collection,
                                  tier_cycle_start_date: 2021-09-12T10:12:42Z,
                                  tiers_expire_in: 27W_U,
                                  tiers_downgrade_policy: null,
-                                 card_code_settings: null)
+                                 card_code_settings: null,
+                                 return_policy: null)
 ```
 
 

data/docs/Binding.md

@@ -16,7 +16,7 @@ require 'TalonOne'
 
 instance = TalonOne::Binding.new(name: my property,
                                  type: templateParameter,
-                                 expression: null,
+                                 expression: [string1, string2],
                                  value_type: string)
 ```
 

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

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 
 **name** | **String** | A user-facing name for this campaign. | 
 **description** | **String** | A detailed description of the campaign. | 
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 **campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.  | [optional] 
 **type** | **String** | The campaign type. Possible type values:   - `cartItem`: Type of campaign that can apply effects only to cart items.   - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.  | [default to 'advanced']
 **linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link to the campaign.  **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.  | [optional] 
-**budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage.  **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.  | 
+**budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage.  **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.  | [optional] 
 **coupon_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.  | [optional] 
 **referral_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.  | [optional] 
 **discount_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.  | [optional] 
@@ -44,8 +44,10 @@ 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. | 
+**value_maps_ids** | **Array<Integer>** | A list of value map IDs for the campaign. | [optional] 
+**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] 
@@ -100,6 +102,8 @@ instance = TalonOne::Campaign.new(id: 4,
                                  template_id: 3,
                                  frontend_state: running,
                                  stores_imported: true,
+                                 value_maps_ids: [100, 215],
+                                 revision_frontend_state: revised,
                                  active_revision_id: 6,
                                  active_revision_version_id: 6,
                                  version: 6,

data/docs/CampaignEvaluationGroup.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **name** | **String** | The name of the campaign evaluation group. | 
 **parent_id** | **Integer** | The ID of the parent group that contains the campaign evaluation group. | 
 **description** | **String** | A description of the campaign evaluation group. | [optional] 

data/docs/CampaignNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Notification name. | 
 **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::CampaignNotificationPolicy.new(name: Christmas Sale,
-                                 batching_enabled: false)
+                                 batching_enabled: false,
+                                 batch_size: 5)
 ```
 
 

data/docs/CampaignSet.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **id** | **Integer** | Internal ID of this entity. | 
 **version** | **Integer** | Version of the campaign set. | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 

data/docs/CampaignStoreBudget.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **created** | **DateTime** | The time this entity was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **store_id** | **Integer** | The ID of the store. | 
-**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of budget limits for stores linked to the campaign. | 
+**limits** | [**Array<CampaignStoreBudgetLimitConfig>**](CampaignStoreBudgetLimitConfig.md) | The set of budget limits for stores linked to the campaign. | 
 
 ## Code Sample
 

data/docs/CampaignTemplate.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **tags** | **Array<String>** | A list of tags for the campaign template. | [optional] 
 **features** | **Array<String>** | A list of features for the campaign template. | [optional] 
 **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**coupon_reservation_settings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) |  | [optional] 
 **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **limits** | [**Array<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] 
 **template_params** | [**Array<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] 
@@ -48,10 +49,11 @@ instance = TalonOne::CampaignTemplate.new(id: 6,
                                  tags: [discount],
                                  features: null,
                                  coupon_settings: null,
+                                 coupon_reservation_settings: null,
                                  referral_settings: null,
                                  limits: null,
                                  template_params: null,
-                                 applications_ids: null,
+                                 applications_ids: [1, 2, 3, 1, 2, 3],
                                  campaign_collections: null,
                                  default_campaign_group_id: 42,
                                  campaign_type: advanced,

data/docs/CampaignTemplateCouponReservationSettings.md

@@ -0,0 +1,19 @@
+# TalonOne::CampaignTemplateCouponReservationSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
+**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignTemplateCouponReservationSettings.new(reservation_limit: 45,
+                                 is_reservation_mandatory: false)
+```
+
+

data/docs/CampaignVersions.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**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] 
@@ -16,7 +17,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignVersions.new(active_revision_id: 6,
+instance = TalonOne::CampaignVersions.new(revision_frontend_state: revised,
+                                 active_revision_id: 6,
                                  active_revision_version_id: 6,
                                  version: 6,
                                  current_revision_id: 6,