Skip to content

Commit 5178d50

Browse files
authored
Merge pull request #34 from talon-one/update-7.0.0
update 7.0.0
2 parents a7e6d64 + 368a5f5 commit 5178d50

File tree

504 files changed

+16256
-2817
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

504 files changed

+16256
-2817
lines changed

README.md

Lines changed: 542 additions & 523 deletions
Large diffs are not rendered by default.

docs/Account.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Account
22

3-
43
## Properties
54
Name | Type | Description | Notes
65
------------ | ------------- | ------------- | -------------

docs/AccountAdditionalCost.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# AccountAdditionalCost
22

3-
43
## Properties
54
Name | Type | Description | Notes
65
------------ | ------------- | ------------- | -------------

docs/Achievement.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Achievement
22

3-
43
## Properties
54
Name | Type | Description | Notes
65
------------ | ------------- | ------------- | -------------
@@ -12,6 +11,10 @@ Name | Type | Description | Notes
1211
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. |
1312
**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. |
1413
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
14+
**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]
15+
**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]
16+
**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]
17+
**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]
1518
**campaign_id** | **int** | ID of the campaign, to which the achievement belongs to |
1619
**user_id** | **int** | ID of the user that created this achievement. |
1720
**created_by** | **str** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |

docs/AchievementProgress.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
**achievement_id** | **int** | The internal ID of the achievement. |
77
**name** | **str** | The internal name of the achievement used in API requests. |
88
**title** | **str** | The display name of the achievement in the Campaign Manager. |
9+
**description** | **str** | The description of the achievement in the Campaign Manager. |
910
**campaign_id** | **int** | The ID of the campaign the achievement belongs to. |
1011
**status** | **str** | The status of the achievement. |
1112
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]

docs/AdditionalCampaignProperties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
2424
**created_by** | **str** | Name of the user who created this campaign if available. | [optional]
2525
**updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional]
2626
**template_id** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional]
27-
**frontend_state** | **str** | A campaign state described exactly as in the Campaign Manager. |
27+
**frontend_state** | **str** | The campaign state displayed in the Campaign Manager. |
2828
**stores_imported** | **bool** | Indicates whether the linked stores were imported via a CSV file. |
2929

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

docs/AnalyticsProduct.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AnalyticsProduct
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **int** | The ID of the analytics-level product. |
7+
**is_preliminary** | **bool** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. |
8+
**name** | **str** | The name of the analytics-level product. |
9+
**catalog_id** | **int** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | [optional]
10+
11+
[[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+
13+

docs/AnalyticsProductSKU.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AnalyticsProductSKU
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **int** | The ID of the SKU linked to the analytics-level product. |
7+
**sku** | **str** | The SKU linked to the analytics-level product. |
8+
**last_updated** | **datetime** | Values in UTC for the date the SKU linked to the analytics-level product was last updated. |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/Application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Application
22

3-
43
## Properties
54
Name | Type | Description | Notes
65
------------ | ------------- | ------------- | -------------
@@ -23,6 +22,7 @@ Name | Type | Description | Notes
2322
**enable_partial_discounts** | **bool** | Indicates if this Application supports partial discounts. | [optional]
2423
**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]
2524
**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]
25+
**default_cart_item_filter_id** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional]
2626
**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]
2727
**loyalty_programs** | [**list[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. |
2828

docs/ApplicationAPIKey.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# ApplicationAPIKey
22

3-
43
## Properties
54
Name | Type | Description | Notes
65
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)