v4.5.0: Partial Returns & Collections (#28)

* Initial Commit

Author: altJake

README.md

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

api/openapi.yaml

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

build.gradle

@@ -14,6 +14,17 @@ Name | Type | Description | Notes
 **title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | 
 **description** | **String** | A description of this additional cost. | 
 **subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost |  [optional]
+**type** | [**TypeEnum**](#TypeEnum) | The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session.  |  [optional]
+
+
+
+## Enum: TypeEnum
+
+Name | Value
+---- | -----
+SESSION | "session"
+ITEM | "item"
+BOTH | "both"
 
 
 

build.sbt

@@ -23,7 +23,8 @@ Name | Type | Description | Notes
 **roles** | **Integer** | Total number of roles in the account | 
 **customAttributes** | **Integer** | Total number of custom attributes in the account | 
 **webhooks** | **Integer** | Total number of webhooks in the account | 
-**loyaltyPrograms** | **Integer** | Total number of loyalty programs 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 | 
 
 
 

docs/AccountAdditionalCost.md

@@ -2,19 +2,23 @@
 
 # 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.
+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. 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The name/description of this loyalty point addition | 
-**programId** | **Integer** | 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 | 
-**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 | 
+**name** | **String** | The name/description of this loyalty point addition. | 
+**programId** | **Integer** | 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]
+**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) | 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]
+**cardIdentifier** | **String** | The card on which these points were added. |  [optional]
 
 
 

docs/AccountAnalytics.md

@@ -14,17 +14,19 @@ Name | Type | Description | Notes
 **name** | **String** | The name of this application. | 
 **description** | **String** | A longer description of the application. |  [optional]
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
-**currency** | **String** | A string describing a default currency for new customer sessions. | 
-**caseSensitivity** | [**CaseSensitivityEnum**](#CaseSensitivityEnum) | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. |  [optional]
-**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign |  [optional]
-**limits** | [**List<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application |  [optional]
-**campaignPriority** | [**CampaignPriorityEnum**](#CampaignPriorityEnum) | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" |  [optional]
-**exclusiveCampaignsStrategy** | [**ExclusiveCampaignsStrategyEnum**](#ExclusiveCampaignsStrategyEnum) | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" |  [optional]
-**defaultDiscountScope** | [**DefaultDiscountScopeEnum**](#DefaultDiscountScopeEnum) | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. |  [optional]
-**enableCascadingDiscounts** | **Boolean** | Flag indicating if discounts should cascade for this application |  [optional]
-**enableFlattenedCartItems** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one |  [optional]
+**currency** | **String** | The default currency for new customer sessions. | 
+**caseSensitivity** | [**CaseSensitivityEnum**](#CaseSensitivityEnum) | The case sensitivity behavior to check coupon codes in the campaigns of this Application. |  [optional]
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. |  [optional]
+**limits** | [**List<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. |  [optional]
+**campaignPriority** | [**CampaignPriorityEnum**](#CampaignPriorityEnum) | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application.  |  [optional]
+**exclusiveCampaignsStrategy** | [**ExclusiveCampaignsStrategyEnum**](#ExclusiveCampaignsStrategyEnum) | The strategy used when choosing exclusive campaigns for evaluation. |  [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/campaign-evaluation/#flattened-cart-items).  |  [optional]
 **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  |  [optional]
-**sandbox** | **Boolean** | Flag indicating if this is a live or sandbox application |  [optional]
+**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. |  [optional]
+**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]
 **loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
 
@@ -69,3 +71,13 @@ ADDITIONALCOSTS | "additionalCosts"
 
 
 
+## Enum: DefaultDiscountAdditionalCostPerItemScopeEnum
+
+Name | Value
+---- | -----
+PRICE | "price"
+ITEMTOTAL | "itemTotal"
+ADDITIONALCOSTS | "additionalCosts"
+
+
+

docs/AddLoyaltyPointsEffectProps.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **String** | Title for API Key | 
 **expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expired | 
-**platform** | [**PlatformEnum**](#PlatformEnum) | Platform the API key is valid for. |  [optional]
+**platform** | [**PlatformEnum**](#PlatformEnum) | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer.  |  [optional]
 **id** | **Integer** | ID of the API Key | 
 **createdBy** | **Integer** | ID of user who created | 
 **accountID** | **Integer** | ID of account the key is used for | 
@@ -27,6 +27,9 @@ SEGMENT | "segment"
 BRAZE | "braze"
 MPARTICLE | "mparticle"
 SELLIGENT | "selligent"
+ITERABLE | "iterable"
+CUSTOMER_ENGAGEMENT | "customer_engagement"
+CUSTOMER_DATA | "customer_data"
 
 
 

docs/Application.md

@@ -7,16 +7,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Unique ID for this entity. | 
-**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | 
+**id** | **Integer** | Unique ID for this entity. Unique ID for this entity. | 
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | 
 **integrationId** | **String** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item | 
 **accountId** | **Integer** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | 
 **closedSessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **totalSales** | [**BigDecimal**](BigDecimal.md) | Sum of all purchases made by this customer | 
-**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer |  [optional]
+**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  |  [optional]
 **audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | A list of audiences the customer belongs to |  [optional]
-**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received from this customer | 
+**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.  | 
+**advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. |  [optional]