Skip to content
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

Jump to bottom

DO NOT MERGE (openapi 3 sdk update) #46

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

DO NOT MERGE (openapi 3 sdk update) #46

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
195 changes: 70 additions & 125 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

2,260 changes: 1,843 additions & 417 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 = '8.0.0'
version = '9.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 := "8.0.0",
version := "9.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 1 addition & 0 deletions docs/AdditionalCampaignProperties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Name | Type | Description | Notes
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |



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


# AnalyticsDataPoint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | [**BigDecimal**](BigDecimal.md) | |
**influenced** | [**BigDecimal**](BigDecimal.md) | |



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


# AnalyticsDataPointWithTrend

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**BigDecimal**](BigDecimal.md) | |
**trend** | [**BigDecimal**](BigDecimal.md) | |



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


# AnalyticsDataPointWithTrendAndInfluencedRate

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**BigDecimal**](BigDecimal.md) | |
**influencedRate** | [**BigDecimal**](BigDecimal.md) | |
**trend** | [**BigDecimal**](BigDecimal.md) | |



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


# AnalyticsDataPointWithTrendAndUplift

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**BigDecimal**](BigDecimal.md) | |
**uplift** | [**BigDecimal**](BigDecimal.md) | |
**trend** | [**BigDecimal**](BigDecimal.md) | |



12 changes: 6 additions & 6 deletions docs/ApplicationAnalyticsDataPoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | [optional]
**totalRevenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) | | [optional]
**sessionsCount** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) | | [optional]
**avgItemsPerSession** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) | | [optional]
**avgSessionValue** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) | | [optional]
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. |
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. |
**totalRevenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**sessionsCount** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**avgItemsPerSession** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**avgSessionValue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**totalDiscounts** | [**BigDecimal**](BigDecimal.md) | The total value of discounts given for cart items in influenced sessions. | [optional]
**couponsCount** | [**BigDecimal**](BigDecimal.md) | The number of times a coupon was successfully redeemed in influenced sessions. | [optional]

Expand Down
32 changes: 16 additions & 16 deletions docs/ApplicationCampaignAnalytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | [optional]
**campaignId** | **Integer** | The ID of the campaign. | [optional]
**campaignName** | **String** | The name of the campaign. | [optional]
**campaignTags** | **List<String>** | A list of tags for the campaign. | [optional]
**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | [optional]
**campaignActiveRulesetId** | **Integer** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**campaignStartTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes active. | [optional]
**campaignEndTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes inactive. | [optional]
**totalRevenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) | | [optional]
**sessionsCount** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) | | [optional]
**avgItemsPerSession** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) | | [optional]
**avgSessionValue** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) | | [optional]
**totalDiscounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) | | [optional]
**couponsCount** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) | | [optional]
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. |
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. |
**campaignId** | **Integer** | The ID of the campaign. |
**campaignName** | **String** | The name of the campaign. |
**campaignTags** | **List<String>** | A list of tags for the campaign. |
**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
**totalRevenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**sessionsCount** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**avgItemsPerSession** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**avgSessionValue** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**totalDiscounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
**couponsCount** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]



## Enum: CampaignStateEnum

Name | Value
---- | -----
ENABLED | "enabled"
EXPIRED | "expired"
SCHEDULED | "scheduled"
RUNNING | "running"
DRAFT | "draft"
DISABLED | "disabled"
ARCHIVED | "archived"

Expand Down
1 change: 0 additions & 1 deletion docs/Attribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Name | Type | Description | Notes

Name | Value
---- | -----
ACCOUNT | "Account"
APPLICATION | "Application"
CAMPAIGN | "Campaign"
CUSTOMERPROFILE | "CustomerProfile"
Expand Down
28 changes: 16 additions & 12 deletions docs/BaseLoyaltyProgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,42 @@ Name | Type | Description | Notes
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
**usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. - `customer_attribute`: The tier expiration date is calculated based on a custom customer attribute. - `absolute_expiration`: The tier expires on a specified date and time. **Note**: For absolute expiration, it is required to provide a `tiersStartDate.` | [optional]
**tiersStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the tier starts for all customers. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. | [optional]
**tiersExpireIn** | **String** | The amount of time after which the tier expires. The time format is an **integer** 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 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]
**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]



