Skip to content

Commit 9ba3dd7

Browse files
kkupreevakkupreeva
committed
update python sdk
1 parent 917dffb commit 9ba3dd7

File tree

690 files changed

+48158
-10326
lines changed

Some content is hidden

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

690 files changed

+48158
-10326
lines changed

‎.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,3 @@ target/
6464

6565
#Ipython Notebook
6666
.ipynb_checkpoints
67-
68-
# IDEs
69-
.vscode/

‎.idea/.gitignore

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/modules.xml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/talon_one.py.iml

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/vcs.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md

+131-38
Large diffs are not rendered by default.

‎docs/AccountAnalytics.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
2222
**webhooks** | **int** | Total number of webhooks in the account. |
2323
**loyalty_programs** | **int** | Total number of all loyalty programs in the account. |
2424
**live_loyalty_programs** | **int** | Total number of live loyalty programs in the account. |
25+
**last_updated_at** | **datetime** | The point in time when the analytics numbers were updated last. |
2526

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

‎docs/AccountDashboardStatistic.md

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
77
**discounts** | [**list[AccountDashboardStatisticDiscount]**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional]
88
**loyalty_points** | [**list[AccountDashboardStatisticLoyaltyPoints]**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional]
99
**referrals** | [**list[AccountDashboardStatisticReferrals]**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional]
10-
**api_calls** | [**list[AccountDashboardStatisticApiCalls]**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional]
1110
**campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | |
1211

1312
[[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/AccountDashboardStatisticCampaigns.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**live** | **int** | Number of campaigns that are active and live (across all Applications). |
7-
**ending_soon** | **int** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. |
7+
**ending_soon** | **int** | Campaigns scheduled to expire sometime in the next 7 days. |
8+
**low_on_budget** | **int** | Campaigns with less than 10% of budget left. |
89

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

‎docs/Achievement.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Achievement
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **int** | Internal ID of this entity. |
8+
**created** | **datetime** | The time this entity was created. |
9+
**name** | **str** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
10+
**title** | **str** | The display name for the achievement in the Campaign Manager. |
11+
**description** | **str** | A description of the achievement. |
12+
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. |
13+
**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. |
14+
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
15+
**campaign_id** | **int** | ID of the campaign, to which the achievement belongs to |
16+
**user_id** | **int** | ID of the user that created this achievement. |
17+
**created_by** | **str** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
18+
**has_progress** | **bool** | Indicates if a customer has made progress in the achievement. | [optional]
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+

‎docs/AchievementAdditionalProperties.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AchievementAdditionalProperties
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**campaign_id** | **int** | ID of the campaign, to which the achievement belongs to |
7+
**user_id** | **int** | ID of the user that created this achievement. |
8+
**created_by** | **str** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
9+
**has_progress** | **bool** | Indicates if a customer has made progress in the achievement. | [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/AchievementProgress.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AchievementProgress
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**achievement_id** | **int** | The internal ID of the achievement. |
7+
**name** | **str** | The internal name of the achievement used in API requests. |
8+
**title** | **str** | The display name of the achievement in the Campaign Manager. |
9+
**campaign_id** | **int** | The ID of the campaign the achievement belongs to. |
10+
**status** | **str** | The status of the achievement. |
11+
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
12+
**progress** | **float** | The current progress of the customer in the achievement. |
13+
**start_date** | **datetime** | Timestamp at which the customer started the achievement. |
14+
**completion_date** | **datetime** | Timestamp at which point the customer completed the achievement. | [optional]
15+
**end_date** | **datetime** | Timestamp at which point the achievement ends and resets for the customer. |
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

‎docs/AddItemCatalogAction.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# AddItemCatalogAction
22

3-
The specific properties of the \"ADD\" catalog sync action.
3+
The specific properties of the \"ADD\" catalog sync action.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**sku** | **str** | The unique SKU of the item to add. |
88
**price** | **float** | Price of the item. | [optional]
99
**attributes** | [**object**](.md) | The attributes of the item to add. | [optional]
10-
**replace_if_exists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to False]
10+
**product** | [**Product**](Product.md) | | [optional]
11+
**replace_if_exists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists. **Note**: When set to `true`: - If you do not provide a new `price` value, the existing `price` value is retained. - If you do not provide a new `product` value, the `product` value is set to `null`. | [optional] [default to False]
1112

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

‎docs/AddLoyaltyPoints.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**points** | **float** | Amount of loyalty points. |
88
**name** | **str** | Name / reason for the point addition. | [optional]
9-
**validity_duration** | **str** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months 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 and months. Signifies the end of the day, week, or month. If passed, `validUntil` should be omitted. | [optional]
9+
**validity_duration** | **str** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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. If passed, `validUntil` should be omitted. | [optional]
1010
**valid_until** | **datetime** | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional]
11-
**pending_duration** | **str** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months 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 and months. Signifies the end of the day, week, or month. | [optional]
11+
**pending_duration** | **str** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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]
1212
**pending_until** | **datetime** | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional]
1313
**subledger_id** | **str** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional]
1414
**application_id** | **int** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional]

‎docs/AddLoyaltyPointsEffectProps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
1414
**expiry_date** | **datetime** | Date after which points will expire. | [optional]
1515
**transaction_uuid** | **str** | The identifier of this addition in the loyalty ledger. |
1616
**cart_item_position** | **float** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional]
17-
**cart_item_sub_position** | **float** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. | [optional]
17+
**cart_item_sub_position** | **float** | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional]
1818
**card_identifier** | **str** | The alphanumeric identifier of the loyalty card. | [optional]
1919
**bundle_index** | **int** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
2020
**bundle_name** | **str** | The name of the bundle definition. | [optional]

‎docs/AddToAudienceEffectProps.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AddToAudienceEffectProps
2+
3+
The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**audience_id** | **int** | The internal ID of the audience. | [optional]
8+
**audience_name** | **str** | The name of the audience. | [optional]
9+
**profile_integration_id** | **str** | The ID of the customer profile in the third-party integration platform. | [optional]
10+
**profile_id** | **int** | The internal ID of the customer profile. | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/AdditionalCampaignProperties.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AdditionalCampaignProperties
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**budgets** | [**list[CampaignBudget]**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. |
7+
**coupon_redemption_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
8+
**referral_redemption_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
9+
**discount_count** | **float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
10+
**discount_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
11+
**coupon_creation_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
12+
**custom_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
13+
**referral_creation_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
14+
**add_free_item_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional]
15+
**awarded_giveaways_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
16+
**created_loyalty_points_count** | **float** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional]
17+
**created_loyalty_points_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
18+
**redeemed_loyalty_points_count** | **float** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional]
19+
**redeemed_loyalty_points_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
20+
**call_api_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
21+
**reservecoupon_effect_count** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
22+
**last_activity** | **datetime** | Timestamp of the most recent event received by this campaign. | [optional]
23+
**updated** | **datetime** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional]
24+
**created_by** | **str** | Name of the user who created this campaign if available. | [optional]
25+
**updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional]
26+
**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. |
28+
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

0 commit comments

Comments
 (0)