Skip to content

Commit 406dd7a

Browse files
authored
v3.5.0 (#12)
- Expose new _profile inventory endpoint_. Consult our developer docs for more information: https://developers.talon.one/Integration-API/API-Reference#getCustomerInventory - Expose more attributes handling endpoints (create, update, get all) - `copyCampaignToApplications` endpoint extended and now allows to override original campaign's description scheduling details and tags as part of the copy functionality. See parameters here: https://developers.talon.one/Management-API/API-Reference#copyCampaignToApplications
1 parent 295f2fd commit 406dd7a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+2517
-680
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Add this dependency to your project's POM:
3939
<dependency>
4040
<groupId>one.talon</groupId>
4141
<artifactId>talon-one-client</artifactId>
42-
<version>3.4.0</version>
42+
<version>3.5.0</version>
4343
<scope>compile</scope>
4444
</dependency>
4545
```
@@ -49,7 +49,7 @@ Add this dependency to your project's POM:
4949
Add this dependency to your project's build file:
5050

5151
```groovy
52-
compile "one.talon:talon-one-client:3.4.0"
52+
compile "one.talon:talon-one-client:3.5.0"
5353
```
5454

5555
### Others
@@ -62,7 +62,7 @@ mvn clean package
6262

6363
Then manually install the following JARs:
6464

65-
* `target/talon-one-client-3.4.0.jar`
65+
* `target/talon-one-client-3.5.0.jar`
6666
* `target/lib/*.jar`
6767

6868
## Getting Started
@@ -146,6 +146,7 @@ public class TalonApiTest {
146146
}
147147
```
148148

149+
149150
## Documentation for API Endpoints
150151

151152
All URIs are relative to *http://localhost*
@@ -156,13 +157,15 @@ Class | Method | HTTP request | Description
156157
*IntegrationApi* | [**createReferral**](docs/IntegrationApi.md#createReferral) | **POST** /v1/referrals | Create a referral code for an advocate
157158
*IntegrationApi* | [**deleteCouponReservation**](docs/IntegrationApi.md#deleteCouponReservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
158159
*IntegrationApi* | [**deleteCustomerData**](docs/IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
160+
*IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
159161
*IntegrationApi* | [**getReservedCoupons**](docs/IntegrationApi.md#getReservedCoupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
160162
*IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
161163
*IntegrationApi* | [**trackEvent**](docs/IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
162164
*IntegrationApi* | [**updateCustomerProfile**](docs/IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
163165
*IntegrationApi* | [**updateCustomerSession**](docs/IntegrationApi.md#updateCustomerSession) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
164166
*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
165167
*ManagementApi* | [**copyCampaignToApplications**](docs/ManagementApi.md#copyCampaignToApplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
168+
*ManagementApi* | [**createAttribute**](docs/ManagementApi.md#createAttribute) | **POST** /v1/attributes | Define a new custom attribute
166169
*ManagementApi* | [**createCampaign**](docs/ManagementApi.md#createCampaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
167170
*ManagementApi* | [**createCoupons**](docs/ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
168171
*ManagementApi* | [**createPasswordRecoveryEmail**](docs/ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset
@@ -177,7 +180,6 @@ Class | Method | HTTP request | Description
177180
*ManagementApi* | [**getAccessLogsWithoutTotalCount**](docs/ManagementApi.md#getAccessLogsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
178181
*ManagementApi* | [**getAccount**](docs/ManagementApi.md#getAccount) | **GET** /v1/accounts/{accountId} | Get Account Details
179182
*ManagementApi* | [**getAccountAnalytics**](docs/ManagementApi.md#getAccountAnalytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
180-
*ManagementApi* | [**getAccountLimits**](docs/ManagementApi.md#getAccountLimits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
181183
*ManagementApi* | [**getAllAccessLogs**](docs/ManagementApi.md#getAllAccessLogs) | **GET** /v1/access_logs | Get all access logs
182184
*ManagementApi* | [**getAllRoles**](docs/ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles.
183185
*ManagementApi* | [**getApplication**](docs/ManagementApi.md#getApplication) | **GET** /v1/applications/{applicationId} | Get Application
@@ -192,6 +194,7 @@ Class | Method | HTTP request | Description
192194
*ManagementApi* | [**getApplicationSessions**](docs/ManagementApi.md#getApplicationSessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
193195
*ManagementApi* | [**getApplications**](docs/ManagementApi.md#getApplications) | **GET** /v1/applications | List Applications
194196
*ManagementApi* | [**getAttribute**](docs/ManagementApi.md#getAttribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
197+
*ManagementApi* | [**getAttributes**](docs/ManagementApi.md#getAttributes) | **GET** /v1/attributes | List custom attributes
195198
*ManagementApi* | [**getCampaign**](docs/ManagementApi.md#getCampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
196199
*ManagementApi* | [**getCampaignAnalytics**](docs/ManagementApi.md#getCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
197200
*ManagementApi* | [**getCampaignByAttributes**](docs/ManagementApi.md#getCampaignByAttributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
@@ -233,7 +236,7 @@ Class | Method | HTTP request | Description
233236
*ManagementApi* | [**searchCouponsAdvancedApplicationWide**](docs/ManagementApi.md#searchCouponsAdvancedApplicationWide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
234237
*ManagementApi* | [**searchCouponsAdvancedApplicationWideWithoutTotalCount**](docs/ManagementApi.md#searchCouponsAdvancedApplicationWideWithoutTotalCount) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
235238
*ManagementApi* | [**searchCouponsAdvancedWithoutTotalCount**](docs/ManagementApi.md#searchCouponsAdvancedWithoutTotalCount) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
236-
*ManagementApi* | [**setAccountLimits**](docs/ManagementApi.md#setAccountLimits) | **PUT** /v1/accounts/{accountId}/limits | Set account limits
239+
*ManagementApi* | [**updateAttribute**](docs/ManagementApi.md#updateAttribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
237240
*ManagementApi* | [**updateCampaign**](docs/ManagementApi.md#updateCampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
238241
*ManagementApi* | [**updateCampaignSet**](docs/ManagementApi.md#updateCampaignSet) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
239242
*ManagementApi* | [**updateCoupon**](docs/ManagementApi.md#updateCoupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
@@ -261,6 +264,9 @@ Class | Method | HTTP request | Description
261264
- [ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
262265
- [Attribute](docs/Attribute.md)
263266
- [AttributeQuery](docs/AttributeQuery.md)
267+
- [AttributesMandatory](docs/AttributesMandatory.md)
268+
- [AttributesSettings](docs/AttributesSettings.md)
269+
- [BaseSamlConnection](docs/BaseSamlConnection.md)
264270
- [Binding](docs/Binding.md)
265271
- [Campaign](docs/Campaign.md)
266272
- [CampaignAnalytics](docs/CampaignAnalytics.md)
@@ -284,6 +290,7 @@ Class | Method | HTTP request | Description
284290
- [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
285291
- [CustomerActivityReport](docs/CustomerActivityReport.md)
286292
- [CustomerAnalytics](docs/CustomerAnalytics.md)
293+
- [CustomerInventory](docs/CustomerInventory.md)
287294
- [CustomerProfile](docs/CustomerProfile.md)
288295
- [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
289296
- [CustomerSession](docs/CustomerSession.md)
@@ -323,6 +330,7 @@ Class | Method | HTTP request | Description
323330
- [InlineResponse20026](docs/InlineResponse20026.md)
324331
- [InlineResponse20027](docs/InlineResponse20027.md)
325332
- [InlineResponse20028](docs/InlineResponse20028.md)
333+
- [InlineResponse20029](docs/InlineResponse20029.md)
326334
- [InlineResponse2003](docs/InlineResponse2003.md)
327335
- [InlineResponse2004](docs/InlineResponse2004.md)
328336
- [InlineResponse2005](docs/InlineResponse2005.md)
@@ -388,6 +396,7 @@ Class | Method | HTTP request | Description
388396
- [Rule](docs/Rule.md)
389397
- [Ruleset](docs/Ruleset.md)
390398
- [SamlConnection](docs/SamlConnection.md)
399+
- [SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
391400
- [Session](docs/Session.md)
392401
- [SlotDef](docs/SlotDef.md)
393402
- [TemplateArgDef](docs/TemplateArgDef.md)

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'idea'
22
apply plugin: 'eclipse'
33

44
group = 'one.talon'
5-
version = '3.4.0'
5+
version = '3.5.0'
66

77
buildscript {
88
repositories {

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "one.talon",
44
name := "talon-one-client",
5-
version := "3.4.0",
5+
version := "3.5.0",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AccountAnalytics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
1818
**roles** | **Integer** | Total Number of roles inside the account |
1919
**webhooks** | **Integer** | Total Number of webhooks inside the account |
2020
**loyaltyPrograms** | **Integer** | Total Number of loyalty programs inside the account |
21+
**activeRules** | **Integer** | Total Number of active rules in the account |
2122

2223

2324

docs/AccountLimits.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**webhooks** | **Integer** | Total Number of allowed webhooks in the account |
1515
**users** | **Integer** | Total Number of allowed users in the account |
1616
**apiVolume** | **Integer** | Total allowed api volume |
17+
**activeRules** | **Integer** | Total allowed active rulesets | [optional]
1718
**promotionTypes** | **List&lt;String&gt;** | array of rulesets where webhook is used |
1819

1920

docs/Application.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**caseSensitivity** | [**CaseSensitivityEnum**](#CaseSensitivityEnum) | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
1616
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
1717
**limits** | [**List&lt;LimitConfig&gt;**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
18+
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
1819
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
1920
**loyaltyPrograms** | [**List&lt;LoyaltyProgram&gt;**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |
2021

docs/AttributesMandatory.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AttributesMandatory
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**campaigns** | **List&lt;String&gt;** | List of mandatory attributes for campaigns. | [optional]
8+
**coupons** | **List&lt;String&gt;** | List of mandatory attributes for campaigns. | [optional]
9+
10+
11+

docs/AttributesSettings.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
# AttributesSettings
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**mandatory** | [**AttributesMandatory**](AttributesMandatory.md) | | [optional]
8+
9+
10+

docs/BaseSamlConnection.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
# BaseSamlConnection
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**accountId** | **Integer** | The ID of the account that owns this entity. |
8+
**name** | **String** | ID of the SAML service. |
9+
**enabled** | **Boolean** | Determines if this SAML connection active. |
10+
**issuer** | **String** | Identity Provider Entity ID. |
11+
**signOnURL** | **String** | Single Sign-On URL. |
12+
**signOutURL** | **String** | Single Sign-Out URL. | [optional]
13+
**metadataURL** | **String** | Metadata URL. | [optional]
14+
**audienceURI** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. | [optional]
15+
16+
17+

docs/CampaignAnalytics.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,20 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**date** | [**OffsetDateTime**](OffsetDateTime.md) | |
8-
**campaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign. |
9-
**totalCampaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign since it began. |
8+
**campaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign (for coupon or discount sessions). |
9+
**totalCampaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign since it began (for coupon or discount sessions). |
10+
**campaignRefund** | [**BigDecimal**](BigDecimal.md) | Amount of refunds in this campaign (for coupon or discount sessions). |
11+
**totalCampaignRefund** | [**BigDecimal**](BigDecimal.md) | Amount of refunds in this campaign since it began (for coupon or discount sessions). |
1012
**campaignDiscountCosts** | [**BigDecimal**](BigDecimal.md) | Amount of cost caused by discounts given in the campaign. |
1113
**totalCampaignDiscountCosts** | [**BigDecimal**](BigDecimal.md) | Amount of cost caused by discounts given in the campaign since it began. |
14+
**campaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign. |
15+
**totalCampaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign since it began. |
1216
**campaignFreeItems** | **Integer** | Amount of free items given in the campaign. |
1317
**totalCampaignFreeItems** | **Integer** | Amount of free items given in the campaign since it began. |
14-
**couponRedemptions** | **Integer** | Number of coupon redemptions in the campaign (only accepted referrals on sessions that were closed are considered). |
18+
**couponRedemptions** | **Integer** | Number of coupon redemptions in the campaign. |
1519
**totalCouponRedemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. |
20+
**couponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
21+
**totalCouponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
1622
**referralRedemptions** | **Integer** | Number of referral redemptions in the campaign. |
1723
**totalReferralRedemptions** | **Integer** | Number of referral redemptions in the campaign since it began. |
1824
**couponsCreated** | **Integer** | Number of coupons created in the campaign by the rule engine. |

0 commit comments

Comments
 (0)