Skip to content

update 13.0.0 #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Neokil merged 1 commit into from
Jul 10, 2025
Merged

update 13.0.0 #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 64 additions & 7 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

4,569 changes: 3,568 additions & 1,001 deletions api/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
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 = '12.0.0'
version = '13.0.0'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
View file
Open in desktop
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 := "12.0.0",
version := "13.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
2 changes: 1 addition & 1 deletion docs/Account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**companyName** | **String** | |
Expand Down
2 changes: 1 addition & 1 deletion docs/AccountAdditionalCost.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**accountId** | **Long** | The ID of the account that owns this entity. |
**name** | **String** | The internal name used in API requests. |
Expand Down
2 changes: 2 additions & 0 deletions docs/AccountLimits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Name | Type | Description | Notes
**users** | **Long** | Total number of allowed users in the account. |
**apiVolume** | **Long** | Allowed volume of API requests to the account. |
**promotionTypes** | **List<String>** | Array of promotion types that are employed in the account. |
**secondaryDeploymentPrice** | **Long** | The price for a secondary deployment according to contractual agreements. |
**currencyCode** | **String** | The currency of the contract. |



5 changes: 3 additions & 2 deletions docs/Achievement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**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]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [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. | [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]
Expand All @@ -32,6 +32,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



Expand Down
3 changes: 2 additions & 1 deletion docs/AchievementBase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**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]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [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. | [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]
Expand All @@ -25,6 +25,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



Expand Down
3 changes: 2 additions & 1 deletion docs/AchievementProgressWithDefinition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**description** | **String** | The description of the achievement in the Campaign Manager. |
**campaignId** | **Long** | The ID of the campaign the achievement belongs to. |
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**achievementRecurrencePolicy** | [**AchievementRecurrencePolicyEnum**](#AchievementRecurrencePolicyEnum) | 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. |
**achievementRecurrencePolicy** | [**AchievementRecurrencePolicyEnum**](#AchievementRecurrencePolicyEnum) | 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. |
**achievementActivationPolicy** | [**AchievementActivationPolicyEnum**](#AchievementActivationPolicyEnum) | 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. |
**achievementFixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
**achievementEndDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
Expand All @@ -42,6 +42,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



Expand Down
5 changes: 3 additions & 2 deletions docs/AchievementStatusEntry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**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]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [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. | [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]
Expand All @@ -30,6 +30,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
ON_COMPLETION | "on_completion"



Expand Down
14 changes: 14 additions & 0 deletions docs/AddPriceAdjustmentCatalogAction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AddPriceAdjustmentCatalogAction

The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sku** | **String** | The SKU of the item for which the price is being adjusted. |
**adjustments** | [**List<NewPriceAdjustment>**](NewPriceAdjustment.md) | A list of adjustments to apply to a given item. |



24 changes: 24 additions & 0 deletions docs/AddedDeductedPointsBalancesNotificationPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@


# AddedDeductedPointsBalancesNotificationPolicy

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
**scopes** | [**List<ScopesEnum>**](#List<ScopesEnum>) | |



## Enum: List<ScopesEnum>

Name | Value
---- | -----
ALL | "all"
CAMPAIGN_MANAGER | "campaign_manager"
MANAGEMENT_API | "management_api"
RULE_ENGINE | "rule_engine"



52 changes: 52 additions & 0 deletions docs/AddedDeductedPointsNotification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@


# AddedDeductedPointsNotification

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profileIntegrationID** | **String** | The integration ID of the customer profile to whom points were added or deducted. |
**loyaltyProgramID** | **Long** | The ID of the loyalty program. |
**subledgerID** | **String** | The ID of the subledger within the loyalty program where these points were added. |
**amount** | [**BigDecimal**](BigDecimal.md) | The amount of added or deducted loyalty points. |
**reason** | **String** | The reason for the points addition or deduction. |
**typeOfChange** | [**TypeOfChangeEnum**](#TypeOfChangeEnum) | The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: - [The Campaign Manager](/docs/product/getting-started) - [Management API](/management-api#tag/Loyalty) - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) |
**employeeName** | **String** | The name of the employee who added or deducted points. |
**userID** | **Long** | The ID of the employee who added or deducted points. |
**operation** | [**OperationEnum**](#OperationEnum) | The action (addition or deduction) 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]
**sessionIntegrationID** | **String** | The integration ID of the session through which the points were earned or lost. |
**notificationType** | [**NotificationTypeEnum**](#NotificationTypeEnum) | The type of notification. |



## Enum: TypeOfChangeEnum

Name | Value
---- | -----
CAMPAIGN_MANAGER | "campaign_manager"
RULE_ENGINE | "rule_engine"
MANAGEMENT_API | "management_api"



## Enum: OperationEnum

Name | Value
---- | -----
ADDITION | "addition"
DEDUCTION | "deduction"



## Enum: NotificationTypeEnum

Name | Value
---- | -----
LOYALTYPOINTSDEDUCTED | "LoyaltyPointsDeducted"
LOYALTYPOINTSADDED | "LoyaltyPointsAdded"



2 changes: 1 addition & 1 deletion docs/Application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**accountId** | **Long** | The ID of the account that owns this entity. |
Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationCIF.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**name** | **String** | The name of the Application cart item filter used in API requests. |
**description** | **String** | A short description of the Application cart item filter. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationCIFExpression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | Internal ID of this entity. |
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**cartItemFilterId** | **Long** | The ID of the Application cart item filter. | [optional]
**createdBy** | **Long** | The ID of the user who created the Application cart item filter. | [optional]
Expand Down
Loading
Loading