Update SDK to 16.0.0

build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
 apply plugin: 'java'
 
 group = 'one.talon'
-version = '15.0.0'
+version = '16.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 := "15.0.0",
+    version := "16.0.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AcceptCouponEffectProps.md

@@ -2,7 +2,7 @@
 
 # AcceptCouponEffectProps
 
-The properties specific to the \"acceptCoupon\" effect. This gets triggered whenever the coupon is valid and all other conditions in the rules of its campaign are met.
+This effect indicates that the coupon code supplied was valid.  You should handle this effect by clearing any messages from previous `rejectCoupon` effects and informing the user that the coupon is valid.  The code is automatically redeemed when you close the session.  Other effects, such as [setDiscount](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscount), provide more information about the actual rewards received.
 ## Properties
 
 Name | Type | Description | Notes

docs/AcceptReferralEffectProps.md

@@ -2,12 +2,12 @@
 
 # AcceptReferralEffectProps
 
-The properties specific to the \"acceptReferral\" effect. TThis gets triggered whenever the referral code is valid and all other conditions in the rules of its campaign are met.
+This effect indicates that the referral code supplied is valid.  You should handle this effect by informing the user that the referral code is valid.  The code is automatically redeemed when you close the session.  Other effects will provide more information about the actual reward.
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **String** | The referral code that was accepted. | 
+**value** | **String** | The referral code provided in the session. | 
 
 
 

docs/AchievementAdditionalPropertiesV2.md

@@ -8,19 +8,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **userId** | **Long** | The 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.  |  [optional]
+**periodEndOverride** | [**TimePoint**](TimePoint.md) |  |  [optional]
 **hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. |  [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |  [optional]
+**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement.                                                                                               - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past.  |  [optional]
 
 
 
 ## Enum: StatusEnum
 
 Name | Value
 ---- | -----
-INPROGRESS | "inprogress"
+ACTIVE | "active"
+SCHEDULED | "scheduled"
 EXPIRED | "expired"
-NOT_STARTED | "not_started"
-COMPLETED | "completed"
 
 
 

docs/AchievementBaseV2.md

@@ -16,9 +16,7 @@ Name | Type | Description | Notes
 **fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string.  |  [optional]
 **endDate** | [**OffsetDateTime**](OffsetDateTime.md) | 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]
 **allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. |  [optional]
-**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |  [optional]
 **subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. |  [optional]
-**timezone** | **String** | A string containing an IANA timezone descriptor. |  [optional]
 
 
 

docs/AchievementProgressWithDefinition.md

@@ -16,7 +16,9 @@ Name | Type | Description | Notes
 **name** | **String** | The internal name of the achievement used in API requests.  | 
 **title** | **String** | The display name of the achievement in the Campaign Manager. | 
 **description** | **String** | The description of the achievement in the Campaign Manager. | 
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. | 
+**campaignId** | **Long** | This property is **deprecated**. Use `campaignIds` (Integration API) or `referencedByCampaigns` (Management API) instead. This field contains the first campaign ID from the related `campaignIds`, and is omitted when `campaignIds` is empty. |  [optional]
+**campaignIds** | **List<Long>** | The IDs of the campaigns that reference this achievement, in ascending order. | 
+**referencedByCampaigns** | [**List<CampaignReference>**](CampaignReference.md) | The campaigns that reference this achievement, in ascending order of their `id`. | 
 **target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |  [optional]
 **achievementRecurrencePolicy** | [**AchievementRecurrencePolicyEnum**](#AchievementRecurrencePolicyEnum) | 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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.  | 
 **achievementActivationPolicy** | [**AchievementActivationPolicyEnum**](#AchievementActivationPolicyEnum) | 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.  | 

docs/AchievementReference.md

@@ -10,6 +10,18 @@ Name | Type | Description | Notes
 **applicationId** | **Long** | The ID of the Application associated with the campaign that references this achievement. | 
 **applicationName** | **String** | The name of the Application associated with the campaign that references this achievement. | 
 **campaignId** | **Long** | The ID of the campaign that references this achievement. | 
+**campaignName** | **String** | The name of the campaign that references this achievement. | 
+**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign that references this achievement. | 
+
+
+
+## Enum: CampaignStateEnum
+
+Name | Value
+---- | -----
+ENABLED | "enabled"
+DISABLED | "disabled"
+ARCHIVED | "archived"
 
 
 

docs/AchievementStatusEntry.md

@@ -19,7 +19,8 @@ Name | Type | Description | Notes
 **fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string.  |  [optional]
 **endDate** | [**OffsetDateTime**](OffsetDateTime.md) | 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]
 **allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. |  [optional]
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. |  [optional]
+**campaignId** | **Long** | This property is **deprecated**. Use `referencedByCampaigns` instead. This field contains the first campaign ID from the related `referencedByCampaigns`, and is omitted when `referencedByCampaigns` is empty. |  [optional]
+**campaignIds** | **List<Long>** | The IDs of the campaigns that reference this achievement, in ascending order. |  [optional]
 **status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |  [optional]
 **currentProgress** | [**AchievementProgress**](AchievementProgress.md) |  |  [optional]
 

docs/AchievementV2.md

@@ -18,13 +18,16 @@ Name | Type | Description | Notes
 **fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string.  |  [optional]
 **endDate** | [**OffsetDateTime**](OffsetDateTime.md) | 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]
 **allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. |  [optional]
