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
36 changes: 36 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ docs/AudienceIntegrationID.md
docs/AudienceMembership.md
docs/AudienceReference.md
docs/AwardGiveawayEffectProps.md
docs/BaseBlock.md
docs/BaseCampaign.md
docs/BaseLoyaltyProgram.md
docs/BaseNotification.md
Expand Down Expand Up @@ -206,6 +207,7 @@ docs/CreateTemplateCampaign.md
docs/CreateTemplateCampaignResponse.md
docs/CustomEffect.md
docs/CustomEffectProps.md
docs/CustomerAchievement.md
docs/CustomerActivityReport.md
docs/CustomerAnalytics.md
docs/CustomerInventory.md
Expand Down Expand Up @@ -546,6 +548,7 @@ docs/OutgoingIntegrationTemplateWithConfigurationDetails.md
docs/OutgoingIntegrationTemplates.md
docs/OutgoingIntegrationType.md
docs/OutgoingIntegrationTypes.md
docs/PassthroughBlock.md
docs/PatchItemCatalogAction.md
docs/PatchManyItemsCatalogAction.md
docs/PendingActivePointsData.md
Expand All @@ -567,6 +570,8 @@ docs/ProductUnitAnalyticsTotals.md
docs/ProfileAudiencesChanges.md
docs/ProjectedTier.md
docs/PromoteExperiment.md
docs/PromotionGroupBlock.md
docs/PromotionRuleV2.md
docs/RedeemReferralEffectProps.md
docs/Referral.md
docs/ReferralConstraints.md
Expand All @@ -588,6 +593,9 @@ docs/RevisionActivationRequest.md
docs/RevisionVersion.md
docs/Reward.md
docs/RewardPointsRequired.md
docs/Risk.md
docs/RiskAffectedEntityItem.md
docs/RiskDetail.md
docs/RiskNotification.md
docs/Role.md
docs/RoleAssign.md
Expand All @@ -612,7 +620,9 @@ docs/RuleEligibilityFailureDetails.md
docs/RuleFailureReason.md
docs/RuleMetadata.md
docs/RuleMetadataEligibility.md
docs/RuleV2.md
docs/Ruleset.md
docs/RulesetV2.md
docs/SSOConfig.md
docs/SamlConnection.md
docs/SamlConnectionInternal.md
Expand Down Expand Up @@ -654,7 +664,9 @@ docs/StrikethroughChangedItem.md
docs/StrikethroughCustomEffectPerItemProps.md
docs/StrikethroughDebugResponse.md
docs/StrikethroughEffect.md
docs/StrikethroughGroupBlock.md
docs/StrikethroughLabelingNotification.md
docs/StrikethroughRuleV2.md
docs/StrikethroughSetDiscountPerItemEffectProps.md
docs/StrikethroughSetDiscountPerItemMemberEffectProps.md
docs/StrikethroughTrigger.md
Expand Down Expand Up @@ -825,6 +837,7 @@ talon_one/models/audience_integration_id.py
talon_one/models/audience_membership.py
talon_one/models/audience_reference.py
talon_one/models/award_giveaway_effect_props.py
talon_one/models/base_block.py
talon_one/models/base_campaign.py
talon_one/models/base_loyalty_program.py
talon_one/models/base_notification.py
Expand Down Expand Up @@ -942,6 +955,7 @@ talon_one/models/create_template_campaign.py
talon_one/models/create_template_campaign_response.py
talon_one/models/custom_effect.py
talon_one/models/custom_effect_props.py
talon_one/models/customer_achievement.py
talon_one/models/customer_activity_report.py
talon_one/models/customer_analytics.py
talon_one/models/customer_inventory.py
Expand Down Expand Up @@ -1280,6 +1294,7 @@ talon_one/models/outgoing_integration_template_with_configuration_details.py
talon_one/models/outgoing_integration_templates.py
talon_one/models/outgoing_integration_type.py
talon_one/models/outgoing_integration_types.py
talon_one/models/passthrough_block.py
talon_one/models/patch_item_catalog_action.py
talon_one/models/patch_many_items_catalog_action.py
talon_one/models/pending_active_points_data.py
Expand All @@ -1301,6 +1316,8 @@ talon_one/models/product_unit_analytics_totals.py
talon_one/models/profile_audiences_changes.py
talon_one/models/projected_tier.py
talon_one/models/promote_experiment.py
talon_one/models/promotion_group_block.py
talon_one/models/promotion_rule_v2.py
talon_one/models/redeem_referral_effect_props.py
talon_one/models/referral.py
talon_one/models/referral_constraints.py
Expand All @@ -1322,6 +1339,9 @@ 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.py
talon_one/models/risk_affected_entity_item.py
talon_one/models/risk_detail.py
talon_one/models/risk_notification.py
talon_one/models/role.py
talon_one/models/role_assign.py
Expand All @@ -1346,7 +1366,9 @@ talon_one/models/rule_eligibility_failure_details.py
talon_one/models/rule_failure_reason.py
talon_one/models/rule_metadata.py
talon_one/models/rule_metadata_eligibility.py
talon_one/models/rule_v2.py
talon_one/models/ruleset.py
talon_one/models/ruleset_v2.py
talon_one/models/saml_connection.py
talon_one/models/saml_connection_internal.py
talon_one/models/saml_connection_metadata.py
Expand Down Expand Up @@ -1388,7 +1410,9 @@ talon_one/models/strikethrough_changed_item.py
talon_one/models/strikethrough_custom_effect_per_item_props.py
talon_one/models/strikethrough_debug_response.py
talon_one/models/strikethrough_effect.py
talon_one/models/strikethrough_group_block.py
talon_one/models/strikethrough_labeling_notification.py
talon_one/models/strikethrough_rule_v2.py
talon_one/models/strikethrough_set_discount_per_item_effect_props.py
talon_one/models/strikethrough_set_discount_per_item_member_effect_props.py
talon_one/models/strikethrough_trigger.py
Expand Down Expand Up @@ -1548,6 +1572,7 @@ test/test_audience_integration_id.py
test/test_audience_membership.py
test/test_audience_reference.py
test/test_award_giveaway_effect_props.py
test/test_base_block.py
test/test_base_campaign.py
test/test_base_loyalty_program.py
test/test_base_notification.py
Expand Down Expand Up @@ -1665,6 +1690,7 @@ test/test_create_template_campaign.py
test/test_create_template_campaign_response.py
test/test_custom_effect.py
test/test_custom_effect_props.py
test/test_customer_achievement.py
test/test_customer_activity_report.py
test/test_customer_analytics.py
test/test_customer_inventory.py
Expand Down Expand Up @@ -2005,6 +2031,7 @@ test/test_outgoing_integration_template_with_configuration_details.py
test/test_outgoing_integration_templates.py
test/test_outgoing_integration_type.py
test/test_outgoing_integration_types.py
test/test_passthrough_block.py
test/test_patch_item_catalog_action.py
test/test_patch_many_items_catalog_action.py
test/test_pending_active_points_data.py
Expand All @@ -2026,6 +2053,8 @@ test/test_product_unit_analytics_totals.py
test/test_profile_audiences_changes.py
test/test_projected_tier.py
test/test_promote_experiment.py
test/test_promotion_group_block.py
test/test_promotion_rule_v2.py
test/test_redeem_referral_effect_props.py
test/test_referral.py
test/test_referral_constraints.py
Expand All @@ -2047,6 +2076,9 @@ test/test_revision_activation_request.py
test/test_revision_version.py
test/test_reward.py
test/test_reward_points_required.py
test/test_risk.py
test/test_risk_affected_entity_item.py
test/test_risk_detail.py
test/test_risk_notification.py
test/test_role.py
test/test_role_assign.py
Expand All @@ -2071,7 +2103,9 @@ test/test_rule_eligibility_failure_details.py
test/test_rule_failure_reason.py
test/test_rule_metadata.py
test/test_rule_metadata_eligibility.py
test/test_rule_v2.py
test/test_ruleset.py
test/test_ruleset_v2.py
test/test_saml_connection.py
test/test_saml_connection_internal.py
test/test_saml_connection_metadata.py
Expand Down Expand Up @@ -2113,7 +2147,9 @@ test/test_strikethrough_changed_item.py
test/test_strikethrough_custom_effect_per_item_props.py
test/test_strikethrough_debug_response.py
test/test_strikethrough_effect.py
test/test_strikethrough_group_block.py
test/test_strikethrough_labeling_notification.py
test/test_strikethrough_rule_v2.py
test/test_strikethrough_set_discount_per_item_effect_props.py
test/test_strikethrough_set_discount_per_item_member_effect_props.py
test/test_strikethrough_trigger.py
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ 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* | [**integration_get_all_campaigns**](docs/IntegrationApi.md#integration_get_all_campaigns) | **GET** /v1/integration/campaigns | List all running campaigns
*IntegrationApi* | [**join_loyalty_program**](docs/IntegrationApi.md#join_loyalty_program) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/join | Join customer profile to loyalty program
*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* | [**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
Expand Down Expand Up @@ -313,6 +314,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
*ManagementApi* | [**get_role_v2**](docs/ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
*ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
*ManagementApi* | [**get_ruleset_v2**](docs/ManagementApi.md#get_ruleset_v2) | **GET** /v2/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset (V2)
*ManagementApi* | [**get_rulesets**](docs/ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets
*ManagementApi* | [**get_store**](docs/ManagementApi.md#get_store) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store
*ManagementApi* | [**get_user**](docs/ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get user
Expand Down Expand Up @@ -461,6 +463,7 @@ Class | Method | HTTP request | Description
- [AudienceMembership](docs/AudienceMembership.md)
- [AudienceReference](docs/AudienceReference.md)
- [AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md)
- [BaseBlock](docs/BaseBlock.md)
- [BaseCampaign](docs/BaseCampaign.md)
- [BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md)
- [BaseNotification](docs/BaseNotification.md)
Expand Down Expand Up @@ -578,6 +581,7 @@ Class | Method | HTTP request | Description
- [CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md)
- [CustomEffect](docs/CustomEffect.md)
- [CustomEffectProps](docs/CustomEffectProps.md)
- [CustomerAchievement](docs/CustomerAchievement.md)
- [CustomerActivityReport](docs/CustomerActivityReport.md)
- [CustomerAnalytics](docs/CustomerAnalytics.md)
- [CustomerInventory](docs/CustomerInventory.md)
Expand Down Expand Up @@ -916,6 +920,7 @@ Class | Method | HTTP request | Description
- [OutgoingIntegrationTemplates](docs/OutgoingIntegrationTemplates.md)
- [OutgoingIntegrationType](docs/OutgoingIntegrationType.md)
- [OutgoingIntegrationTypes](docs/OutgoingIntegrationTypes.md)
- [PassthroughBlock](docs/PassthroughBlock.md)
- [PatchItemCatalogAction](docs/PatchItemCatalogAction.md)
- [PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md)
- [PendingActivePointsData](docs/PendingActivePointsData.md)
Expand All @@ -937,6 +942,8 @@ Class | Method | HTTP request | Description
- [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
- [ProjectedTier](docs/ProjectedTier.md)
- [PromoteExperiment](docs/PromoteExperiment.md)
- [PromotionGroupBlock](docs/PromotionGroupBlock.md)
- [PromotionRuleV2](docs/PromotionRuleV2.md)
- [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
- [Referral](docs/Referral.md)
- [ReferralConstraints](docs/ReferralConstraints.md)
Expand All @@ -958,6 +965,9 @@ Class | Method | HTTP request | Description
- [RevisionVersion](docs/RevisionVersion.md)
- [Reward](docs/Reward.md)
- [RewardPointsRequired](docs/RewardPointsRequired.md)
- [Risk](docs/Risk.md)
- [RiskAffectedEntityItem](docs/RiskAffectedEntityItem.md)
- [RiskDetail](docs/RiskDetail.md)
- [RiskNotification](docs/RiskNotification.md)
- [Role](docs/Role.md)
- [RoleAssign](docs/RoleAssign.md)
Expand All @@ -982,7 +992,9 @@ Class | Method | HTTP request | Description
- [RuleFailureReason](docs/RuleFailureReason.md)
- [RuleMetadata](docs/RuleMetadata.md)
- [RuleMetadataEligibility](docs/RuleMetadataEligibility.md)
- [RuleV2](docs/RuleV2.md)
- [Ruleset](docs/Ruleset.md)
- [RulesetV2](docs/RulesetV2.md)
- [SSOConfig](docs/SSOConfig.md)
- [SamlConnection](docs/SamlConnection.md)
- [SamlConnectionInternal](docs/SamlConnectionInternal.md)
Expand Down Expand Up @@ -1024,7 +1036,9 @@ Class | Method | HTTP request | Description
- [StrikethroughCustomEffectPerItemProps](docs/StrikethroughCustomEffectPerItemProps.md)
- [StrikethroughDebugResponse](docs/StrikethroughDebugResponse.md)
- [StrikethroughEffect](docs/StrikethroughEffect.md)
- [StrikethroughGroupBlock](docs/StrikethroughGroupBlock.md)
- [StrikethroughLabelingNotification](docs/StrikethroughLabelingNotification.md)
- [StrikethroughRuleV2](docs/StrikethroughRuleV2.md)
- [StrikethroughSetDiscountPerItemEffectProps](docs/StrikethroughSetDiscountPerItemEffectProps.md)
- [StrikethroughSetDiscountPerItemMemberEffectProps](docs/StrikethroughSetDiscountPerItemMemberEffectProps.md)
- [StrikethroughTrigger](docs/StrikethroughTrigger.md)
Expand Down
32 changes: 32 additions & 0 deletions docs/BaseBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# BaseBlock

Common properties shared by all block types.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique identifier for this block. |
**type** | **str** | Identifies the block variant and determines which additional properties are present in it. |
**tags** | **List[str]** | Semantic labels attached to this block. | [optional]

## Example

```python
from talon_one.models.base_block import BaseBlock

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

# convert the object into a dict
base_block_dict = base_block_instance.to_dict()
# create an instance of BaseBlock from a dict
base_block_from_dict = BaseBlock.from_dict(base_block_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)


40 changes: 40 additions & 0 deletions docs/CustomerAchievement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# CustomerAchievement

A customer's progress in an achievement, together with the achievement definition.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The internal ID of the achievement. |
**name** | **str** | The internal name of the achievement used in API requests. |
**title** | **str** | The display name of the achievement in the Campaign Manager. |
**description** | **str** | The description of the achievement in the Campaign Manager. |
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. |
**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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
**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. |
**fixed_start_date** | **datetime** | The achievement's start date when `activationPolicy` is equal to `fixed_schedule`. **Note:** It is 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 is an RFC3339 timestamp string. | [optional]
**allow_rollback_after_completion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. |
**current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]

## Example

```python
from talon_one.models.customer_achievement import CustomerAchievement

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

# convert the object into a dict
customer_achievement_dict = customer_achievement_instance.to_dict()
# create an instance of CustomerAchievement from a dict
customer_achievement_from_dict = CustomerAchievement.from_dict(customer_achievement_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)


Loading
Loading