Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>one.talon</groupId>
<artifactId>talon-one-client</artifactId>
<version>3.4.0</version>
<version>3.5.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -49,7 +49,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:3.4.0"
compile "one.talon:talon-one-client:3.5.0"
```

### Others
Expand All @@ -62,7 +62,7 @@ mvn clean package

Then manually install the following JARs:

* `target/talon-one-client-3.4.0.jar`
* `target/talon-one-client-3.5.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -146,6 +146,7 @@ public class TalonApiTest {
}
```


## Documentation for API Endpoints

All URIs are relative to *http://localhost*
Expand All @@ -156,13 +157,15 @@ Class | Method | HTTP request | Description
*IntegrationApi* | [**createReferral**](docs/IntegrationApi.md#createReferral) | **POST** /v1/referrals | Create a referral code for an advocate
*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* | [**updateCustomerSession**](docs/IntegrationApi.md#updateCustomerSession) | **PUT** /v1/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
*ManagementApi* | [**copyCampaignToApplications**](docs/ManagementApi.md#copyCampaignToApplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
*ManagementApi* | [**createAttribute**](docs/ManagementApi.md#createAttribute) | **POST** /v1/attributes | Define a new custom attribute
*ManagementApi* | [**createCampaign**](docs/ManagementApi.md#createCampaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
*ManagementApi* | [**createCoupons**](docs/ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
*ManagementApi* | [**createPasswordRecoveryEmail**](docs/ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset
Expand All @@ -177,7 +180,6 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**getAccessLogsWithoutTotalCount**](docs/ManagementApi.md#getAccessLogsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
*ManagementApi* | [**getAccount**](docs/ManagementApi.md#getAccount) | **GET** /v1/accounts/{accountId} | Get Account Details
*ManagementApi* | [**getAccountAnalytics**](docs/ManagementApi.md#getAccountAnalytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
*ManagementApi* | [**getAccountLimits**](docs/ManagementApi.md#getAccountLimits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
*ManagementApi* | [**getAllAccessLogs**](docs/ManagementApi.md#getAllAccessLogs) | **GET** /v1/access_logs | Get all access logs
*ManagementApi* | [**getAllRoles**](docs/ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles.
*ManagementApi* | [**getApplication**](docs/ManagementApi.md#getApplication) | **GET** /v1/applications/{applicationId} | Get Application
Expand All @@ -192,6 +194,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**getApplicationSessions**](docs/ManagementApi.md#getApplicationSessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
*ManagementApi* | [**getApplications**](docs/ManagementApi.md#getApplications) | **GET** /v1/applications | List Applications
*ManagementApi* | [**getAttribute**](docs/ManagementApi.md#getAttribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
*ManagementApi* | [**getAttributes**](docs/ManagementApi.md#getAttributes) | **GET** /v1/attributes | List custom attributes
*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
Expand Down Expand Up @@ -233,7 +236,7 @@ Class | Method | HTTP request | Description
*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
*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
*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
*ManagementApi* | [**setAccountLimits**](docs/ManagementApi.md#setAccountLimits) | **PUT** /v1/accounts/{accountId}/limits | Set account limits
*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
Expand Down Expand Up @@ -261,6 +264,9 @@ Class | Method | HTTP request | Description
- [ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
- [Attribute](docs/Attribute.md)
- [AttributeQuery](docs/AttributeQuery.md)
- [AttributesMandatory](docs/AttributesMandatory.md)
- [AttributesSettings](docs/AttributesSettings.md)
- [BaseSamlConnection](docs/BaseSamlConnection.md)
- [Binding](docs/Binding.md)
- [Campaign](docs/Campaign.md)
- [CampaignAnalytics](docs/CampaignAnalytics.md)
Expand All @@ -284,6 +290,7 @@ Class | Method | HTTP request | Description
- [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
- [CustomerActivityReport](docs/CustomerActivityReport.md)
- [CustomerAnalytics](docs/CustomerAnalytics.md)
- [CustomerInventory](docs/CustomerInventory.md)
- [CustomerProfile](docs/CustomerProfile.md)
- [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
- [CustomerSession](docs/CustomerSession.md)
Expand Down Expand Up @@ -323,6 +330,7 @@ Class | Method | HTTP request | Description
- [InlineResponse20026](docs/InlineResponse20026.md)
- [InlineResponse20027](docs/InlineResponse20027.md)
- [InlineResponse20028](docs/InlineResponse20028.md)
- [InlineResponse20029](docs/InlineResponse20029.md)
- [InlineResponse2003](docs/InlineResponse2003.md)
- [InlineResponse2004](docs/InlineResponse2004.md)
- [InlineResponse2005](docs/InlineResponse2005.md)
Expand Down Expand Up @@ -388,6 +396,7 @@ Class | Method | HTTP request | Description
- [Rule](docs/Rule.md)
- [Ruleset](docs/Ruleset.md)
- [SamlConnection](docs/SamlConnection.md)
- [SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
- [Session](docs/Session.md)
- [SlotDef](docs/SlotDef.md)
- [TemplateArgDef](docs/TemplateArgDef.md)
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'idea'
apply plugin: 'eclipse'

group = 'one.talon'
version = '3.4.0'
version = '3.5.0'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "one.talon",
name := "talon-one-client",
version := "3.4.0",
version := "3.5.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 1 addition & 0 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Name | Type | Description | Notes
**roles** | **Integer** | Total Number of roles inside the account |
**webhooks** | **Integer** | Total Number of webhooks inside the account |
**loyaltyPrograms** | **Integer** | Total Number of loyalty programs inside the account |
**activeRules** | **Integer** | Total Number of active rules in the account |



1 change: 1 addition & 0 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**webhooks** | **Integer** | Total Number of allowed webhooks in the account |
**users** | **Integer** | Total Number of allowed users in the account |
**apiVolume** | **Integer** | Total allowed api volume |
**activeRules** | **Integer** | Total allowed active rulesets | [optional]
**promotionTypes** | **List&lt;String&gt;** | array of rulesets where webhook is used |


Expand Down
1 change: 1 addition & 0 deletions docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,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&lt;LimitConfig&gt;**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
**loyaltyPrograms** | [**List&lt;LoyaltyProgram&gt;**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |

Expand Down
11 changes: 11 additions & 0 deletions docs/AttributesMandatory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# AttributesMandatory

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaigns** | **List&lt;String&gt;** | List of mandatory attributes for campaigns. | [optional]
**coupons** | **List&lt;String&gt;** | List of mandatory attributes for campaigns. | [optional]



10 changes: 10 additions & 0 deletions docs/AttributesSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# AttributesSettings

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mandatory** | [**AttributesMandatory**](AttributesMandatory.md) | | [optional]



17 changes: 17 additions & 0 deletions docs/BaseSamlConnection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

# BaseSamlConnection

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | ID of the SAML service. |
**enabled** | **Boolean** | Determines if this SAML connection active. |
**issuer** | **String** | Identity Provider Entity ID. |
**signOnURL** | **String** | Single Sign-On URL. |
**signOutURL** | **String** | Single Sign-Out URL. | [optional]
**metadataURL** | **String** | Metadata URL. | [optional]
**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]



12 changes: 9 additions & 3 deletions docs/CampaignAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**date** | [**OffsetDateTime**](OffsetDateTime.md) | |
**campaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign. |
**totalCampaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign since it began. |
**campaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign (for coupon or discount sessions). |
**totalCampaignRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of revenue in this campaign since it began (for coupon or discount sessions). |
**campaignRefund** | [**BigDecimal**](BigDecimal.md) | Amount of refunds in this campaign (for coupon or discount sessions). |
**totalCampaignRefund** | [**BigDecimal**](BigDecimal.md) | Amount of refunds in this campaign since it began (for coupon or discount sessions). |
**campaignDiscountCosts** | [**BigDecimal**](BigDecimal.md) | Amount of cost caused by discounts given in the campaign. |
**totalCampaignDiscountCosts** | [**BigDecimal**](BigDecimal.md) | Amount of cost caused by discounts given in the campaign since it began. |
**campaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign. |
**totalCampaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign since it began. |
**campaignFreeItems** | **Integer** | Amount of free items given in the campaign. |
**totalCampaignFreeItems** | **Integer** | Amount of free items given in the campaign since it began. |
**couponRedemptions** | **Integer** | Number of coupon redemptions in the campaign (only accepted referrals on sessions that were closed are considered). |
**couponRedemptions** | **Integer** | Number of coupon redemptions in the campaign. |
**totalCouponRedemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. |
**couponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
**totalCouponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
**referralRedemptions** | **Integer** | Number of referral redemptions in the campaign. |
**totalReferralRedemptions** | **Integer** | Number of referral redemptions in the campaign since it began. |
**couponsCreated** | **Integer** | Number of coupons created in the campaign by the rule engine. |
Expand Down
4 changes: 4 additions & 0 deletions docs/CampaignCopy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the copied campaign (Defaults to \&quot;Copy of original campaign name\&quot;) | [optional]
**applicationIds** | **List&lt;String&gt;** | Application IDs of the applications to which a campaign should be copied to |
**description** | **String** | A detailed description of the campaign. | [optional]
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Datetime when the campaign will become active. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Datetime when the campaign will become in-active. | [optional]
**tags** | **List&lt;String&gt;** | A list of tags for the campaign. | [optional]



4 changes: 2 additions & 2 deletions docs/Change.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Name | Type | Description | Notes
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. |
**userId** | **Integer** | The ID of the account that owns this entity. |
**entity** | **String** | API endpoint on which the change was initiated. |
**old** | [**Object**](.md) | Resource before the change occured. | [optional]
**_new** | [**Object**](.md) | Resource after the change occured. | [optional]
**old** | [**Object**](.md) | Resource before the change occurred. | [optional]
**_new** | [**Object**](.md) | Resource after the change occurred. | [optional]



11 changes: 11 additions & 0 deletions docs/CustomerInventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# CustomerInventory

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
**referrals** | [**List&lt;Referral&gt;**](Referral.md) | | [optional]



2 changes: 1 addition & 1 deletion docs/InlineResponse20020.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;Webhook&gt;**](Webhook.md) | |
**data** | [**List&lt;Attribute&gt;**](Attribute.md) | |
**totalResultSize** | **Integer** | |


Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse20021.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;WebhookActivationLogEntry&gt;**](WebhookActivationLogEntry.md) | |
**data** | [**List&lt;Webhook&gt;**](Webhook.md) | |
**totalResultSize** | **Integer** | |


Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse20022.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;WebhookLogEntry&gt;**](WebhookLogEntry.md) | |
**data** | [**List&lt;WebhookActivationLogEntry&gt;**](WebhookActivationLogEntry.md) | |
**totalResultSize** | **Integer** | |


Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse20023.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;EventType&gt;**](EventType.md) | |
**data** | [**List&lt;WebhookLogEntry&gt;**](WebhookLogEntry.md) | |
**totalResultSize** | **Integer** | |


Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse20024.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;User&gt;**](User.md) | |
**data** | [**List&lt;EventType&gt;**](EventType.md) | |
**totalResultSize** | **Integer** | |


Expand Down
5 changes: 2 additions & 3 deletions docs/InlineResponse20025.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;Change&gt;**](Change.md) | |
**hasMore** | **Boolean** | | [optional]
**totalResultSize** | **Integer** | | [optional]
**data** | [**List&lt;User&gt;**](User.md) | |
**totalResultSize** | **Integer** | |



5 changes: 3 additions & 2 deletions docs/InlineResponse20026.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;Export&gt;**](Export.md) | |
**totalResultSize** | **Integer** | |
**data** | [**List&lt;Change&gt;**](Change.md) | |
**hasMore** | **Boolean** | | [optional]
**totalResultSize** | **Integer** | | [optional]



2 changes: 1 addition & 1 deletion docs/InlineResponse20027.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;ModelImport&gt;**](ModelImport.md) | |
**data** | [**List&lt;Export&gt;**](Export.md) | |
**totalResultSize** | **Integer** | |


Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse20028.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;Role&gt;**](Role.md) | |
**data** | [**List&lt;ModelImport&gt;**](ModelImport.md) | |
**totalResultSize** | **Integer** | |


Expand Down
11 changes: 11 additions & 0 deletions docs/InlineResponse20029.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# InlineResponse20029

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List&lt;Role&gt;**](Role.md) | |
**totalResultSize** | **Integer** | |



Loading