talon_one_sdk 26.09.0 → 26.10.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.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -6
  3. data/docs/CampaignEligibility.md +5 -5
  4. data/docs/Experiment.md +4 -0
  5. data/docs/FeatureFlagUpdate.md +20 -0
  6. data/docs/IntegrationCampaign.md +1 -1
  7. data/docs/IntegrationCampaignBase.md +36 -0
  8. data/docs/ManagementApi.md +39 -39
  9. data/docs/NewExperiment.md +5 -1
  10. data/docs/NewReward.md +1 -5
  11. data/docs/NewRiskNotification.md +22 -0
  12. data/docs/Reward.md +5 -1
  13. data/docs/RiskNotification.md +30 -0
  14. data/docs/RuleMetadata.md +1 -3
  15. data/docs/RuleMetadataEligibility.md +26 -0
  16. data/docs/StrikethroughLabelingNotification.md +1 -1
  17. data/docs/StrikethroughSetDiscountPerItemEffectProps.md +2 -2
  18. data/docs/StrikethroughSetDiscountPerItemMemberEffectProps.md +1 -1
  19. data/docs/UpdateExperiment.md +5 -1
  20. data/docs/UpdateReward.md +3 -1
  21. data/lib/talon_one_sdk/api/management_api.rb +36 -36
  22. data/lib/talon_one_sdk/models/campaign_eligibility.rb +61 -44
  23. data/lib/talon_one_sdk/models/experiment.rb +40 -1
  24. data/lib/talon_one_sdk/models/feature_flag_update.rb +192 -0
  25. data/lib/talon_one_sdk/models/integration_campaign.rb +18 -1
  26. data/lib/talon_one_sdk/models/integration_campaign_base.rb +383 -0
  27. data/lib/talon_one_sdk/models/new_experiment.rb +65 -4
  28. data/lib/talon_one_sdk/models/new_reward.rb +4 -28
  29. data/lib/talon_one_sdk/models/new_risk_notification.rb +248 -0
  30. data/lib/talon_one_sdk/models/reward.rb +24 -6
  31. data/lib/talon_one_sdk/models/risk_notification.rb +364 -0
  32. data/lib/talon_one_sdk/models/rule_metadata.rb +4 -15
  33. data/lib/talon_one_sdk/models/rule_metadata_eligibility.rb +230 -0
  34. data/lib/talon_one_sdk/models/strikethrough_labeling_notification.rb +1 -1
  35. data/lib/talon_one_sdk/models/strikethrough_set_discount_per_item_effect_props.rb +2 -1
  36. data/lib/talon_one_sdk/models/strikethrough_set_discount_per_item_member_effect_props.rb +1 -1
  37. data/lib/talon_one_sdk/models/update_experiment.rb +58 -4
  38. data/lib/talon_one_sdk/models/update_reward.rb +13 -5
  39. data/lib/talon_one_sdk/version.rb +1 -1
  40. data/lib/talon_one_sdk.rb +5 -0
  41. data/spec/api/management_api_spec.rb +18 -18
  42. data/spec/models/campaign_eligibility_spec.rb +4 -4
  43. data/spec/models/experiment_spec.rb +16 -0
  44. data/spec/models/feature_flag_update_spec.rb +42 -0
  45. data/spec/models/integration_campaign_base_spec.rb +98 -0
  46. data/spec/models/new_experiment_spec.rb +16 -0
  47. data/spec/models/new_reward_spec.rb +0 -12
  48. data/spec/models/new_risk_notification_spec.rb +60 -0
  49. data/spec/models/reward_spec.rb +12 -0
  50. data/spec/models/risk_notification_spec.rb +84 -0
  51. data/spec/models/rule_metadata_eligibility_spec.rb +60 -0
  52. data/spec/models/rule_metadata_spec.rb +0 -6
  53. data/spec/models/update_experiment_spec.rb +16 -0
  54. data/spec/models/update_reward_spec.rb +6 -0
  55. metadata +21 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2784188ae0f0516b6b137dca2a8b074156f849d84e28473f9be2f249576f5e77
4
- data.tar.gz: 7bfed0a41fc37b3e3550e54bc1a007a6d48dd144eb7b14f7465da7d6bd32ccc9
3
+ metadata.gz: 0a336bbbe1183f35e30562723e3d0e9c2c3483878223d6119e7168718f72abaa
4
+ data.tar.gz: 0b70417abe3379c783c590dd93896176de15f21d25220a45123133fca80c8be8
5
5
  SHA512:
