update 7.0.0

talon-one · Jan 16, 2025 · 368a5f5 · 368a5f5
1 parent a7e6d64
commit 368a5f5
Show file tree

Hide file tree

Showing 504 changed files with 16,256 additions and 2,817 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/Account.md b/docs/Account.md
@@ -1,6 +1,5 @@
 # Account
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md
@@ -1,6 +1,5 @@
 # AccountAdditionalCost
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/Achievement.md b/docs/Achievement.md
@@ -1,6 +1,5 @@
 # Achievement
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -12,6 +11,10 @@ Name | Type | Description | Notes
 **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | 
 **period** | **str** | The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The &#x60;period&#x60; does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: &#x60;30s&#x60;, &#x60;40m&#x60;, &#x60;1h&#x60;, &#x60;5D&#x60;, &#x60;7W&#x60;, &#x60;10M&#x60;, &#x60;15Y&#x60;.  Available units:  - &#x60;s&#x60;: seconds - &#x60;m&#x60;: minutes - &#x60;h&#x60;: hours - &#x60;D&#x60;: days - &#x60;W&#x60;: weeks - &#x60;M&#x60;: months - &#x60;Y&#x60;: years  You can also round certain units down to the beginning of period and up to the end of period.: - &#x60;_D&#x60; for rounding down days only. Signifies the start of the day. Example: &#x60;30D_D&#x60; - &#x60;_U&#x60; for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: &#x60;23W_U&#x60;  **Note**: You can either use the round down and round up option or set an absolute period.  | 
 **period_end_override** | [**TimePoint**](TimePoint.md) |  | [optional] 
+**recurrence_policy** | **str** | The policy that determines if and how the achievement recurs. - &#x60;no_recurrence&#x60;: The achievement can be completed only once. - &#x60;on_expiration&#x60;: The achievement resets after it expires and becomes available again.  | [optional] 
+**activation_policy** | **str** | The policy that determines how the achievement starts, ends, or resets. - &#x60;user_action&#x60;: The achievement ends or resets relative to when the customer started the achievement. - &#x60;fixed_schedule&#x60;: The achievement starts, ends, or resets for all customers following a fixed schedule.  | [optional] 
+**fixed_start_date** | **datetime** | The achievement&#39;s start date when &#x60;activationPolicy&#x60; is set to &#x60;fixed_schedule&#x60;.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
+**end_date** | **datetime** | The achievement&#39;s end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
 **campaign_id** | **int** | ID of the campaign, to which the achievement belongs to | 
 **user_id** | **int** | ID of the user that created this achievement. | 
 **created_by** | **str** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 

diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **achievement_id** | **int** | The internal ID of the achievement. | 
 **name** | **str** | The internal name of the achievement used in API requests.  | 
 **title** | **str** | The display name of the achievement in the Campaign Manager. | 
+**description** | **str** | The description of the achievement in the Campaign Manager. | 
 **campaign_id** | **int** | The ID of the campaign the achievement belongs to. | 
 **status** | **str** | The status of the achievement. | 
 **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 

diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **created_by** | **str** | Name of the user who created this campaign if available. | [optional] 
 **updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional] 
 **template_id** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional] 
-**frontend_state** | **str** | A campaign state described exactly as in the Campaign Manager. | 
+**frontend_state** | **str** | The campaign state displayed in the Campaign Manager. | 
 **stores_imported** | **bool** | Indicates whether the linked stores were imported via a CSV file. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/AnalyticsProduct.md b/docs/AnalyticsProduct.md
@@ -0,0 +1,13 @@
+# AnalyticsProduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the analytics-level product. | 
+**is_preliminary** | **bool** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. | 
+**name** | **str** | The name of the analytics-level product. | 
+**catalog_id** | **int** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** &gt; **Tools** &gt; **Cart item catalogs**.  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AnalyticsProductSKU.md b/docs/AnalyticsProductSKU.md
@@ -0,0 +1,12 @@
+# AnalyticsProductSKU
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the SKU linked to the analytics-level product. | 
+**sku** | **str** | The SKU linked to the analytics-level product. | 
+**last_updated** | **datetime** | Values in UTC for the date the SKU linked to the analytics-level product was last updated. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Application.md b/docs/Application.md
@@ -1,6 +1,5 @@
 # Application
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -23,6 +22,7 @@ Name | Type | Description | Notes
 **enable_partial_discounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] 
 **default_discount_additional_cost_per_item_scope** | **str** | The default scope to apply &#x60;setDiscountPerItem&#x60; effects on if no scope was provided with the effect.  | [optional] 
 **default_evaluation_group_id** | **int** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional] 
