Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
  •  
  •  
  •  
30 changes: 30 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,9 @@ docs/DeleteUserRequest.md
docs/Effect.md
docs/EffectEntity.md
docs/EmailEntity.md
docs/EmbeddedAnalyticsConfiguration.md
docs/EmbeddedAnalyticsConfigurationDashboards.md
docs/EmbeddedDashboardConfiguration.md
docs/Endpoint.md
docs/Entity.md
docs/EntityWithTalangVisibleID.md
Expand All @@ -238,6 +241,9 @@ docs/Experiment.md
docs/ExperimentCampaignCopy.md
docs/ExperimentCopy.md
docs/ExperimentCopyExperiment.md
docs/ExperimentListResults.md
docs/ExperimentListResultsRequest.md
docs/ExperimentResult.md
docs/ExperimentResults.md
docs/ExperimentVariant.md
docs/ExperimentVariantAllocation.md
Expand Down Expand Up @@ -316,6 +322,8 @@ docs/GetRulesets200Response.md
docs/GetUsers200Response.md
docs/GetWebhooks200Response.md
docs/Giveaway.md
docs/GiveawayPoolNotification.md
docs/GiveawayPoolNotificationData.md
docs/GiveawaysPool.md
docs/HiddenConditionsEffects.md
docs/History.md
Expand Down Expand Up @@ -559,6 +567,7 @@ docs/RoleV2PermissionSet.md
docs/RoleV2Permissions.md
docs/RoleV2Readonly.md
docs/RoleV2RolesGroup.md
docs/RolesV2Thresholds.md
docs/RollbackAddedLoyaltyPointsEffectProps.md
docs/RollbackCouponEffectProps.md
docs/RollbackDeductedLoyaltyPointsEffectProps.md
Expand All @@ -567,6 +576,7 @@ docs/RollbackIncreasedAchievementProgressEffectProps.md
docs/RollbackReferralEffectProps.md
docs/Rule.md
docs/RuleFailureReason.md
docs/RuleMetadata.md
docs/Ruleset.md
docs/SSOConfig.md
docs/SamlConnection.md
Expand Down Expand Up @@ -911,6 +921,9 @@ talon_one/models/delete_user_request.py
talon_one/models/effect.py
talon_one/models/effect_entity.py
talon_one/models/email_entity.py
talon_one/models/embedded_analytics_configuration.py
talon_one/models/embedded_analytics_configuration_dashboards.py
talon_one/models/embedded_dashboard_configuration.py
talon_one/models/endpoint.py
talon_one/models/entity.py
talon_one/models/entity_with_talang_visible_id.py
Expand All @@ -929,6 +942,9 @@ talon_one/models/experiment.py
talon_one/models/experiment_campaign_copy.py
talon_one/models/experiment_copy.py
talon_one/models/experiment_copy_experiment.py
talon_one/models/experiment_list_results.py
talon_one/models/experiment_list_results_request.py
talon_one/models/experiment_result.py
talon_one/models/experiment_results.py
talon_one/models/experiment_variant.py
talon_one/models/experiment_variant_allocation.py
Expand Down Expand Up @@ -1007,6 +1023,8 @@ talon_one/models/get_rulesets200_response.py
talon_one/models/get_users200_response.py
talon_one/models/get_webhooks200_response.py
talon_one/models/giveaway.py
talon_one/models/giveaway_pool_notification.py
talon_one/models/giveaway_pool_notification_data.py
talon_one/models/giveaways_pool.py
talon_one/models/hidden_conditions_effects.py
talon_one/models/history.py
Expand Down Expand Up @@ -1248,6 +1266,7 @@ talon_one/models/role_v2_permission_set.py
talon_one/models/role_v2_permissions.py
talon_one/models/role_v2_readonly.py
talon_one/models/role_v2_roles_group.py
talon_one/models/roles_v2_thresholds.py
talon_one/models/rollback_added_loyalty_points_effect_props.py
talon_one/models/rollback_coupon_effect_props.py
talon_one/models/rollback_deducted_loyalty_points_effect_props.py
Expand All @@ -1256,6 +1275,7 @@ talon_one/models/rollback_increased_achievement_progress_effect_props.py
talon_one/models/rollback_referral_effect_props.py
talon_one/models/rule.py
talon_one/models/rule_failure_reason.py
talon_one/models/rule_metadata.py
talon_one/models/ruleset.py
talon_one/models/saml_connection.py
talon_one/models/saml_connection_internal.py
Expand Down Expand Up @@ -1589,6 +1609,9 @@ test/test_delete_user_request.py
test/test_effect.py
test/test_effect_entity.py
test/test_email_entity.py
test/test_embedded_analytics_configuration.py
test/test_embedded_analytics_configuration_dashboards.py
test/test_embedded_dashboard_configuration.py
test/test_endpoint.py
test/test_entity.py
test/test_entity_with_talang_visible_id.py
Expand All @@ -1607,6 +1630,9 @@ test/test_experiment.py
test/test_experiment_campaign_copy.py
test/test_experiment_copy.py
test/test_experiment_copy_experiment.py
test/test_experiment_list_results.py
test/test_experiment_list_results_request.py
test/test_experiment_result.py
test/test_experiment_results.py
test/test_experiment_variant.py
test/test_experiment_variant_allocation.py
Expand Down Expand Up @@ -1685,6 +1711,8 @@ test/test_get_rulesets200_response.py
test/test_get_users200_response.py
test/test_get_webhooks200_response.py
test/test_giveaway.py
test/test_giveaway_pool_notification.py
test/test_giveaway_pool_notification_data.py
test/test_giveaways_pool.py
test/test_hidden_conditions_effects.py
test/test_history.py
Expand Down Expand Up @@ -1928,6 +1956,7 @@ test/test_role_v2_permission_set.py
test/test_role_v2_permissions.py
test/test_role_v2_readonly.py
test/test_role_v2_roles_group.py
test/test_roles_v2_thresholds.py
test/test_rollback_added_loyalty_points_effect_props.py
test/test_rollback_coupon_effect_props.py
test/test_rollback_deducted_loyalty_points_effect_props.py
Expand All @@ -1936,6 +1965,7 @@ test/test_rollback_increased_achievement_progress_effect_props.py
test/test_rollback_referral_effect_props.py
test/test_rule.py
test/test_rule_failure_reason.py
test/test_rule_metadata.py
test/test_ruleset.py
test/test_saml_connection.py
test/test_saml_connection_internal.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.20.0
7.21.0
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,6 @@ Class | Method | HTTP request | Description
*IntegrationApi* | [**get_loyalty_program_profile_transactions**](docs/IntegrationApi.md#get_loyalty_program_profile_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions
*IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
*IntegrationApi* | [**link_loyalty_card_to_profile**](docs/IntegrationApi.md#link_loyalty_card_to_profile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card
*IntegrationApi* | [**price_history**](docs/IntegrationApi.md#price_history) | **POST** /v1/best_prior_price_history | Get summary of price history
*IntegrationApi* | [**reopen_customer_session**](docs/IntegrationApi.md#reopen_customer_session) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session
*IntegrationApi* | [**return_cart_items**](docs/IntegrationApi.md#return_cart_items) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items
*IntegrationApi* | [**sync_catalog**](docs/IntegrationApi.md#sync_catalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog
Expand Down Expand Up @@ -338,6 +337,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**list_experiments**](docs/ManagementApi.md#list_experiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments
*ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
*ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
*ManagementApi* | [**price_history**](docs/ManagementApi.md#price_history) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history
*ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
*ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
*ManagementApi* | [**scim_create_group**](docs/ManagementApi.md#scim_create_group) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
Expand Down Expand Up @@ -587,6 +587,9 @@ Class | Method | HTTP request | Description
- [Effect](docs/Effect.md)
- [EffectEntity](docs/EffectEntity.md)
- [EmailEntity](docs/EmailEntity.md)
- [EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
- [EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
- [EmbeddedDashboardConfiguration](docs/EmbeddedDashboardConfiguration.md)
- [Endpoint](docs/Endpoint.md)
- [Entity](docs/Entity.md)
- [EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md)
Expand All @@ -605,6 +608,9 @@ Class | Method | HTTP request | Description
- [ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
- [ExperimentCopy](docs/ExperimentCopy.md)
- [ExperimentCopyExperiment](docs/ExperimentCopyExperiment.md)
- [ExperimentListResults](docs/ExperimentListResults.md)
- [ExperimentListResultsRequest](docs/ExperimentListResultsRequest.md)
- [ExperimentResult](docs/ExperimentResult.md)
- [ExperimentResults](docs/ExperimentResults.md)
- [ExperimentVariant](docs/ExperimentVariant.md)
- [ExperimentVariantAllocation](docs/ExperimentVariantAllocation.md)
Expand Down Expand Up @@ -683,6 +689,8 @@ Class | Method | HTTP request | Description
- [GetUsers200Response](docs/GetUsers200Response.md)
- [GetWebhooks200Response](docs/GetWebhooks200Response.md)
- [Giveaway](docs/Giveaway.md)
- [GiveawayPoolNotification](docs/GiveawayPoolNotification.md)
- [GiveawayPoolNotificationData](docs/GiveawayPoolNotificationData.md)
- [GiveawaysPool](docs/GiveawaysPool.md)
- [HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
- [History](docs/History.md)
Expand Down Expand Up @@ -924,6 +932,7 @@ Class | Method | HTTP request | Description
- [RoleV2Permissions](docs/RoleV2Permissions.md)
- [RoleV2Readonly](docs/RoleV2Readonly.md)
- [RoleV2RolesGroup](docs/RoleV2RolesGroup.md)
- [RolesV2Thresholds](docs/RolesV2Thresholds.md)
- [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md)
- [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
- [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
Expand All @@ -932,6 +941,7 @@ Class | Method | HTTP request | Description
- [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
- [Rule](docs/Rule.md)
- [RuleFailureReason](docs/RuleFailureReason.md)
- [RuleMetadata](docs/RuleMetadata.md)
- [Ruleset](docs/Ruleset.md)
- [SSOConfig](docs/SSOConfig.md)
- [SamlConnection](docs/SamlConnection.md)
Expand Down Expand Up @@ -1060,15 +1070,3 @@ Authentication schemes defined for the API:
- **API key parameter name**: Authorization
- **Location**: HTTP header

### manager_auth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

### management_key

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

2 changes: 1 addition & 1 deletion docs/ActivateLoyaltyPoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Activate loyalty points

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transaction_uuids** | **List[UUID]** | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional]
**transaction_uuids** | **List[UUID]** | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional]
**session_id** | **str** | The ID of the session containing the pending point transactions to activate. If provided, do not include the `transactionUUIDs` parameter. | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/AddPriceAdjustmentCatalogAction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AddPriceAdjustmentCatalogAction

The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action. **Note:** You can only use this object if the `Beta` **price types** feature is enabled for your Application. To enable it, contact your Technical Account Manager.

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/ApplicationCustomer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Name | Type | Description | Notes
**id** | **int** | The internal ID of the customer profile. |
**created** | **datetime** | The time this entity was created. |
**integration_id** | **str** | The integration ID set by your integration layer. |
**attributes** | **object** | Arbitrary properties associated with this item. | [optional]
**attributes** | **Dict[str, object]** | Arbitrary properties associated with this item. | [optional]
**account_id** | **int** | The ID of the Talon.One account that owns this profile. |
**closed_sessions** | **int** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
**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. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional]
**audience_memberships** | [**List[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**last_activity** | **datetime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
**last_activity** | **datetime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. |
**sandbox** | **bool** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
**advocate_integration_id** | **str** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/AudienceCustomer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Name | Type | Description | Notes
**id** | **int** | The internal ID of the customer profile. |
**created** | **datetime** | The time this entity was created. |
**integration_id** | **str** | The integration ID set by your integration layer. |
**attributes** | **object** | Arbitrary properties associated with this item. | [optional]
**attributes** | **Dict[str, object]** | Arbitrary properties associated with this item. | [optional]
**account_id** | **int** | The ID of the Talon.One account that owns this profile. |
**closed_sessions** | **int** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
**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. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional]
**audience_memberships** | [**List[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**last_activity** | **datetime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
**last_activity** | **datetime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. |
**sandbox** | **bool** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
**connected_applications_ids** | **List[int]** | A list of the IDs of the Applications that are connected to this customer profile. | [optional]
**connected_audiences** | **List[int]** | A list of the IDs of the audiences that are connected to this customer profile. | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/BaseCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**end_time** | **datetime** | Timestamp when the campaign will become inactive. | [optional]
**attributes** | **object** | Arbitrary properties associated with this campaign. | [optional]
**state** | **str** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled']
**active_ruleset_id** | **int** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**active_ruleset_id** | **int** | [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**tags** | **List[str]** | A list of tags for the campaign. |
**reevaluate_on_return** | **bool** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional]
**features** | **List[str]** | The features enabled in this campaign. |
Expand All @@ -21,6 +21,7 @@ Name | Type | Description | Notes
**campaign_groups** | **List[int]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
**type** | **str** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced']
**linked_store_ids** | **List[int]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
**coupon_attributes** | **object** | Arbitrary properties associated with coupons in this campaign. | [optional]

## Example

Expand Down
Loading
Loading