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 7.0.0 #34

Merged
merged 1 commit into from
Jan 16, 2025
Merged

update 7.0.0 #34

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,065 changes: 542 additions & 523 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/Account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Account


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
5 changes: 4 additions & 1 deletion docs/Achievement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Achievement


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand All @@ -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 `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. |
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
**recurrence_policy** | **str** | 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]
**activation_policy** | **str** | 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]
**fixed_start_date** | **datetime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**end_date** | **datetime** | 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]
**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. |
Expand Down
1 change: 1 addition & 0 deletions docs/AchievementProgress.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
**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]
Expand Down
2 changes: 1 addition & 1 deletion docs/AdditionalCampaignProperties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
13 changes: 13 additions & 0 deletions docs/AnalyticsProduct.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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** > **Tools** > **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)


12 changes: 12 additions & 0 deletions docs/AnalyticsProductSKU.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)


2 changes: 1 addition & 1 deletion docs/Application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Application


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand All @@ -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 `setDiscountPerItem` 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. |

Expand Down
1 change: 0 additions & 1 deletion docs/ApplicationAPIKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# ApplicationAPIKey


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
18 changes: 18 additions & 0 deletions docs/ApplicationCIF.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)


15 changes: 15 additions & 0 deletions docs/ApplicationCIFExpression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)


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 @@ 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. |
Expand Down
9 changes: 4 additions & 5 deletions docs/ApplicationCustomer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
1 change: 0 additions & 1 deletion docs/ApplicationEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# ApplicationEvent


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
3 changes: 1 addition & 2 deletions docs/ApplicationSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
Expand Down
1 change: 0 additions & 1 deletion docs/AsyncCouponDeletionJobResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# AsyncCouponDeletionJobResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
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
@@ -1,6 +1,5 @@
# Attribute


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
3 changes: 1 addition & 2 deletions docs/AudienceCustomer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
Expand Down
1 change: 1 addition & 0 deletions docs/BaseLoyaltyProgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: `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]
**tiers_downgrade_policy** | **str** | 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]
**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). - `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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 0 additions & 1 deletion docs/BaseNotification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# BaseNotification


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions docs/BulkOperationOnCampaigns.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
------------ | ------------- | ------------- | -------------
**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 `activate_revision` 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)

Expand Down
10 changes: 8 additions & 2 deletions docs/Campaign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Campaign


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down Expand Up @@ -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)

Expand Down
1 change: 0 additions & 1 deletion docs/CampaignAnalytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# CampaignAnalytics


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


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


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


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


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
14 changes: 14 additions & 0 deletions docs/CampaignStoreBudget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)


Loading
Loading