+**default_cart_item_filter_id** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional] 
 **enable_campaign_state_management** | **bool** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  | [optional] 
 **loyalty_programs** | [**list[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 

diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md
@@ -1,6 +1,5 @@
 # ApplicationAPIKey
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md
@@ -0,0 +1,18 @@
+# ApplicationCIF
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Internal ID of this entity. | 
+**created** | **datetime** | The time this entity was created. | 
+**name** | **str** | The name of the Application cart item filter used in API requests. | 
+**description** | **str** | A short description of the Application cart item filter. | [optional] 
+**active_expression_id** | **int** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modified_by** | **int** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | **datetime** | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+**application_id** | **int** | The ID of the application that owns this entity. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md
@@ -0,0 +1,15 @@
+# ApplicationCIFExpression
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Internal ID of this entity. | 
+**created** | **datetime** | The time this entity was created. | 
+**cart_item_filter_id** | **int** | The ID of the Application cart item filter. | [optional] 
+**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] 
+**expression** | **list[object]** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] 
+**application_id** | **int** | The ID of the application that owns this entity. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md
@@ -5,6 +5,7 @@ Provides statistics regarding an application's campaigns.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **disabled** | **int** | Number of disabled campaigns. | 
+**staged** | **int** | Number of staged campaigns. | 
 **scheduled** | **int** | Number of scheduled campaigns. | 
 **running** | **int** | Number of running campaigns. | 
 **expired** | **int** | Number of expired campaigns. | 

diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md
@@ -1,14 +1,13 @@
 # ApplicationCustomer
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** | Internal ID of this entity. Internal ID of this entity. | 
-**created** | **datetime** | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. | 
-**integration_id** | **str** | The integration ID set by your integration layer. The integration ID set by your integration layer. | 
+**id** | **int** | Internal ID of this entity. | 
+**created** | **datetime** | The time this entity was created. | 
+**integration_id** | **str** | The integration ID set by your integration layer. | 
 **attributes** | [**object**](.md) | Arbitrary properties associated with this item. | 
