v6.0.0: Add stores (#41)

* update java sdk

* update java sdk

* merge master

build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
 apply plugin: 'java'
 
 group = 'one.talon'
-version = '5.0.3'
+version = '6.0.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "one.talon",
     name := "talon-one-client",
-    version := "5.0.3",
+    version := "6.0.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AccountAnalytics.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **webhooks** | **Integer** | Total number of webhooks in the account. | 
 **loyaltyPrograms** | **Integer** | Total number of all loyalty programs in the account. | 
 **liveLoyaltyPrograms** | **Integer** | Total number of live loyalty programs in the account. | 
+**lastUpdatedAt** | [**OffsetDateTime**](OffsetDateTime.md) | The point in time when the analytics numbers were updated last. | 
 
 
 

docs/AccountDashboardStatisticCampaigns.md

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

docs/Achievement.md

@@ -0,0 +1,22 @@
+
+
+# Achievement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | 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** | [**BigDecimal**](BigDecimal.md) | 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** | **Integer** | 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,13 @@
+
+
+# AchievementAdditionalProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **Integer** | 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

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Date after which points will expire. |  [optional]
 **transactionUUID** | **String** | The identifier of this addition in the loyalty ledger. | 
 **cartItemPosition** | [**BigDecimal**](BigDecimal.md) | The index of the item in the cart items list on which the loyal points addition should be applied. |  [optional]
-**cartItemSubPosition** | [**BigDecimal**](BigDecimal.md) | 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** | [**BigDecimal**](BigDecimal.md) | 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** | **Integer** | 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,16 @@
+
+
+# AddToAudienceEffectProps
+
+The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audienceId** | **Integer** | 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** | **Integer** | The internal ID of the customer profile. |  [optional]
+
+
+

docs/AdditionalCampaignProperties.md

@@ -6,21 +6,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**couponRedemptionCount** | **Integer** | Number of coupons redeemed in the campaign. |  [optional]
-**referralRedemptionCount** | **Integer** | Number of referral codes redeemed in the campaign. |  [optional]
-**discountCount** | [**BigDecimal**](BigDecimal.md) | Total amount of discounts redeemed in the campaign. |  [optional]
-**discountEffectCount** | **Integer** | Total number of times discounts were redeemed in this campaign. |  [optional]
-**couponCreationCount** | **Integer** | Total number of coupons created by rules in this campaign. |  [optional]
-**customEffectCount** | **Integer** | Total number of custom effects triggered by rules in this campaign. |  [optional]
-**referralCreationCount** | **Integer** | Total number of referrals created by rules in this campaign. |  [optional]
-**addFreeItemEffectCount** | **Integer** | 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** | **Integer** | Total number of giveaways awarded by rules in this campaign. |  [optional]
-**createdLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | Total number of loyalty points created by rules in this campaign. |  [optional]
-**createdLoyaltyPointsEffectCount** | **Integer** | Total number of loyalty point creation effects triggered by rules in this campaign. |  [optional]
-**redeemedLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | Total number of loyalty points redeemed by rules in this campaign. |  [optional]
-**redeemedLoyaltyPointsEffectCount** | **Integer** | Total number of loyalty point redemption effects triggered by rules in this campaign. |  [optional]
-**callApiEffectCount** | **Integer** | Total number of webhooks triggered by rules in this campaign. |  [optional]
-**reservecouponEffectCount** | **Integer** | Total number of reserve coupon effects triggered by rules in this campaign. |  [optional]
+**budgets** | [**List<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** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.  |  [optional]
+**referralRedemptionCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.  |  [optional]
+**discountCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.  |  [optional]
+**discountEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign.  |  [optional]
+**couponCreationCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign.  |  [optional]
+**customEffectCount** | **Integer** | 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** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign.  |  [optional]
+**addFreeItemEffectCount** | **Integer** | 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** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign.  |  [optional]
+**createdLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | 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** | **Integer** | 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** | [**BigDecimal**](BigDecimal.md) | 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** | **Integer** | 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** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign.  |  [optional]
+**reservecouponEffectCount** | **Integer** | 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** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received by this campaign. |  [optional]
 **updated** | [**OffsetDateTime**](OffsetDateTime.md) | 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]

docs/Application.md

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **limits** | [**List<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. |  [optional]
 **defaultDiscountScope** | [**DefaultDiscountScopeEnum**](#DefaultDiscountScopeEnum) | 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

@@ -31,6 +31,7 @@ ITERABLE | "iterable"
 CUSTOMER_ENGAGEMENT | "customer_engagement"
 CUSTOMER_DATA | "customer_data"
 SALESFORCE | "salesforce"
+EMARSYS | "emarsys"
 
 
 

docs/ApplicationCustomer.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **totalSales** | [**BigDecimal**](BigDecimal.md) | 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** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  |  [optional]
 **audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. |  [optional]
-**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | 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** | [**OffsetDateTime**](OffsetDateTime.md) | 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

@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | 
 **applicationId** | **Integer** | The ID of the application that owns this entity. | 
 **profileId** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. |  [optional]
+**storeId** | **Integer** | 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** | **Integer** | 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

@@ -9,13 +9,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | [**OffsetDateTime**](OffsetDateTime.md) | 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** | **Integer** | The ID of the application that owns this entity. | 
 **profileId** | **Integer** | 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** | [**StateEnum**](#StateEnum) | 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** | [**StateEnum**](#StateEnum) | 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** | [**List<CartItem>**](CartItem.md) | Serialized JSON representation. | 
 **discounts** | [**Map<String, BigDecimal>**](BigDecimal.md) | **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** | [**BigDecimal**](BigDecimal.md) | The total sum of the discounts applied to this session. | 

docs/ApplicationStoreEntity.md

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

docs/Attribute.md

@@ -41,6 +41,7 @@ COUPON | "Coupon"
 EVENT | "Event"
 GIVEAWAY | "Giveaway"
 REFERRAL | "Referral"
+STORE | "Store"