You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*TalonOne.ManagementApi* | [**getCustomerProfileAchievementProgress**](docs/ManagementApi.md#getCustomerProfileAchievementProgress) | **GET** /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements
296
296
*TalonOne.ManagementApi* | [**getCustomerProfiles**](docs/ManagementApi.md#getCustomerProfiles) | **GET** /v1/customers/no_total | List customer profiles
297
297
*TalonOne.ManagementApi* | [**getCustomersByAttributes**](docs/ManagementApi.md#getCustomersByAttributes) | **POST** /v1/customer_search/no_total | List customer profiles matching the given attributes
298
+
*TalonOne.ManagementApi* | [**getDashboardStatistics**](docs/ManagementApi.md#getDashboardStatistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/dashboard | Get statistics for loyalty dashboard
298
299
*TalonOne.ManagementApi* | [**getEventTypes**](docs/ManagementApi.md#getEventTypes) | **GET** /v1/event_types | List event types
299
300
*TalonOne.ManagementApi* | [**getExports**](docs/ManagementApi.md#getExports) | **GET** /v1/exports | Get exports
300
301
*TalonOne.ManagementApi* | [**getLoyaltyCard**](docs/ManagementApi.md#getLoyaltyCard) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
Copy file name to clipboardexpand all lines: docs/Achievement.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,14 @@ Name | Type | Description | Notes
10
10
**title** | **String** | The display name for the achievement in the Campaign Manager. |
11
11
**description** | **String** | A description of the achievement. |
12
12
**target** | **Number** | The required number of actions or the transactional milestone to complete the achievement. |
13
-
**period** | **String** | 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. |
13
+
**period** | **String** | 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]
**recurrencePolicy** | **String** | 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. | [optional]
16
16
**activationPolicy** | **String** | 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]
17
17
**fixedStartDate** | **Date** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
18
18
**endDate** | **Date** | 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]
19
+
**isCappedByTarget** | **Boolean** | When `true`, it prevents the achievement from exceeding the target. | [optional]
20
+
**isOptinRequired** | **Boolean** | When `true`, a customer can join an achievement only after explicit opt-in. | [optional]
19
21
**campaignId** | **Number** | ID of the campaign, to which the achievement belongs to |
20
22
**userId** | **Number** | ID of the user that created this achievement. |
21
23
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
**name** | **String** | 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]
8
+
**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional]
9
+
**description** | **String** | A description of the achievement. | [optional]
10
+
**target** | **Number** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
11
+
**period** | **String** | 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]
**recurrencePolicy** | **String** | 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. | [optional]
14
+
**activationPolicy** | **String** | 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]
15
+
**fixedStartDate** | **Date** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
16
+
**endDate** | **Date** | 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]
17
+
**isCappedByTarget** | **Boolean** | When `true`, it prevents the achievement from exceeding the target. | [optional]
18
+
**isOptinRequired** | **Boolean** | When `true`, a customer can join an achievement only after explicit opt-in. | [optional]
**id** | **Number** | Internal ID of this entity. |
8
+
**created** | **Date** | The time this entity was created. |
9
+
**name** | **String** | 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. |
10
+
**title** | **String** | The display name for the achievement in the Campaign Manager. |
11
+
**description** | **String** | A description of the achievement. |
12
+
**target** | **Number** | The required number of actions or the transactional milestone to complete the achievement. |
13
+
**period** | **String** | 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]
**recurrencePolicy** | **String** | 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. | [optional]
16
+
**activationPolicy** | **String** | 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]
17
+
**fixedStartDate** | **Date** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
18
+
**endDate** | **Date** | 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]
19
+
**isCappedByTarget** | **Boolean** | When `true`, it prevents the achievement from exceeding the target. | [optional]
20
+
**isOptinRequired** | **Boolean** | When `true`, a customer can join an achievement only after explicit opt-in. | [optional]
Copy file name to clipboardexpand all lines: docs/AchievementProgress.md
+29
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,15 @@ Name | Type | Description | Notes
11
11
**campaignId** | **Number** | The ID of the campaign the achievement belongs to. |
12
12
**status** | **String** | The status of the achievement. |
13
13
**target** | **Number** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
14
+
**achievementRecurrencePolicy** | **String** | 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. |
15
+
**achievementActivationPolicy** | **String** | 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. |
16
+
**achievementFixedStartDate** | **Date** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
17
+
**achievementEndDate** | **Date** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
14
18
**progress** | **Number** | The current progress of the customer in the achievement. |
15
19
**startDate** | **Date** | Timestamp at which the customer started the achievement. |
16
20
**completionDate** | **Date** | Timestamp at which point the customer completed the achievement. | [optional]
17
21
**endDate** | **Date** | Timestamp at which point the achievement ends and resets for the customer. |
22
+
**optinDate** | **Date** | Timestamp at which the customer opted in to the achievement. | [optional]
18
23
19
24
20
25
@@ -27,6 +32,30 @@ Name | Type | Description | Notes
0 commit comments