Merge pull request #32 from talon-one/sc-31534-update-js-sdk

v6.0.0: Stores

docs/AccountAnalytics.md

@@ -23,5 +23,6 @@ Name | Type | Description | Notes
 **webhooks** | **Number** | Total number of webhooks in the account. | 
 **loyaltyPrograms** | **Number** | Total number of all loyalty programs in the account. | 
 **liveLoyaltyPrograms** | **Number** | Total number of live loyalty programs in the account. | 
+**lastUpdatedAt** | **Date** | The point in time when the analytics numbers were updated last. | 
 
 

docs/AccountDashboardStatisticCampaigns.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **live** | **Number** | Number of campaigns that are active and live (across all Applications). | 
-**endingSoon** | **Number** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. | 
+**endingSoon** | **Number** | Campaigns scheduled to expire sometime in the next 7 days. | 
+**lowOnBudget** | **Number** | Campaigns with less than 10% of budget left. | 
 
 

docs/Achievement.md

@@ -0,0 +1,18 @@
+# TalonOne.Achievement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | Internal ID of this entity. | 
+**created** | **Date** | The time this entity was created. | 
+**name** | **String** | The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created.  | 
+**title** | **String** | The display name for the achievement in the Campaign Manager. | 
+**description** | **String** | A description of the achievement. | 
+**target** | **Number** | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. | 
+**period** | **String** | The relative duration after which the achievement is reset 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.  | 
+**periodEndOverride** | [**TimePoint**](TimePoint.md) |  | [optional] 
+**userId** | **Number** | ID of the user that created this achievement. | 
+**createdBy** | **String** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 
+
+

docs/AchievementAdditionalProperties.md

@@ -0,0 +1,10 @@
+# TalonOne.AchievementAdditionalProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **Number** | ID of the user that created this achievement. | 
+**createdBy** | **String** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 
+
+

docs/AddLoyaltyPointsEffectProps.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **expiryDate** | **Date** | Date after which points will expire. | [optional] 
 **transactionUUID** | **String** | The identifier of this addition in the loyalty ledger. | 
 **cartItemPosition** | **Number** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] 
-**cartItemSubPosition** | **Number** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1.  | [optional] 
+**cartItemSubPosition** | **Number** | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied.  | [optional] 
 **cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card.  | [optional] 
 **bundleIndex** | **Number** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] 
 **bundleName** | **String** | The name of the bundle definition. | [optional] 

docs/AddToAudienceEffectProps.md

@@ -0,0 +1,12 @@
+# TalonOne.AddToAudienceEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audienceId** | **Number** | The internal ID of the audience. | [optional] 
+**audienceName** | **String** | The name of the audience. | [optional] 
+**profileIntegrationId** | **String** | The ID of the customer profile in the third-party integration platform. | [optional] 
+**profileId** | **Number** | The internal ID of the customer profile. | [optional] 
+
+

docs/AdditionalCampaignProperties.md

@@ -0,0 +1,29 @@
+# TalonOne.AdditionalCampaignProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgets** | [**[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.  | 
+**couponRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.  | [optional] 
+**referralRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.  | [optional] 
+**discountCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.  | [optional] 
+**discountEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign.  | [optional] 
+**couponCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign.  | [optional] 
+**customEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign.  | [optional] 
+**referralCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign.  | [optional] 
+**addFreeItemEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.  | [optional] 
+**awardedGiveawaysCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign.  | [optional] 
+**createdLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign.  | [optional] 
+**createdLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign.  | [optional] 
+**redeemedLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign.  | [optional] 
+**redeemedLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign.  | [optional] 
+**callApiEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign.  | [optional] 
+**reservecouponEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign.  | [optional] 
+**lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional] 
+**updated** | **Date** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates.  | [optional] 
+**createdBy** | **String** | Name of the user who created this campaign if available. | [optional] 
+**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional] 
+**templateId** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional] 
+
+

docs/Application.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] 
 **defaultDiscountScope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect.  | [optional] 
 **enableCascadingDiscounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional] 
-**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening).  | [optional] 
+**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one.  | [optional] 
 **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
 **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] 
 **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] 

docs/ApplicationAPIKey.md

@@ -36,6 +36,8 @@ Name | Type | Description | Notes
 
 * `salesforce` (value: `"salesforce"`)
 
+* `emarsys` (value: `"emarsys"`)
+
 
 
 

docs/ApplicationCustomer.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **totalSales** | **Number** | 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.  | 
 **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  | [optional] 
 **audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] 
-**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.  | 
+**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.  | 
 **sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).  | [optional] 
 **advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] 
 

docs/ApplicationEvent.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **created** | **Date** | The time this entity was created. | 
 **applicationId** | **Number** | The ID of the application that owns this entity. | 
 **profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
+**storeId** | **Number** | The ID of the store. | [optional] 
+**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **sessionId** | **Number** | The globally unique Talon.One ID of the session that contains this event. | [optional] 
 **type** | **String** | A string representing the event. Must not be a reserved event name. | 
 **attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. | 

docs/ApplicationSession.md

@@ -6,13 +6,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** | Internal ID of this entity. | 
 **created** | **Date** | The time this entity was created. The time this entity was created. | 
+**integrationId** | **String** | The integration ID set by your integration layer. | 
+**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **applicationId** | **Number** | The ID of the application that owns this entity. | 
 **profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
-**integrationId** | **String** | The integration ID set by your integration layer. | 
 **profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional] 
 **coupon** | **String** | Any coupon code entered. | 
 **referral** | **String** | Any referral code entered. | 
-**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-session).  | 
+**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).  | 
 **cartItems** | [**[CartItem]**](CartItem.md) | Serialized JSON representation. | 
 **discounts** | **{String: Number}** | **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.  | 
 **totalDiscounts** | **Number** | The total sum of the discounts applied to this session. | 

docs/ApplicationStoreEntity.md

@@ -0,0 +1,9 @@
+# TalonOne.ApplicationStoreEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storeId** | **Number** | The ID of the store. | [optional] 
+
+

docs/Attribute.md

@@ -47,6 +47,8 @@ Name | Type | Description | Notes
 
 * `Referral` (value: `"Referral"`)
 
+* `Store` (value: `"Store"`)
+
 
 
 

docs/AudienceCustomer.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **totalSales** | **Number** | 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.  | 
 **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  | [optional] 
 **audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] 
-**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.  | 
+**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.  | 
 **sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).  | [optional] 
 **connectedApplicationsIds** | **[Number]** | A list of the IDs of the Applications that are connected to this customer profile. | [optional] 
 **connectedAudiences** | **[Number]** | A list of the IDs of the audiences that are connected to this customer profile. | [optional] 

docs/BaseCampaign.md

@@ -17,6 +17,9 @@ Name | Type | Description | Notes
 **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.  | 
 **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.  | [optional] 
+**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the 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.  | [optional] [default to 'advanced']
+**linkedStoreIds** | **[Number]** | 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] 
 
 
 
@@ -49,3 +52,14 @@ Name | Type | Description | Notes
 
 
 
+
+## Enum: TypeEnum
+
+
+* `cartItem` (value: `"cartItem"`)
+
+* `advanced` (value: `"advanced"`)
+
+
+
+