talon_one 8.0.0 → 9.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -8
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +3 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/InlineResponse20048.md +19 -0
- data/docs/InlineResponse20049.md +19 -0
- data/docs/IntegrationApi.md +3 -1
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/ManagementApi.md +164 -323
- data/docs/MessageTest.md +27 -0
- data/docs/NewMessageTest.md +29 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/lib/talon_one/api/integration_api.rb +3 -0
- data/lib/talon_one/api/management_api.rb +191 -354
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application_cif_references.rb +219 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +16 -4
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/inline_response20048.rb +222 -0
- data/lib/talon_one/models/inline_response20049.rb +227 -0
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/message_test.rb +227 -0
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
- data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +2 -1
- data/spec/api/integration_api_spec.rb +1 -0
- data/spec/api/management_api_spec.rb +60 -87
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- metadata +563 -527
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1d35e72926d5a93c5ed6c2227584ccdac124132a669318106b4855af180e46e0
|
4
|
+
data.tar.gz: bc9801a5b3f49dc36088b916509be5c544179c7826b0b1585287463b981a07a7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 722ce13ea2285cba0eaa3696098a9d4af557da4eb86f5896ed2a07b4ffe9a29f9950ec71b241089bc833c19767d714b3321e50c27ab3197169719eaf524a590c
|
7
|
+
data.tar.gz: 2eee4833dda82e73638015297df148b29f16a6c84a12147e0a4bf6ab74945d7b217b806bcd30b2d9bb0d80439d83f4ed2de97d63023395c8ac47faf655e1768e
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ This SDK supports all of the operations of Talon.One's Integration API and Manag
|
|
9
9
|
Add this to the Gemfile:
|
10
10
|
|
11
11
|
```shell
|
12
|
-
gem 'talon_one', '~>
|
12
|
+
gem 'talon_one', '~> 9.0.0'
|
13
13
|
```
|
14
14
|
|
15
15
|
### Build a gem
|
@@ -25,10 +25,10 @@ gem build talon_one.gemspec
|
|
25
25
|
To install the gem locally:
|
26
26
|
|
27
27
|
```shell
|
28
|
-
gem install ./talon_one-
|
28
|
+
gem install ./talon_one-9.0.0.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
For development, run `gem install --dev ./talon_one-
|
31
|
+
For development, run `gem install --dev ./talon_one-9.0.0.gem` to install the development dependencies.
|
32
32
|
|
33
33
|
### RubyGems
|
34
34
|
|
@@ -308,6 +308,7 @@ Class | Method | HTTP request | Description
|
|
308
308
|
*TalonOne::ManagementApi* | [**get_loyalty_program_transactions**](docs/ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
|
309
309
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
310
310
|
*TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
311
|
+
*TalonOne::ManagementApi* | [**get_message_logs**](docs/ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
|
311
312
|
*TalonOne::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
|
312
313
|
*TalonOne::ManagementApi* | [**get_role_v2**](docs/ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
313
314
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
@@ -338,11 +339,7 @@ Class | Method | HTTP request | Description
|
|
338
339
|
*TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
339
340
|
*TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
340
341
|
*TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
341
|
-
*TalonOne::ManagementApi* | [**notification_activation**](docs/ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
342
342
|
*TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
343
|
-
*TalonOne::ManagementApi* | [**post_added_deducted_points_notification**](docs/ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
|
344
|
-
*TalonOne::ManagementApi* | [**post_catalogs_strikethrough_notification**](docs/ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
345
|
-
*TalonOne::ManagementApi* | [**post_pending_points_notification**](docs/ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
346
343
|
*TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
347
344
|
*TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
348
345
|
*TalonOne::ManagementApi* | [**scim_create_user**](docs/ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
@@ -533,9 +530,9 @@ Class | Method | HTTP request | Description
|
|
533
530
|
- [TalonOne::CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md)
|
534
531
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
535
532
|
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
536
|
-
- [TalonOne::DeactivateUserRequest](docs/DeactivateUserRequest.md)
|
537
533
|
- [TalonOne::DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md)
|
538
534
|
- [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
|
535
|
+
- [TalonOne::DeleteUserRequest](docs/DeleteUserRequest.md)
|
539
536
|
- [TalonOne::Effect](docs/Effect.md)
|
540
537
|
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
541
538
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
@@ -795,6 +792,7 @@ Class | Method | HTTP request | Description
|
|
795
792
|
- [TalonOne::ReturnedCartItem](docs/ReturnedCartItem.md)
|
796
793
|
- [TalonOne::Revision](docs/Revision.md)
|
797
794
|
- [TalonOne::RevisionActivation](docs/RevisionActivation.md)
|
795
|
+
- [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
|
798
796
|
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
799
797
|
- [TalonOne::Role](docs/Role.md)
|
800
798
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# TalonOne::AchievementBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**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** | **Float** | 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]
|
12
|
+
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
13
|
+
**recurrence_policy** | **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
|
+
**activation_policy** | **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
|
+
**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]
|
16
|
+
**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]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'TalonOne'
|
22
|
+
|
23
|
+
instance = TalonOne::AchievementBase.new(name: Order50Discount,
|
24
|
+
title: 50% off on 50th purchase.,
|
25
|
+
description: 50% off for every 50th purchase in a year.,
|
26
|
+
target: 50.0,
|
27
|
+
period: 1Y,
|
28
|
+
period_end_override: null,
|
29
|
+
recurrence_policy: no_recurrence,
|
30
|
+
activation_policy: fixed_schedule,
|
31
|
+
fixed_start_date: null,
|
32
|
+
end_date: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# TalonOne::AchievementProgressWithDefinition
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | The status of the achievement. |
|
8
|
+
**progress** | **Float** | The current progress of the customer in the achievement. |
|
9
|
+
**start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
|
10
|
+
**completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
|
11
|
+
**end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
|
12
|
+
**achievement_id** | **Integer** | The internal ID of the achievement. |
|
13
|
+
**name** | **String** | The internal name of the achievement used in API requests. |
|
14
|
+
**title** | **String** | The display name of the achievement in the Campaign Manager. |
|
15
|
+
**description** | **String** | The description of the achievement in the Campaign Manager. |
|
16
|
+
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
|
17
|
+
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
18
|
+
**achievement_recurrence_policy** | **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. |
|
19
|
+
**achievement_activation_policy** | **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. |
|
20
|
+
**achievement_fixed_start_date** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
|
21
|
+
**achievement_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]
|
22
|
+
|
23
|
+
## Code Sample
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'TalonOne'
|
27
|
+
|
28
|
+
instance = TalonOne::AchievementProgressWithDefinition.new(status: completed,
|
29
|
+
progress: 10.0,
|
30
|
+
start_date: null,
|
31
|
+
completion_date: null,
|
32
|
+
end_date: null,
|
33
|
+
achievement_id: 3,
|
34
|
+
name: FreeCoffee10Orders,
|
35
|
+
title: 50% off on 50th purchase.,
|
36
|
+
description: 50% off for every 50th purchase in a year.,
|
37
|
+
campaign_id: 3,
|
38
|
+
target: 10.0,
|
39
|
+
achievement_recurrence_policy: no_recurrence,
|
40
|
+
achievement_activation_policy: fixed_schedule,
|
41
|
+
achievement_fixed_start_date: null,
|
42
|
+
achievement_end_date: null)
|
43
|
+
```
|
44
|
+
|
45
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# TalonOne::AchievementStatusEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
8
|
+
**created** | **DateTime** | 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** | **Float** | 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]
|
14
|
+
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
15
|
+
**recurrence_policy** | **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
|
+
**activation_policy** | **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
|
+
**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]
|
18
|
+
**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]
|
19
|
+
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
|
20
|
+
**status** | **String** | The status of the achievement. | [optional]
|
21
|
+
**current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
|
22
|
+
|
23
|
+
## Code Sample
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'TalonOne'
|
27
|
+
|
28
|
+
instance = TalonOne::AchievementStatusEntry.new(id: 6,
|
29
|
+
created: 2020-06-10T09:05:27.993483Z,
|
30
|
+
name: Order50Discount,
|
31
|
+
title: 50% off on 50th purchase.,
|
32
|
+
description: 50% off for every 50th purchase in a year.,
|
33
|
+
target: 50.0,
|
34
|
+
period: 1Y,
|
35
|
+
period_end_override: null,
|
36
|
+
recurrence_policy: no_recurrence,
|
37
|
+
activation_policy: fixed_schedule,
|
38
|
+
fixed_start_date: null,
|
39
|
+
end_date: null,
|
40
|
+
campaign_id: 1,
|
41
|
+
status: active,
|
42
|
+
current_progress: null)
|
43
|
+
```
|
44
|
+
|
45
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::AnalyticsSKU
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | The ID of the SKU linked to the application. |
|
8
|
+
**sku** | **String** | The SKU linked to the application. |
|
9
|
+
**last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
|
10
|
+
**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::AnalyticsSKU.new(id: 1,
|
18
|
+
sku: SKU-123,
|
19
|
+
last_updated: 2024-02-01T00:00Z,
|
20
|
+
units_sold: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::ApplicationCIFReferences
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**application_cart_item_filter_id** | **Integer** | The ID of the Application Cart Item Filter that is referenced by a campaign. | [optional]
|
8
|
+
**campaigns** | [**Array<CampaignDetail>**](CampaignDetail.md) | Campaigns that reference a speciifc Application Cart Item Filter. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::ApplicationCIFReferences.new(application_cart_item_filter_id: 322,
|
16
|
+
campaigns: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CampaignDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**campaign_id** | **Integer** | The ID of the campaign that references the application cart item filter. | [optional]
|
8
|
+
**campaign_name** | **String** | A user-facing name for this campaign. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CampaignDetail.new(campaign_id: 1,
|
16
|
+
campaign_name: Summer promotions)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# TalonOne::CampaignStoreBudgetLimitConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` |
|
8
|
+
**limit** | **Float** | The value to set for the limit. |
|
9
|
+
**period** | **String** | The period on which the budget limit recurs. | [optional]
|
10
|
+
**entities** | **Array<String>** | The entity that this limit applies to. |
|
11
|
+
**imported** | **Boolean** | Indicates whether this limit configuration is managed via a CSV file. |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'TalonOne'
|
17
|
+
|
18
|
+
instance = TalonOne::CampaignStoreBudgetLimitConfig.new(action: createCoupon,
|
19
|
+
limit: 1000.0,
|
20
|
+
period: yearly,
|
21
|
+
entities: [Coupon],
|
22
|
+
imported: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/CampaignTemplate.md
CHANGED
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
|
29
29
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign template or any of its elements. | [optional]
|
30
30
|
**updated_by** | **String** | Name of the user who last updated this campaign template, if available. | [optional]
|
31
31
|
**valid_application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. |
|
32
|
+
**is_user_favorite** | **Boolean** | A flag indicating whether the user marked the template as a favorite. | [optional] [default to false]
|
32
33
|
|
33
34
|
## Code Sample
|
34
35
|
|
@@ -59,7 +60,8 @@ instance = TalonOne::CampaignTemplate.new(id: 6,
|
|
59
60
|
campaign_type: advanced,
|
60
61
|
updated: 2022-08-24T14:15:22Z,
|
61
62
|
updated_by: Jane Doe,
|
62
|
-
valid_application_ids: [1, 2, 3]
|
63
|
+
valid_application_ids: [1, 2, 3],
|
64
|
+
is_user_favorite: false)
|
63
65
|
```
|
64
66
|
|
65
67
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::HiddenConditionsEffects
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**built_in_effects** | **Array<String>** | List of hidden built-in effects. | [optional]
|
8
|
+
**conditions** | **Array<String>** | List of hidden conditions. | [optional]
|
9
|
+
**custom_effects** | **Array<Integer>** | List of the IDs of hidden custom effects. | [optional]
|
10
|
+
**webhooks** | **Array<Integer>** | List of the IDs of hidden webhooks. | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::HiddenConditionsEffects.new(built_in_effects: [addFreeItem, createNotification],
|
18
|
+
conditions: [checkAttributeValue, couponCodeIsValid],
|
19
|
+
custom_effects: [1, 2],
|
20
|
+
webhooks: [3, 4])
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::InlineResponse20048
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**has_more** | **Boolean** | | [optional]
|
8
|
+
**data** | [**Array<Achievement>**](Achievement.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20048.new(has_more: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::InlineResponse20049
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**has_more** | **Boolean** | |
|
8
|
+
**data** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20049.new(has_more: true,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/IntegrationApi.md
CHANGED
@@ -1495,7 +1495,8 @@ api_instance = TalonOne::IntegrationApi.new
|
|
1495
1495
|
body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
|
1496
1496
|
opts = {
|
1497
1497
|
silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
1498
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
1498
|
+
dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
1499
|
+
force_complete_evaluation: false # Boolean | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`.
|
1499
1500
|
}
|
1500
1501
|
|
1501
1502
|
begin
|
@@ -1515,6 +1516,7 @@ Name | Type | Description | Notes
|
|
1515
1516
|
**body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md)| body |
|
1516
1517
|
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to 'yes']
|
1517
1518
|
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
1519
|
+
**force_complete_evaluation** | **Boolean**| Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. | [optional] [default to false]
|
1518
1520
|
|
1519
1521
|
### Return type
|
1520
1522
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**id** | **Integer** | ID of the loyalty ledger transaction. |
|
17
17
|
**ruleset_id** | **Integer** | The ID of the ruleset containing the rule that triggered this effect. | [optional]
|
18
18
|
**rule_name** | **String** | The name of the rule that triggered this effect. | [optional]
|
19
|
+
**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) | | [optional]
|
19
20
|
|
20
21
|
## Code Sample
|
21
22
|
|
@@ -33,7 +34,8 @@ instance = TalonOne::LedgerTransactionLogEntryIntegrationAPI.new(created: null,
|
|
33
34
|
amount: 10.25,
|
34
35
|
id: 123,
|
35
36
|
ruleset_id: 11,
|
36
|
-
rule_name: Add 2 points
|
37
|
+
rule_name: Add 2 points,
|
38
|
+
flags: null)
|
37
39
|
```
|
38
40
|
|
39
41
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::LoyaltyLedgerEntryFlags
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**creates_negative_balance** | **Boolean** | Set to true if the entry creates negative balance. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::LoyaltyLedgerEntryFlags.new(creates_negative_balance: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
|
|
22
22
|
**user_email** | **String** | The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions. | [optional]
|
23
23
|
**ruleset_id** | **Integer** | ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional]
|
24
24
|
**rule_name** | **String** | Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional]
|
25
|
+
**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) | | [optional]
|
25
26
|
|
26
27
|
## Code Sample
|
27
28
|
|
@@ -45,7 +46,8 @@ instance = TalonOne::LoyaltyProgramTransaction.new(id: 123,
|
|
45
46
|
user_id: 5,
|
46
47
|
user_email: john.doe@example.com,
|
47
48
|
ruleset_id: 11,
|
48
|
-
rule_name: 10 points for every $100 spent
|
49
|
+
rule_name: 10 points for every $100 spent,
|
50
|
+
flags: null)
|
49
51
|
```
|
50
52
|
|
51
53
|
|