talon_one_sdk 26.10.0 → 26.11.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 +13 -3
- data/docs/AchievementBaseV2.md +1 -5
- data/docs/AchievementV2.md +5 -5
- data/docs/ApplicationEvent.md +3 -1
- data/docs/BestPriorPrice.md +5 -3
- data/docs/CatalogAction.md +20 -0
- data/docs/CatalogSyncRequest.md +1 -1
- data/docs/CreateAchievementV2.md +2 -2
- data/docs/CustomerSessionV2.md +3 -1
- data/docs/Event.md +3 -1
- data/docs/EventAttributesEntity.md +1 -1
- data/docs/EventV2.md +1 -1
- data/docs/EventV3.md +15 -11
- data/docs/EventV3Connections.md +18 -0
- data/docs/EventV3Entity.md +18 -0
- data/docs/EventV3RequestEntity.md +30 -0
- data/docs/ExperimentCopyExperiment.md +5 -1
- data/docs/History.md +5 -3
- data/docs/IntegrationApi.md +2 -2
- data/docs/IntegrationEvent.md +1 -1
- data/docs/IntegrationEventV2Request.md +1 -1
- data/docs/IntegrationEventV3Request.md +4 -6
- data/docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md +4 -2
- data/docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.md +4 -0
- data/docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md +3 -1
- data/docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md +3 -1
- data/docs/IntegrationHubEventRecord.md +2 -0
- data/docs/IntegrationHubEventStatusUpdate.md +20 -0
- data/docs/ManagementApi.md +2 -2
- data/docs/NewEvent.md +1 -1
- data/docs/NewEventV3Entity.md +18 -0
- data/docs/NewExperiment.md +1 -1
- data/docs/Reward.md +3 -1
- data/docs/RewardPointsRequired.md +24 -0
- data/docs/SupportRequest.md +46 -0
- data/docs/SupportRequestInput.md +32 -0
- data/docs/UpdateAchievementV2.md +6 -10
- data/docs/UpdateExperiment.md +2 -2
- data/docs/UpdateReward.md +3 -1
- data/docs/UpdateSupportRequest.md +20 -0
- data/lib/talon_one_sdk/api/integration_api.rb +2 -2
- data/lib/talon_one_sdk/api/management_api.rb +4 -4
- data/lib/talon_one_sdk/models/achievement_base_v2.rb +4 -43
- data/lib/talon_one_sdk/models/achievement_v2.rb +63 -63
- data/lib/talon_one_sdk/models/application_event.rb +32 -2
- data/lib/talon_one_sdk/models/best_prior_price.rb +25 -11
- data/lib/talon_one_sdk/models/catalog_action.rb +216 -0
- data/lib/talon_one_sdk/models/catalog_sync_request.rb +1 -1
- data/lib/talon_one_sdk/models/create_achievement_v2.rb +28 -28
- data/lib/talon_one_sdk/models/customer_session_v2.rb +28 -1
- data/lib/talon_one_sdk/models/event.rb +32 -2
- data/lib/talon_one_sdk/models/event_attributes_entity.rb +1 -1
- data/lib/talon_one_sdk/models/event_v2.rb +1 -1
- data/lib/talon_one_sdk/models/event_v3.rb +163 -99
- data/lib/talon_one_sdk/models/event_v3_connections.rb +167 -0
- data/lib/talon_one_sdk/models/event_v3_entity.rb +167 -0
- data/lib/talon_one_sdk/models/event_v3_request_entity.rb +338 -0
- data/lib/talon_one_sdk/models/experiment_copy_experiment.rb +58 -4
- data/lib/talon_one_sdk/models/history.rb +25 -11
- data/lib/talon_one_sdk/models/integration_event.rb +1 -1
- data/lib/talon_one_sdk/models/integration_event_v2_request.rb +1 -1
- data/lib/talon_one_sdk/models/integration_event_v3_request.rb +41 -70
- data/lib/talon_one_sdk/models/integration_hub_event_payload_loyalty_profile_based_notification.rb +55 -10
- data/lib/talon_one_sdk/models/integration_hub_event_payload_loyalty_profile_based_points_changed_notification.rb +55 -1
- data/lib/talon_one_sdk/models/integration_hub_event_payload_loyalty_profile_based_tier_downgrade_notification.rb +29 -1
- data/lib/talon_one_sdk/models/integration_hub_event_payload_loyalty_profile_based_tier_upgrade_notification.rb +46 -1
- data/lib/talon_one_sdk/models/integration_hub_event_record.rb +10 -1
- data/lib/talon_one_sdk/models/integration_hub_event_status_update.rb +216 -0
- data/lib/talon_one_sdk/models/new_event.rb +1 -1
- data/lib/talon_one_sdk/models/new_event_v3_entity.rb +174 -0
- data/lib/talon_one_sdk/models/new_experiment.rb +3 -3
- data/lib/talon_one_sdk/models/reward.rb +16 -4
- data/lib/talon_one_sdk/models/reward_points_required.rb +239 -0
- data/lib/talon_one_sdk/models/support_request.rb +470 -0
- data/lib/talon_one_sdk/models/support_request_input.rb +329 -0
- data/lib/talon_one_sdk/models/talang_attribute.rb +2 -2
- data/lib/talon_one_sdk/models/update_achievement_v2.rb +76 -50
- data/lib/talon_one_sdk/models/update_experiment.rb +4 -4
- data/lib/talon_one_sdk/models/update_reward.rb +16 -4
- data/lib/talon_one_sdk/models/update_support_request.rb +199 -0
- data/lib/talon_one_sdk/version.rb +1 -1
- data/lib/talon_one_sdk.rb +10 -0
- data/spec/api/integration_api_spec.rb +1 -1
- data/spec/api/management_api_spec.rb +2 -2
- data/spec/models/achievement_base_v2_spec.rb +0 -12
- data/spec/models/achievement_v2_spec.rb +11 -11
- data/spec/models/application_event_spec.rb +6 -0
- data/spec/models/base_campaign_spec.rb +1 -1
- data/spec/models/best_prior_price_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +1 -1
- data/spec/models/campaign_template_spec.rb +1 -1
- data/spec/models/catalog_action_spec.rb +46 -0
- data/spec/models/create_achievement_v2_spec.rb +2 -2
- data/spec/models/customer_session_v2_spec.rb +6 -0
- data/spec/models/event_spec.rb +6 -0
- data/spec/models/event_v3_connections_spec.rb +36 -0
- data/spec/models/event_v3_entity_spec.rb +36 -0
- data/spec/models/event_v3_request_entity_spec.rb +72 -0
- data/spec/models/event_v3_spec.rb +18 -6
- data/spec/models/experiment_copy_experiment_spec.rb +16 -0
- data/spec/models/history_spec.rb +6 -0
- data/spec/models/integration_event_v3_request_spec.rb +2 -8
- data/spec/models/integration_hub_event_payload_loyalty_profile_based_notification_spec.rb +12 -6
- data/spec/models/integration_hub_event_payload_loyalty_profile_based_points_changed_notification_spec.rb +12 -0
- data/spec/models/integration_hub_event_payload_loyalty_profile_based_tier_downgrade_notification_spec.rb +6 -0
- data/spec/models/integration_hub_event_payload_loyalty_profile_based_tier_upgrade_notification_spec.rb +6 -0
- data/spec/models/integration_hub_event_record_spec.rb +6 -0
- data/spec/models/integration_hub_event_status_update_spec.rb +46 -0
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_campaign_template_spec.rb +1 -1
- data/spec/models/new_event_v3_entity_spec.rb +36 -0
- data/spec/models/new_experiment_spec.rb +1 -1
- data/spec/models/new_revision_version_spec.rb +1 -1
- data/spec/models/revision_version_spec.rb +1 -1
- data/spec/models/reward_points_required_spec.rb +54 -0
- data/spec/models/reward_spec.rb +6 -0
- data/spec/models/support_request_input_spec.rb +82 -0
- data/spec/models/support_request_spec.rb +128 -0
- data/spec/models/talang_attribute_spec.rb +1 -1
- data/spec/models/update_achievement_v2_spec.rb +0 -12
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_campaign_template_spec.rb +1 -1
- data/spec/models/update_experiment_spec.rb +1 -1
- data/spec/models/update_reward_spec.rb +6 -0
- data/spec/models/update_support_request_spec.rb +46 -0
- data/talon_one_sdk.gemspec +3 -2
- metadata +42 -22
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 85d4694d2c1de4a455fee9a76e0b529939dfbcb2fa6175fd213d99a39c7253f7
|
|
4
|
+
data.tar.gz: e6841d21f623fb87a72cdd5ae800e1a4f4ded1fe7a94b350fb2dc999fd8c00fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 45884e4e34a1954bce59b4a79ed58f0e64f21342bf093a388053dd12bdfeb7943ca8fc451bc621a9fa4a6946d6cc7b36d0d9452ab44f5059a9f2b060bf81ca76
|
|
7
|
+
data.tar.gz: a2da07dcc84447cdb22293ddb2dcb48fd5b13ec55a0fd8e292c42f98a8a356246b0220ba787f8f8034f0b797040dd491b679803597ddf3cf30d0ac4d798e8413
|
data/README.md
CHANGED
|
@@ -16,7 +16,7 @@ See our [migration guide](MIGRATION.md).
|
|
|
16
16
|
Add this to the Gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'talon_one_sdk', '~> 26.
|
|
19
|
+
gem 'talon_one_sdk', '~> 26.11.0'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
### Build a gem
|
|
@@ -32,10 +32,10 @@ gem build talon_one_sdk.gemspec
|
|
|
32
32
|
To install the gem locally:
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
gem install ./talon_one_sdk-26.
|
|
35
|
+
gem install ./talon_one_sdk-26.11.0.gem
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
For development, run `gem install --dev ./talon_one_sdk-26.
|
|
38
|
+
For development, run `gem install --dev ./talon_one_sdk-26.11.0.gem` to install the development dependencies.
|
|
39
39
|
|
|
40
40
|
### RubyGems
|
|
41
41
|
|
|
@@ -557,6 +557,7 @@ Class | Method | HTTP request | Description
|
|
|
557
557
|
- [TalonOne::CartItem](docs/CartItem.md)
|
|
558
558
|
- [TalonOne::CartItemFilterTemplate](docs/CartItemFilterTemplate.md)
|
|
559
559
|
- [TalonOne::Catalog](docs/Catalog.md)
|
|
560
|
+
- [TalonOne::CatalogAction](docs/CatalogAction.md)
|
|
560
561
|
- [TalonOne::CatalogActionFilter](docs/CatalogActionFilter.md)
|
|
561
562
|
- [TalonOne::CatalogItem](docs/CatalogItem.md)
|
|
562
563
|
- [TalonOne::CatalogRule](docs/CatalogRule.md)
|
|
@@ -636,6 +637,9 @@ Class | Method | HTTP request | Description
|
|
|
636
637
|
- [TalonOne::EventType](docs/EventType.md)
|
|
637
638
|
- [TalonOne::EventV2](docs/EventV2.md)
|
|
638
639
|
- [TalonOne::EventV3](docs/EventV3.md)
|
|
640
|
+
- [TalonOne::EventV3Connections](docs/EventV3Connections.md)
|
|
641
|
+
- [TalonOne::EventV3Entity](docs/EventV3Entity.md)
|
|
642
|
+
- [TalonOne::EventV3RequestEntity](docs/EventV3RequestEntity.md)
|
|
639
643
|
- [TalonOne::Experiment](docs/Experiment.md)
|
|
640
644
|
- [TalonOne::ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
|
|
641
645
|
- [TalonOne::ExperimentCopy](docs/ExperimentCopy.md)
|
|
@@ -760,6 +764,7 @@ Class | Method | HTTP request | Description
|
|
|
760
764
|
- [TalonOne::IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md)
|
|
761
765
|
- [TalonOne::IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md)
|
|
762
766
|
- [TalonOne::IntegrationHubEventRecord](docs/IntegrationHubEventRecord.md)
|
|
767
|
+
- [TalonOne::IntegrationHubEventStatusUpdate](docs/IntegrationHubEventStatusUpdate.md)
|
|
763
768
|
- [TalonOne::IntegrationHubFlow](docs/IntegrationHubFlow.md)
|
|
764
769
|
- [TalonOne::IntegrationHubFlowConfig](docs/IntegrationHubFlowConfig.md)
|
|
765
770
|
- [TalonOne::IntegrationHubFlowConfigResponse](docs/IntegrationHubFlowConfigResponse.md)
|
|
@@ -874,6 +879,7 @@ Class | Method | HTTP request | Description
|
|
|
874
879
|
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
|
875
880
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
|
876
881
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
|
882
|
+
- [TalonOne::NewEventV3Entity](docs/NewEventV3Entity.md)
|
|
877
883
|
- [TalonOne::NewExperiment](docs/NewExperiment.md)
|
|
878
884
|
- [TalonOne::NewExperimentVariant](docs/NewExperimentVariant.md)
|
|
879
885
|
- [TalonOne::NewExperimentVariantArray](docs/NewExperimentVariantArray.md)
|
|
@@ -969,6 +975,7 @@ Class | Method | HTTP request | Description
|
|
|
969
975
|
- [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
|
|
970
976
|
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
|
971
977
|
- [TalonOne::Reward](docs/Reward.md)
|
|
978
|
+
- [TalonOne::RewardPointsRequired](docs/RewardPointsRequired.md)
|
|
972
979
|
- [TalonOne::RiskNotification](docs/RiskNotification.md)
|
|
973
980
|
- [TalonOne::Role](docs/Role.md)
|
|
974
981
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
|
@@ -1043,6 +1050,8 @@ Class | Method | HTTP request | Description
|
|
|
1043
1050
|
- [TalonOne::StrikethroughTrigger](docs/StrikethroughTrigger.md)
|
|
1044
1051
|
- [TalonOne::SummarizeCampaignStoreBudget200Response](docs/SummarizeCampaignStoreBudget200Response.md)
|
|
1045
1052
|
- [TalonOne::SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.md)
|
|
1053
|
+
- [TalonOne::SupportRequest](docs/SupportRequest.md)
|
|
1054
|
+
- [TalonOne::SupportRequestInput](docs/SupportRequestInput.md)
|
|
1046
1055
|
- [TalonOne::TalangAttribute](docs/TalangAttribute.md)
|
|
1047
1056
|
- [TalonOne::TalangAttributeVisibility](docs/TalangAttributeVisibility.md)
|
|
1048
1057
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
|
@@ -1100,6 +1109,7 @@ Class | Method | HTTP request | Description
|
|
|
1100
1109
|
- [TalonOne::UpdateReward](docs/UpdateReward.md)
|
|
1101
1110
|
- [TalonOne::UpdateRole](docs/UpdateRole.md)
|
|
1102
1111
|
- [TalonOne::UpdateStore](docs/UpdateStore.md)
|
|
1112
|
+
- [TalonOne::UpdateSupportRequest](docs/UpdateSupportRequest.md)
|
|
1103
1113
|
- [TalonOne::UpdateUser](docs/UpdateUser.md)
|
|
1104
1114
|
- [TalonOne::User](docs/User.md)
|
|
1105
1115
|
- [TalonOne::UserEntity](docs/UserEntity.md)
|
data/docs/AchievementBaseV2.md
CHANGED
|
@@ -14,9 +14,7 @@
|
|
|
14
14
|
| **fixed_start_date** | **Time** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] |
|
|
15
15
|
| **end_date** | **Time** | 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] |
|
|
16
16
|
| **allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
|
|
17
|
-
| **sandbox** | **Boolean** | 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] |
|
|
18
17
|
| **subscribed_applications** | **Array<Integer>** | 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] |
|
|
19
|
-
| **timezone** | **String** | A string containing an IANA timezone descriptor. | [optional] |
|
|
20
18
|
|
|
21
19
|
## Example
|
|
22
20
|
|
|
@@ -34,9 +32,7 @@ instance = TalonOne::AchievementBaseV2.new(
|
|
|
34
32
|
fixed_start_date: 2024-01-15T15:04:05+07:00,
|
|
35
33
|
end_date: 2024-01-15T15:04:05+07:00,
|
|
36
34
|
allow_rollback_after_completion: false,
|
|
37
|
-
|
|
38
|
-
subscribed_applications: [132, 97],
|
|
39
|
-
timezone: Europe/Berlin
|
|
35
|
+
subscribed_applications: [132, 97]
|
|
40
36
|
)
|
|
41
37
|
```
|
|
42
38
|
|
data/docs/AchievementV2.md
CHANGED
|
@@ -16,13 +16,13 @@
|
|
|
16
16
|
| **fixed_start_date** | **Time** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] |
|
|
17
17
|
| **end_date** | **Time** | 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] |
|
|
18
18
|
| **allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
|
|
19
|
-
| **sandbox** | **Boolean** | 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. | |
|
|
20
19
|
| **subscribed_applications** | **Array<Integer>** | 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. | |
|
|
21
|
-
| **timezone** | **String** | A string containing an IANA timezone descriptor. | |
|
|
22
20
|
| **user_id** | **Integer** | The ID of the user that created this achievement. | |
|
|
23
21
|
| **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional] |
|
|
24
22
|
| **has_progress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] |
|
|
25
23
|
| **status** | **String** | The status of the achievement. | [optional] |
|
|
24
|
+
| **sandbox** | **Boolean** | 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. | |
|
|
25
|
+
| **timezone** | **String** | A string containing an IANA timezone descriptor. | |
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
|
@@ -42,13 +42,13 @@ instance = TalonOne::AchievementV2.new(
|
|
|
42
42
|
fixed_start_date: 2024-01-15T15:04:05+07:00,
|
|
43
43
|
end_date: 2024-01-15T15:04:05+07:00,
|
|
44
44
|
allow_rollback_after_completion: false,
|
|
45
|
-
sandbox: true,
|
|
46
45
|
subscribed_applications: [132, 97],
|
|
47
|
-
timezone: Europe/Berlin,
|
|
48
46
|
user_id: 1234,
|
|
49
47
|
created_by: John Doe,
|
|
50
48
|
has_progress: null,
|
|
51
|
-
status: inprogress
|
|
49
|
+
status: inprogress,
|
|
50
|
+
sandbox: true,
|
|
51
|
+
timezone: Europe/Berlin
|
|
52
52
|
)
|
|
53
53
|
```
|
|
54
54
|
|
data/docs/ApplicationEvent.md
CHANGED
|
@@ -10,8 +10,9 @@
|
|
|
10
10
|
| **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] |
|
|
11
11
|
| **store_id** | **Integer** | The ID of the store. | [optional] |
|
|
12
12
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
13
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] |
|
|
13
14
|
| **session_id** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional] |
|
|
14
|
-
| **type** | **String** |
|
|
15
|
+
| **type** | **String** | 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. | |
|
|
15
16
|
| **attributes** | **Object** | Additional JSON serialized data associated with the event. | |
|
|
16
17
|
| **effects** | [**Array<Effect>**](Effect.md) | An array containing the effects that were applied as a result of this event. | |
|
|
17
18
|
| **rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional] |
|
|
@@ -28,6 +29,7 @@ instance = TalonOne::ApplicationEvent.new(
|
|
|
28
29
|
profile_id: 138,
|
|
29
30
|
store_id: null,
|
|
30
31
|
store_integration_id: STORE-001,
|
|
32
|
+
integration_id: 175KJPS947296,
|
|
31
33
|
session_id: null,
|
|
32
34
|
type: null,
|
|
33
35
|
attributes: null,
|
data/docs/BestPriorPrice.md
CHANGED
|
@@ -7,7 +7,8 @@
|
|
|
7
7
|
| **id** | **Integer** | The ID of the historical price. | |
|
|
8
8
|
| **sku** | **String** | sku | |
|
|
9
9
|
| **observed_at** | **Time** | The date and time when the price was observed. | |
|
|
10
|
-
| **
|
|
10
|
+
| **context_ids** | **Array<String>** | 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. | |
|
|
11
|
+
| **context_id** | **String** | This property is **deprecated**. Use `contextIds` instead. Defaults to an empty string. | [optional][default to ''] |
|
|
11
12
|
| **price** | **Float** | Price of the item. | |
|
|
12
13
|
| **metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | | |
|
|
13
14
|
| **target** | **Object** | | |
|
|
@@ -20,8 +21,9 @@ require 'talon_one_sdk'
|
|
|
20
21
|
instance = TalonOne::BestPriorPrice.new(
|
|
21
22
|
id: 1,
|
|
22
23
|
sku: NVR-GN-GV-UUP,
|
|
23
|
-
observed_at:
|
|
24
|
-
|
|
24
|
+
observed_at: 2025-11-10T23:00:00Z,
|
|
25
|
+
context_ids: [SpringSale, SummerSale2025],
|
|
26
|
+
context_id: ,
|
|
25
27
|
price: 99.99,
|
|
26
28
|
metadata: null,
|
|
27
29
|
target: null
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TalonOne::CatalogAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of sync action. | |
|
|
8
|
+
| **payload** | **Object** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'talon_one_sdk'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::CatalogAction.new(
|
|
16
|
+
type: ADD,
|
|
17
|
+
payload: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/CatalogSyncRequest.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **actions** | **Array<
|
|
7
|
+
| **actions** | [**Array<CatalogAction>**](CatalogAction.md) | | |
|
|
8
8
|
| **version** | **Integer** | The version number of the catalog to apply the actions on. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
data/docs/CreateAchievementV2.md
CHANGED
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
| **fixed_start_date** | **Time** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] |
|
|
15
15
|
| **end_date** | **Time** | 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] |
|
|
16
16
|
| **allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
|
|
17
|
-
| **sandbox** | **Boolean** | 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. | |
|
|
18
17
|
| **subscribed_applications** | **Array<Integer>** | 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] |
|
|
18
|
+
| **sandbox** | **Boolean** | 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. | |
|
|
19
19
|
| **timezone** | **String** | A string containing an IANA timezone descriptor. | |
|
|
20
20
|
|
|
21
21
|
## Example
|
|
@@ -34,8 +34,8 @@ instance = TalonOne::CreateAchievementV2.new(
|
|
|
34
34
|
fixed_start_date: 2024-01-15T15:04:05+07:00,
|
|
35
35
|
end_date: 2024-01-15T15:04:05+07:00,
|
|
36
36
|
allow_rollback_after_completion: false,
|
|
37
|
-
sandbox: true,
|
|
38
37
|
subscribed_applications: [132, 97],
|
|
38
|
+
sandbox: true,
|
|
39
39
|
timezone: Europe/Berlin
|
|
40
40
|
)
|
|
41
41
|
```
|
data/docs/CustomerSessionV2.md
CHANGED
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
| **total** | **Float** | The total value of cart items and additional costs in the session, before any discounts are applied. | |
|
|
26
26
|
| **cart_item_total** | **Float** | The total value of cart items, before any discounts are applied. | |
|
|
27
27
|
| **additional_cost_total** | **Float** | The total value of additional costs, before any discounts are applied. | |
|
|
28
|
+
| **cart_item_additional_cost_total** | **Float** | The total value of additional costs applied to individual items, before any discounts are applied. | [readonly] |
|
|
28
29
|
| **updated** | **Time** | Timestamp of the most recent event received on this session. | |
|
|
29
30
|
|
|
30
31
|
## Example
|
|
@@ -51,9 +52,10 @@ instance = TalonOne::CustomerSessionV2.new(
|
|
|
51
52
|
attributes: {ShippingCity=Berlin},
|
|
52
53
|
first_session: true,
|
|
53
54
|
update_count: 3,
|
|
54
|
-
total:
|
|
55
|
+
total: 134.99,
|
|
55
56
|
cart_item_total: 99.99,
|
|
56
57
|
additional_cost_total: 20,
|
|
58
|
+
cart_item_additional_cost_total: 15,
|
|
57
59
|
updated: 2020-02-08T14:15:22Z
|
|
58
60
|
)
|
|
59
61
|
```
|
data/docs/Event.md
CHANGED
|
@@ -9,8 +9,9 @@
|
|
|
9
9
|
| **application_id** | **Integer** | The ID of the Application that owns this entity. | |
|
|
10
10
|
| **profile_id** | **String** | 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] |
|
|
11
11
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
12
|
-
| **type** | **String** |
|
|
12
|
+
| **type** | **String** | 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. | |
|
|
13
13
|
| **attributes** | **Object** | Arbitrary additional JSON data associated with the event. | |
|
|
14
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] |
|
|
14
15
|
| **session_id** | **String** | The ID of the session that this event occurred in. | [optional] |
|
|
15
16
|
| **effects** | **Array<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). | |
|
|
16
17
|
| **ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. | [optional] |
|
|
@@ -29,6 +30,7 @@ instance = TalonOne::Event.new(
|
|
|
29
30
|
store_integration_id: STORE-001,
|
|
30
31
|
type: pageViewed,
|
|
31
32
|
attributes: {myAttribute=myValue},
|
|
33
|
+
integration_id: 175KJPS947296,
|
|
32
34
|
session_id: 175KJPS947296,
|
|
33
35
|
effects: null,
|
|
34
36
|
ledger_entries: null,
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** |
|
|
7
|
+
| **type** | **String** | 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. | |
|
|
8
8
|
| **attributes** | **Object** | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
data/docs/EventV2.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **profile_id** | **String** | 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] |
|
|
8
8
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
9
|
| **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] |
|
|
10
|
-
| **type** | **String** |
|
|
10
|
+
| **type** | **String** | 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. | |
|
|
11
11
|
| **attributes** | **Object** | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] |
|
|
12
12
|
|
|
13
13
|
## Example
|
data/docs/EventV3.md
CHANGED
|
@@ -4,14 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **connected_session_id** | **String** | The ID of the session to reference. The session must be in `closed` state. Otherwise, the API call will fail. | [optional] |
|
|
8
|
+
| **id** | **Integer** | The internal ID of this entity. | |
|
|
9
|
+
| **created** | **Time** | The time this entity was created. | |
|
|
10
|
+
| **application_id** | **Integer** | The ID of the Application that owns this entity. | |
|
|
11
|
+
| **profile_id** | **String** | 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] |
|
|
8
12
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **connected_session_id** | **String** | The ID of the session that happened in the past. | [optional] |
|
|
14
|
-
| **previous_event_id** | **String** | The unique identifier of the event that happened in the past. | [optional] |
|
|
13
|
+
| **type** | **String** | 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. | |
|
|
14
|
+
| **attributes** | **Object** | Arbitrary additional JSON data associated with the event. | |
|
|
15
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] |
|
|
16
|
+
| **effects** | **Array<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). | |
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -19,14 +21,16 @@
|
|
|
19
21
|
require 'talon_one_sdk'
|
|
20
22
|
|
|
21
23
|
instance = TalonOne::EventV3.new(
|
|
24
|
+
connected_session_id: 175KJPS947296,
|
|
25
|
+
id: 6,
|
|
26
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
27
|
+
application_id: 322,
|
|
22
28
|
profile_id: URNGV8294NV,
|
|
23
29
|
store_integration_id: STORE-001,
|
|
24
|
-
evaluable_campaign_ids: [10, 12],
|
|
25
|
-
integration_id: 175KJPS947296,
|
|
26
30
|
type: pageViewed,
|
|
27
31
|
attributes: {myAttribute=myValue},
|
|
28
|
-
|
|
29
|
-
|
|
32
|
+
integration_id: 175KJPS947296,
|
|
33
|
+
effects: null
|
|
30
34
|
)
|
|
31
35
|
```
|
|
32
36
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TalonOne::EventV3Connections
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **connected_session_id** | **String** | The ID of the session to reference. The session must be in `closed` state. Otherwise, the API call will fail. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'talon_one_sdk'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::EventV3Connections.new(
|
|
15
|
+
connected_session_id: 175KJPS947296
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TalonOne::EventV3Entity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'talon_one_sdk'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::EventV3Entity.new(
|
|
15
|
+
integration_id: 175KJPS947296
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TalonOne::EventV3RequestEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **profile_id** | **String** | 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`. | |
|
|
8
|
+
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
|
+
| **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] |
|
|
10
|
+
| **type** | **String** | 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. | |
|
|
11
|
+
| **attributes** | **Object** | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] |
|
|
12
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | |
|
|
13
|
+
| **connected_session_id** | **String** | The ID of the session to reference. The session must be in `closed` state. Otherwise, the API call will fail. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'talon_one_sdk'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::EventV3RequestEntity.new(
|
|
21
|
+
profile_id: URNGV8294NV,
|
|
22
|
+
store_integration_id: STORE-001,
|
|
23
|
+
evaluable_campaign_ids: [10, 12],
|
|
24
|
+
type: pageViewed,
|
|
25
|
+
attributes: {myAttribute=myValue},
|
|
26
|
+
integration_id: 175KJPS947296,
|
|
27
|
+
connected_session_id: 175KJPS947296
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **is_variant_assignment_external** | **Boolean** | The source of the assignment. - false - The variant assignment is handled internally by Talon.One. - true - The variant assignment is handled externally. | |
|
|
8
8
|
| **campaign** | [**ExperimentCampaignCopy**](ExperimentCampaignCopy.md) | | |
|
|
9
|
+
| **goal_type** | **String** | The goal of the experiment. Determines which single metric is used to decide the winning variant. When set to `other`, multiple metrics are used. If omitted, the value from the source experiment is used. | [optional] |
|
|
10
|
+
| **goal_description** | **String** | A description of the experiment goal. Provides context for the AI summary and helps it interpret the outcome of the experiment against the stated goal. If omitted, the value from the source experiment is used. | [optional] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -14,7 +16,9 @@ require 'talon_one_sdk'
|
|
|
14
16
|
|
|
15
17
|
instance = TalonOne::ExperimentCopyExperiment.new(
|
|
16
18
|
is_variant_assignment_external: null,
|
|
17
|
-
campaign: null
|
|
19
|
+
campaign: null,
|
|
20
|
+
goal_type: null,
|
|
21
|
+
goal_description: null
|
|
18
22
|
)
|
|
19
23
|
```
|
|
20
24
|
|
data/docs/History.md
CHANGED
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **Integer** | The ID of the historical price. | |
|
|
8
8
|
| **observed_at** | **Time** | The date and time when the price was observed. | |
|
|
9
|
-
| **
|
|
9
|
+
| **context_ids** | **Array<String>** | 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. | |
|
|
10
|
+
| **context_id** | **String** | This property is **deprecated**. Use `contextIds` instead. Defaults to an empty string. | [optional][default to ''] |
|
|
10
11
|
| **price** | **Float** | Price of the item. | |
|
|
11
12
|
| **metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | | |
|
|
12
13
|
| **target** | **Object** | | |
|
|
@@ -18,8 +19,9 @@ require 'talon_one_sdk'
|
|
|
18
19
|
|
|
19
20
|
instance = TalonOne::History.new(
|
|
20
21
|
id: 1,
|
|
21
|
-
observed_at:
|
|
22
|
-
|
|
22
|
+
observed_at: 2025-11-10T23:00:00Z,
|
|
23
|
+
context_ids: [SpringSale, SummerSale2025],
|
|
24
|
+
context_id: ,
|
|
23
25
|
price: 99.99,
|
|
24
26
|
metadata: null,
|
|
25
27
|
target: null
|
data/docs/IntegrationApi.md
CHANGED
|
@@ -2161,7 +2161,7 @@ end
|
|
|
2161
2161
|
|
|
2162
2162
|
api_instance = TalonOne::IntegrationApi.new
|
|
2163
2163
|
catalog_id = 789 # Integer | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
|
2164
|
-
catalog_sync_request = TalonOne::CatalogSyncRequest.new({actions: [3.56]}) # CatalogSyncRequest | body
|
|
2164
|
+
catalog_sync_request = TalonOne::CatalogSyncRequest.new({actions: [TalonOne::CatalogAction.new({type: 'ADD', payload: 3.56})]}) # CatalogSyncRequest | body
|
|
2165
2165
|
|
|
2166
2166
|
begin
|
|
2167
2167
|
# Sync cart item catalog
|
|
@@ -2217,7 +2217,7 @@ end
|
|
|
2217
2217
|
|
|
2218
2218
|
Track event
|
|
2219
2219
|
|
|
2220
|
-
Triggers a custom event. To use this endpoint: 1.
|
|
2220
|
+
Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.
|
|
2221
2221
|
|
|
2222
2222
|
### Examples
|
|
2223
2223
|
|
data/docs/IntegrationEvent.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **profile_id** | **String** | 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] |
|
|
8
8
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
|
-
| **type** | **String** |
|
|
9
|
+
| **type** | **String** | 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. | |
|
|
10
10
|
| **attributes** | **Object** | Arbitrary additional JSON data associated with the event. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **profile_id** | **String** | 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] |
|
|
8
8
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
9
|
| **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] |
|
|
10
|
-
| **type** | **String** |
|
|
10
|
+
| **type** | **String** | 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. | |
|
|
11
11
|
| **attributes** | **Object** | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] |
|
|
12
12
|
| **response_content** | **Array<String>** | Extends the response with the chosen data entities. Use this property to get as much data back as needed from one request instead of sending extra requests to other endpoints. | [optional] |
|
|
13
13
|
| **loyalty_cards** | **Array<String>** | Identifiers of the loyalty cards used during this event. | [optional] |
|
|
@@ -7,11 +7,10 @@
|
|
|
7
7
|
| **profile_id** | **String** | 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`. | |
|
|
8
8
|
| **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] |
|
|
9
9
|
| **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] |
|
|
10
|
-
| **
|
|
11
|
-
| **type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. | |
|
|
10
|
+
| **type** | **String** | 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. | |
|
|
12
11
|
| **attributes** | **Object** | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] |
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
12
|
+
| **integration_id** | **String** | The unique ID of the event. Only one event with this ID can be registered. | |
|
|
13
|
+
| **connected_session_id** | **String** | The ID of the session to reference. The session must be in `closed` state. Otherwise, the API call will fail. | [optional] |
|
|
15
14
|
| **loyalty_cards** | **Array<String>** | Identifiers of the loyalty cards used during this event. | [optional] |
|
|
16
15
|
| **response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the tracking custom event. | [optional] |
|
|
17
16
|
|
|
@@ -24,11 +23,10 @@ instance = TalonOne::IntegrationEventV3Request.new(
|
|
|
24
23
|
profile_id: URNGV8294NV,
|
|
25
24
|
store_integration_id: STORE-001,
|
|
26
25
|
evaluable_campaign_ids: [10, 12],
|
|
27
|
-
integration_id: 175KJPS947296,
|
|
28
26
|
type: pageViewed,
|
|
29
27
|
attributes: {myAttribute=myValue},
|
|
28
|
+
integration_id: 175KJPS947296,
|
|
30
29
|
connected_session_id: 175KJPS947296,
|
|
31
|
-
previous_event_id: 175KJPS947296,
|
|
32
30
|
loyalty_cards: [loyalty-card-1],
|
|
33
31
|
response_content: [triggeredCampaigns, customerProfile]
|
|
34
32
|
)
|
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **profile_integration_id** | **String** | | |
|
|
8
8
|
| **loyalty_program_id** | **Integer** | | |
|
|
9
|
+
| **loyalty_program_name** | **String** | The name of the loyalty program. | |
|
|
9
10
|
| **subledger_id** | **String** | | |
|
|
10
11
|
| **source_of_event** | **String** | | |
|
|
12
|
+
| **current_tier** | **String** | The name of the customer's current tier. | |
|
|
11
13
|
| **employee_name** | **String** | | [optional] |
|
|
12
14
|
| **user_id** | **Integer** | | [optional] |
|
|
13
15
|
| **current_points** | **Float** | | |
|
|
14
16
|
| **actions** | [**Array<IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction>**](IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md) | | [optional] |
|
|
15
17
|
| **published_at** | **Time** | Timestamp when the event was published. | |
|
|
16
|
-
| **current_tier** | **String** | | [optional] |
|
|
17
18
|
| **old_tier** | **String** | | [optional] |
|
|
18
19
|
| **tier_expiration_date** | **Time** | | [optional] |
|
|
19
20
|
| **timestamp_of_tier_change** | **Time** | | [optional] |
|
|
@@ -28,14 +29,15 @@ require 'talon_one_sdk'
|
|
|
28
29
|
instance = TalonOne::IntegrationHubEventPayloadLoyaltyProfileBasedNotification.new(
|
|
29
30
|
profile_integration_id: null,
|
|
30
31
|
loyalty_program_id: null,
|
|
32
|
+
loyalty_program_name: null,
|
|
31
33
|
subledger_id: null,
|
|
32
34
|
source_of_event: null,
|
|
35
|
+
current_tier: null,
|
|
33
36
|
employee_name: null,
|
|
34
37
|
user_id: null,
|
|
35
38
|
current_points: null,
|
|
36
39
|
actions: null,
|
|
37
40
|
published_at: null,
|
|
38
|
-
current_tier: null,
|
|
39
41
|
old_tier: null,
|
|
40
42
|
tier_expiration_date: null,
|
|
41
43
|
timestamp_of_tier_change: null,
|
|
@@ -6,8 +6,10 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **profile_integration_id** | **String** | | |
|
|
8
8
|
| **loyalty_program_id** | **Integer** | | |
|
|
9
|
+
| **loyalty_program_name** | **String** | The name of the loyalty program. | |
|
|
9
10
|
| **subledger_id** | **String** | | |
|
|
10
11
|
| **source_of_event** | **String** | | |
|
|
12
|
+
| **current_tier** | **String** | The name of the customer's current tier. | |
|
|
11
13
|
| **employee_name** | **String** | | [optional] |
|
|
12
14
|
| **user_id** | **Integer** | | [optional] |
|
|
13
15
|
| **current_points** | **Float** | | |
|
|
@@ -22,8 +24,10 @@ require 'talon_one_sdk'
|
|
|
22
24
|
instance = TalonOne::IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.new(
|
|
23
25
|
profile_integration_id: null,
|
|
24
26
|
loyalty_program_id: null,
|
|
27
|
+
loyalty_program_name: null,
|
|
25
28
|
subledger_id: null,
|
|
26
29
|
source_of_event: null,
|
|
30
|
+
current_tier: null,
|
|
27
31
|
employee_name: null,
|
|
28
32
|
user_id: null,
|
|
29
33
|
current_points: null,
|
|
@@ -6,9 +6,10 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **profile_integration_id** | **String** | | |
|
|
8
8
|
| **loyalty_program_id** | **Integer** | | |
|
|
9
|
+
| **loyalty_program_name** | **String** | The name of the loyalty program. | |
|
|
9
10
|
| **subledger_id** | **String** | | |
|
|
10
11
|
| **source_of_event** | **String** | | |
|
|
11
|
-
| **current_tier** | **String** |
|
|
12
|
+
| **current_tier** | **String** | The name of the customer's current tier, or null if the customer was downgraded below all tiers. | [optional] |
|
|
12
13
|
| **current_points** | **Float** | | |
|
|
13
14
|
| **old_tier** | **String** | | [optional] |
|
|
14
15
|
| **tier_expiration_date** | **Time** | | [optional] |
|
|
@@ -23,6 +24,7 @@ require 'talon_one_sdk'
|
|
|
23
24
|
instance = TalonOne::IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.new(
|
|
24
25
|
profile_integration_id: null,
|
|
25
26
|
loyalty_program_id: null,
|
|
27
|
+
loyalty_program_name: null,
|
|
26
28
|
subledger_id: null,
|
|
27
29
|
source_of_event: null,
|
|
28
30
|
current_tier: null,
|