Quarterly sdk update (#47)

build.gradle

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

docs/AchievementProgress.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **achievementId** | **Integer** | The internal ID of the achievement. | 
 **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** | **Integer** | The ID of the campaign the achievement belongs to. | 
 **status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | 
 **target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |  [optional]

docs/AdditionalCampaignProperties.md

@@ -28,6 +28,7 @@ Name | Type | Description | Notes
 **updatedBy** | **String** | Name of the user who last updated this campaign if available. |  [optional]
 **templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. |  [optional]
 **frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. | 
+**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
 
 
 
@@ -38,7 +39,6 @@ Name | Value
 EXPIRED | "expired"
 SCHEDULED | "scheduled"
 RUNNING | "running"
-DRAFT | "draft"
 DISABLED | "disabled"
 ARCHIVED | "archived"
 

docs/AnalyticsDataPoint.md

@@ -0,0 +1,13 @@
+
+
+# AnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | [**BigDecimal**](BigDecimal.md) |  | 
+**influenced** | [**BigDecimal**](BigDecimal.md) |  | 
+
+
+

docs/AnalyticsDataPointWithTrend.md

@@ -0,0 +1,13 @@
+
+
+# AnalyticsDataPointWithTrend
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) |  | 
+**trend** | [**BigDecimal**](BigDecimal.md) |  | 
+
+
+

docs/AnalyticsDataPointWithTrendAndInfluencedRate.md

@@ -0,0 +1,14 @@
+
+
+# AnalyticsDataPointWithTrendAndInfluencedRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) |  | 
+**influencedRate** | [**BigDecimal**](BigDecimal.md) |  | 
+**trend** | [**BigDecimal**](BigDecimal.md) |  | 
+
+
+

docs/AnalyticsDataPointWithTrendAndUplift.md

@@ -0,0 +1,14 @@
+
+
+# AnalyticsDataPointWithTrendAndUplift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) |  | 
+**uplift** | [**BigDecimal**](BigDecimal.md) |  | 
+**trend** | [**BigDecimal**](BigDecimal.md) |  | 
+
+
+

docs/Application.md

@@ -26,6 +26,8 @@ Name | Type | Description | Notes
 **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. |  [optional]
 **defaultDiscountAdditionalCostPerItemScope** | [**DefaultDiscountAdditionalCostPerItemScopeEnum**](#DefaultDiscountAdditionalCostPerItemScopeEnum) | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect.  |  [optional]
 **defaultEvaluationGroupId** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. |  [optional]
+**defaultCartItemFilterId** | **Integer** | The ID of the default Cart-Item-Filter for this application. |  [optional]
+**enableCampaignStateManagement** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  |  [optional]
 **loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 
 

docs/ApplicationAnalyticsDataPoint.md

@@ -6,12 +6,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. |  [optional]
-**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. |  [optional]
-**totalRevenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) |  |  [optional]
-**sessionsCount** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) |  |  [optional]
-**avgItemsPerSession** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) |  |  [optional]
-**avgSessionValue** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) |  |  [optional]
+**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | 
+**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | 
+**totalRevenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  |  [optional]
+**sessionsCount** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  |  [optional]
+**avgItemsPerSession** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  |  [optional]
+**avgSessionValue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  |  [optional]
 **totalDiscounts** | [**BigDecimal**](BigDecimal.md) | The total value of discounts given for cart items in influenced sessions. |  [optional]
 **couponsCount** | [**BigDecimal**](BigDecimal.md) | The number of times a coupon was successfully redeemed in influenced sessions. |  [optional]
 

docs/ApplicationCIF.md

@@ -0,0 +1,21 @@
+
+
+# ApplicationCIF
+
+
+## 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 name of the Application cart item filter used in API requests. | 
+**description** | **String** | A short description of the Application cart item filter. |  [optional]
+**activeExpressionId** | **Integer** | The ID of the expression that the Application cart item filter uses. |  [optional]
+**modifiedBy** | **Integer** | The ID of the user who last updated the Application cart item filter. |  [optional]
+**createdBy** | **Integer** | The ID of the user who created the Application cart item filter. |  [optional]
+**modified** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update to the Application cart item filter. |  [optional]
+**applicationId** | **Integer** | The ID of the application that owns this entity. | 
+
+
+

docs/ApplicationCIFExpression.md

@@ -0,0 +1,18 @@
+
+
+# ApplicationCIFExpression
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | 
+**cartItemFilterId** | **Integer** | The ID of the Application cart item filter. |  [optional]
+**createdBy** | **Integer** | The ID of the user who created the Application cart item filter. |  [optional]
+**expression** | **List<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. |  [optional]
+**applicationId** | **Integer** | The ID of the application that owns this entity. | 
+
+
+

docs/ApplicationCampaignAnalytics.md

