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
21 changes: 21 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,14 @@ docs/AccountEntity.md
docs/AccountLimits.md
docs/Achievement.md
docs/AchievementAdditionalProperties.md
docs/AchievementAdditionalPropertiesV2.md
docs/AchievementBase.md
docs/AchievementBaseV2.md
docs/AchievementProgress.md
docs/AchievementProgressWithDefinition.md
docs/AchievementReference.md
docs/AchievementStatusEntry.md
docs/AchievementV2.md
docs/ActivateLoyaltyPoints.md
docs/ActivateLoyaltyPointsResponse.md
docs/ActivateUserRequest.md
Expand Down Expand Up @@ -184,6 +188,7 @@ docs/CouponWithApplication.md
docs/CouponsNotificationData.md
docs/CouponsNotificationPolicy.md
docs/CreateAchievement.md
docs/CreateAchievementV2.md
docs/CreateApplicationAPIKey.md
docs/CreateCouponData.md
docs/CreateCoupons200Response.md
Expand Down Expand Up @@ -319,6 +324,7 @@ docs/ImportEntity.md
docs/IncreaseAchievementProgressEffectProps.md
docs/InfluencingCampaignDetails.md
docs/IntegrationApi.md
docs/IntegrationCampaign.md
docs/IntegrationCoupon.md
docs/IntegrationCustomerProfileAudienceRequest.md
docs/IntegrationCustomerProfileAudienceRequestItem.md
Expand Down Expand Up @@ -633,6 +639,7 @@ docs/TriggerWebhookEffectProps.md
docs/TwoFAConfig.md
docs/UpdateAccount.md
docs/UpdateAchievement.md
docs/UpdateAchievementV2.md
docs/UpdateApplication.md
docs/UpdateApplicationAPIKey.md
docs/UpdateApplicationCIF.md
Expand Down Expand Up @@ -708,10 +715,14 @@ talon_one/models/account_entity.py
talon_one/models/account_limits.py
talon_one/models/achievement.py
talon_one/models/achievement_additional_properties.py
talon_one/models/achievement_additional_properties_v2.py
talon_one/models/achievement_base.py
talon_one/models/achievement_base_v2.py
talon_one/models/achievement_progress.py
talon_one/models/achievement_progress_with_definition.py
talon_one/models/achievement_reference.py
talon_one/models/achievement_status_entry.py
talon_one/models/achievement_v2.py
talon_one/models/activate_loyalty_points.py
talon_one/models/activate_loyalty_points_response.py
talon_one/models/activate_user_request.py
Expand Down Expand Up @@ -868,6 +879,7 @@ talon_one/models/coupon_with_application.py
talon_one/models/coupons_notification_data.py
talon_one/models/coupons_notification_policy.py
talon_one/models/create_achievement.py
talon_one/models/create_achievement_v2.py
talon_one/models/create_application_api_key.py
talon_one/models/create_coupon_data.py
talon_one/models/create_coupons200_response.py
Expand Down Expand Up @@ -1002,6 +1014,7 @@ talon_one/models/identifiable_entity.py
talon_one/models/import_entity.py
talon_one/models/increase_achievement_progress_effect_props.py
talon_one/models/influencing_campaign_details.py
talon_one/models/integration_campaign.py
talon_one/models/integration_coupon.py
talon_one/models/integration_customer_profile_audience_request.py
talon_one/models/integration_customer_profile_audience_request_item.py
Expand Down Expand Up @@ -1315,6 +1328,7 @@ talon_one/models/trigger_webhook_effect_props.py
talon_one/models/two_fa_config.py
talon_one/models/update_account.py
talon_one/models/update_achievement.py
talon_one/models/update_achievement_v2.py
talon_one/models/update_application.py
talon_one/models/update_application_api_key.py
talon_one/models/update_application_cif.py
Expand Down Expand Up @@ -1379,10 +1393,14 @@ test/test_account_entity.py
test/test_account_limits.py
test/test_achievement.py
test/test_achievement_additional_properties.py
test/test_achievement_additional_properties_v2.py
test/test_achievement_base.py
test/test_achievement_base_v2.py
test/test_achievement_progress.py
test/test_achievement_progress_with_definition.py
test/test_achievement_reference.py
test/test_achievement_status_entry.py
test/test_achievement_v2.py
test/test_activate_loyalty_points.py
test/test_activate_loyalty_points_response.py
test/test_activate_user_request.py
Expand Down Expand Up @@ -1539,6 +1557,7 @@ test/test_coupon_with_application.py
test/test_coupons_notification_data.py
test/test_coupons_notification_policy.py
test/test_create_achievement.py
test/test_create_achievement_v2.py
test/test_create_application_api_key.py
test/test_create_coupon_data.py
test/test_create_coupons200_response.py
Expand Down Expand Up @@ -1674,6 +1693,7 @@ test/test_import_entity.py
test/test_increase_achievement_progress_effect_props.py
test/test_influencing_campaign_details.py
test/test_integration_api.py
test/test_integration_campaign.py
test/test_integration_coupon.py
test/test_integration_customer_profile_audience_request.py
test/test_integration_customer_profile_audience_request_item.py
Expand Down Expand Up @@ -1988,6 +2008,7 @@ test/test_trigger_webhook_effect_props.py
test/test_two_fa_config.py
test/test_update_account.py
test/test_update_achievement.py
test/test_update_achievement_v2.py
test/test_update_application.py
test/test_update_application_api_key.py
test/test_update_application_cif.py
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,10 +392,14 @@ Class | Method | HTTP request | Description
- [AccountLimits](docs/AccountLimits.md)
- [Achievement](docs/Achievement.md)
- [AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md)
- [AchievementAdditionalPropertiesV2](docs/AchievementAdditionalPropertiesV2.md)
- [AchievementBase](docs/AchievementBase.md)
- [AchievementBaseV2](docs/AchievementBaseV2.md)
- [AchievementProgress](docs/AchievementProgress.md)
- [AchievementProgressWithDefinition](docs/AchievementProgressWithDefinition.md)
- [AchievementReference](docs/AchievementReference.md)
- [AchievementStatusEntry](docs/AchievementStatusEntry.md)
- [AchievementV2](docs/AchievementV2.md)
- [ActivateLoyaltyPoints](docs/ActivateLoyaltyPoints.md)
- [ActivateLoyaltyPointsResponse](docs/ActivateLoyaltyPointsResponse.md)
- [ActivateUserRequest](docs/ActivateUserRequest.md)
Expand Down Expand Up @@ -551,6 +555,7 @@ Class | Method | HTTP request | Description
- [CouponsNotificationData](docs/CouponsNotificationData.md)
- [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md)
- [CreateAchievement](docs/CreateAchievement.md)
- [CreateAchievementV2](docs/CreateAchievementV2.md)
- [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
- [CreateCouponData](docs/CreateCouponData.md)
- [CreateCoupons200Response](docs/CreateCoupons200Response.md)
Expand Down Expand Up @@ -685,6 +690,7 @@ Class | Method | HTTP request | Description
- [ImportEntity](docs/ImportEntity.md)
- [IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md)
- [InfluencingCampaignDetails](docs/InfluencingCampaignDetails.md)
- [IntegrationCampaign](docs/IntegrationCampaign.md)
- [IntegrationCoupon](docs/IntegrationCoupon.md)
- [IntegrationCustomerProfileAudienceRequest](docs/IntegrationCustomerProfileAudienceRequest.md)
- [IntegrationCustomerProfileAudienceRequestItem](docs/IntegrationCustomerProfileAudienceRequestItem.md)
Expand Down Expand Up @@ -998,6 +1004,7 @@ Class | Method | HTTP request | Description
- [TwoFAConfig](docs/TwoFAConfig.md)
- [UpdateAccount](docs/UpdateAccount.md)
- [UpdateAchievement](docs/UpdateAchievement.md)
- [UpdateAchievementV2](docs/UpdateAchievementV2.md)
- [UpdateApplication](docs/UpdateApplication.md)
- [UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
- [UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
Expand Down
32 changes: 32 additions & 0 deletions docs/AchievementAdditionalPropertiesV2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AchievementAdditionalPropertiesV2


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]

## Example

```python
from talon_one.models.achievement_additional_properties_v2 import AchievementAdditionalPropertiesV2

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

# convert the object into a dict
achievement_additional_properties_v2_dict = achievement_additional_properties_v2_instance.to_dict()
# create an instance of AchievementAdditionalPropertiesV2 from a dict
achievement_additional_properties_v2_from_dict = AchievementAdditionalPropertiesV2.from_dict(achievement_additional_properties_v2_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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. | [optional]
**title** | **str** | The display name for the achievement in the Campaign Manager. | [optional]
**description** | **str** | A description of the achievement. | [optional]
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**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. | [optional]
**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. | [optional]
**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. | [optional]
**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

```python
from talon_one.models.achievement_base_v2 import AchievementBaseV2

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

# convert the object into a dict
achievement_base_v2_dict = achievement_base_v2_instance.to_dict()
# create an instance of AchievementBaseV2 from a dict
achievement_base_v2_from_dict = AchievementBaseV2.from_dict(achievement_base_v2_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**achievement_id** | **int** | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievementsV2) endpoint. |
**application_id** | **int** | The ID of the Application associated with the campaign that references this achievement. |
**application_name** | **str** | The name of the Application associated with the campaign that references this achievement. |
**campaign_id** | **int** | The ID of the campaign that references this achievement. |

## Example

```python
from talon_one.models.achievement_reference import AchievementReference

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

# convert the object into a dict
achievement_reference_dict = achievement_reference_instance.to_dict()
# create an instance of AchievementReference from a dict
achievement_reference_from_dict = AchievementReference.from_dict(achievement_reference_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The internal ID of this entity. |
**created** | **datetime** | The time this entity was created. |
**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. | [optional]
**title** | **str** | The display name for the achievement in the Campaign Manager. | [optional]
**description** | **str** | A description of the achievement. | [optional]
**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**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. | [optional]
**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. | [optional]
**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. | [optional]
**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]
**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]

## Example

```python
from talon_one.models.achievement_v2 import AchievementV2

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

# convert the object into a dict
achievement_v2_dict = achievement_v2_instance.to_dict()
# create an instance of AchievementV2 from a dict
achievement_v2_from_dict = AchievementV2.from_dict(achievement_v2_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)


3 changes: 2 additions & 1 deletion docs/AddedDeductedPointsBalancesAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | **float** | The amount of added or deducted loyalty points. |
**reason** | **str** | The reason for the points addition or deduction. |
**operation** | **str** | The action (addition or deduction) made with loyalty points. |
**operation** | **str** | The action (addition or subtraction) made with loyalty points. |
**start_date** | **datetime** | The start date for loyalty points. | [optional]
**expiry_date** | **datetime** | The expiration date for loyalty points. | [optional]
**transaction_uuid** | **UUID** | The identifier of the transaction in the loyalty ledger. |

## Example

Expand Down
Loading
Loading