talon_one 5.0.0 → 6.0.0

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

@@ -12,10 +12,12 @@ 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] 
 
 ## Code Sample
 
@@ -30,10 +32,12 @@ 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)
 ```
 
 

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

@@ -45,6 +45,13 @@ Name | Type | Description | Notes
 **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. | 
+**stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
+**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 +98,14 @@ 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,
+                                 active_revision_id: 6,
+                                 active_revision_version_id: 6,
+                                 version: 6,
+                                 current_revision_id: 6,
+                                 current_revision_version_id: 6,
+                                 stage_revision: false)
 ```
 
 

data/docs/CampaignCollectionEditedNotification.md

@@ -0,0 +1,21 @@
+# TalonOne::CampaignCollectionEditedNotification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignCollectionEditedNotification.new(campaign: null,
+                                 ruleset: null,
+                                 collection: null)
+```
+
+

data/docs/CampaignNotificationPolicy.md

@@ -5,13 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Notification name. | 
+**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignNotificationPolicy.new(name: Christmas Sale)
+instance = TalonOne::CampaignNotificationPolicy.new(name: Christmas Sale,
+                                 batching_enabled: false)
 ```
 
 

data/docs/CampaignStateChangedNotification.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign** | [**Campaign**](Campaign.md) |  | 
-**old_state** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived']  | 
-**new_state** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived']  | 
+**old_state** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
+**new_state** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
 **ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
 
 ## Code Sample

data/docs/CampaignStoreBudget.md

@@ -0,0 +1,25 @@
+# TalonOne::CampaignStoreBudget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**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. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignStoreBudget.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 campaign_id: 322,
+                                 store_id: null,
+                                 limits: null)
+```
+
+

data/docs/CampaignVersions.md

@@ -0,0 +1,27 @@
+# TalonOne::CampaignVersions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignVersions.new(active_revision_id: 6,
+                                 active_revision_version_id: 6,
+                                 version: 6,
+                                 current_revision_id: 6,
+                                 current_revision_version_id: 6,
+                                 stage_revision: false)
+```
+
+

data/docs/CardAddedDeductedPointsNotificationPolicy.md

@@ -0,0 +1,19 @@
+# TalonOne::CardAddedDeductedPointsNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. | 
+**scopes** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CardAddedDeductedPointsNotificationPolicy.new(name: Christmas Sale,
+                                 scopes: null)
+```
+
+

data/docs/CartItem.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **width** | **Float** | Width of item in mm. | [optional] 
 **length** | **Float** | Length of item in mm. | [optional] 
 **position** | **Float** | Position of the Cart Item in the Cart (calculated internally). | [optional] 
-**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property.  | [optional] 
+**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property.  **Note:** Any previously defined attributes that you do not include in the array will be removed.  | [optional] 
 **additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).  | [optional] 
 **catalog_item_id** | **Integer** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional] 
 

data/docs/CodeGeneratorSettings.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code.  | 
-**coupon_pattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.  | 
+**coupon_pattern** | **String** | The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.  | 
 
 ## Code Sample
 

data/docs/Coupon.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.  | [optional] 
 **usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. | 
 **discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] 

data/docs/CouponConstraints.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 
 ## Code Sample
 

data/docs/CouponCreationJob.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. | 
 **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with coupons. | 

data/docs/CouponDeletionFilters.md

@@ -0,0 +1,43 @@
+# TalonOne::CouponDeletionFilters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_before** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+**created_after** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+**starts_after** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+**starts_before** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+**valid** | **String** | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future.  | [optional] 
+**usable** | **Boolean** | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter.  | [optional] 
+**redeemed** | **Boolean** | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned.  **Note:** This field cannot be used in conjunction with the `usable` query parameter.  | [optional] 
+**recipient_integration_id** | **String** | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.  | [optional] 
+**exact_match** | **Boolean** | Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
+**value** | **String** | Filter results by the coupon code | [optional] [default to 'false']
+**batch_id** | **String** | Filter results by batches of coupons | [optional] 
+**referral_id** | **Integer** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] 
+**expires_after** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+**expires_before** | **DateTime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CouponDeletionFilters.new(created_before: null,
+                                 created_after: null,
+                                 starts_after: null,
+                                 starts_before: null,
+                                 valid: null,
+                                 usable: null,
+                                 redeemed: null,
+                                 recipient_integration_id: null,
+                                 exact_match: null,
+                                 value: null,
+                                 batch_id: null,
+                                 referral_id: null,
+                                 expires_after: null,
+                                 expires_before: null)
+```
+
+

