Skip to content

Commit cf95673

Browse files
authored
Update SDK (#43)
* Update SDK * Modify api sample in README
1 parent 2b5723e commit cf95673

File tree

365 files changed

+22017
-4826
lines changed

Some content is hidden

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

365 files changed

+22017
-4826
lines changed

README.md

Lines changed: 57 additions & 8 deletions
Large diffs are not rendered by default.

api/openapi.yaml

Lines changed: 2894 additions & 1259 deletions
Large diffs are not rendered by default.

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
33
apply plugin: 'java'
44

55
group = 'one.talon'
6-
version = '6.0.1'
6+
version = '7.0.0'
77

88
buildscript {
99
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 := "6.0.1",
5+
version := "7.0.0",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AccountDashboardStatistic.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
1010
**discounts** | [**List<AccountDashboardStatisticDiscount>**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional]
1111
**loyaltyPoints** | [**List<AccountDashboardStatisticLoyaltyPoints>**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional]
1212
**referrals** | [**List<AccountDashboardStatisticReferrals>**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional]
13-
**apiCalls** | [**List<AccountDashboardStatisticApiCalls>**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional]
1413
**campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | |
1514

1615

docs/Achievement.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ Name | Type | Description | Notes
1212
**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. |
1313
**title** | **String** | The display name for the achievement in the Campaign Manager. |
1414
**description** | **String** | A description of the achievement. |
15-
**target** | [**BigDecimal**](BigDecimal.md) | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. |
16-
**period** | **String** | The relative duration after which the achievement is reset 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. |
15+
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
16+
**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. |
1717
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
18+
**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
1819
**userId** | **Integer** | ID of the user that created this achievement. |
1920
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
21+
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
2022

2123

2224

docs/AchievementAdditionalProperties.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9+
**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
910
**userId** | **Integer** | ID of the user that created this achievement. |
1011
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
12+
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
1113

1214

1315

docs/AchievementProgress.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
3+
# AchievementProgress
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**achievementId** | **Integer** | The internal ID of the achievement. |
10+
**name** | **String** | The internal name of the achievement used in API requests. |
11+
**title** | **String** | The display name of the achievement in the Campaign Manager. |
12+
**campaignId** | **Integer** | The ID of the campaign the achievement belongs to. |
13+
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |
14+
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
15+
**progress** | [**BigDecimal**](BigDecimal.md) | The current progress of the customer in the achievement. |
16+
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the customer started the achievement. |
17+
**completionDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the customer completed the achievement. | [optional]
18+
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the achievement ends and resets for the customer. |
19+
20+
21+
22+
## Enum: StatusEnum
23+
24+
Name | Value
25+
---- | -----
26+
INPROGRESS | "inprogress"
27+
COMPLETED | "completed"
28+
EXPIRED | "expired"
29+
30+
31+

docs/AddItemCatalogAction.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
# AddItemCatalogAction
44

5-
The specific properties of the \"ADD\" catalog sync action.
5+
The specific properties of the \"ADD\" catalog sync action.
66
## Properties
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
1010
**sku** | **String** | The unique SKU of the item to add. |
1111
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. | [optional]
1212
**attributes** | [**Object**](.md) | The attributes of the item to add. | [optional]
13-
**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional]
13+
**product** | [**Product**](Product.md) | | [optional]
14+
**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. **Note**: When set to `true`: - If you do not provide a new `price` value, the existing `price` value is retained. - If you do not provide a new `product` value, the `product` value is set to `null`. | [optional]
1415

1516

1617

docs/AdditionalCampaignProperties.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ Name | Type | Description | Notes
2727
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
2828
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
2929
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
30+
**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. |
31+
32+
33+
34+
## Enum: FrontendStateEnum
35+
36+
Name | Value
37+
---- | -----
38+
EXPIRED | "expired"
39+
SCHEDULED | "scheduled"
40+
RUNNING | "running"
41+
DRAFT | "draft"
3042

3143

3244

0 commit comments

Comments
 (0)