Skip to content

Commit b74051f

Browse files
giou-kgiou-k
committed
Merge pull request #37 from talon-one/v5.0.3
v5.0.3: Fix issue with FrontendStateEnum and StateEnum for campaign notifications
1 parent 1eeb4a3 commit b74051f

File tree

272 files changed

+20918
-2963
lines changed

Some content is hidden

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

272 files changed

+20918
-2963
lines changed

‎README.md‎

Lines changed: 36 additions & 18 deletions
Large diffs are not rendered by default.

‎api/openapi.yaml‎

Lines changed: 3761 additions & 1036 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 = '5.0.2'
6+
version = '5.0.3'
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 := "5.0.2",
5+
version := "5.0.3",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

‎docs/AddLoyaltyPoints.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
1010
**points** | [**BigDecimal**](BigDecimal.md) | Amount of loyalty points. |
1111
**name** | **String** | Name / reason for the point addition. | [optional]
12-
**validityDuration** | **String** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. If passed, `validUntil` should be omitted. | [optional]
12+
**validityDuration** | **String** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted. | [optional]
1313
**validUntil** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional]
14-
**pendingDuration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. | [optional]
14+
**pendingDuration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
1515
**pendingUntil** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional]
1616
**subledgerId** | **String** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional]
1717
**applicationId** | **Integer** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional]

‎docs/AdditionalCampaignProperties.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
3+
# AdditionalCampaignProperties
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**couponRedemptionCount** | **Integer** | Number of coupons redeemed in the campaign. | [optional]
10+
**referralRedemptionCount** | **Integer** | Number of referral codes redeemed in the campaign. | [optional]
11+
**discountCount** | [**BigDecimal**](BigDecimal.md) | Total amount of discounts redeemed in the campaign. | [optional]
12+
**discountEffectCount** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional]
13+
**couponCreationCount** | **Integer** | Total number of coupons created by rules in this campaign. | [optional]
14+
**customEffectCount** | **Integer** | Total number of custom effects triggered by rules in this campaign. | [optional]
15+
**referralCreationCount** | **Integer** | Total number of referrals created by rules in this campaign. | [optional]
16+
**addFreeItemEffectCount** | **Integer** | Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional]
17+
**awardedGiveawaysCount** | **Integer** | Total number of giveaways awarded by rules in this campaign. | [optional]
18+
**createdLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | Total number of loyalty points created by rules in this campaign. | [optional]
19+
**createdLoyaltyPointsEffectCount** | **Integer** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
20+
**redeemedLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | Total number of loyalty points redeemed by rules in this campaign. | [optional]
21+
**redeemedLoyaltyPointsEffectCount** | **Integer** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
22+
**callApiEffectCount** | **Integer** | Total number of webhooks triggered by rules in this campaign. | [optional]
23+
**reservecouponEffectCount** | **Integer** | Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
24+
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received by this campaign. | [optional]
25+
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional]
26+
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
27+
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
28+
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
29+
30+
31+

‎docs/Application.md‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ Name | Type | Description | Notes
1818
**caseSensitivity** | [**CaseSensitivityEnum**](#CaseSensitivityEnum) | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional]
1919
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
2020
**limits** | [**List<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional]
21-
**campaignPriority** | [**CampaignPriorityEnum**](#CampaignPriorityEnum) | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional]
22-
**exclusiveCampaignsStrategy** | [**ExclusiveCampaignsStrategyEnum**](#ExclusiveCampaignsStrategyEnum) | The strategy used when choosing exclusive campaigns for evaluation. | [optional]
2321
**defaultDiscountScope** | [**DefaultDiscountScopeEnum**](#DefaultDiscountScopeEnum) | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional]
2422
**enableCascadingDiscounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional]
25-
**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening). | [optional]
23+
**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). | [optional]
2624
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
2725
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
2826
**enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
2927
**defaultDiscountAdditionalCostPerItemScope** | [**DefaultDiscountAdditionalCostPerItemScopeEnum**](#DefaultDiscountAdditionalCostPerItemScopeEnum) | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
28+
**defaultEvaluationGroupId** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional]
3029
**loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. |
3130

3231

@@ -41,26 +40,6 @@ INSENSITIVE_LOWERCASE | "insensitive-lowercase"
4140

4241

4342

44-
## Enum: CampaignPriorityEnum
45-
46-
Name | Value
47-
---- | -----
48-
UNIVERSAL | "universal"
49-
STACKABLE | "stackable"
50-
EXCLUSIVE | "exclusive"
51-
52-
53-
54-
## Enum: ExclusiveCampaignsStrategyEnum
55-
56-
Name | Value
57-
---- | -----
58-
LISTORDER | "listOrder"
59-
LOWESTDISCOUNT | "lowestDiscount"
60-
HIGHESTDISCOUNT | "highestDiscount"
61-
62-
63-
6443
## Enum: DefaultDiscountScopeEnum
6544

6645
Name | Value

‎docs/ApplicationNotification.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**event** | **String** | Event type. It can be one of the following: ['campaign_priorities_changed'] |
9+
**event** | **String** | Event type. It can be one of the following: ['campaign_evaluation_tree_changed'] |
1010

1111

1212

‎docs/BaseCampaign.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
3+
# BaseCampaign
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**name** | **String** | A user-facing name for this campaign. |
10+
**description** | **String** | A detailed description of the campaign. | [optional]
11+
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become active. | [optional]
12+
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
13+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
14+
**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. |
15+
**activeRulesetId** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
16+
**tags** | **List<String>** | A list of tags for the campaign. |
17+
**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. |
18+
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
19+
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
20+
**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
21+
**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
22+
23+
24+
25+
## Enum: StateEnum
26+
27+
Name | Value
28+
---- | -----
29+
ENABLED | "enabled"
30+
DISABLED | "disabled"
31+
ARCHIVED | "archived"
32+
33+
34+
35+
## Enum: List<FeaturesEnum>
36+
37+
Name | Value
38+
---- | -----
39+
COUPONS | "coupons"
40+
REFERRALS | "referrals"
41+
LOYALTY | "loyalty"
42+
GIVEAWAYS | "giveaways"
43+
STRIKETHROUGH | "strikethrough"
44+
45+
46+

‎docs/BaseCampaignForNotification.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
3+
# BaseCampaignForNotification
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**name** | **String** | A user-facing name for this campaign. |
10+
**description** | **String** | A detailed description of the campaign. | [optional]
11+
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become active. | [optional]
12+
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
13+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
14+
**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. |
15+
**activeRulesetId** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
16+
**tags** | **List<String>** | A list of tags for the campaign. |
17+
**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. |
18+
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
19+
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
20+
**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
21+
**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
22+
23+
24+
25+
## Enum: StateEnum
26+
27+
Name | Value
28+
---- | -----
29+
ENABLED | "enabled"
30+
DISABLED | "disabled"
31+
ARCHIVED | "archived"
32+
DRAFT | "draft"
33+
SCHEDULED | "scheduled"
34+
RUNNING | "running"
35+
EXPIRED | "expired"
36+
37+
38+
39+
## Enum: List<FeaturesEnum>
40+
41+
Name | Value
42+
---- | -----
43+
COUPONS | "coupons"
44+
REFERRALS | "referrals"
45+
LOYALTY | "loyalty"
46+
GIVEAWAYS | "giveaways"
47+
STRIKETHROUGH | "strikethrough"
48+
49+
50+

0 commit comments

Comments
 (0)