6
- metadata.gz: 2e28d7dfdb6c7f33c3cdc199eff712bb8ccbf4cd5bb02d4579cd7fb011d73e539c318bd28eaa418a228b99c4be184dce23145f472275bdd8bc4dba2ae8696e36
7
- data.tar.gz: 06fda459a5edb117c8f2ae0f1728a54d01bf4c15dc572342823a112f781b21d74b3b0b1a4ba7882f2f6effeff120ab80cbd1afc281353622cfdd2a2e8278189d
6
+ metadata.gz: 5b52be179397d4c2c26c0dfd21083241386b98ad3adc85d7b16990c33dc574fc6319aad3bc01e52a087d0d0881e47ac3596b2a653dc573381f94fbdcaf20455b
7
+ data.tar.gz: 2319fb5d63bc1f80cf094a9ef2721db509f632003d9c4d1ff0b4046bc0edea2d46324f6c00024bbfaf04ade88be835bc96782e348d63d7c4ed7874620923428f
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.09.0'
19
+ gem 'talon_one_sdk', '~> 26.10.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.09.0.gem
35
+ gem install ./talon_one_sdk-26.10.0.gem
36
36
  ```
37
37
 
38
- For development, run `gem install --dev ./talon_one_sdk-26.09.0.gem` to install the development dependencies.
38
+ For development, run `gem install --dev ./talon_one_sdk-26.10.0.gem` to install the development dependencies.
39
39
 
40
40
  ### RubyGems
41
41
 
@@ -322,12 +322,12 @@ Class | Method | HTTP request | Description
322
322
  *TalonOne::ManagementApi* | [**get_experiment**](docs/ManagementApi.md#get_experiment) | **GET** /v1/applications/{applicationId}/experiments/{experimentId} | Get experiment in Application
323
323
  *TalonOne::ManagementApi* | [**get_exports**](docs/ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports
324
324
  *TalonOne::ManagementApi* | [**get_loyalty_card**](docs/ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
325
- *TalonOne::ManagementApi* | [**get_loyalty_card_transaction_logs**](docs/ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions
325
+ *TalonOne::ManagementApi* | [**get_loyalty_card_transaction_logs**](docs/ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions (Management API)
326
326
  *TalonOne::ManagementApi* | [**get_loyalty_cards**](docs/ManagementApi.md#get_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards
327
- *TalonOne::ManagementApi* | [**get_loyalty_ledger_balances**](docs/ManagementApi.md#get_loyalty_ledger_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances | Get customer's loyalty balances
327
+ *TalonOne::ManagementApi* | [**get_loyalty_ledger_balances**](docs/ManagementApi.md#get_loyalty_ledger_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances | Get customer's loyalty balances (Management API)
328
328
  *TalonOne::ManagementApi* | [**get_loyalty_points**](docs/ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger
329
329
  *TalonOne::ManagementApi* | [**get_loyalty_program**](docs/ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program
330
- *TalonOne::ManagementApi* | [**get_loyalty_program_profile_ledger_transactions**](docs/ManagementApi.md#get_loyalty_program_profile_ledger_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions | List customer's loyalty transactions
330
+ *TalonOne::ManagementApi* | [**get_loyalty_program_profile_ledger_transactions**](docs/ManagementApi.md#get_loyalty_program_profile_ledger_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions | List customer's loyalty transactions (Management API)
331
331
  *TalonOne::ManagementApi* | [**get_loyalty_program_transactions**](docs/ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
332
332
  *TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
333
333
  *TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
@@ -668,6 +668,7 @@ Class | Method | HTTP request | Description
668
668
  - [TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps](docs/ExtendLoyaltyPointsExpiryDateEffectProps.md)
669
669
  - [TalonOne::ExtendedCoupon](docs/ExtendedCoupon.md)
670
670
  - [TalonOne::FeatureFlag](docs/FeatureFlag.md)
671
+ - [TalonOne::FeatureFlagUpdate](docs/FeatureFlagUpdate.md)
671
672
  - [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
672
673
  - [TalonOne::FuncArgDef](docs/FuncArgDef.md)
673
674
  - [TalonOne::FunctionDef](docs/FunctionDef.md)
@@ -738,6 +739,7 @@ Class | Method | HTTP request | Description
738
739
  - [TalonOne::IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md)
739
740
  - [TalonOne::InfluencingCampaignDetails](docs/InfluencingCampaignDetails.md)
740
741
  - [TalonOne::IntegrationCampaign](docs/IntegrationCampaign.md)
742
+ - [TalonOne::IntegrationCampaignBase](docs/IntegrationCampaignBase.md)
741
743
  - [TalonOne::IntegrationCoupon](docs/IntegrationCoupon.md)
742
744
  - [TalonOne::IntegrationCustomerProfileAudienceRequest](docs/IntegrationCustomerProfileAudienceRequest.md)
743
745
  - [TalonOne::IntegrationCustomerProfileAudienceRequestItem](docs/IntegrationCustomerProfileAudienceRequestItem.md)
@@ -898,6 +900,7 @@ Class | Method | HTTP request | Description
898
900
  - [TalonOne::NewReturn](docs/NewReturn.md)
899
901
  - [TalonOne::NewRevisionVersion](docs/NewRevisionVersion.md)
900
902
  - [TalonOne::NewReward](docs/NewReward.md)
903
+ - [TalonOne::NewRiskNotification](docs/NewRiskNotification.md)
901
904
  - [TalonOne::NewRole](docs/NewRole.md)
902
905
  - [TalonOne::NewRoleV2](docs/NewRoleV2.md)
903
906
  - [TalonOne::NewRuleset](docs/NewRuleset.md)
@@ -966,6 +969,7 @@ Class | Method | HTTP request | Description
966
969
  - [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
967
970
  - [TalonOne::RevisionVersion](docs/RevisionVersion.md)
968
971
  - [TalonOne::Reward](docs/Reward.md)
972
+ - [TalonOne::RiskNotification](docs/RiskNotification.md)
969
973
  - [TalonOne::Role](docs/Role.md)
970
974
  - [TalonOne::RoleAssign](docs/RoleAssign.md)
971
975
  - [TalonOne::RoleMembership](docs/RoleMembership.md)
@@ -988,6 +992,7 @@ Class | Method | HTTP request | Description
988
992
  - [TalonOne::RuleEligibilityFailureDetails](docs/RuleEligibilityFailureDetails.md)
989
993
  - [TalonOne::RuleFailureReason](docs/RuleFailureReason.md)
990
994
  - [TalonOne::RuleMetadata](docs/RuleMetadata.md)
995
+ - [TalonOne::RuleMetadataEligibility](docs/RuleMetadataEligibility.md)
991
996
  - [TalonOne::Ruleset](docs/Ruleset.md)
992
997
  - [TalonOne::SSOConfig](docs/SSOConfig.md)
993
998
  - [TalonOne::SamlConnection](docs/SamlConnection.md)
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | Unique ID of Campaign. | |
8
7
  | **application_id** | **Integer** | The ID of the Application that owns this entity. | |
8
+ | **id** | **Integer** | Unique ID of Campaign. | |
9
9
  | **name** | **String** | The name of the campaign. | |
10
10
  | **description** | **String** | A detailed description of the campaign. | [optional] |
11
11
  | **start_time** | **Time** | Timestamp when the campaign will become active. | [optional] |
@@ -14,8 +14,8 @@
14
14
  | **state** | **String** | The state of the campaign. | [default to 'enabled'] |
15
15
  | **tags** | **Array<String>** | A list of tags for the campaign. | |
16
16
  | **features** | **Array<String>** | The features enabled in this campaign. | |
17
- | **rules** | [**Array<RuleMetadata>**](RuleMetadata.md) | A list of rules containing customer-facing details of the rewards defined in the campaign. | [optional] |
18
17
  | **eligibility** | [**Array<CampaignEligibilityDetails>**](CampaignEligibilityDetails.md) | The customer's eligibility for each campaign in the current customer session. | |
18
+ | **rules** | [**Array<RuleMetadataEligibility>**](RuleMetadataEligibility.md) | A list of rules containing customer-facing details of the rewards defined in the campaign. | |
19
19
 
20
20
  ## Example
21
21
 
@@ -23,8 +23,8 @@
23
23
  require 'talon_one_sdk'
24
24
 
25
25
  instance = TalonOne::CampaignEligibility.new(
26
- id: 4,
27
26
  application_id: 322,
27
+ id: 4,
28
28
  name: Summer promotions,
29
29
  description: Campaign for all summer 2021 promotions,
30
30
  start_time: 2021-07-20T22:00:00Z,
@@ -33,8 +33,8 @@ instance = TalonOne::CampaignEligibility.new(
33
33
  state: enabled,
34
34
  tags: [summer],
35
35
  features: [coupons, referrals],
36
- rules: null,
37
- eligibility: null
36
+ eligibility: null,
37
+ rules: null
38
38
  )
39
39
  ```