## Enum: TiersExpirationPolicyEnum
## Enum: ProgramJoinPolicyEnum

Name | Value
---- | -----
TIER_START_DATE | "tier_start_date"
PROGRAM_JOIN_DATE | "program_join_date"
NOT_JOIN | "not_join"
POINTS_ACTIVATED | "points_activated"
POINTS_EARNED | "points_earned"



## Enum: TiersDowngradePolicyEnum
## Enum: TiersExpirationPolicyEnum

Name | Value
---- | -----
ONE_DOWN | "one_down"
BALANCE_BASED | "balance_based"
TIER_START_DATE | "tier_start_date"
PROGRAM_JOIN_DATE | "program_join_date"
CUSTOMER_ATTRIBUTE | "customer_attribute"
ABSOLUTE_EXPIRATION | "absolute_expiration"



## Enum: ProgramJoinPolicyEnum
## Enum: TiersDowngradePolicyEnum

Name | Value
---- | -----
NOT_JOIN | "not_join"
POINTS_ACTIVATED | "points_activated"
POINTS_EARNED | "points_earned"
ONE_DOWN | "one_down"
BALANCE_BASED | "balance_based"



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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**policy** | [**Object**](.md) | |
**policy** | [**Object**](.md) | Indicates which notification properties to apply. |
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional]
**webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
**id** | **Integer** | Unique ID for this entity. |
Expand All @@ -21,6 +21,7 @@ Name | Value
---- | -----
CAMPAIGN | "campaign"
LOYALTY_ADDED_DEDUCTED_POINTS | "loyalty_added_deducted_points"
CARD_ADDED_DEDUCTED_POINTS | "card_added_deducted_points"
COUPON | "coupon"
EXPIRING_COUPONS | "expiring_coupons"
EXPIRING_POINTS | "expiring_points"
Expand Down
2 changes: 1 addition & 1 deletion docs/BaseNotificationEntity.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
------------ | ------------- | ------------- | -------------
**policy** | [**Object**](.md) | |
**policy** | [**Object**](.md) | Indicates which notification properties to apply. |
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional]


Expand Down
1 change: 1 addition & 0 deletions docs/Campaign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Name | Type | Description | Notes
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |



Expand Down
1 change: 1 addition & 0 deletions docs/CampaignNotificationPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]



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


# CardAddedDeductedPointsNotificationPolicy

## 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"



2 changes: 1 addition & 1 deletion docs/CodeGeneratorSettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**validCharacters** | **List<String>** | List of characters used to generate the random parts of a code. |
**couponPattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. |
**couponPattern** | **String** | The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. |



2 changes: 2 additions & 0 deletions docs/Effect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Name | Type | Description | Notes
**triggeredByCoupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
**triggeredForCatalogItem** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
**conditionIndex** | **Integer** | The index of the condition that was triggered. | [optional]
**evaluationGroupID** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
**evaluationGroupMode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
**props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |


Expand Down
2 changes: 2 additions & 0 deletions docs/EffectEntity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Name | Type | Description | Notes
**triggeredByCoupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
**triggeredForCatalogItem** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
**conditionIndex** | **Integer** | The index of the condition that was triggered. | [optional]
**evaluationGroupID** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
**evaluationGroupMode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]



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


# GenerateCampaignDescription

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignID** | **Integer** | ID of the campaign. |
**currency** | **String** | Currency for the campaign. |



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


# GenerateCampaignTags

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignID** | **Integer** | ID of the campaign. |



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


# GenerateItemFilterDescription

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**itemFilter** | **List<Object>** | An array of item filter Talang expressions. |



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


# GenerateRuleTitle

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rule** | [**GenerateRuleTitleRule**](GenerateRuleTitleRule.md) | |
**currency** | **String** | Currency for the campaign. |



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


# GenerateRuleTitleRule

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**effects** | **List<Object>** | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | [optional]
**condition** | **List<Object>** | A Talang expression that will be evaluated in the context of the given event. | [optional]



Loading