-**account_id** | **int** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | 
+**account_id** | **int** | The ID of the Talon.One account that owns this profile. | 
 **closed_sessions** | **int** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **total_sales** | **float** | 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.  | 
 **loyalty_memberships** | [**list[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  | [optional] 

diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md
@@ -1,6 +1,5 @@
 # ApplicationEvent
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md
@@ -1,6 +1,5 @@
 # ApplicationReferee
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md
@@ -1,11 +1,10 @@
 # ApplicationSession
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** | Internal ID of this entity. | 
-**created** | **datetime** | The time this entity was created. The time this entity was created. | 
+**created** | **datetime** | The time this entity was created. | 
 **integration_id** | **str** | The integration ID set by your integration layer. | 
 **store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **application_id** | **int** | The ID of the application that owns this entity. | 

diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md
@@ -1,6 +1,5 @@
 # AsyncCouponDeletionJobResponse
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/Attribute.md b/docs/Attribute.md
@@ -1,6 +1,5 @@
 # Attribute
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/Audience.md b/docs/Audience.md
@@ -1,6 +1,5 @@
 # Audience
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md
@@ -1,11 +1,10 @@
 # AudienceCustomer
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** | Internal ID of this entity. | 
-**created** | **datetime** | The time this entity was created. The time this entity was created. | 
+**created** | **datetime** | The time this entity was created. | 
 **integration_id** | **str** | The integration ID set by your integration layer. | 
 **attributes** | [**object**](.md) | Arbitrary properties associated with this item. | 
 **account_id** | **int** | The ID of the Talon.One account that owns this profile. | 

diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **tiers_expire_in** | **str** | 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: &#x60;30s&#x60;, &#x60;40m&#x60;, &#x60;1h&#x60;, &#x60;5D&#x60;, &#x60;7W&#x60;, &#x60;10M&#x60;, &#x60;15Y&#x60;.  Available units:  - &#x60;s&#x60;: seconds - &#x60;m&#x60;: minutes - &#x60;h&#x60;: hours - &#x60;D&#x60;: days - &#x60;W&#x60;: weeks - &#x60;M&#x60;: months - &#x60;Y&#x60;: years  You can round certain units up or down: - &#x60;_D&#x60; for rounding down days only. Signifies the start of the day. - &#x60;_U&#x60; for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
 **tiers_downgrade_policy** | **str** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - &#x60;one_down&#x60;: If the customer doesn&#39;t have enough points to stay in the current tier, they are downgraded by one tier.  - &#x60;balance_based&#x60;: The customer&#39;s tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
 **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**return_policy** | **str** | 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). - &#x60;only_pending&#x60;: Only pending points can be rolled back. - &#x60;within_balance&#x60;: Available active points can be rolled back if there aren&#39;t enough pending points. The active balance of the customer cannot be negative.  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BaseNotification.md b/docs/BaseNotification.md
@@ -1,6 +1,5 @@
 # BaseNotification
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md
@@ -1,6 +1,5 @@
 # BaseNotificationWebhook
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BulkOperationOnCampaigns.md b/docs/BulkOperationOnCampaigns.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **operation** | **str** | The operation to perform on the specified campaign IDs.  | 
 **campaign_ids** | **list[int]** | The list of campaign IDs on which the operation will be performed. | 
+**activate_at** | **datetime** | Timestamp when the revisions are finalized after the &#x60;activate_revision&#x60; operation. The current time is used when left blank.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Campaign.md b/docs/Campaign.md
@@ -1,6 +1,5 @@
 # Campaign
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -44,8 +43,15 @@ Name | Type | Description | Notes
 **created_by** | **str** | Name of the user who created this campaign if available. | [optional] 
 **updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional] 
 **template_id** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional] 
-**frontend_state** | **str** | A campaign state described exactly as in the Campaign Manager. | 
+**frontend_state** | **str** | The campaign state displayed in the Campaign Manager. | 
 **stores_imported** | **bool** | Indicates whether the linked stores were imported via a CSV file. | 
+**revision_frontend_state** | **str** | The campaign revision state displayed in the Campaign Manager. | [optional] 
+**active_revision_id** | **int** | ID of the revision that was last activated on this campaign.  | [optional] 
+**active_revision_version_id** | **int** | ID of the revision version that is active on the campaign.  | [optional] 
+**version** | **int** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.  | [optional] 
+**current_revision_id** | **int** | ID of the revision currently being modified for the campaign.  | [optional] 
+**current_revision_version_id** | **int** | ID of the latest version applied on the current revision.  | [optional] 
+**stage_revision** | **bool** | Flag for determining whether we use current revision when sending requests with staging API key.  | [optional] [default to False]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/CampaignAnalytics.md b/docs/CampaignAnalytics.md
@@ -1,6 +1,5 @@
 # CampaignAnalytics
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md
@@ -1,6 +1,5 @@
 # CampaignCollection
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md
@@ -1,6 +1,5 @@
 # CampaignCollectionWithoutPayload
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignEvaluationGroup.md b/docs/CampaignEvaluationGroup.md
@@ -1,6 +1,5 @@
 # CampaignEvaluationGroup
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md
@@ -1,6 +1,5 @@
 # CampaignGroup
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md
@@ -1,6 +1,5 @@
 # CampaignSet
 
-
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CampaignStoreBudget.md b/docs/CampaignStoreBudget.md
@@ -0,0 +1,14 @@
+# CampaignStoreBudget
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Internal ID of this entity. | 
+**created** | **datetime** | The time this entity was created. | 
+**campaign_id** | **int** | The ID of the campaign that owns this entity. | 
+**store_id** | **int** | The ID of the store. | 
+**limits** | [**list[LimitConfig]**](LimitConfig.md) | The set of budget limits for stores linked to the campaign. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+