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
Jump to file
Failed to load files.
Loading
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 @@ -164,6 +164,7 @@ docs/CardLedgerTransactionLogEntryIntegrationAPI.md
docs/CartItem.md
docs/CartItemFilterTemplate.md
docs/Catalog.md
docs/CatalogAction.md
docs/CatalogActionFilter.md
docs/CatalogItem.md
docs/CatalogRule.md
Expand Down Expand Up @@ -243,6 +244,9 @@ docs/EventAttributesEntity.md
docs/EventType.md
docs/EventV2.md
docs/EventV3.md
docs/EventV3Connections.md
docs/EventV3Entity.md
docs/EventV3RequestEntity.md
docs/Experiment.md
docs/ExperimentCampaignCopy.md
docs/ExperimentCopy.md
Expand Down Expand Up @@ -367,6 +371,7 @@ docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationActio
docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md
docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md
docs/IntegrationHubEventRecord.md
docs/IntegrationHubEventStatusUpdate.md
docs/IntegrationHubFlow.md
docs/IntegrationHubFlowConfig.md
docs/IntegrationHubFlowConfigResponse.md
Expand Down Expand Up @@ -483,6 +488,7 @@ docs/NewCustomerSession.md
docs/NewCustomerSessionV2.md
docs/NewEvent.md
docs/NewEventType.md
docs/NewEventV3Entity.md
docs/NewExperiment.md
docs/NewExperimentVariant.md
docs/NewExperimentVariantArray.md
Expand Down Expand Up @@ -578,6 +584,7 @@ docs/RevisionActivation.md
docs/RevisionActivationRequest.md
docs/RevisionVersion.md
docs/Reward.md
docs/RewardPointsRequired.md
docs/RiskNotification.md
docs/Role.md
docs/RoleAssign.md
Expand Down Expand Up @@ -652,6 +659,8 @@ docs/StrikethroughSetDiscountPerItemMemberEffectProps.md
docs/StrikethroughTrigger.md
docs/SummarizeCampaignStoreBudget200Response.md
docs/SummaryCampaignStoreBudget.md
docs/SupportRequest.md
docs/SupportRequestInput.md
docs/TalangAttribute.md
docs/TalangAttributeVisibility.md
docs/TemplateArgDef.md
Expand Down Expand Up @@ -709,6 +718,7 @@ docs/UpdateReferralBatch.md
docs/UpdateReward.md
docs/UpdateRole.md
docs/UpdateStore.md
docs/UpdateSupportRequest.md
docs/UpdateUser.md
docs/User.md
docs/UserEntity.md
Expand Down Expand Up @@ -889,6 +899,7 @@ talon_one/models/card_ledger_transaction_log_entry_integration_api.py
talon_one/models/cart_item.py
talon_one/models/cart_item_filter_template.py
talon_one/models/catalog.py
talon_one/models/catalog_action.py
talon_one/models/catalog_action_filter.py
talon_one/models/catalog_item.py
talon_one/models/catalog_rule.py
Expand Down Expand Up @@ -968,6 +979,9 @@ talon_one/models/event_attributes_entity.py
talon_one/models/event_type.py
talon_one/models/event_v2.py
talon_one/models/event_v3.py
talon_one/models/event_v3_connections.py
talon_one/models/event_v3_entity.py
talon_one/models/event_v3_request_entity.py
talon_one/models/experiment.py
talon_one/models/experiment_campaign_copy.py
talon_one/models/experiment_copy.py
Expand Down Expand Up @@ -1091,6 +1105,7 @@ talon_one/models/integration_hub_event_payload_loyalty_profile_based_points_chan
talon_one/models/integration_hub_event_payload_loyalty_profile_based_tier_downgrade_notification.py
talon_one/models/integration_hub_event_payload_loyalty_profile_based_tier_upgrade_notification.py
talon_one/models/integration_hub_event_record.py
talon_one/models/integration_hub_event_status_update.py
talon_one/models/integration_hub_flow.py
talon_one/models/integration_hub_flow_config.py
talon_one/models/integration_hub_flow_config_response.py
Expand Down Expand Up @@ -1206,6 +1221,7 @@ talon_one/models/new_customer_session.py
talon_one/models/new_customer_session_v2.py
talon_one/models/new_event.py
talon_one/models/new_event_type.py
talon_one/models/new_event_v3_entity.py
talon_one/models/new_experiment.py
talon_one/models/new_experiment_variant.py
talon_one/models/new_experiment_variant_array.py
Expand Down Expand Up @@ -1301,6 +1317,7 @@ talon_one/models/revision_activation.py
talon_one/models/revision_activation_request.py
talon_one/models/revision_version.py
talon_one/models/reward.py
talon_one/models/reward_points_required.py
talon_one/models/risk_notification.py
talon_one/models/role.py
talon_one/models/role_assign.py
Expand Down Expand Up @@ -1375,6 +1392,8 @@ talon_one/models/strikethrough_set_discount_per_item_member_effect_props.py
talon_one/models/strikethrough_trigger.py
talon_one/models/summarize_campaign_store_budget200_response.py
talon_one/models/summary_campaign_store_budget.py
talon_one/models/support_request.py
talon_one/models/support_request_input.py
talon_one/models/talang_attribute.py
talon_one/models/talang_attribute_visibility.py
talon_one/models/template_arg_def.py
Expand Down Expand Up @@ -1432,6 +1451,7 @@ talon_one/models/update_referral_batch.py
talon_one/models/update_reward.py
talon_one/models/update_role.py
talon_one/models/update_store.py
talon_one/models/update_support_request.py
talon_one/models/update_user.py
talon_one/models/user.py
talon_one/models/user_entity.py
Expand Down Expand Up @@ -1601,6 +1621,7 @@ test/test_card_ledger_transaction_log_entry_integration_api.py
test/test_cart_item.py
test/test_cart_item_filter_template.py
test/test_catalog.py
test/test_catalog_action.py
test/test_catalog_action_filter.py
test/test_catalog_item.py
test/test_catalog_rule.py
Expand Down Expand Up @@ -1680,6 +1701,9 @@ test/test_event_attributes_entity.py
test/test_event_type.py
test/test_event_v2.py
test/test_event_v3.py
test/test_event_v3_connections.py
test/test_event_v3_entity.py
test/test_event_v3_request_entity.py
test/test_experiment.py
test/test_experiment_campaign_copy.py
test/test_experiment_copy.py
Expand Down Expand Up @@ -1804,6 +1828,7 @@ test/test_integration_hub_event_payload_loyalty_profile_based_points_changed_not
test/test_integration_hub_event_payload_loyalty_profile_based_tier_downgrade_notification.py
test/test_integration_hub_event_payload_loyalty_profile_based_tier_upgrade_notification.py
test/test_integration_hub_event_record.py
test/test_integration_hub_event_status_update.py
test/test_integration_hub_flow.py
test/test_integration_hub_flow_config.py
test/test_integration_hub_flow_config_response.py
Expand Down Expand Up @@ -1920,6 +1945,7 @@ test/test_new_customer_session.py
test/test_new_customer_session_v2.py
test/test_new_event.py
test/test_new_event_type.py
test/test_new_event_v3_entity.py
test/test_new_experiment.py
test/test_new_experiment_variant.py
test/test_new_experiment_variant_array.py
Expand Down Expand Up @@ -2015,6 +2041,7 @@ test/test_revision_activation.py
test/test_revision_activation_request.py
test/test_revision_version.py
test/test_reward.py
test/test_reward_points_required.py
test/test_risk_notification.py
test/test_role.py
test/test_role_assign.py
Expand Down Expand Up @@ -2089,6 +2116,8 @@ test/test_strikethrough_set_discount_per_item_member_effect_props.py
test/test_strikethrough_trigger.py
test/test_summarize_campaign_store_budget200_response.py
test/test_summary_campaign_store_budget.py
test/test_support_request.py
test/test_support_request_input.py
test/test_talang_attribute.py
test/test_talang_attribute_visibility.py
test/test_template_arg_def.py
Expand Down Expand Up @@ -2146,6 +2175,7 @@ test/test_update_referral_batch.py
test/test_update_reward.py
test/test_update_role.py
test/test_update_store.py
test/test_update_support_request.py
test/test_update_user.py
test/test_user.py
test/test_user_entity.py
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@ Class | Method | HTTP request | Description
- [CartItem](docs/CartItem.md)
- [CartItemFilterTemplate](docs/CartItemFilterTemplate.md)
- [Catalog](docs/Catalog.md)
- [CatalogAction](docs/CatalogAction.md)
- [CatalogActionFilter](docs/CatalogActionFilter.md)
- [CatalogItem](docs/CatalogItem.md)
- [CatalogRule](docs/CatalogRule.md)
Expand Down Expand Up @@ -612,6 +613,9 @@ Class | Method | HTTP request | Description
- [EventType](docs/EventType.md)
- [EventV2](docs/EventV2.md)
- [EventV3](docs/EventV3.md)
- [EventV3Connections](docs/EventV3Connections.md)
- [EventV3Entity](docs/EventV3Entity.md)
- [EventV3RequestEntity](docs/EventV3RequestEntity.md)
- [Experiment](docs/Experiment.md)
- [ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
- [ExperimentCopy](docs/ExperimentCopy.md)
Expand Down Expand Up @@ -735,6 +739,7 @@ Class | Method | HTTP request | Description
- [IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md)
- [IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md)
- [IntegrationHubEventRecord](docs/IntegrationHubEventRecord.md)
- [IntegrationHubEventStatusUpdate](docs/IntegrationHubEventStatusUpdate.md)
- [IntegrationHubFlow](docs/IntegrationHubFlow.md)
- [IntegrationHubFlowConfig](docs/IntegrationHubFlowConfig.md)
- [IntegrationHubFlowConfigResponse](docs/IntegrationHubFlowConfigResponse.md)
Expand Down Expand Up @@ -850,6 +855,7 @@ Class | Method | HTTP request | Description
- [NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
- [NewEvent](docs/NewEvent.md)
- [NewEventType](docs/NewEventType.md)
- [NewEventV3Entity](docs/NewEventV3Entity.md)
- [NewExperiment](docs/NewExperiment.md)
- [NewExperimentVariant](docs/NewExperimentVariant.md)
- [NewExperimentVariantArray](docs/NewExperimentVariantArray.md)
Expand Down Expand Up @@ -945,6 +951,7 @@ Class | Method | HTTP request | Description
- [RevisionActivationRequest](docs/RevisionActivationRequest.md)
- [RevisionVersion](docs/RevisionVersion.md)
- [Reward](docs/Reward.md)
- [RewardPointsRequired](docs/RewardPointsRequired.md)
- [RiskNotification](docs/RiskNotification.md)
- [Role](docs/Role.md)
- [RoleAssign](docs/RoleAssign.md)
Expand Down Expand Up @@ -1019,6 +1026,8 @@ Class | Method | HTTP request | Description
- [StrikethroughTrigger](docs/StrikethroughTrigger.md)
- [SummarizeCampaignStoreBudget200Response](docs/SummarizeCampaignStoreBudget200Response.md)
- [SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.md)
- [SupportRequest](docs/SupportRequest.md)
- [SupportRequestInput](docs/SupportRequestInput.md)
- [TalangAttribute](docs/TalangAttribute.md)
- [TalangAttributeVisibility](docs/TalangAttributeVisibility.md)
- [TemplateArgDef](docs/TemplateArgDef.md)
Expand Down Expand Up @@ -1076,6 +1085,7 @@ Class | Method | HTTP request | Description
- [UpdateReward](docs/UpdateReward.md)
- [UpdateRole](docs/UpdateRole.md)
- [UpdateStore](docs/UpdateStore.md)
- [UpdateSupportRequest](docs/UpdateSupportRequest.md)
- [UpdateUser](docs/UpdateUser.md)
- [User](docs/User.md)
- [UserEntity](docs/UserEntity.md)
Expand Down
2 changes: 0 additions & 2 deletions docs/AchievementBaseV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ Name | Type | Description | Notes
**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]
**allow_rollback_after_completion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**sandbox** | **bool** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | [optional]
**subscribed_applications** | **List[int]** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | [optional]
**timezone** | **str** | A string containing an IANA timezone descriptor. | [optional]

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/AchievementV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Name | Type | Description | Notes
**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]
**allow_rollback_after_completion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**sandbox** | **bool** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |
**subscribed_applications** | **List[int]** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. |
**timezone** | **str** | A string containing an IANA timezone descriptor. |
**user_id** | **int** | The 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. | [optional]
**has_progress** | **bool** | Indicates if a customer has made progress in the achievement. | [optional]
**status** | **str** | The status of the achievement. | [optional]
**sandbox** | **bool** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |
**timezone** | **str** | A string containing an IANA timezone descriptor. |

