talon_one 5.0.0 → 7.0.0

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/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

@@ -0,0 +1,29 @@
+# TalonOne::CampaignVersions
+
+## Properties
+
+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] 
+**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(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)
+```
+
+

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

@@ -23,7 +23,7 @@ instance = TalonOne::Change.new(id: 6,
                                  user_id: 388,
                                  application_id: 359,
                                  entity: /v1/applications/359/campaigns/6727,
-                                 old: null,
+                                 old: {},
                                  new: {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727},
                                  management_key_id: 3)
 ```

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] 
+**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/CreateAchievement.md

@@ -10,6 +10,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] 
 
 ## Code Sample
 
@@ -21,7 +25,11 @@ instance = TalonOne::CreateAchievement.new(name: Order50Discount,
                                  description: 50% off for every 50th purchase in a year.,
                                  target: 50.0,
                                  period: 1Y,
-                                 period_end_override: null)
+                                 period_end_override: null,
+                                 recurrence_policy: no_recurrence,
+                                 activation_policy: fixed_schedule,
+                                 fixed_start_date: null,
+                                 end_date: null)
 ```
 
 

data/docs/CustomerProfile.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. | 
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::CustomerProfile.new(id: 6,
-                                 created: null,
+                                 created: 2020-02-07T08:15:22Z,
                                  integration_id: URNGV8294NV,
                                  attributes: {"Language":"english","ShippingCountry":"DE"},
                                  account_id: 31,

data/docs/CustomerProfileAudienceRequestItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience.  | 
+**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience.    **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application   until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience.  | 
 **profile_integration_id** | **String** | The ID of this customer profile in the third-party integration. | 
 **audience_id** | **Integer** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). | 
 

data/docs/CustomerSession.md

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CustomerSession.new(integration_id: null,
+instance = TalonOne::CustomerSession.new(integration_id: URNGV8294NV,
                                  created: 2020-02-07T08:15:22Z,
                                  application_id: 322,
                                  profile_id: URNGV8294NV,

data/docs/CustomerSessionV2.md

@@ -5,25 +5,26 @@
 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. | 
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
 **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, 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, 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.  | 
 **additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, 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] 
-**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules.  For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers).  **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview).  | [optional] 
+**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules.  For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers).  **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). - We recommend passing an anonymized (hashed) version of the identifier value.  | [optional] 
 **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city.  You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property.  | 
-**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | 
+**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions. | 
 **total** | **Float** | The total value of cart items and additional costs in the session, before any discounts are applied. | 
 **cart_item_total** | **Float** | The total value of cart items, before any discounts are applied. | 
 **additional_cost_total** | **Float** | The total value of additional costs, before any discounts are applied. | 
 **updated** | **DateTime** | Timestamp of the most recent event received on this session. | 
+**closure_prediction** | **Float** | The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. | [optional] 
 
 ## Code Sample
 
@@ -31,7 +32,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::CustomerSessionV2.new(id: 6,
-                                 created: null,
+                                 created: 2020-02-07T08:15:22Z,
                                  integration_id: URNGV8294NV,
                                  application_id: 322,
                                  profile_id: URNGV8294NV,
@@ -43,13 +44,14 @@ instance = TalonOne::CustomerSessionV2.new(id: 6,
                                  state: open,
                                  cart_items: null,
                                  additional_costs: {"shipping":{"price":9}},
-                                 identifiers: [91.11.156.141],
+                                 identifiers: [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea],
                                  attributes: {"ShippingCity":"Berlin"},
                                  first_session: true,
                                  total: 119.99,
                                  cart_item_total: 99.99,
                                  additional_cost_total: 20.0,
-                                 updated: 2020-02-08T14:15:22Z)
+                                 updated: 2020-02-08T14:15:22Z,
+                                 closure_prediction: 0.283)
 ```
 
 

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

@@ -17,7 +17,7 @@ require 'TalonOne'
 instance = TalonOne::FeatureFlag.new(name: canCreateCampaignFromTemplate,
                                  value: true,
                                  created: 2021-09-22T12:24:14.956203Z,
-                                 modified: null)
+                                 modified: 2021-09-25T10:34:12.956203Z)
 ```
 
 

data/docs/GenerateCampaignDescription.md

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

data/docs/GenerateCampaignTags.md

@@ -0,0 +1,17 @@
+# TalonOne::GenerateCampaignTags
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ruleset_id** | **Integer** | ID of a ruleset. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateCampaignTags.new(ruleset_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,21 @@
+# 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] 
+**card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::GenerateLoyaltyCard.new(status: active,
+                                 customer_profile_ids: [R195412, G244519],
+                                 card_identifier: summer-loyalty-card-0543)
+```
+
+