-**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | 
 **subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | 
-**timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **userId** | **Long** | The 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.  |  [optional]
+**periodEndOverride** | [**TimePoint**](TimePoint.md) |  |  [optional]
 **hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. |  [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |  [optional]
+**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement.                                                                                               - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past.  |  [optional]
+**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | 
+**timezone** | **String** | A string containing an IANA timezone descriptor. | 
+**campaignId** | **Long** | This property is **deprecated**. Use `referencedByCampaigns` instead. This field contains the first campaign ID from the related `referencedByCampaigns`, and is omitted when `referencedByCampaigns` is empty. |  [optional]
+**referencedByCampaigns** | [**List<CampaignReference>**](CampaignReference.md) | The campaigns that reference this achievement. They are sorted in ascending order by their id. | 
 
 
 
@@ -51,10 +54,9 @@ FIXED_SCHEDULE | "fixed_schedule"
 
 Name | Value
 ---- | -----
-INPROGRESS | "inprogress"
+ACTIVE | "active"
+SCHEDULED | "scheduled"
 EXPIRED | "expired"
-NOT_STARTED | "not_started"
-COMPLETED | "completed"
 
 
 

docs/AddFreeItemEffectProps.md

@@ -2,13 +2,13 @@
 
 # AddFreeItemEffectProps
 
-The properties specific to the \"addFreeItem\" effect. This gets triggered whenever a validated rule contained an \"add free item\" effect.
+This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set its price to `0`.  The effect of a successful referral can mean a free item for someone else, such as the referrer.
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sku** | **String** | SKU of the item that needs to be added. | 
-**name** | **String** | The name / description of the effect | 
+**name** | **String** | Description of the effect. | 
 **desiredQuantity** | **Long** | The original quantity in case a partial reward was applied. |  [optional]
 
 

docs/AddLoyaltyPointsEffectProps.md

@@ -2,27 +2,27 @@
 
 # AddLoyaltyPointsEffectProps
 
-The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. 
+This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card.  If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which item to add the loyalty points for.  Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points.  If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. See the example below for more information.  If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the items for which loyalty points are added.  If you have set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire.  If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card on which these points are added.  The points only persist when the session is closed.
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The name / description of this loyalty point addition. | 
+**name** | **String** | The reason of this loyalty point addition. | 
 **programId** | **Long** | The ID of the loyalty program where these points were added. | 
 **subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. | 
 **value** | [**BigDecimal**](BigDecimal.md) | The amount of points that were added. | 
-**desiredValue** | [**BigDecimal**](BigDecimal.md) | The original amount of loyalty points to be awarded. |  [optional]
+**desiredValue** | [**BigDecimal**](BigDecimal.md) | (Partial rewards enabled only) The amount of loyalty points to be awarded without considering budget limitations. |  [optional]
 **recipientIntegrationId** | **String** | The user for whom these points were added. | 
-**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Date after which points will be valid. |  [optional]
-**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) | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied.  |  [optional]
+**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date after which the added points will be valid. |  [optional]
+**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date after which the added points will expire. |  [optional]
+**transactionUUID** | **String** | The identifier of this loyalty point transaction. | 
+**cartItemPosition** | [**BigDecimal**](BigDecimal.md) | (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were added. |  [optional]
+**cartItemSubPosition** | [**BigDecimal**](BigDecimal.md) | (_Add points per cart item_ ) The index of the item unit in its line item. |  [optional]
 **cardIdentifier** | **String** | The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.  |  [optional]
-**bundleIndex** | **Long** | 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]
-**awaitsActivation** | **Boolean** | If `true`, the loyalty points remain pending until a specific action is complete. The `startDate` parameter automatically sets to `on_action`.  |  [optional]
-**validityDuration** | **String** | The duration for which the points remain active, calculated relative to the  activation date.    **Note**: This value is returned only if `awaitsActivation` is `true`  and `expiryDate` is not set.  |  [optional]
+**bundleIndex** | **Long** | _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. |  [optional]
+**bundleName** | **String** | _(With bundles only)_ The name of the bundle definition. |  [optional]
+**awaitsActivation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. |  [optional]
+**validityDuration** | **String** | The duration for which the points remain active, calculated relative to their start date. |  [optional]