@@ -6,29 +6,28 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. |  [optional]
-**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. |  [optional]
-**campaignId** | **Integer** | The ID of the campaign. |  [optional]
-**campaignName** | **String** | The name of the campaign. |  [optional]
-**campaignTags** | **List<String>** | A list of tags for the campaign. |  [optional]
-**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  |  [optional]
-**campaignActiveRulesetId** | **Integer** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.  |  [optional]
-**campaignStartTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes active. |  [optional]
-**campaignEndTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes inactive. |  [optional]
-**totalRevenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) |  |  [optional]
-**sessionsCount** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) |  |  [optional]
-**avgItemsPerSession** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) |  |  [optional]
-**avgSessionValue** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) |  |  [optional]
-**totalDiscounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) |  |  [optional]
-**couponsCount** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) |  |  [optional]
+**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | 
+**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | 
+**campaignId** | **Integer** | The ID of the campaign. | 
+**campaignName** | **String** | The name of the campaign. | 
+**campaignTags** | **List<String>** | A list of tags for the campaign. | 
+**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | 
+**totalRevenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  |  [optional]
+**sessionsCount** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  |  [optional]
+**avgItemsPerSession** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  |  [optional]
+**avgSessionValue** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  |  [optional]
+**totalDiscounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  |  [optional]
+**couponsCount** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  |  [optional]
 
 
 
 ## Enum: CampaignStateEnum
 
 Name | Value
 ---- | -----
-ENABLED | "enabled"
+EXPIRED | "expired"
+SCHEDULED | "scheduled"
+RUNNING | "running"
 DISABLED | "disabled"
 ARCHIVED | "archived"
 

docs/ApplicationCampaignStats.md

@@ -7,7 +7,6 @@ Provides statistics regarding an application's campaigns.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**draft** | **Integer** | Number of draft campaigns. | 
 **disabled** | **Integer** | Number of disabled campaigns. | 
 **scheduled** | **Integer** | Number of scheduled campaigns. | 
 **running** | **Integer** | Number of running campaigns. | 

docs/AsyncCouponDeletionJobResponse.md

@@ -0,0 +1,13 @@
+
+
+# AsyncCouponDeletionJobResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
+
+
+

docs/Attribute.md

@@ -31,7 +31,6 @@ Name | Type | Description | Notes
 
 Name | Value
 ---- | -----
-ACCOUNT | "Account"
 APPLICATION | "Application"
 CAMPAIGN | "Campaign"
 CUSTOMERPROFILE | "CustomerProfile"

docs/BaseLoyaltyProgram.md

@@ -14,38 +14,42 @@ Name | Type | Description | Notes
 **allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |  [optional]
 **usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.  |  [optional]
 **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |  [optional]
-**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.  |  [optional]
-**tiersExpireIn** | **String** | The amount of time after which the tier expires.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  |  [optional]
-**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.  |  [optional]
 **programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.  |  [optional]
+**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.  |  [optional]
+**tierCycleStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.  |  [optional]
+**tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  |  [optional]
+**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  |  [optional]
+**cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  |  [optional]
 
 
 
-## Enum: TiersExpirationPolicyEnum
+## Enum: ProgramJoinPolicyEnum
 
 Name | Value
 ---- | -----
-TIER_START_DATE | "tier_start_date"
-PROGRAM_JOIN_DATE | "program_join_date"
+NOT_JOIN | "not_join"
+POINTS_ACTIVATED | "points_activated"
+POINTS_EARNED | "points_earned"
 
 
 
-## Enum: TiersDowngradePolicyEnum
+## Enum: TiersExpirationPolicyEnum
 
 Name | Value
 ---- | -----
-ONE_DOWN | "one_down"
-BALANCE_BASED | "balance_based"
+TIER_START_DATE | "tier_start_date"
+PROGRAM_JOIN_DATE | "program_join_date"
+CUSTOMER_ATTRIBUTE | "customer_attribute"
+ABSOLUTE_EXPIRATION | "absolute_expiration"
 
 
 
-## Enum: ProgramJoinPolicyEnum
+## Enum: TiersDowngradePolicyEnum
 
 Name | Value
 ---- | -----
-NOT_JOIN | "not_join"
-POINTS_ACTIVATED | "points_activated"
-POINTS_EARNED | "points_earned"
+ONE_DOWN | "one_down"
+BALANCE_BASED | "balance_based"
 
 
 

docs/BaseNotification.md

@@ -7,7 +7,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | Indicates which notification properties to apply. | 
 **enabled** | **Boolean** | Indicates whether the notification is activated. |  [optional]
 **webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) |  | 
 **id** | **Integer** | Unique ID for this entity. | 
@@ -21,6 +21,7 @@ Name | Value
 ---- | -----
 CAMPAIGN | "campaign"
 LOYALTY_ADDED_DEDUCTED_POINTS | "loyalty_added_deducted_points"
+CARD_ADDED_DEDUCTED_POINTS | "card_added_deducted_points"
 COUPON | "coupon"
 EXPIRING_COUPONS | "expiring_coupons"
 EXPIRING_POINTS | "expiring_points"

docs/BaseNotificationEntity.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | Indicates which notification properties to apply. | 
 **enabled** | **Boolean** | Indicates whether the notification is activated. |  [optional]