Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 34 additions & 9 deletions README.md

Large diffs are not rendered by default.

7,431 changes: 5,086 additions & 2,345 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 = '14.2.0'
version = '14.3.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 := "14.2.0",
version := "14.3.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 1 addition & 0 deletions docs/Attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ CARTITEM | "CartItem"
COUPON | "Coupon"
EVENT | "Event"
GIVEAWAY | "Giveaway"
LOYALTYCARD | "LoyaltyCard"
REFERRAL | "Referral"
STORE | "Store"

Expand Down
3 changes: 2 additions & 1 deletion docs/BestPriorPrice.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | The ID of the historical price. |
**sku** | **String** | sku |
**observedAt** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the best price was observed. |
**observedAt** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the price was observed. |
**contextId** | **String** | The context ID of the context active at the time of observation. |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. |
**metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | |
Expand Down
13 changes: 12 additions & 1 deletion docs/BestPriorPriceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,19 @@ Name | Type | Description | Notes
**skus** | **List<String>** | List of product SKUs to check when determining the best prior price. |
**timeframeEndDate** | [**OffsetDateTime**](OffsetDateTime.md) | The end date and time that defines the latest time for retrieving historical SKU prices. |
**timeframe** | **String** | The number of days prior to the timeframeEndDate. Only prices within this look back period are considered for the best prior price evaluation. |
**strictEndDate** | **Boolean** | Indicates whether the timeframe includes the start of the current sale. - When `false`, the timeframe includes the start date of the current sale. - When `true`, the timeframe striclty uses the number of days specified in `timeframe`. |
**strictEndDate** | **Boolean** | This property is **deprecated**. Use `timeframeEndDateType` instead. Indicates whether the timeframe includes the start of the current sale. - When `false`, the timeframe includes the start date of the current sale. - When `true`, the timeframe strictly uses the number of days specified in `timeframe`. |
**timeframeEndDateType** | [**TimeframeEndDateTypeEnum**](#TimeframeEndDateTypeEnum) | Sets the timeframe for retrieving historical pricing data. Can be one of the following values: - `strict`: The timeframe ends at the `timeframeEndDate` value. - `price`: The timeframe ends at the start of the current `contextId` with the current price value. Identical price records are merged. If there is no `contextId` for the most recent price, the most recent timestamp for the price is used. - `sale`: The timeframe ends at the start of current `contextId` and takes the prices prior to the start of the `contextId` into account. | [optional]
**target** | [**BestPriorTarget**](BestPriorTarget.md) | | [optional]



## Enum: TimeframeEndDateTypeEnum

Name | Value
---- | -----
STRICT | "strict"
PRICE | "price"
SALE | "sale"



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


# Blueprint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | The internal ID of this blueprint. |
**accountId** | **Long** | The ID of the account that owns this blueprint. |
**applicationId** | **Long** | The ID of the Application that owns this blueprint. |
**title** | **String** | A short description of the blueprint. |
**description** | **String** | A longer, more detailed description of the blueprint. | [optional]
**category** | [**CategoryEnum**](#CategoryEnum) | Category used to group blueprints. |
**source** | [**SourceEnum**](#SourceEnum) | Indicates whether the blueprint is custom or shipped by Talon.One. |
**rules** | [**List<CatalogRule>**](CatalogRule.md) | Array of rule templates in this blueprint. Rules only contain title (no description, as description is at the blueprint level). |
**cartItemFilters** | [**List<CartItemFilterTemplate>**](CartItemFilterTemplate.md) | Array of cart item filter templates in this blueprint. Cart item filters only contain name (no description, as description is at the blueprint level). |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the blueprint was created. |
**createdBy** | **Long** | ID of the user who created the blueprint. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the blueprint was last updated. | [optional]
**modifiedBy** | **Long** | ID of the user who last updated the blueprint. | [optional]



## Enum: CategoryEnum

Name | Value
---- | -----
PROMOTIONS | "promotions"
PRICING | "pricing"
LOYALTY | "loyalty"
CUSTOM | "custom"



## Enum: SourceEnum

Name | Value
---- | -----
CUSTOM | "custom"
DEFAULT | "default"



1 change: 1 addition & 0 deletions docs/CampaignCollectionEditedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**placeholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]
**collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.md) | |


Expand Down
1 change: 1 addition & 0 deletions docs/CampaignCreatedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**placeholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]
**evaluationPosition** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | |


Expand Down
1 change: 1 addition & 0 deletions docs/CampaignEditedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**campaign** | [**Campaign**](Campaign.md) | |
**oldCampaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**placeholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]



2 changes: 2 additions & 0 deletions docs/CampaignRulesetChangedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Name | Type | Description | Notes
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | [**Campaign**](Campaign.md) | |
**oldRuleset** | [**Ruleset**](Ruleset.md) | | [optional]
**oldPlaceholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The previous details of the placeholders before the ruleset was changed. | [optional]
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**placeholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]



1 change: 1 addition & 0 deletions docs/CampaignStateChangedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**oldState** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**newState** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**placeholders** | [**List<PlaceholderDetails>**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]



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


