Skip to content

Commit

Permalink
Update SDK (#43)
Browse files Browse the repository at this point in the history
* Update SDK

* Modify api sample in README
  • Loading branch information
rubyjohn93 committed May 24, 2024
1 parent 2b5723e commit cf95673
Show file tree
Hide file tree
Showing 365 changed files with 22,017 additions and 4,826 deletions.
65 changes: 57 additions & 8 deletions README.md

Large diffs are not rendered by default.

4,153 changes: 2,894 additions & 1,259 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 = '6.0.1'
version = '7.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 := "6.0.1",
version := "7.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 0 additions & 1 deletion docs/AccountDashboardStatistic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Name | Type | Description | Notes
**discounts** | [**List<AccountDashboardStatisticDiscount>**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional]
**loyaltyPoints** | [**List<AccountDashboardStatisticLoyaltyPoints>**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional]
**referrals** | [**List<AccountDashboardStatisticReferrals>**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional]
**apiCalls** | [**List<AccountDashboardStatisticApiCalls>**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional]
**campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | |


Expand Down
6 changes: 4 additions & 2 deletions docs/Achievement.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ 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. |
**title** | **String** | The display name for the achievement in the Campaign Manager. |
**description** | **String** | A description of the achievement. |
**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. |
**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. |
**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. |
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
**userId** | **Integer** | 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. |
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]



2 changes: 2 additions & 0 deletions docs/AchievementAdditionalProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
**userId** | **Integer** | 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. |
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]



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


# AchievementProgress

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**achievementId** | **Integer** | The internal ID of the achievement. |
**name** | **String** | The internal name of the achievement used in API requests. |
**title** | **String** | The display name of the achievement in the Campaign Manager. |
**campaignId** | **Integer** | The ID of the campaign the achievement belongs to. |
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**progress** | [**BigDecimal**](BigDecimal.md) | The current progress of the customer in the achievement. |
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the customer started the achievement. |
**completionDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the customer completed the achievement. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the achievement ends and resets for the customer. |



## Enum: StatusEnum

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



5 changes: 3 additions & 2 deletions docs/AddItemCatalogAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

# AddItemCatalogAction

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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sku** | **String** | The unique SKU of the item to add. |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. | [optional]
**attributes** | [**Object**](.md) | The attributes of the item to add. | [optional]
**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional]
**product** | [**Product**](Product.md) | | [optional]
**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]



12 changes: 12 additions & 0 deletions docs/AdditionalCampaignProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,18 @@ Name | Type | Description | Notes
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
**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. |



## Enum: FrontendStateEnum

Name | Value
---- | -----
EXPIRED | "expired"
SCHEDULED | "scheduled"
RUNNING | "running"
DRAFT | "draft"



14 changes: 12 additions & 2 deletions docs/ApplicationAPIKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Title for API Key. |
**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expired. |
**title** | **String** | Title of the API key. |
**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expires. |
**platform** | [**PlatformEnum**](#PlatformEnum) | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. | [optional]
**timeOffset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. | [optional]
**id** | **Integer** | ID of the API Key. |
**createdBy** | **Integer** | ID of user who created. |
**accountID** | **Integer** | ID of account the key is used for. |
Expand All @@ -35,3 +37,11 @@ EMARSYS | "emarsys"



## Enum: TypeEnum

Name | Value
---- | -----
STAGING | "staging"



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


# ApplicationAnalyticsDataPoint

## Properties

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]
**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]



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


# ApplicationAnalyticsDataPointAvgItemsPerSession

The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationAnalyticsDataPointAvgSessionValue

The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationAnalyticsDataPointSessionsCount

The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationAnalyticsDataPointTotalRevenue

The total, pre-discount value of all items purchased in a customer session.
## Properties

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



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


# ApplicationCampaignAnalytics

## Properties

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]



## Enum: CampaignStateEnum

Name | Value
---- | -----
ENABLED | "enabled"
DISABLED | "disabled"
ARCHIVED | "archived"



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


# ApplicationCampaignAnalyticsAvgItemsPerSession

The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationCampaignAnalyticsAvgSessionValue

The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationCampaignAnalyticsCouponsCount

The number of times a coupon was successfully redeemed in influenced sessions.
## Properties

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



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


# ApplicationCampaignAnalyticsSessionsCount

The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect.
## Properties

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



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


# ApplicationCampaignAnalyticsTotalDiscounts

The total value of discounts given for cart items in influenced sessions.
## Properties

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



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


# ApplicationCampaignAnalyticsTotalRevenue

The total, pre-discount value of all items purchased in a customer session.
## Properties

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



2 changes: 1 addition & 1 deletion docs/ApplicationCustomer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** 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. |
**sandbox** | **Boolean** | Shows 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]
**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
4 changes: 2 additions & 2 deletions docs/AudienceAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

# AudienceAnalytics

The audiences and their members count.
The audiences and their member count.
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**audienceId** | **Integer** | The ID of the audience. | [optional]
**membersCount** | **Integer** | The count of members under a single audience. | [optional]
**membersCount** | **Integer** | The member count of the audience. | [optional]



Loading

0 comments on commit cf95673

Please sign in to comment.