data/docs/CouponDeletionJob.md

@@ -0,0 +1,39 @@
+# TalonOne::CouponDeletionJob
+
+## Properties
+
+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. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) |  | 
+**status** | **String** | The current status of this request. Possible values: - `not_ready` - `pending` - `completed` - `failed`  | 
+**deleted_amount** | **Integer** | The number of coupon codes that were already deleted for this request. | [optional] 
+**fail_count** | **Integer** | The number of times this job failed. | 
+**errors** | **Array<String>** | An array of individual problems encountered during the request. | 
+**created_by** | **Integer** | ID of the user who created this effect. | 
+**communicated** | **Boolean** | Indicates whether the user that created this job was notified of its final state. | 
+**campaign_i_ds** | **Array<Integer>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CouponDeletionJob.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 application_id: 322,
+                                 account_id: 3886,
+                                 filters: null,
+                                 status: pending,
+                                 deleted_amount: 1000000,
+                                 fail_count: 10,
+                                 errors: [Connection to database was reset, failed to delete codes],
+                                 created_by: 1,
+                                 communicated: false,
+                                 campaign_i_ds: null)
+```
+
+

data/docs/CustomerSessionV2.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **profile_id** | **String** | ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.  | 
 **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.  These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.  | [optional] 
-**coupon_codes** | **Array<String>** | Any coupon codes entered.  **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it.  | [optional] 
-**referral_code** | **String** | Any referral code entered.  **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it.  | [optional] 
+**coupon_codes** | **Array<String>** | Any coupon codes entered.  **Important - for requests only**:  - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely.  | [optional] 
+**referral_code** | **String** | Any referral code entered.  **Important - for requests only**:  - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely.  | [optional] 
 **loyalty_cards** | **Array<String>** | Identifier of a loyalty card. | [optional] 
 **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. Either:    - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or    - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems))    - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled`  For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).  | [default to 'open']
 **cart_items** | [**Array<CartItem>**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request.  | 

data/docs/Effect.md

@@ -12,6 +12,10 @@ Name | Type | Description | Notes
 **triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] 
 **triggered_for_catalog_item** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] 
 **condition_index** | **Integer** | The index of the condition that was triggered. | [optional] 
+**evaluation_group_id** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
+**evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
+**campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional] 
+**campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional] 
 **props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | 
 
 ## Code Sample
@@ -27,6 +31,10 @@ instance = TalonOne::Effect.new(campaign_id: 244,
                                  triggered_by_coupon: 4928,
                                  triggered_for_catalog_item: 786,
                                  condition_index: 786,
+                                 evaluation_group_id: 3,
+                                 evaluation_group_mode: stackable,
+                                 campaign_revision_id: 1,
+                                 campaign_revision_version_id: 5,
                                  props: null)
 ```
 

data/docs/EffectEntity.md

@@ -12,6 +12,10 @@ Name | Type | Description | Notes
 **triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] 
 **triggered_for_catalog_item** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] 
 **condition_index** | **Integer** | The index of the condition that was triggered. | [optional] 
+**evaluation_group_id** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
+**evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
+**campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional] 
+**campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional] 
 
 ## Code Sample
 
@@ -25,7 +29,11 @@ instance = TalonOne::EffectEntity.new(campaign_id: 244,
                                  effect_type: rejectCoupon,
                                  triggered_by_coupon: 4928,
                                  triggered_for_catalog_item: 786,
-                                 condition_index: 786)
+                                 condition_index: 786,
+                                 evaluation_group_id: 3,
+                                 evaluation_group_mode: stackable,
+                                 campaign_revision_id: 1,
+                                 campaign_revision_version_id: 5)
 ```
 
 