# CouponWithApplication

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | The internal ID of the coupon. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time the coupon was created. |
**campaignId** | **Long** | The ID of the campaign that owns this entity. |
**value** | **String** | The coupon code. |
**usageLimit** | **Long** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
**discountLimit** | [**BigDecimal**](BigDecimal.md) | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional]
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. | [optional]
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
**limits** | [**List<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
**usageCounter** | **Long** | The number of times the coupon has been successfully redeemed. |
**discountCounter** | [**BigDecimal**](BigDecimal.md) | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional]
**discountRemainder** | [**BigDecimal**](BigDecimal.md) | The remaining discount this coupon can give. | [optional]
**reservationCounter** | [**BigDecimal**](BigDecimal.md) | The number of times this coupon has been reserved. | [optional]
**attributes** | [**Object**](.md) | Custom attributes associated with this coupon. | [optional]
**referralId** | **Long** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
**recipientIntegrationId** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
**importId** | **Long** | The ID of the Import which created this coupon. | [optional]
**reservation** | **Boolean** | Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code. | [optional]
**batchId** | **String** | The id of the batch the coupon belongs to. | [optional]
**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional]
**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
**applicationId** | **Long** | The ID of the application. |
**applicationName** | **String** | Name of the Application that is connected to the coupon. |



2 changes: 1 addition & 1 deletion docs/CustomerProfileIntegrationRequestV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
**responseContent** | [**List<ResponseContentEnum>**](#List<ResponseContentEnum>) | Extends the response with the chosen data entities. Use this property to get as much data back as needed from one request instead of sending extra requests to other endpoints. | [optional]
**audiencesChanges** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
**responseContent** | [**List<ResponseContentEnum>**](#List<ResponseContentEnum>) | Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer profile_ request instead of sending extra requests to other endpoints. | [optional]



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


# EventAttributesEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. |
**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional]



5 changes: 3 additions & 2 deletions docs/Experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Name | Type | Description | Notes
**id** | **Long** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**applicationId** | **Long** | The ID of the Application that owns this entity. |
**isVariantAssignmentExternal** | **Boolean** | The source of the assignment. - false - The assignment to the variant is handled internally by the Talon.Oneandled internally by the Talon.One. - true - The assignment to the variant handled externally. | [optional]
**isVariantAssignmentExternal** | **Boolean** | The source of the assignment. - false - The variant assignment is handled internally by Talon.One. - true - The variant assignment is handled externally. | [optional]
**campaign** | [**Campaign**](Campaign.md) | | [optional]
**activated** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time the experiment was activated. | [optional]
**state** | [**StateEnum**](#StateEnum) | A disabled experiment is not evaluated for rules or coupons. | [optional]
**state** | [**StateEnum**](#StateEnum) | A disabled experiment is not evaluated for rules or coupons. |
**variants** | [**List<ExperimentVariant>**](ExperimentVariant.md) | | [optional]
**deletedat** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time the experiment was deleted. | [optional]

Expand All @@ -24,6 +24,7 @@ Name | Value
---- | -----
ENABLED | "enabled"
DISABLED | "disabled"
ARCHIVED | "archived"



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


# ExperimentCampaignCopy

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\"). | [optional]
**description** | **String** | A detailed description of the campaign. | [optional]
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become active. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
**tags** | **List<String>** | A list of tags for the campaign. | [optional]
**evaluationGroupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. | [optional]



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


# ExperimentCopy

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**targetApplicationId** | **Long** | The ID of the Application to copy the experiment. It is displayed in your Talon.One deployment URL. |
**experiment** | [**ExperimentCopyExperiment**](ExperimentCopyExperiment.md) | |



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


# ExperimentCopyExperiment

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isVariantAssignmentExternal** | **Boolean** | The source of the assignment. - false - The variant assignment is handled internally by Talon.One. - true - The variant assignment is handled externally. |
**campaign** | [**ExperimentCampaignCopy**](ExperimentCampaignCopy.md) | |



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


# History

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | The ID of the historical price. |
**observedAt** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the price was observed. |
**contextId** | **String** | Identifier of the relevant context at the time the price was observed (e.g. summer sale). |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. |
**metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | |
**target** | [**Object**](.md) | |



2 changes: 1 addition & 1 deletion docs/InlineResponse20015.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Long** | |
**data** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | |
**data** | [**List<Experiment>**](Experiment.md) | |



2 changes: 1 addition & 1 deletion docs/InlineResponse20016.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Long** | |
**data** | [**List<LoyaltyDashboardData>**](LoyaltyDashboardData.md) | |
**data** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | |



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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | |
**data** | [**List<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |
**totalResultSize** | **Long** | |
**data** | [**List<LoyaltyDashboardData>**](LoyaltyDashboardData.md) | |



2 changes: 1 addition & 1 deletion docs/InlineResponse20018.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | |
**data** | [**List<LoyaltyCard>**](LoyaltyCard.md) | |
**data** | [**List<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |



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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | true means there is more data in the source collection to request.. |
**data** | [**List<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |
**hasMore** | **Boolean** | |
**data** | [**List<LoyaltyCard>**](LoyaltyCard.md) | |



5 changes: 2 additions & 3 deletions docs/InlineResponse20020.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
**totalResultSize** | **Long** | | [optional]
**data** | [**List<CollectionWithoutPayload>**](CollectionWithoutPayload.md) | |
**hasMore** | **Boolean** | true means there is more data in the source collection to request.. |
**data** | [**List<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |



Loading
Loading