40
40
 
data/docs/Experiment.md CHANGED
@@ -12,6 +12,8 @@
12
12
  | **activated** | **Time** | The date and time the experiment was activated. | [optional] |
13
13
  | **state** | **String** | A disabled experiment is not evaluated for rules or coupons. | [default to 'disabled'] |
14
14
  | **variants** | [**Array<ExperimentVariant>**](ExperimentVariant.md) | | [optional] |
15
+ | **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. | |
16
+ | **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. | [optional] |
15
17
  | **deletedat** | **Time** | The date and time the experiment was deleted. | [optional] |
16
18
 
17
19
  ## Example
@@ -28,6 +30,8 @@ instance = TalonOne::Experiment.new(
28
30
  activated: null,
29
31
  state: enabled,
30
32
  variants: null,
33
+ goal_type: null,
34
+ goal_description: Offering free shipping will increase average order revenue more than a 10% discount,
31
35
  deletedat: null
32
36
  )
33
37
  ```
@@ -0,0 +1,20 @@
1
+ # TalonOne::FeatureFlagUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the feature flag. | |
8
+ | **value** | **String** | The value of the feature flag. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'talon_one_sdk'
14
+
15
+ instance = TalonOne::FeatureFlagUpdate.new(
16
+ name: canCreateCampaignFromTemplate,
17
+ value: true
18
+ )
19
+ ```
20
+
@@ -14,7 +14,7 @@
14
14
  | **state** | **String** | The state of the campaign. | [default to 'enabled'] |
