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

Update to version 10.0.0 #46

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Update to version 10.0.0 #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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1,156 changes: 542 additions & 614 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions docs/Achievement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,35 @@ Name | Type | Description | Notes
**target** | **Number** | 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]
**recurrencePolicy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
**activationPolicy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | **Date** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | **Date** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
**campaignId** | **Number** | ID of the campaign, to which the achievement belongs to |
**userId** | **Number** | 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]



## Enum: RecurrencePolicyEnum


* `no_recurrence` (value: `"no_recurrence"`)

* `on_expiration` (value: `"on_expiration"`)





## Enum: ActivationPolicyEnum


* `user_action` (value: `"user_action"`)

* `fixed_schedule` (value: `"fixed_schedule"`)




9 changes: 0 additions & 9 deletions docs/ActivateUserRequest.md
View file
Open in desktop

This file was deleted.

4 changes: 3 additions & 1 deletion docs/AdditionalCampaignProperties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ 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** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | **String** | A campaign state described exactly as in the Campaign Manager. |
**frontendState** | **String** | The campaign state displayed in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |


Expand All @@ -43,6 +43,8 @@ Name | Type | Description | Notes

* `archived` (value: `"archived"`)

* `staged` (value: `"staged"`)




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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | The ID of the analytics-level product. |
**isPreliminary** | **Boolean** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. |
**name** | **String** | The name of the analytics-level product. |
**catalogId** | **Number** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | [optional]


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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | The ID of the SKU linked to the analytics-level product. |
**sku** | **String** | The SKU linked to the analytics-level product. |
**lastUpdated** | **Date** | Values in UTC for the date the SKU linked to the analytics-level product was last updated. |


2 changes: 2 additions & 0 deletions docs/ApplicationCampaignAnalytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Name | Type | Description | Notes

* `archived` (value: `"archived"`)

* `staged` (value: `"staged"`)




1 change: 1 addition & 0 deletions docs/ApplicationCampaignStats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**disabled** | **Number** | Number of disabled campaigns. |
**staged** | **Number** | Number of staged campaigns. |
**scheduled** | **Number** | Number of scheduled campaigns. |
**running** | **Number** | Number of running campaigns. |
**expired** | **Number** | Number of expired campaigns. |
Expand Down
8 changes: 4 additions & 4 deletions docs/ApplicationCustomer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Internal ID of this entity. Internal ID of this entity. |
**created** | **Date** | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. The integration ID set by your integration layer. |
**id** | **Number** | Internal ID of this entity. |
**created** | **Date** | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
**accountId** | **Number** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. |
**accountId** | **Number** | The ID of the Talon.One account that owns this profile. |
**closedSessions** | **Number** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
**totalSales** | **Number** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
**loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Internal ID of this entity. |
**created** | **Date** | The time this entity was created. The time this entity was created. |
**created** | **Date** | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
**applicationId** | **Number** | The ID of the application that owns this entity. |
Expand Down
2 changes: 1 addition & 1 deletion docs/AudienceCustomer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Internal ID of this entity. |
**created** | **Date** | The time this entity was created. The time this entity was created. |
**created** | **Date** | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
**accountId** | **Number** | The ID of the Talon.One account that owns this profile. |
Expand Down
12 changes: 12 additions & 0 deletions docs/BaseLoyaltyProgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Name | Type | Description | Notes
**tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated. 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** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional]
**cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**returnPolicy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional]



Expand Down Expand Up @@ -59,3 +60,14 @@ Name | Type | Description | Notes




## Enum: ReturnPolicyEnum


* `only_pending` (value: `"only_pending"`)

* `within_balance` (value: `"within_balance"`)




3 changes: 3 additions & 0 deletions docs/BulkOperationOnCampaigns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | **String** | The operation to perform on the specified campaign IDs. |
**campaignIds** | **[Number]** | The list of campaign IDs on which the operation will be performed. |
**activateAt** | **Date** | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. | [optional]



Expand All @@ -16,6 +17,8 @@ Name | Type | Description | Notes

* `delete` (value: `"delete"`)

* `activate_revision` (value: `"activate_revision"`)




16 changes: 15 additions & 1 deletion docs/Campaign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ 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** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | **String** | A campaign state described exactly as in the Campaign Manager. |
**frontendState** | **String** | The campaign state displayed in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
**revisionFrontendState** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional]
**activeRevisionId** | **Number** | ID of the revision that was last activated on this campaign. | [optional]
**activeRevisionVersionId** | **Number** | ID of the revision version that is active on the campaign. | [optional]
**version** | **Number** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
Expand Down Expand Up @@ -111,6 +112,19 @@ Name | Type | Description | Notes

* `archived` (value: `"archived"`)

* `staged` (value: `"staged"`)





## Enum: RevisionFrontendStateEnum


* `revised` (value: `"revised"`)

* `pending` (value: `"pending"`)




1 change: 1 addition & 0 deletions docs/CampaignTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Name | Type | Description | Notes
**tags** | **[String]** | A list of tags for the campaign template. | [optional]
**features** | **[String]** | A list of features for the campaign template. | [optional]
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**couponReservationSettings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional]
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**limits** | [**[TemplateLimitConfig]**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional]
**templateParams** | [**[CampaignTemplateParams]**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional]
Expand Down
10 changes: 10 additions & 0 deletions docs/CampaignTemplateCouponReservationSettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.CampaignTemplateCouponReservationSettings

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reservationLimit** | **Number** | The number of reservations that can be made with this coupon code. | [optional]
**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]


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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**revisionFrontendState** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional]
**activeRevisionId** | **Number** | ID of the revision that was last activated on this campaign. | [optional]
**activeRevisionVersionId** | **Number** | ID of the revision version that is active on the campaign. | [optional]
**version** | **Number** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
Expand All @@ -12,3 +13,14 @@ Name | Type | Description | Notes
**stageRevision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to false]



## Enum: RevisionFrontendStateEnum


* `revised` (value: `"revised"`)

* `pending` (value: `"pending"`)




2 changes: 1 addition & 1 deletion docs/CouponDeletionFilters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**redeemed** | **Boolean** | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. **Note:** This field cannot be used in conjunction with the `usable` query parameter. | [optional]
**recipientIntegrationId** | **String** | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional]
**exactMatch** | **Boolean** | Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
**value** | **String** | Filter results by the coupon code | [optional] [default to 'false']
**value** | **String** | Filter results by the coupon code | [optional]
**batchId** | **String** | Filter results by batches of coupons | [optional]
**referralId** | **Number** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
**expiresAfter** | **Date** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
Expand Down
26 changes: 26 additions & 0 deletions docs/CreateAchievement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,31 @@ Name | Type | Description | Notes
**target** | **Number** | 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]
**recurrencePolicy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
**activationPolicy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | **Date** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | **Date** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]



## Enum: RecurrencePolicyEnum


* `no_recurrence` (value: `"no_recurrence"`)

* `on_expiration` (value: `"on_expiration"`)





## Enum: ActivationPolicyEnum


* `user_action` (value: `"user_action"`)

* `fixed_schedule` (value: `"fixed_schedule"`)




2 changes: 1 addition & 1 deletion docs/CustomerProfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Internal ID of this entity. |
**created** | **Date** | The time this entity was created. The time this entity was created. |
**created** | **Date** | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
**accountId** | **Number** | The ID of the Talon.One account that owns this profile. |
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomerProfileAudienceRequestItem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. |
**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. |
**profileIntegrationId** | **String** | The ID of this customer profile in the third-party integration. |
**audienceId** | **Number** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |

Expand Down
Loading
Loading