Skip to content

Commit

Permalink
Merge pull request #27 from talon-one/sc-41192-fix-python-sdk-track-e…
Browse files Browse the repository at this point in the history
…vent-ledgerEntries

fix(TrackEventsV2): Error in python SDK track event endpoint.
  • Loading branch information
giou-k committed Aug 22, 2024
2 parents 79f2afa + 0b20315 commit cfbc82d
Show file tree
Hide file tree
Showing 273 changed files with 16,077 additions and 3,182 deletions.
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,3 @@ target/

#Ipython Notebook
.ipynb_checkpoints

# IDEs
.vscode/
.idea
61 changes: 48 additions & 13 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/AdditionalCampaignProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**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. |
**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
11 changes: 11 additions & 0 deletions docs/AnalyticsDataPoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AnalyticsDataPoint

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **float** | |
**influenced** | **float** | |

[[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 changes: 11 additions & 0 deletions docs/AnalyticsDataPointWithTrend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AnalyticsDataPointWithTrend

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **float** | |
**trend** | **float** | |

[[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/AnalyticsDataPointWithTrendAndInfluencedRate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AnalyticsDataPointWithTrendAndInfluencedRate

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **float** | |
**influenced_rate** | **float** | |
**trend** | **float** | |

[[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/AnalyticsDataPointWithTrendAndUplift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AnalyticsDataPointWithTrendAndUplift

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **float** | |
**uplift** | **float** | |
**trend** | **float** | |

[[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/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,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]
**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. |

[[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
12 changes: 6 additions & 6 deletions docs/ApplicationAnalyticsDataPoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_time** | **datetime** | The start of the aggregation time frame in UTC. | [optional]
**end_time** | **datetime** | The end of the aggregation time frame in UTC. | [optional]
**total_revenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) | | [optional]
**sessions_count** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) | | [optional]
**avg_items_per_session** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) | | [optional]
**avg_session_value** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) | | [optional]
**start_time** | **datetime** | The start of the aggregation time frame in UTC. |
**end_time** | **datetime** | The end of the aggregation time frame in UTC. |
**total_revenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**sessions_count** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**avg_items_per_session** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**avg_session_value** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**total_discounts** | **float** | The total value of discounts given for cart items in influenced sessions. | [optional]
**coupons_count** | **float** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional]

Expand Down
27 changes: 12 additions & 15 deletions docs/ApplicationCampaignAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,18 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_time** | **datetime** | The start of the aggregation time frame in UTC. | [optional]
**end_time** | **datetime** | The end of the aggregation time frame in UTC. | [optional]
**campaign_id** | **int** | The ID of the campaign. | [optional]
**campaign_name** | **str** | The name of the campaign. | [optional]
**campaign_tags** | **list[str]** | A list of tags for the campaign. | [optional]
**campaign_state** | **str** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to 'enabled']
**campaign_active_ruleset_id** | **int** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**campaign_start_time** | **datetime** | Date and time when the campaign becomes active. | [optional]
**campaign_end_time** | **datetime** | Date and time when the campaign becomes inactive. | [optional]
**total_revenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) | | [optional]
**sessions_count** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) | | [optional]
**avg_items_per_session** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) | | [optional]
**avg_session_value** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) | | [optional]
**total_discounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) | | [optional]
**coupons_count** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) | | [optional]
**start_time** | **datetime** | The start of the aggregation time frame in UTC. |
**end_time** | **datetime** | The end of the aggregation time frame in UTC. |
**campaign_id** | **int** | The ID of the campaign. |
**campaign_name** | **str** | The name of the campaign. |
**campaign_tags** | **list[str]** | A list of tags for the campaign. |
**campaign_state** | **str** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
**total_revenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**sessions_count** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**avg_items_per_session** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**avg_session_value** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**total_discounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
**coupons_count** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [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/ApplicationCampaignStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Provides statistics regarding an application's campaigns.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**draft** | **int** | Number of draft campaigns. |
**disabled** | **int** | Number of disabled campaigns. |
**scheduled** | **int** | Number of scheduled campaigns. |
**running** | **int** | Number of running campaigns. |
Expand Down
11 changes: 11 additions & 0 deletions docs/AsyncCouponDeletionJobResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AsyncCouponDeletionJobResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |

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


8 changes: 5 additions & 3 deletions docs/BaseLoyaltyProgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Name | Type | Description | Notes
**allow_subledger** | **bool** | Indicates if this program supports subledgers inside the program. | [optional]
**users_per_card_limit** | **int** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
**tiers_expiration_policy** | **str** | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
**tiers_expire_in** | **str** | The amount of time after which the tier expires. 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** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
**program_join_policy** | **str** | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**tiers_expiration_policy** | **str** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. | [optional]
**tier_cycle_start_date** | **datetime** | Timestamp at which the tier cycle starts for all customers in the loyalty program. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. | [optional]
**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]

[[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
2 changes: 1 addition & 1 deletion docs/BaseNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**policy** | [**object**](.md) | |
**policy** | [**object**](.md) | Indicates which notification properties to apply. |
**enabled** | **bool** | Indicates whether the notification is activated. | [optional] [default to True]
**webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
**id** | **int** | Unique ID for this entity. |
Expand Down
2 changes: 1 addition & 1 deletion docs/BaseNotificationEntity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**policy** | [**object**](.md) | |
**policy** | [**object**](.md) | Indicates which notification properties to apply. |
**enabled** | **bool** | Indicates whether the notification is activated. | [optional] [default to True]

[[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: 1 addition & 0 deletions docs/Campaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Name | Type | Description | Notes
**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. |
**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/CampaignCollectionEditedNotification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CampaignCollectionEditedNotification

A notification regarding a collection that was edited.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.md) | |

[[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/CampaignNotificationPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Notification name. |
**batching_enabled** | **bool** | Indicates whether batching is activated. | [optional] [default to True]

[[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
4 changes: 2 additions & 2 deletions docs/CampaignStateChangedNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ A notification regarding a campaign whose state changed.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign** | [**Campaign**](Campaign.md) | |
**old_state** | **str** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] |
**new_state** | **str** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] |
**old_state** | **str** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**new_state** | **str** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**ruleset** | [**Ruleset**](Ruleset.md) | | [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
11 changes: 11 additions & 0 deletions docs/CardAddedDeductedPointsNotificationPolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CardAddedDeductedPointsNotificationPolicy

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Notification name. |
**scopes** | **list[str]** | |

[[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/CartItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**width** | **float** | Width of item in mm. | [optional]
**length** | **float** | Length of item in mm. | [optional]
**position** | **float** | Position of the Cart Item in the Cart (calculated internally). | [optional]
**attributes** | [**object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. | [optional]
**attributes** | [**object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. | [optional]
**additional_costs** | [**dict(str, AdditionalCost)**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
**catalog_item_id** | **int** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional]

Expand Down
Loading

0 comments on commit cfbc82d

Please sign in to comment.