15
15
  | **tags** | **Array<String>** | A list of tags for the campaign. | |
16
16
  | **features** | **Array<String>** | The features enabled in this campaign. | |
17
- | **rules** | [**Array<RuleMetadata>**](RuleMetadata.md) | A list of rules containing customer-facing details of the rewards defined in the campaign. | [optional] |
17
+ | **rules** | [**Array<RuleMetadata>**](RuleMetadata.md) | A list of rules containing customer-facing details of the rewards defined in the campaign. | |
18
18
 
19
19
  ## Example
20
20
 
@@ -0,0 +1,36 @@
1
+ # TalonOne::IntegrationCampaignBase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **application_id** | **Integer** | The ID of the Application that owns this entity. | |
8
+ | **id** | **Integer** | Unique ID of Campaign. | |
9
+ | **name** | **String** | The name of the campaign. | |
10
+ | **description** | **String** | A detailed description of the campaign. | [optional] |
11
+ | **start_time** | **Time** | Timestamp when the campaign will become active. | [optional] |
12
+ | **end_time** | **Time** | Timestamp when the campaign will become inactive. | [optional] |
13
+ | **attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
14
+ | **state** | **String** | The state of the campaign. | [default to 'enabled'] |
15
+ | **tags** | **Array<String>** | A list of tags for the campaign. | |
16
+ | **features** | **Array<String>** | The features enabled in this campaign. | |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'talon_one_sdk'
22
+
23
+ instance = TalonOne::IntegrationCampaignBase.new(
24
+ application_id: 322,
25
+ id: 4,
26
+ name: Summer promotions,
27
+ description: Campaign for all summer 2021 promotions,
28
+ start_time: 2021-07-20T22:00:00Z,
29
+ end_time: 2021-09-22T22:00:00Z,
30
+ attributes: null,
31
+ state: enabled,
32
+ tags: [summer],
33
+ features: [coupons, referrals]
34
+ )
35
+ ```
36
+
@@ -110,12 +110,12 @@ All URIs are relative to *https://yourbaseurl.talon.one*
110
110
  | [**get_experiment**](ManagementApi.md#get_experiment) | **GET** /v1/applications/{applicationId}/experiments/{experimentId} | Get experiment in Application |
111
111
  | [**get_exports**](ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports |
112
112
  | [**get_loyalty_card**](ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card |
113
- | [**get_loyalty_card_transaction_logs**](ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions |
113
+ | [**get_loyalty_card_transaction_logs**](ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions (Management API) |
114
114
  | [**get_loyalty_cards**](ManagementApi.md#get_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards |
115
- | [**get_loyalty_ledger_balances**](ManagementApi.md#get_loyalty_ledger_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances | Get customer's loyalty balances |
115
+ | [**get_loyalty_ledger_balances**](ManagementApi.md#get_loyalty_ledger_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances | Get customer's loyalty balances (Management API) |
116
116
  | [**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger |
117
117
  | [**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program |
118
- | [**get_loyalty_program_profile_ledger_transactions**](ManagementApi.md#get_loyalty_program_profile_ledger_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions | List customer's loyalty transactions |
118
+ | [**get_loyalty_program_profile_ledger_transactions**](ManagementApi.md#get_loyalty_program_profile_ledger_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions | List customer's loyalty transactions (Management API) |
119
119
  | [**get_loyalty_program_transactions**](ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions |
120
120
  | [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs |
121
121
  | [**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics |
@@ -8409,9 +8409,9 @@ end
8409
8409
 
8410
8410
  > <GetLoyaltyCardTransactionLogs200Response> get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
8411
8411
 
8412
- List card's transactions
8412
+ List card's transactions (Management API)
8413
8413
 
8414
- Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
8414
+ Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. > [!note] For most use cases, especially real-time integrations, use the Integration API endpoint: > [List card's transactions](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/getLoyaltyCardTransactions). If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
8415
8415
 
8416
8416
  ### Examples
8417
8417
 
@@ -8440,7 +8440,7 @@ opts = {
8440
8440
  }
8441
8441
 
8442
8442
  begin
8443
- # List card's transactions
8443
+ # List card's transactions (Management API)
8444
8444
  result = api_instance.get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
8445
8445
  p result
8446
8446
  rescue TalonOne::ApiError => e
@@ -8456,7 +8456,7 @@ This returns an Array which contains the response data, status code and headers.
8456
8456
 
8457
8457
  ```ruby
