V4.1.0: Dry Runs & Coupons discount limits (#14)

 - Introduce "dry runs" for Integration API endpoints (See more details below)
 - Add support to retrieve coupons as part of requesting customer profile inventories
 - Add support for setting the `discountLimit` when creating or editing coupons

### Introduce "dry runs" for Integration API endpoints
You can read more about the concept and where this feature could apply in your integration and workflow in our developers documentation center: https://developers.talon.one/Integration-API/dry-requests

**Please Notice** that all current integration request operations (`trackEvent`, `updateCustomerProfile`, `updateCustomerSession`, `updateCustomerSessionV2` ) expects a boolean flag to determine whether this request is a dry run or not.
See code examples in the [README.md](https://github.com/talon-one/TalonOneJavaSdk/blob/v4.1.0/README.md#v1) as for reference.

Commit Summary
=============
* Initial Commit v4.1.0
* Update readme examples to support the new dry-run parameter

Author: altJake

README.md

@@ -49,7 +49,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>one.talon</groupId>
   <artifactId>talon-one-client</artifactId>
-  <version>4.0.0</version>
+  <version>4.1.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -59,7 +59,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "one.talon:talon-one-client:4.0.0"
+compile "one.talon:talon-one-client:4.1.0"
 ```
 
 ### Others
@@ -72,7 +72,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/talon-one-client-4.0.0.jar`
+* `target/talon-one-client-4.1.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -124,8 +124,11 @@ public class TalonApiTest {
                     IntegrationRequest.ResponseContentEnum.CUSTOMERPROFILE
                 ));
 
+            // Flag to communicate whether the request is a "dry run"
+            Boolean dryRun = false;
+
             // Create/update a customer session using `updateCustomerSessionV2` function
-            IntegrationStateV2 is = iApi.updateCustomerSessionV2("deetdoot", request);
+            IntegrationStateV2 is = iApi.updateCustomerSessionV2("deetdoot", request, dryRun);
             System.out.println(is.toString());
 
             // Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding properties
@@ -179,8 +182,11 @@ public class TalonApiTest {
             customerSession.setState(NewCustomerSession.StateEnum.OPEN);
             customerSession.setTotal(new java.math.BigDecimal("42.0"));
 
+            // Flag to communicate whether the request is a "dry run"
+            Boolean dryRun = false;
+
             // Create/update a customer session using `updateCustomerSession` function
-            IntegrationState ie = iApi.updateCustomerSession("deetdoot", customerSession);
+            IntegrationState ie = iApi.updateCustomerSession("deetdoot", customerSession, dryRun);
             System.out.println(ie.toString());
         } catch (Exception e) {
             System.out.println(e);
@@ -239,10 +245,10 @@ Class | Method | HTTP request | Description
 *IntegrationApi* | [**deleteCouponReservation**](docs/IntegrationApi.md#deleteCouponReservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
 *IntegrationApi* | [**deleteCustomerData**](docs/IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
 *IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
-*IntegrationApi* | [**getReservedCoupons**](docs/IntegrationApi.md#getReservedCoupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
 *IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
 *IntegrationApi* | [**trackEvent**](docs/IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
 *IntegrationApi* | [**updateCustomerProfile**](docs/IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
+*IntegrationApi* | [**updateCustomerProfileV2**](docs/IntegrationApi.md#updateCustomerProfileV2) | **PUT** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile
 *IntegrationApi* | [**updateCustomerSession**](docs/IntegrationApi.md#updateCustomerSession) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
 *IntegrationApi* | [**updateCustomerSessionV2**](docs/IntegrationApi.md#updateCustomerSessionV2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
 *ManagementApi* | [**addLoyaltyPoints**](docs/ManagementApi.md#addLoyaltyPoints) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
@@ -283,7 +289,6 @@ Class | Method | HTTP request | Description
 *ManagementApi* | [**getCampaign**](docs/ManagementApi.md#getCampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
 *ManagementApi* | [**getCampaignAnalytics**](docs/ManagementApi.md#getCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
 *ManagementApi* | [**getCampaignByAttributes**](docs/ManagementApi.md#getCampaignByAttributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
-*ManagementApi* | [**getCampaignSet**](docs/ManagementApi.md#getCampaignSet) | **GET** /v1/applications/{applicationId}/campaign_set | List CampaignSet
 *ManagementApi* | [**getCampaigns**](docs/ManagementApi.md#getCampaigns) | **GET** /v1/applications/{applicationId}/campaigns | List your Campaigns
 *ManagementApi* | [**getChanges**](docs/ManagementApi.md#getChanges) | **GET** /v1/changes | Get audit log for an account
 *ManagementApi* | [**getCoupons**](docs/ManagementApi.md#getCoupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons
@@ -323,7 +328,6 @@ Class | Method | HTTP request | Description
 *ManagementApi* | [**updateAdditionalCost**](docs/ManagementApi.md#updateAdditionalCost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost
 *ManagementApi* | [**updateAttribute**](docs/ManagementApi.md#updateAttribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
 *ManagementApi* | [**updateCampaign**](docs/ManagementApi.md#updateCampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
-*ManagementApi* | [**updateCampaignSet**](docs/ManagementApi.md#updateCampaignSet) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
 *ManagementApi* | [**updateCoupon**](docs/ManagementApi.md#updateCoupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
 *ManagementApi* | [**updateCouponBatch**](docs/ManagementApi.md#updateCouponBatch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
 *ManagementApi* | [**updateRuleset**](docs/ManagementApi.md#updateRuleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
@@ -385,6 +389,7 @@ Class | Method | HTTP request | Description
  - [CustomerInventory](docs/CustomerInventory.md)
  - [CustomerProfile](docs/CustomerProfile.md)
  - [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
+ - [CustomerProfileUpdate](docs/CustomerProfileUpdate.md)
  - [CustomerSession](docs/CustomerSession.md)
  - [CustomerSessionV2](docs/CustomerSessionV2.md)
  - [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)

build.gradle

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

build.sbt

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

docs/Application.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **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) |  [optional]
 **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  |  [optional]
 **loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
@@ -33,3 +34,13 @@ INSENSITIVE_LOWERCASE | "insensitive-lowercase"
 
 
 
+## Enum: CampaignPriorityEnum
+
+Name | Value
+---- | -----
+UNIVERSAL | "universal"
+STACKABLE | "stackable"
+EXCLUSIVE | "exclusive"
+
+
+

docs/ApplicationSession.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **state** | [**StateEnum**](#StateEnum) | Indicating if the customer session is in progress (\"open\"), \"closed\", or \"cancelled\". | 
 **cartItems** | [**List<CartItem>**](CartItem.md) | Serialized JSON representation. | 
 **discounts** | [**Map<String, BigDecimal>**](BigDecimal.md) | A map of labelled discount values, in the same currency as the session. | 
-**total** | [**BigDecimal**](BigDecimal.md) | The total sum of the session before any discounts applied. |  [optional]
+**total** | [**BigDecimal**](BigDecimal.md) | The total sum of the session before any discounts applied. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item |  [optional]
 
 

docs/CampaignSet.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. | 
 **applicationId** | **Integer** | The ID of the application that owns this entity. | 
+**version** | **Integer** | Version of the campaign set | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
 
 

docs/Coupon.md

@@ -12,12 +12,15 @@ Name | Type | Description | Notes
 **campaignId** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The actual coupon code. | 
 **usageLimit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | 
+**discountLimit** | [**BigDecimal**](BigDecimal.md) | The amount of discounts that can be given with this coupon code.  |  [optional]
 **startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. |  [optional]
 **expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. |  [optional]
 **usageCounter** | **Integer** | The number of times this coupon has been successfully used. | 
+**discountCounter** | [**BigDecimal**](BigDecimal.md) | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. |  [optional]
+**discountRemainder** | [**BigDecimal**](BigDecimal.md) | The remaining discount this coupon can give. |  [optional]
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item |  [optional]
 **referralId** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. |  [optional]
-**recipientIntegrationId** | **String** | The integration ID of a referred customer profile. |  [optional]
+**recipientIntegrationId** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. |  [optional]
 **importId** | **Integer** | The ID of the Import which created this coupon. |  [optional]
 **reservation** | **Boolean** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. |  [optional]
 **batchId** | **String** | The id of the batch the coupon belongs to. |  [optional]

docs/CouponConstraints.md

@@ -7,6 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **usageLimit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  |  [optional]
+**discountLimit** | [**BigDecimal**](BigDecimal.md) | The amount of discounts that can be given with this coupon code.  |  [optional]
 **startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. |  [optional]
 **expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. |  [optional]
 

docs/CustomerInventory.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **profile** | [**CustomerProfile**](CustomerProfile.md) |  |  [optional]
 **referrals** | [**List<Referral>**](Referral.md) |  |  [optional]
+**coupons** | [**List<Coupon>**](Coupon.md) |  |  [optional]
 
 
 

docs/CustomerProfileUpdate.md

@@ -0,0 +1,12 @@
+
+
+# CustomerProfileUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerProfile** | [**CustomerProfile**](CustomerProfile.md) |  | 
+
+
+