data/docs/Environment.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **additional_costs** | [**Array<AccountAdditionalCost>**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional] 
 **audiences** | [**Array<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] 
 **collections** | [**Array<Collection>**](Collection.md) | The account-level collections that the application is subscribed to. | [optional] 
+**application_cart_item_filters** | [**Array<ApplicationCIF>**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional] 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = TalonOne::Environment.new(id: 6,
                                  attributes: null,
                                  additional_costs: null,
                                  audiences: null,
-                                 collections: null)
+                                 collections: null,
+                                 application_cart_item_filters: null)
 ```
 
 

data/docs/Event.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. | 
 **session_id** | **String** | The ID of the session that this event occurred in. | [optional] 
 **effects** | **Array<Object>** | An array of effects generated by the rules of the enabled campaigns of the Application.  You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).  | 
-**ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. | 
+**ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. | [optional] 
 **meta** | [**Meta**](Meta.md) |  | [optional] 
 
 ## Code Sample

data/docs/GenerateCampaignDescription.md

@@ -0,0 +1,19 @@
+# TalonOne::GenerateCampaignDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign. | 
+**currency** | **String** | Currency for the campaign. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateCampaignDescription.new(campaign_id: null,
+                                 currency: null)
+```
+
+

data/docs/GenerateCampaignTags.md

@@ -0,0 +1,17 @@
+# TalonOne::GenerateCampaignTags
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateCampaignTags.new(campaign_id: null)
+```
+
+

data/docs/GenerateItemFilterDescription.md

@@ -0,0 +1,17 @@
+# TalonOne::GenerateItemFilterDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_filter** | **Array<Object>** | An array of item filter Talang expressions. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateItemFilterDescription.new(item_filter: [filter, [., Session, CartItems], [[Item], [catch, false, [and, [!=, [., Item, Attributes, c_productType], egiftcard]]]]])
+```
+
+

data/docs/GenerateLoyaltyCard.md

@@ -0,0 +1,19 @@
+# TalonOne::GenerateLoyaltyCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Status of the loyalty card. | [optional] [default to 'active']
+**customer_profile_ids** | **Array<String>** | Integration IDs of the customer profiles linked to the card. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateLoyaltyCard.new(status: active,
+                                 customer_profile_ids: [R195412, G244519])
+```
+
+

data/docs/GenerateRuleTitle.md

@@ -0,0 +1,19 @@
+# TalonOne::GenerateRuleTitle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule** | [**GenerateRuleTitleRule**](GenerateRuleTitleRule.md) |  | 
+**currency** | **String** | Currency for the campaign. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateRuleTitle.new(rule: null,
+                                 currency: null)
+```
+
+

data/docs/GenerateRuleTitleRule.md

@@ -0,0 +1,19 @@
+# TalonOne::GenerateRuleTitleRule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**effects** | **Array<Object>** | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | [optional] 
+**condition** | **Array<Object>** | A Talang expression that will be evaluated in the context of the given event. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateRuleTitleRule.new(effects: [catch, [noop], [setDiscount, 10% off, [*, [., Session, Total], [/, 10, 100]]]],
+                                 condition: [and, [couponValid]])
+```
+
+

data/docs/IncreaseAchievementProgressEffectProps.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **progress_tracker_id** | **Integer** | The internal ID of the achievement progress tracker. | [optional] 
 **delta** | **Float** | The value by which the customer's current progress in the achievement is increased. | 
 **value** | **Float** | The current progress of the customer in the achievement. | 
-**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | 
+**target** | **Float** | The target value to complete the achievement. | 
 **is_just_completed** | **Boolean** | Indicates if the customer has completed the achievement in the current session. | 
 
 ## Code Sample