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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
71 changes: 53 additions & 18 deletions README.md

Large diffs are not rendered by default.

4,523 changes: 3,427 additions & 1,096 deletions api/openapi.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'java'

group = 'one.talon'
version = '14.3.0'
version = '15.0.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 := "14.3.0",
version := "15.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
26 changes: 26 additions & 0 deletions docs/AchievementAdditionalPropertiesV2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@


# AchievementAdditionalPropertiesV2

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**userId** | **Long** | The ID of the user that created this achievement. |
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional]



## Enum: StatusEnum

Name | Value
---- | -----
INPROGRESS | "inprogress"
EXPIRED | "expired"
NOT_STARTED | "not_started"
COMPLETED | "completed"



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


# AchievementBaseV2

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | [optional]
**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional]
**description** | **String** | A description of the achievement. | [optional]
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** 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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
**allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | [optional]
**subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | [optional]
**timezone** | **String** | A string containing an IANA timezone descriptor. | [optional]



## Enum: RecurrencePolicyEnum

Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



## Enum: ActivationPolicyEnum

Name | Value
---- | -----
USER_ACTION | "user_action"
FIXED_SCHEDULE | "fixed_schedule"



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


# AchievementReference

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**achievementId** | **Long** | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievementsV2) endpoint. |
**applicationId** | **Long** | The ID of the Application associated with the campaign that references this achievement. |
**applicationName** | **String** | The name of the Application associated with the campaign that references this achievement. |
**campaignId** | **Long** | The ID of the campaign that references this achievement. |



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


# AchievementV2

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
**title** | **String** | The display name for the achievement in the Campaign Manager. |
**description** | **String** | A description of the achievement. |
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** 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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
**allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |
**subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. |
**timezone** | **String** | A string containing an IANA timezone descriptor. |
**userId** | **Long** | The ID of the user that created this achievement. |
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional]



## Enum: RecurrencePolicyEnum

Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



## Enum: ActivationPolicyEnum

Name | Value
---- | -----
USER_ACTION | "user_action"
FIXED_SCHEDULE | "fixed_schedule"



## Enum: StatusEnum

Name | Value
---- | -----
INPROGRESS | "inprogress"
EXPIRED | "expired"
NOT_STARTED | "not_started"
COMPLETED | "completed"



2 changes: 1 addition & 1 deletion docs/ActivateLoyaltyPoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Activate loyalty points

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transactionUUIDs** | [**List<UUID>**](UUID.md) | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional]
**transactionUUIDs** | [**List<UUID>**](UUID.md) | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional]
**sessionId** | **String** | The ID of the session containing the pending point transactions to activate. If provided, do not include the `transactionUUIDs` parameter. | [optional]


Expand Down
2 changes: 1 addition & 1 deletion docs/AddLoyaltyPointsEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**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) | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional]
**cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional]
**cardIdentifier** | **String** | The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. | [optional]
**bundleIndex** | **Long** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
**bundleName** | **String** | The name of the bundle definition. | [optional]
**awaitsActivation** | **Boolean** | If `true`, the loyalty points remain pending until a specific action is complete. The `startDate` parameter automatically sets to `on_action`. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/AddPriceAdjustmentCatalogAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# AddPriceAdjustmentCatalogAction

The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action. **Note:** You can only use this object if the `Beta` **price types** feature is enabled for your Application. To enable it, contact your Technical Account Manager.
## Properties

Name | Type | Description | Notes
Expand Down
5 changes: 3 additions & 2 deletions docs/AddedDeductedPointsBalancesAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | [**BigDecimal**](BigDecimal.md) | The amount of added or deducted loyalty points. |
**reason** | **String** | The reason for the points addition or deduction. |
**operation** | [**OperationEnum**](#OperationEnum) | The action (addition or deduction) made with loyalty points. |
**operation** | [**OperationEnum**](#OperationEnum) | The action (addition or subtraction) made with loyalty points. |
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | The start date for loyalty points. | [optional]
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | The expiration date for loyalty points. | [optional]
**transactionUUID** | [**UUID**](UUID.md) | The identifier of the transaction in the loyalty ledger. |



Expand All @@ -19,7 +20,7 @@ Name | Type | Description | Notes
Name | Value
---- | -----
ADDITION | "addition"
DEDUCTION | "deduction"
SUBTRACTION | "subtraction"



5 changes: 3 additions & 2 deletions docs/AddedDeductedPointsNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ Name | Type | Description | Notes
**userID** | **Long** | The ID of the employee who added or deducted points. |
**amount** | [**BigDecimal**](BigDecimal.md) | The amount of added or deducted loyalty points. |
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | The expiration date for loyalty points. | [optional]
**operation** | [**OperationEnum**](#OperationEnum) | The action (addition or deduction) made with loyalty points. |
**operation** | [**OperationEnum**](#OperationEnum) | The action (addition or subtraction) made with loyalty points. |
**reason** | **String** | The reason for the points addition or deduction. |
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | The start date for loyalty points. | [optional]
**transactionUUID** | [**UUID**](UUID.md) | The identifier of the transaction in the loyalty ledger. |



Expand Down Expand Up @@ -46,7 +47,7 @@ MANAGEMENT_API | "management_api"
Name | Value
---- | -----
ADDITION | "addition"
DEDUCTION | "deduction"
SUBTRACTION | "subtraction"



2 changes: 1 addition & 1 deletion docs/ApplicationApiHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Report of health of the API connection of an application.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**summary** | [**SummaryEnum**](#SummaryEnum) | One-word summary of the health of the API connection of an application. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 50 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. |
**summary** | [**SummaryEnum**](#SummaryEnum) | One-word summary of the health of the API connection of an application. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 5 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. |
**lastUsed** | [**OffsetDateTime**](OffsetDateTime.md) | time of last request relevant to the API health test. |


Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationCustomer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Name | Type | Description | Notes
**totalSales** | [**BigDecimal**](BigDecimal.md) | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**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. |
**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#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. |
**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
**advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional]

Expand Down
Loading
Loading