8458
8458
  begin
8459
- # List card's transactions
8459
+ # List card's transactions (Management API)
8460
8460
  data, status_code, headers = api_instance.get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
8461
8461
  p status_code # => 2xx
8462
8462
  p headers # => { ... }
@@ -8583,9 +8583,9 @@ end
8583
8583
 
8584
8584
  > <LoyaltyBalancesWithTiers> get_loyalty_ledger_balances(loyalty_program_id, integration_id, opts)
8585
8585
 
8586
- Get customer's loyalty balances
8586
+ Get customer's loyalty balances (Management API)
8587
8587
 
8588
- Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
8588
+ Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] **Note** > - For most use cases, especially real-time integrations, use the Integration API endpoint: [Get customer's loyalty balances](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyBalances). > - If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
8589
8589
 
8590
8590
  ### Examples
8591
8591
 
@@ -8611,7 +8611,7 @@ opts = {
8611
8611
  }
8612
8612
 
8613
8613
  begin
8614
- # Get customer's loyalty balances
8614
+ # Get customer's loyalty balances (Management API)
8615
8615
  result = api_instance.get_loyalty_ledger_balances(loyalty_program_id, integration_id, opts)
8616
8616
  p result
8617
8617
  rescue TalonOne::ApiError => e
@@ -8627,7 +8627,7 @@ This returns an Array which contains the response data, status code and headers.
8627
8627
 
8628
8628
  ```ruby
8629
8629
  begin
8630
- # Get customer's loyalty balances
8630
+ # Get customer's loyalty balances (Management API)
8631
8631
  data, status_code, headers = api_instance.get_loyalty_ledger_balances_with_http_info(loyalty_program_id, integration_id, opts)
8632
8632
  p status_code # => 2xx
8633
8633
  p headers # => { ... }
@@ -8810,9 +8810,9 @@ end
8810
8810
 
8811
8811
  > <GetLoyaltyProgramProfileTransactions200Response> get_loyalty_program_profile_ledger_transactions(loyalty_program_id, integration_id, opts)
8812
8812
 
8813
- List customer's loyalty transactions
8813
+ List customer's loyalty transactions (Management API)
8814
8814
 
8815
- Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
8815
+ Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] **Note** > - For most use cases, especially real-time integrations, use the Integration API endpoint: > [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions). > - To retrieve all loyalty program transaction logs in a given loyalty program, use the > [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
8816
8816
 
8817
8817
  ### Examples
8818
8818
 
@@ -8843,7 +8843,7 @@ opts = {
8843
8843
  }
8844
8844
 
8845
8845
  begin
8846
- # List customer's loyalty transactions
8846
+ # List customer's loyalty transactions (Management API)
8847
8847
  result = api_instance.get_loyalty_program_profile_ledger_transactions(loyalty_program_id, integration_id, opts)
8848
8848
  p result
8849
8849
  rescue TalonOne::ApiError => e
@@ -8859,7 +8859,7 @@ This returns an Array which contains the response data, status code and headers.
8859
8859
 
8860
8860
  ```ruby
8861
8861
  begin
8862
- # List customer's loyalty transactions
8862
+ # List customer's loyalty transactions (Management API)
8863
8863
  data, status_code, headers = api_instance.get_loyalty_program_profile_ledger_transactions_with_http_info(loyalty_program_id, integration_id, opts)
8864
8864
  p status_code # => 2xx
8865
8865
  p headers # => { ... }
@@ -9951,7 +9951,7 @@ end
9951
9951
  api_instance = TalonOne::ManagementApi.new
9952
9952
  collection_id = 789 # Integer | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
9953
9953
  opts = {
9954
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
9954
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
9955
9955
  }
9956
9956
 
9957
9957
  begin
@@ -9986,7 +9986,7 @@ end
9986
9986
  | Name | Type | Description | Notes |
9987
9987
  | ---- | ---- | ----------- | ----- |
9988
9988
  | **collection_id** | **Integer** | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
9989
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
9989
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
9990
9990
 
9991
9991
  ### Return type
9992
9992
 
@@ -10026,7 +10026,7 @@ end
10026
10026
  api_instance = TalonOne::ManagementApi.new
10027
10027
  attribute_id = 789 # Integer | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
10028
10028
  opts = {
10029
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10029
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10030
10030
  }
10031
10031
 
10032
10032
  begin
@@ -10061,7 +10061,7 @@ end
10061
10061
  | Name | Type | Description | Notes |
10062
10062
  | ---- | ---- | ----------- | ----- |
10063
10063
  | **attribute_id** | **Integer** | The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in **Account** &gt; **Tools** &gt; **Attributes**. | |
10064
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10064
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10065
10065
 
10066
10066
  ### Return type
10067
10067
 
@@ -10101,7 +10101,7 @@ end
10101
10101
  api_instance = TalonOne::ManagementApi.new
10102
10102
  audience_id = 789 # Integer | The ID of the audience.
10103
10103
  opts = {
10104
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10104
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10105
10105
  }
10106
10106
 
10107
10107
  begin
@@ -10136,7 +10136,7 @@ end
10136
10136
  | Name | Type | Description | Notes |
10137
10137
  | ---- | ---- | ----------- | ----- |
10138
10138
  | **audience_id** | **Integer** | The ID of the audience. | |
10139
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10139
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10140
10140
 
10141
10141
  ### Return type
10142
10142
 
@@ -10179,7 +10179,7 @@ campaign_id = 789 # Integer | The ID of the campaign. It is displayed in your Ta
10179
10179
  opts = {
10180
10180
  action: 'setDiscount', # String | The action that this budget is limiting.
10181
10181
  period: 'overall', # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
10182
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10182
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10183
10183
  }
10184
10184
 
10185
10185
  begin
@@ -10217,7 +10217,7 @@ end
10217
10217
  | **campaign_id** | **Integer** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
10218
10218
  | **action** | **String** | The action that this budget is limiting. | [optional] |
10219
10219
  | **period** | **String** | The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;. | [optional] |
10220
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10220
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10221
10221
 
10222
10222
  ### Return type
10223
10223
 
@@ -10258,7 +10258,7 @@ api_instance = TalonOne::ManagementApi.new
10258
10258
  application_id = 789 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
10259
10259
  campaign_id = 789 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
10260
10260
  opts = {
10261
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10261
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10262
10262
  }
10263
10263
 
10264
10264
  begin
@@ -10294,7 +10294,7 @@ end
10294
10294
  | ---- | ---- | ----------- | ----- |
10295
10295
  | **application_id** | **Integer** | The ID of the Application. It is displayed in your Talon.One deployment URL. | |
10296
10296
  | **campaign_id** | **Integer** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
10297
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10297
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10298
10298
 
10299
10299
  ### Return type
10300
10300
 
@@ -10336,7 +10336,7 @@ application_id = 789 # Integer | The ID of the Application. It is displayed in y
10336
10336
  campaign_id = 789 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
10337
10337
  collection_id = 789 # Integer | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
10338
10338
  opts = {
10339
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10339
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10340
10340
  }
10341
10341
 
10342
10342
  begin
@@ -10373,7 +10373,7 @@ end
10373
10373
  | **application_id** | **Integer** | The ID of the Application. It is displayed in your Talon.One deployment URL. | |
10374
10374
  | **campaign_id** | **Integer** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
10375
10375
  | **collection_id** | **Integer** | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
10376
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10376
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10377
10377
 
10378
10378
  ### Return type
10379
10379
 
@@ -10415,7 +10415,7 @@ application_id = 789 # Integer | The ID of the Application. It is displayed in y
10415
10415
  campaign_id = 789 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
10416
10416
  opts = {
10417
10417
  skip_duplicates: true, # Boolean | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
10418
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10418
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10419
10419
  }
10420
10420
 
10421
10421
  begin
@@ -10452,7 +10452,7 @@ end
10452
10452
  | **application_id** | **Integer** | The ID of the Application. It is displayed in your Talon.One deployment URL. | |
10453
10453
  | **campaign_id** | **Integer** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
10454
10454
  | **skip_duplicates** | **Boolean** | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;. | [optional] |
10455
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10455
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10456
10456
 
10457
10457
  ### Return type
10458
10458
 
@@ -10492,7 +10492,7 @@ end
10492
10492
  api_instance = TalonOne::ManagementApi.new
10493
10493
  loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10494
10494
  opts = {
10495
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10495
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10496
10496
  }
10497
10497
 
10498
10498
  begin
@@ -10527,7 +10527,7 @@ end
10527
10527
  | Name | Type | Description | Notes |
10528
10528
  | ---- | ---- | ----------- | ----- |
10529
10529
  | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
10530
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10530
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10531
10531
 
10532
10532
  ### Return type
10533
10533
 
@@ -10567,7 +10567,7 @@ end
10567
10567
  api_instance = TalonOne::ManagementApi.new
10568
10568
  loyalty_program_id = 789 # Integer | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10569
10569
  opts = {
10570
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10570
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10571
10571
  }
10572
10572
 
10573
10573
  begin
@@ -10602,7 +10602,7 @@ end
10602
10602
  | Name | Type | Description | Notes |
10603
10603
  | ---- | ---- | ----------- | ----- |
10604
10604
  | **loyalty_program_id** | **Integer** | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
10605
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10605
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10606
10606
 
10607
10607
  ### Return type
10608
10608
 
@@ -10643,7 +10643,7 @@ api_instance = TalonOne::ManagementApi.new
10643
10643
  loyalty_program_id = 789 # Integer | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10644
10644
  opts = {
10645
10645
  notifications_enabled: true, # Boolean | Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
10646
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10646
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10647
10647
  }
10648
10648
 
10649
10649
  begin
@@ -10679,7 +10679,7 @@ end
10679
10679
  | ---- | ---- | ----------- | ----- |
10680
10680
  | **loyalty_program_id** | **Integer** | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
10681
10681
  | **notifications_enabled** | **Boolean** | Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer&#39;s tier or offsets their negative points balance. This parameter is optional and defaults to &#x60;true&#x60;. | [optional] |
10682
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10682
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10683
10683
 
10684
10684
  ### Return type
10685
10685
 
@@ -10719,7 +10719,7 @@ end
10719
10719
  api_instance = TalonOne::ManagementApi.new
10720
10720
  pool_id = 789 # Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
10721
10721
  opts = {
10722
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10722
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10723
10723
  }
10724
10724
 
10725
10725
  begin
@@ -10754,7 +10754,7 @@ end
10754
10754
  | Name | Type | Description | Notes |
10755
10755
  | ---- | ---- | ----------- | ----- |
10756
10756
  | **pool_id** | **Integer** | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. | |
10757
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10757
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10758
10758
 
10759
10759
  ### Return type
10760
10760
 
@@ -10795,7 +10795,7 @@ api_instance = TalonOne::ManagementApi.new
10795
10795
  application_id = 789 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
10796
10796
  campaign_id = 789 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
10797
10797
  opts = {
10798
- up_file: 'up_file_example' # String | The file containing the data that is being imported.
10798
+ up_file: File.new('/path/to/some/file') # File | The CSV file containing the data that is being imported.
10799
10799
  }
10800
10800
 
10801
10801
  begin
@@ -10831,7 +10831,7 @@ end
10831
10831
  | ---- | ---- | ----------- | ----- |
10832
10832
  | **application_id** | **Integer** | The ID of the Application. It is displayed in your Talon.One deployment URL. | |
10833
10833
  | **campaign_id** | **Integer** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
10834
- | **up_file** | **String** | The file containing the data that is being imported. | [optional] |
10834
+ | **up_file** | **File** | The CSV file containing the data that is being imported. | [optional] |
10835
10835
 
10836
10836
  ### Return type
10837
10837
 
@@ -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** | [**NewCampaign**](NewCampaign.md) | | |
9
+ | **goal_type** | **String** | The goal of the experiment. Determines which single metric is used to decide the winning variant. When set to &#x60;other&#x60;, multiple metrics are used. | |
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. | [optional] |
9
11
 
10
12
  ## Example
11
13
 
@@ -14,7 +16,9 @@ require 'talon_one_sdk'
14
16
 
15
17
  instance = TalonOne::NewExperiment.new(
16
18
  is_variant_assignment_external: null,
17
- campaign: null
19
+ campaign: null,
20
+ goal_type: null,
21
+ goal_description: Offering free shipping will increase average order revenue more than a 10% discount
18
22
  )
19
23
  ```
20
24
 
data/docs/NewReward.md CHANGED
@@ -9,8 +9,6 @@
9
9
  | **description** | **String** | A description of the reward. | [optional] |
10
10
  | **application_ids** | **Array&lt;Integer&gt;** | The IDs of the Applications this reward is connected to. **Note**: Currently, a reward can only be connected to one Application. | |
11
11
  | **sandbox** | **Boolean** | Indicates if this is a live or sandbox reward. Rewards of a given type can only be connected to Applications of the same type. | |
12
- | **rule** | [**Array&lt;Rule&gt;**](Rule.md) | Rule to apply. | [optional] |
13
- | **bindings** | [**Array&lt;Binding&gt;**](Binding.md) | A list of named variables created before the reward&#39;s rules are evaluated. Each binding pairs a name with a talang expression. The expression is evaluated once and its result is available by name in any rule condition or effect. Bindings must be defined outside of individual rules. | [optional] |
14
12
 
15
13
  ## Example
16
14
 
@@ -22,9 +20,7 @@ instance = TalonOne::NewReward.new(
22
20
  api_name: free-coffee,
23
21
  description: This reward gets you one free coffee.,
24
22
  application_ids: [1, 2, 3],
25
- sandbox: true,
26
- rule: null,
27
- bindings: []
23
+ sandbox: true
28
24
  )
29
25
  ```
30
26
 
@@ -0,0 +1,22 @@
1
+ # TalonOne::NewRiskNotification
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **entity** | **String** | The entity type to analyze within the given time frame. | |
8
+ | **activity** | **String** | The activity metric to analyze within the given entity. | |
9
+ | **time_frame** | **String** | The rolling time window for risk evaluation. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'talon_one_sdk'
15
+
16
+ instance = TalonOne::NewRiskNotification.new(
17
+ entity: customer_profile,
18
+ activity: loyalty_points_earned,
19
+ time_frame: 1_week
20
+ )
21
+ ```
22
+
data/docs/Reward.md CHANGED
@@ -12,8 +12,10 @@
12
12
  | **description** | **String** | A description of the reward. | [optional] |
13
13
  | **application_ids** | **Array&lt;Integer&gt;** | The IDs of the Applications this reward is connected to. **Note**: Currently, a reward can only be connected to one Application. | |
14
14
  | **sandbox** | **Boolean** | Indicates if this is a live or sandbox reward. Rewards of a given type can only be connected to Applications of the same type. | |
15
- | **rule** | [**Array&lt;Rule&gt;**](Rule.md) | Rule to apply. | [optional] |
15
+ | **visibility_conditions** | [**Rule**](Rule.md) | An optional rule that manages who can see this reward. If not specified, the reward is visible to all customers. **Note:** Only the &#x60;condition&#x60; field is evaluated within this rule. The &#x60;effects&#x60; field must be an empty array, and &#x60;bindings&#x60; are not supported. | [optional] |
16
+ | **rule** | [**Rule**](Rule.md) | Rule to apply. **Note**: The &#x60;bindings&#x60; field inside the rule must not be used in this endpoint. All bindings should be defined at the reward level via the top-level &#x60;bindings&#x60; field. | [optional] |
16
17
  | **bindings** | [**Array&lt;Binding&gt;**](Binding.md) | A list of named variables created before the reward&#39;s rules are evaluated. Each binding pairs a name with a talang expression. The expression is evaluated once and its result is available by name in any rule condition or effect. Bindings must be defined outside of individual rules. | [optional] |
18
+ | **modified** | **Time** | The timestamp when the reward was last updated in RFC3339 format. | [optional] |
17
19
  | **status** | **String** | The status of the reward. | |
18
20
 
19
21
  ## Example
@@ -30,8 +32,10 @@ instance = TalonOne::Reward.new(
30
32
  description: This reward gets you one free coffee.,
31
33
  application_ids: [1, 2, 3],
32
34
  sandbox: true,
35
+ visibility_conditions: null,
33
36
  rule: null,
34
37
  bindings: [],
38
+ modified: null,
35
39
  status: active
36
40
  )
37
41
  ```