## Example

Expand Down
3 changes: 2 additions & 1 deletion docs/ApplicationEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ Name | Type | Description | Notes
**profile_id** | **int** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
**store_id** | **int** | The ID of the store. | [optional]
**store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional]
**integration_id** | **str** | The unique ID of the event. Only one event with this ID can be registered. | [optional]
**session_id** | **int** | The globally unique Talon.One ID of the session that contains this event. | [optional]
**type** | **str** | A string representing the event. Must not be a reserved event name. |
**type** | **str** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. |
**attributes** | **object** | Additional JSON serialized data associated with the event. |
**effects** | [**List[Effect]**](Effect.md) | An array containing the effects that were applied as a result of this event. |
**rule_failure_reasons** | [**List[RuleFailureReason]**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/BestPriorPrice.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Name | Type | Description | Notes
**id** | **int** | The ID of the historical price. |
**sku** | **str** | sku |
**observed_at** | **datetime** | The date and time when the price was observed. |
**context_id** | **str** | The context ID of the context active at the time of observation. |
**context_ids** | **List[str]** | The identifiers of the relevant context at the time the price was observed. Includes the context IDs of any price adjustments and of the campaigns that influenced the final price. |
**context_id** | **str** | This property is **deprecated**. Use `contextIds` instead. Defaults to an empty string. | [optional] [default to '']
**price** | **float** | Price of the item. |
**metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | |
**target** | **object** | |
Expand Down
31 changes: 31 additions & 0 deletions docs/CatalogAction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# CatalogAction

Definition of all the properties that are needed for a single catalog sync action.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type of sync action. |
**payload** | **object** | |

## Example

```python
from talon_one.models.catalog_action import CatalogAction

# TODO update the JSON string below
json = "{}"
# create an instance of CatalogAction from a JSON string
catalog_action_instance = CatalogAction.from_json(json)
# print the JSON string representation of the object
print(CatalogAction.to_json())

# convert the object into a dict
catalog_action_dict = catalog_action_instance.to_dict()
# create an instance of CatalogAction from a dict
catalog_action_from_dict = CatalogAction.from_dict(catalog_action_dict)
```
[[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/CatalogSyncRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actions** | **List[object]** | |
**actions** | [**List[CatalogAction]**](CatalogAction.md) | |
**version** | **int** | The version number of the catalog to apply the actions on. | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateAchievementV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Name | Type | Description | Notes
**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]
**allow_rollback_after_completion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**sandbox** | **bool** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |
**subscribed_applications** | **List[int]** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | [optional]
**sandbox** | **bool** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. |
**timezone** | **str** | A string containing an IANA timezone descriptor. |

## Example
Expand Down
1 change: 1 addition & 0 deletions docs/CustomerSessionV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Name | Type | Description | Notes
**total** | **float** | The total value of cart items and additional costs in the session, before any discounts are applied. |
**cart_item_total** | **float** | The total value of cart items, before any discounts are applied. |
**additional_cost_total** | **float** | The total value of additional costs, before any discounts are applied. |
**cart_item_additional_cost_total** | **float** | The total value of additional costs applied to individual items, before any discounts are applied. | [readonly]
**updated** | **datetime** | Timestamp of the most recent event received on this session. |

## Example
Expand Down
3 changes: 2 additions & 1 deletion docs/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ Name | Type | Description | Notes
**application_id** | **int** | The ID of the Application that owns this entity. |
**profile_id** | **str** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
**store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional]
**type** | **str** | A string representing the event. Must not be a reserved event name. |
**type** | **str** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. |
**attributes** | **object** | Arbitrary additional JSON data associated with the event. |
**integration_id** | **str** | The unique ID of the event. Only one event with this ID can be registered. | [optional]
**session_id** | **str** | The ID of the session that this event occurred in. | [optional]
**effects** | **List[object]** | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
**ledger_entries** | [**List[LedgerEntry]**](LedgerEntry.md) | Ledger entries for the event. | [optional]
Expand Down
Loading
Loading