talon_one_sdk 26.16.0 → 26.17.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 +38 -12
- data/docs/AchievementProgressWithDefinition.md +5 -1
- data/docs/AchievementStatusEntry.md +3 -1
- data/docs/AchievementV2.md +12 -8
- data/docs/AddLoyaltyPointsSupport.md +36 -0
- data/docs/ApplicationMembership.md +20 -0
- data/docs/ApplicationReferee.md +2 -0
- data/docs/BestPriorPrice.md +0 -2
- data/docs/Bundle.md +28 -0
- data/docs/CampaignReference.md +20 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +1 -1
- data/docs/CatalogAction.md +47 -13
- data/docs/{CatalogActionOneOf.md → CatalogActionAdd.md} +3 -3
- data/docs/CatalogActionAddPriceAdjustment.md +20 -0
- data/docs/{CatalogActionOneOf1.md → CatalogActionPatch.md} +4 -4
- data/docs/{CatalogActionOneOf2.md → CatalogActionPatchMany.md} +4 -4
- data/docs/{CatalogActionOneOf3.md → CatalogActionRemove.md} +4 -4
- data/docs/CatalogActionRemoveMany.md +20 -0
- data/docs/CheckAttributeBlock.md +3 -1
- data/docs/CheckLoyaltyCardBlock.md +26 -0
- data/docs/CheckTierBlock.md +30 -0
- data/docs/CheckTierBlock1Tier.md +24 -0
- data/docs/CreateAchievementV2.md +4 -4
- data/docs/CustomerAchievement.md +6 -0
- data/docs/CustomerInventory.md +3 -1
- data/docs/CustomerProfileReward.md +6 -4
- data/docs/CustomerReward.md +26 -0
- data/docs/Effect.md +1 -1
- data/docs/EventV3.md +2 -0
- data/docs/EventV3ReferralEntity.md +18 -0
- data/docs/EventV3RequestEntity.md +3 -1
- data/docs/History.md +0 -2
- data/docs/IntegrationApi.md +9 -9
- data/docs/IntegrationEventV3Request.md +2 -0
- data/docs/IntegrationEventV3Response.md +3 -1
- data/docs/IntegrationHubFlowResponse.md +0 -2
- data/docs/IntegrationUnlockRewardRequest.md +26 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +1 -1
- data/docs/ListAchievementsV2200Response.md +20 -0
- data/docs/LoyaltyProgramTransaction.md +1 -1
- data/docs/MCPOAuthClient.md +1 -1
- data/docs/MCPOAuthSessionInfo.md +22 -0
- data/docs/ManagementApi.md +444 -1
- data/docs/PromotionBlock.md +9 -0
- data/docs/RedeemLoyaltyPointsBlock.md +32 -0
- data/docs/RedeemLoyaltyPointsBlock1Program.md +22 -0
- data/docs/RedeemLoyaltyPointsBlock1Value.md +49 -0
- data/docs/RewardCatalogItem.md +28 -0
- data/docs/RewardEligibility.md +20 -0
- data/docs/RewardEligibilityFailureDetails.md +20 -0
- data/docs/RollbackUseRewardEffectProps.md +22 -0
- data/docs/RulesetV2.md +2 -2
- data/docs/SelectorGroupBlock.md +2 -2
- data/docs/StrikethroughEffect.md +1 -1
- data/docs/SupportCustomerProfile.md +26 -0
- data/docs/TemplateParameter.md +30 -0
- data/docs/UnlockRewardEffectProps.md +26 -0
- data/docs/UseRewardEffectProps.md +22 -0
- data/lib/talon_one_sdk/api/integration_api.rb +16 -16
- data/lib/talon_one_sdk/api/management_api.rb +413 -2
- data/lib/talon_one_sdk/models/achievement_progress_with_definition.rb +60 -2
- data/lib/talon_one_sdk/models/achievement_status_entry.rb +31 -2
- data/lib/talon_one_sdk/models/achievement_v2.rb +51 -91
- data/lib/talon_one_sdk/models/add_loyalty_points_support.rb +281 -0
- data/lib/talon_one_sdk/models/application_membership.rb +192 -0
- data/lib/talon_one_sdk/models/application_referee.rb +30 -1
- data/lib/talon_one_sdk/models/best_prior_price.rb +1 -13
- data/lib/talon_one_sdk/models/bundle.rb +314 -0
- data/lib/talon_one_sdk/models/campaign_reference.rb +192 -0
- data/lib/talon_one_sdk/models/card_ledger_transaction_log_entry_integration_api.rb +1 -1
- data/lib/talon_one_sdk/models/catalog_action.rb +29 -74
- data/lib/talon_one_sdk/models/{catalog_action_one_of1.rb → catalog_action_add.rb} +47 -6
- data/lib/talon_one_sdk/models/{catalog_action_one_of5.rb → catalog_action_add_price_adjustment.rb} +46 -5
- data/lib/talon_one_sdk/models/{catalog_action_one_of.rb → catalog_action_patch.rb} +46 -6
- data/lib/talon_one_sdk/models/catalog_action_patch_many.rb +217 -0
- data/lib/talon_one_sdk/models/{catalog_action_one_of4.rb → catalog_action_remove.rb} +47 -6
- data/lib/talon_one_sdk/models/catalog_action_remove_many.rb +217 -0
- data/lib/talon_one_sdk/models/check_attribute_block.rb +2 -1
- data/lib/talon_one_sdk/models/check_loyalty_card_block.rb +274 -0
- data/lib/talon_one_sdk/models/check_tier_block.rb +327 -0
- data/lib/talon_one_sdk/models/check_tier_block1_tier.rb +228 -0
- data/lib/talon_one_sdk/models/create_achievement_v2.rb +6 -64
- data/lib/talon_one_sdk/models/customer_achievement.rb +69 -1
- data/lib/talon_one_sdk/models/customer_inventory.rb +16 -4
- data/lib/talon_one_sdk/models/customer_profile_reward.rb +40 -13
- data/lib/talon_one_sdk/models/customer_reward.rb +257 -0
- data/lib/talon_one_sdk/models/effect.rb +2 -16
- data/lib/talon_one_sdk/models/event_v3.rb +31 -1
- data/lib/talon_one_sdk/models/event_v3_referral_entity.rb +167 -0
- data/lib/talon_one_sdk/models/event_v3_request_entity.rb +34 -4
- data/lib/talon_one_sdk/models/history.rb +1 -13
- data/lib/talon_one_sdk/models/integration_event_v3_request.rb +30 -1
- data/lib/talon_one_sdk/models/integration_event_v3_response.rb +14 -4
- data/lib/talon_one_sdk/models/integration_hub_flow_response.rb +1 -28
- data/lib/talon_one_sdk/models/integration_unlock_reward_request.rb +225 -0
- data/lib/talon_one_sdk/models/ledger_transaction_log_entry_integration_api.rb +1 -1
- data/lib/talon_one_sdk/models/{catalog_action_one_of3.rb → list_achievements_v2200_response.rb} +27 -28
- data/lib/talon_one_sdk/models/loyalty_program_transaction.rb +1 -1
- data/lib/talon_one_sdk/models/mcpo_auth_session_info.rb +202 -0
- data/lib/talon_one_sdk/models/promotion_block.rb +6 -0
- data/lib/talon_one_sdk/models/redeem_loyalty_points_block.rb +312 -0
- data/lib/talon_one_sdk/models/redeem_loyalty_points_block1_program.rb +220 -0
- data/lib/talon_one_sdk/models/{strikethrough_effect_props.rb → redeem_loyalty_points_block1_value.rb} +4 -4
- data/lib/talon_one_sdk/models/reward_catalog_item.rb +252 -0
- data/lib/talon_one_sdk/models/{catalog_action_one_of2.rb → reward_eligibility.rb} +30 -28
- data/lib/talon_one_sdk/models/reward_eligibility_failure_details.rb +200 -0
- data/lib/talon_one_sdk/models/rollback_use_reward_effect_props.rb +220 -0
- data/lib/talon_one_sdk/models/ruleset_v2.rb +2 -2
- data/lib/talon_one_sdk/models/selector_group_block.rb +8 -6
- data/lib/talon_one_sdk/models/strikethrough_effect.rb +1 -1
- data/lib/talon_one_sdk/models/support_customer_profile.rb +275 -0
- data/lib/talon_one_sdk/models/template_parameter.rb +262 -0
- data/lib/talon_one_sdk/models/unlock_reward_effect_props.rb +274 -0
- data/lib/talon_one_sdk/models/use_reward_effect_props.rb +220 -0
- data/lib/talon_one_sdk/version.rb +1 -1
- data/lib/talon_one_sdk.rb +29 -9
- data/spec/api/integration_api_spec.rb +8 -8
- data/spec/api/management_api_spec.rb +78 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +12 -0
- data/spec/models/achievement_status_entry_spec.rb +6 -0
- data/spec/models/achievement_v2_spec.rb +12 -0
- data/spec/models/add_loyalty_points_support_spec.rb +90 -0
- data/spec/models/application_membership_spec.rb +42 -0
- data/spec/models/application_referee_spec.rb +6 -0
- data/spec/models/best_prior_price_spec.rb +0 -6
- data/spec/models/bundle_spec.rb +70 -0
- data/spec/models/{catalog_action_one_of_spec.rb → campaign_reference_spec.rb} +8 -8
- data/spec/models/catalog_action_add_price_adjustment_spec.rb +46 -0
- data/spec/models/{catalog_action_one_of2_spec.rb → catalog_action_add_spec.rb} +10 -6
- data/spec/models/catalog_action_patch_many_spec.rb +46 -0
- data/spec/models/{catalog_action_one_of4_spec.rb → catalog_action_patch_spec.rb} +10 -6
- data/spec/models/catalog_action_remove_many_spec.rb +46 -0
- data/spec/models/{catalog_action_one_of1_spec.rb → catalog_action_remove_spec.rb} +10 -6
- data/spec/models/catalog_action_spec.rb +12 -0
- data/spec/models/check_loyalty_card_block_spec.rb +64 -0
- data/spec/models/check_tier_block1_tier_spec.rb +54 -0
- data/spec/models/check_tier_block_spec.rb +76 -0
- data/spec/models/customer_achievement_spec.rb +18 -0
- data/spec/models/customer_inventory_spec.rb +6 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/customer_profile_reward_spec.rb +8 -2
- data/spec/models/customer_reward_spec.rb +60 -0
- data/spec/models/{effect_props_spec.rb → event_v3_referral_entity_spec.rb} +11 -7
- data/spec/models/event_v3_request_entity_spec.rb +6 -0
- data/spec/models/event_v3_spec.rb +6 -0
- data/spec/models/history_spec.rb +0 -6
- data/spec/models/integration_event_v2_request_spec.rb +1 -1
- data/spec/models/integration_event_v3_request_spec.rb +7 -1
- data/spec/models/integration_event_v3_response_spec.rb +6 -0
- data/spec/models/integration_hub_flow_response_spec.rb +0 -6
- data/spec/models/integration_request_spec.rb +1 -1
- data/spec/models/integration_unlock_reward_request_spec.rb +60 -0
- data/spec/models/list_achievements_v2200_response_spec.rb +42 -0
- data/spec/models/mcpo_auth_session_info_spec.rb +48 -0
- data/spec/models/redeem_loyalty_points_block1_program_spec.rb +48 -0
- data/spec/models/{effect_all_of_props_spec.rb → redeem_loyalty_points_block1_value_spec.rb} +2 -2
- data/spec/models/redeem_loyalty_points_block_spec.rb +78 -0
- data/spec/models/response_content_object_spec.rb +1 -1
- data/spec/models/reward_catalog_item_spec.rb +66 -0
- data/spec/models/reward_eligibility_failure_details_spec.rb +46 -0
- data/spec/models/{catalog_action_one_of3_spec.rb → reward_eligibility_spec.rb} +8 -8
- data/spec/models/rollback_use_reward_effect_props_spec.rb +48 -0
- data/spec/models/selector_group_block_spec.rb +4 -0
- data/spec/models/support_customer_profile_spec.rb +60 -0
- data/spec/models/template_parameter_spec.rb +72 -0
- data/spec/models/unlock_reward_effect_props_spec.rb +60 -0
- data/spec/models/use_reward_effect_props_spec.rb +48 -0
- metadata +117 -37
- data/docs/CatalogActionOneOf4.md +0 -20
- data/docs/CatalogActionOneOf5.md +0 -20
- data/docs/EffectAllOfProps.md +0 -117
- data/docs/EffectProps.md +0 -117
- data/docs/StrikethroughEffectProps.md +0 -51
- data/lib/talon_one_sdk/models/effect_all_of_props.rb +0 -138
- data/lib/talon_one_sdk/models/effect_props.rb +0 -139
- data/spec/models/catalog_action_one_of5_spec.rb +0 -42
- data/spec/models/strikethrough_effect_props_spec.rb +0 -32
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7c8d73c672e84463e81bae53708d3167685cabaed23c8883b51286f305f040a5
|
|
4
|
+
data.tar.gz: f74b734e35d6ddd605340d53471131687391ca3f8ef3a5c0cc7877024e86af1e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 152a25c869d5137ec160b31739e99d6faca63df8715d2f4c05684251a4e38eefe21332a779e2fede4c3d227a7aa71b45640f7987803f3b88d9c96595967dd7e1
|
|
7
|
+
data.tar.gz: 2d8c673668e378af8e62b5e7a792836c24c23812c696a786a46499745df734fb05764ae7aaaed61f3d73f0ff12457101def9fb54478e3270ef3ce7d4eaf0b1fd
|
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.17.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.17.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.17.0.gem` to install the development dependencies.
|
|
39
39
|
|
|
40
40
|
### RubyGems
|
|
41
41
|
|
|
@@ -225,6 +225,7 @@ Class | Method | HTTP request | Description
|
|
|
225
225
|
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
|
|
226
226
|
*TalonOne::ManagementApi* | [**create_account_collection**](docs/ManagementApi.md#create_account_collection) | **POST** /v1/collections | Create account-level collection
|
|
227
227
|
*TalonOne::ManagementApi* | [**create_achievement**](docs/ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
|
|
228
|
+
*TalonOne::ManagementApi* | [**create_achievement_v2**](docs/ManagementApi.md#create_achievement_v2) | **POST** /v2/achievements | Create achievement
|
|
228
229
|
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
|
|
229
230
|
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
|
230
231
|
*TalonOne::ManagementApi* | [**create_batch_loyalty_cards**](docs/ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
|
@@ -244,6 +245,7 @@ Class | Method | HTTP request | Description
|
|
|
244
245
|
*TalonOne::ManagementApi* | [**deduct_loyalty_card_points**](docs/ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
|
|
245
246
|
*TalonOne::ManagementApi* | [**delete_account_collection**](docs/ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
|
246
247
|
*TalonOne::ManagementApi* | [**delete_achievement**](docs/ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
|
248
|
+
*TalonOne::ManagementApi* | [**delete_achievement_v2**](docs/ManagementApi.md#delete_achievement_v2) | **DELETE** /v2/achievements/{achievementId} | Delete achievement
|
|
247
249
|
*TalonOne::ManagementApi* | [**delete_campaign**](docs/ManagementApi.md#delete_campaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
|
|
248
250
|
*TalonOne::ManagementApi* | [**delete_campaign_store_budgets**](docs/ManagementApi.md#delete_campaign_store_budgets) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
|
|
249
251
|
*TalonOne::ManagementApi* | [**delete_collection**](docs/ManagementApi.md#delete_collection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection
|
|
@@ -258,6 +260,7 @@ Class | Method | HTTP request | Description
|
|
|
258
260
|
*TalonOne::ManagementApi* | [**disconnect_campaign_stores**](docs/ManagementApi.md#disconnect_campaign_stores) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
|
|
259
261
|
*TalonOne::ManagementApi* | [**exclude_price_history**](docs/ManagementApi.md#exclude_price_history) | **POST** /v1/applications/{applicationId}/price_history/exclusions | Exclude price records from price history
|
|
260
262
|
*TalonOne::ManagementApi* | [**export_account_collection_items**](docs/ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
|
263
|
+
*TalonOne::ManagementApi* | [**export_achievement_v2**](docs/ManagementApi.md#export_achievement_v2) | **GET** /v2/achievements/{achievementId}/export | Export achievement customer data
|
|
261
264
|
*TalonOne::ManagementApi* | [**export_achievements**](docs/ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
|
262
265
|
*TalonOne::ManagementApi* | [**export_application_campaign_analytics**](docs/ManagementApi.md#export_application_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaign_analytics/export | Export Application analytics aggregated by campaign
|
|
263
266
|
*TalonOne::ManagementApi* | [**export_audiences_memberships**](docs/ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
|
@@ -284,6 +287,7 @@ Class | Method | HTTP request | Description
|
|
|
284
287
|
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get account analytics
|
|
285
288
|
*TalonOne::ManagementApi* | [**get_account_collection**](docs/ManagementApi.md#get_account_collection) | **GET** /v1/collections/{collectionId} | Get account-level collection
|
|
286
289
|
*TalonOne::ManagementApi* | [**get_achievement**](docs/ManagementApi.md#get_achievement) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement
|
|
290
|
+
*TalonOne::ManagementApi* | [**get_achievement_v2**](docs/ManagementApi.md#get_achievement_v2) | **GET** /v2/achievements/{achievementId} | Get achievement
|
|
287
291
|
*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
|
|
288
292
|
*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
|
289
293
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
|
@@ -363,6 +367,7 @@ Class | Method | HTTP request | Description
|
|
|
363
367
|
*TalonOne::ManagementApi* | [**invite_user_external**](docs/ManagementApi.md#invite_user_external) | **POST** /v1/users/invite | Invite user from identity provider
|
|
364
368
|
*TalonOne::ManagementApi* | [**list_account_collections**](docs/ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
|
365
369
|
*TalonOne::ManagementApi* | [**list_achievements**](docs/ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
|
370
|
+
*TalonOne::ManagementApi* | [**list_achievements_v2**](docs/ManagementApi.md#list_achievements_v2) | **GET** /v2/achievements | List achievements
|
|
366
371
|
*TalonOne::ManagementApi* | [**list_all_roles_v2**](docs/ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
|
367
372
|
*TalonOne::ManagementApi* | [**list_application_cart_item_filters**](docs/ManagementApi.md#list_application_cart_item_filters) | **GET** /v1/applications/{applicationId}/cart_item_filters | List Application cart item filters
|
|
368
373
|
*TalonOne::ManagementApi* | [**list_campaign_store_budget_limits**](docs/ManagementApi.md#list_campaign_store_budget_limits) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
|
|
@@ -396,6 +401,7 @@ Class | Method | HTTP request | Description
|
|
|
396
401
|
*TalonOne::ManagementApi* | [**transfer_loyalty_card**](docs/ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
|
397
402
|
*TalonOne::ManagementApi* | [**update_account_collection**](docs/ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
|
398
403
|
*TalonOne::ManagementApi* | [**update_achievement**](docs/ManagementApi.md#update_achievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
|
|
404
|
+
*TalonOne::ManagementApi* | [**update_achievement_v2**](docs/ManagementApi.md#update_achievement_v2) | **PUT** /v2/achievements/{achievementId} | Update achievement
|
|
399
405
|
*TalonOne::ManagementApi* | [**update_additional_cost**](docs/ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update additional cost
|
|
400
406
|
*TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update custom attribute
|
|
401
407
|
*TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign
|
|
@@ -442,6 +448,7 @@ Class | Method | HTTP request | Description
|
|
|
442
448
|
- [TalonOne::AddItemCatalogAction](docs/AddItemCatalogAction.md)
|
|
443
449
|
- [TalonOne::AddLoyaltyPoints](docs/AddLoyaltyPoints.md)
|
|
444
450
|
- [TalonOne::AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md)
|
|
451
|
+
- [TalonOne::AddLoyaltyPointsSupport](docs/AddLoyaltyPointsSupport.md)
|
|
445
452
|
- [TalonOne::AddPriceAdjustmentCatalogAction](docs/AddPriceAdjustmentCatalogAction.md)
|
|
446
453
|
- [TalonOne::AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md)
|
|
447
454
|
- [TalonOne::AddedDeductedPointsBalancesAction](docs/AddedDeductedPointsBalancesAction.md)
|
|
@@ -472,6 +479,7 @@ Class | Method | HTTP request | Description
|
|
|
472
479
|
- [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md)
|
|
473
480
|
- [TalonOne::ApplicationEntity](docs/ApplicationEntity.md)
|
|
474
481
|
- [TalonOne::ApplicationEvent](docs/ApplicationEvent.md)
|
|
482
|
+
- [TalonOne::ApplicationMembership](docs/ApplicationMembership.md)
|
|
475
483
|
- [TalonOne::ApplicationReferee](docs/ApplicationReferee.md)
|
|
476
484
|
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
|
|
477
485
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
|
@@ -524,6 +532,7 @@ Class | Method | HTTP request | Description
|
|
|
524
532
|
- [TalonOne::Blueprint](docs/Blueprint.md)
|
|
525
533
|
- [TalonOne::BulkApplicationNotification](docs/BulkApplicationNotification.md)
|
|
526
534
|
- [TalonOne::BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md)
|
|
535
|
+
- [TalonOne::Bundle](docs/Bundle.md)
|
|
527
536
|
- [TalonOne::Campaign](docs/Campaign.md)
|
|
528
537
|
- [TalonOne::CampaignActivationRequest](docs/CampaignActivationRequest.md)
|
|
529
538
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
|
@@ -557,6 +566,7 @@ Class | Method | HTTP request | Description
|
|
|
557
566
|
- [TalonOne::CampaignNotificationGeneric](docs/CampaignNotificationGeneric.md)
|
|
558
567
|
- [TalonOne::CampaignNotificationItemBase](docs/CampaignNotificationItemBase.md)
|
|
559
568
|
- [TalonOne::CampaignNotificationPolicy](docs/CampaignNotificationPolicy.md)
|
|
569
|
+
- [TalonOne::CampaignReference](docs/CampaignReference.md)
|
|
560
570
|
- [TalonOne::CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md)
|
|
561
571
|
- [TalonOne::CampaignRulesetChangedNotificationItem](docs/CampaignRulesetChangedNotificationItem.md)
|
|
562
572
|
- [TalonOne::CampaignSearch](docs/CampaignSearch.md)
|
|
@@ -586,13 +596,13 @@ Class | Method | HTTP request | Description
|
|
|
586
596
|
- [TalonOne::CartItemFilterTemplate](docs/CartItemFilterTemplate.md)
|
|
587
597
|
- [TalonOne::Catalog](docs/Catalog.md)
|
|
588
598
|
- [TalonOne::CatalogAction](docs/CatalogAction.md)
|
|
599
|
+
- [TalonOne::CatalogActionAdd](docs/CatalogActionAdd.md)
|
|
600
|
+
- [TalonOne::CatalogActionAddPriceAdjustment](docs/CatalogActionAddPriceAdjustment.md)
|
|
589
601
|
- [TalonOne::CatalogActionFilter](docs/CatalogActionFilter.md)
|
|
590
|
-
- [TalonOne::
|
|
591
|
-
- [TalonOne::
|
|
592
|
-
- [TalonOne::
|
|
593
|
-
- [TalonOne::
|
|
594
|
-
- [TalonOne::CatalogActionOneOf4](docs/CatalogActionOneOf4.md)
|
|
595
|
-
- [TalonOne::CatalogActionOneOf5](docs/CatalogActionOneOf5.md)
|
|
602
|
+
- [TalonOne::CatalogActionPatch](docs/CatalogActionPatch.md)
|
|
603
|
+
- [TalonOne::CatalogActionPatchMany](docs/CatalogActionPatchMany.md)
|
|
604
|
+
- [TalonOne::CatalogActionRemove](docs/CatalogActionRemove.md)
|
|
605
|
+
- [TalonOne::CatalogActionRemoveMany](docs/CatalogActionRemoveMany.md)
|
|
596
606
|
- [TalonOne::CatalogItem](docs/CatalogItem.md)
|
|
597
607
|
- [TalonOne::CatalogRule](docs/CatalogRule.md)
|
|
598
608
|
- [TalonOne::CatalogSyncRequest](docs/CatalogSyncRequest.md)
|
|
@@ -611,7 +621,10 @@ Class | Method | HTTP request | Description
|
|
|
611
621
|
- [TalonOne::CheckEventBlock](docs/CheckEventBlock.md)
|
|
612
622
|
- [TalonOne::CheckLoyaltyBalanceBlock](docs/CheckLoyaltyBalanceBlock.md)
|
|
613
623
|
- [TalonOne::CheckLoyaltyBalanceBlock1Program](docs/CheckLoyaltyBalanceBlock1Program.md)
|
|
624
|
+
- [TalonOne::CheckLoyaltyCardBlock](docs/CheckLoyaltyCardBlock.md)
|
|
614
625
|
- [TalonOne::CheckReferralBlock](docs/CheckReferralBlock.md)
|
|
626
|
+
- [TalonOne::CheckTierBlock](docs/CheckTierBlock.md)
|
|
627
|
+
- [TalonOne::CheckTierBlock1Tier](docs/CheckTierBlock1Tier.md)
|
|
615
628
|
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
|
|
616
629
|
- [TalonOne::Collection](docs/Collection.md)
|
|
617
630
|
- [TalonOne::CollectionItem](docs/CollectionItem.md)
|
|
@@ -665,6 +678,7 @@ Class | Method | HTTP request | Description
|
|
|
665
678
|
- [TalonOne::CustomerProfileReward](docs/CustomerProfileReward.md)
|
|
666
679
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
|
667
680
|
- [TalonOne::CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md)
|
|
681
|
+
- [TalonOne::CustomerReward](docs/CustomerReward.md)
|
|
668
682
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
|
669
683
|
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
|
670
684
|
- [TalonOne::DeactivateUserRequest](docs/DeactivateUserRequest.md)
|
|
@@ -676,9 +690,7 @@ Class | Method | HTTP request | Description
|
|
|
676
690
|
- [TalonOne::DigitalPass](docs/DigitalPass.md)
|
|
677
691
|
- [TalonOne::DiscardRisksRequest](docs/DiscardRisksRequest.md)
|
|
678
692
|
- [TalonOne::Effect](docs/Effect.md)
|
|
679
|
-
- [TalonOne::EffectAllOfProps](docs/EffectAllOfProps.md)
|
|
680
693
|
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
|
681
|
-
- [TalonOne::EffectProps](docs/EffectProps.md)
|
|
682
694
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
|
683
695
|
- [TalonOne::EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
|
|
684
696
|
- [TalonOne::EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
|
|
@@ -699,6 +711,7 @@ Class | Method | HTTP request | Description
|
|
|
699
711
|
- [TalonOne::EventV3](docs/EventV3.md)
|
|
700
712
|
- [TalonOne::EventV3Connections](docs/EventV3Connections.md)
|
|
701
713
|
- [TalonOne::EventV3Entity](docs/EventV3Entity.md)
|
|
714
|
+
- [TalonOne::EventV3ReferralEntity](docs/EventV3ReferralEntity.md)
|
|
702
715
|
- [TalonOne::EventV3RequestEntity](docs/EventV3RequestEntity.md)
|
|
703
716
|
- [TalonOne::ExcludePriceObservationsRequest](docs/ExcludePriceObservationsRequest.md)
|
|
704
717
|
- [TalonOne::Experiment](docs/Experiment.md)
|
|
@@ -845,6 +858,7 @@ Class | Method | HTTP request | Description
|
|
|
845
858
|
- [TalonOne::IntegrationState](docs/IntegrationState.md)
|
|
846
859
|
- [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md)
|
|
847
860
|
- [TalonOne::IntegrationStoreEntity](docs/IntegrationStoreEntity.md)
|
|
861
|
+
- [TalonOne::IntegrationUnlockRewardRequest](docs/IntegrationUnlockRewardRequest.md)
|
|
848
862
|
- [TalonOne::InventoryCoupon](docs/InventoryCoupon.md)
|
|
849
863
|
- [TalonOne::InventoryReferral](docs/InventoryReferral.md)
|
|
850
864
|
- [TalonOne::ItemAttribute](docs/ItemAttribute.md)
|
|
@@ -860,6 +874,7 @@ Class | Method | HTTP request | Description
|
|
|
860
874
|
- [TalonOne::LimitCounter](docs/LimitCounter.md)
|
|
861
875
|
- [TalonOne::ListAccountCollections200Response](docs/ListAccountCollections200Response.md)
|
|
862
876
|
- [TalonOne::ListAchievements200Response](docs/ListAchievements200Response.md)
|
|
877
|
+
- [TalonOne::ListAchievementsV2200Response](docs/ListAchievementsV2200Response.md)
|
|
863
878
|
- [TalonOne::ListAllRolesV2200Response](docs/ListAllRolesV2200Response.md)
|
|
864
879
|
- [TalonOne::ListApplicationCartItemFilters200Response](docs/ListApplicationCartItemFilters200Response.md)
|
|
865
880
|
- [TalonOne::ListCampaignStoreBudgetLimits200Response](docs/ListCampaignStoreBudgetLimits200Response.md)
|
|
@@ -903,6 +918,7 @@ Class | Method | HTTP request | Description
|
|
|
903
918
|
- [TalonOne::MCPOAuthCompleteResult](docs/MCPOAuthCompleteResult.md)
|
|
904
919
|
- [TalonOne::MCPOAuthProtectedResource](docs/MCPOAuthProtectedResource.md)
|
|
905
920
|
- [TalonOne::MCPOAuthServerMetadata](docs/MCPOAuthServerMetadata.md)
|
|
921
|
+
- [TalonOne::MCPOAuthSessionInfo](docs/MCPOAuthSessionInfo.md)
|
|
906
922
|
- [TalonOne::MCPOAuthToken](docs/MCPOAuthToken.md)
|
|
907
923
|
- [TalonOne::MCPOAuthTokenError](docs/MCPOAuthTokenError.md)
|
|
908
924
|
- [TalonOne::MCPOAuthTokenRequest](docs/MCPOAuthTokenRequest.md)
|
|
@@ -1042,6 +1058,9 @@ Class | Method | HTTP request | Description
|
|
|
1042
1058
|
- [TalonOne::PromotionCheckAttributeBlock](docs/PromotionCheckAttributeBlock.md)
|
|
1043
1059
|
- [TalonOne::PromotionGroupBlock](docs/PromotionGroupBlock.md)
|
|
1044
1060
|
- [TalonOne::PromotionRuleV2](docs/PromotionRuleV2.md)
|
|
1061
|
+
- [TalonOne::RedeemLoyaltyPointsBlock](docs/RedeemLoyaltyPointsBlock.md)
|
|
1062
|
+
- [TalonOne::RedeemLoyaltyPointsBlock1Program](docs/RedeemLoyaltyPointsBlock1Program.md)
|
|
1063
|
+
- [TalonOne::RedeemLoyaltyPointsBlock1Value](docs/RedeemLoyaltyPointsBlock1Value.md)
|
|
1045
1064
|
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
|
1046
1065
|
- [TalonOne::ReduceSelectorStep](docs/ReduceSelectorStep.md)
|
|
1047
1066
|
- [TalonOne::Referral](docs/Referral.md)
|
|
@@ -1066,6 +1085,9 @@ Class | Method | HTTP request | Description
|
|
|
1066
1085
|
- [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
|
|
1067
1086
|
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
|
1068
1087
|
- [TalonOne::Reward](docs/Reward.md)
|
|
1088
|
+
- [TalonOne::RewardCatalogItem](docs/RewardCatalogItem.md)
|
|
1089
|
+
- [TalonOne::RewardEligibility](docs/RewardEligibility.md)
|
|
1090
|
+
- [TalonOne::RewardEligibilityFailureDetails](docs/RewardEligibilityFailureDetails.md)
|
|
1069
1091
|
- [TalonOne::RewardPointsRequired](docs/RewardPointsRequired.md)
|
|
1070
1092
|
- [TalonOne::Risk](docs/Risk.md)
|
|
1071
1093
|
- [TalonOne::RiskAffectedEntityItem](docs/RiskAffectedEntityItem.md)
|
|
@@ -1089,6 +1111,7 @@ Class | Method | HTTP request | Description
|
|
|
1089
1111
|
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
1090
1112
|
- [TalonOne::RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md)
|
|
1091
1113
|
- [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
|
|
1114
|
+
- [TalonOne::RollbackUseRewardEffectProps](docs/RollbackUseRewardEffectProps.md)
|
|
1092
1115
|
- [TalonOne::Rule](docs/Rule.md)
|
|
1093
1116
|
- [TalonOne::RuleEligibility](docs/RuleEligibility.md)
|
|
1094
1117
|
- [TalonOne::RuleEligibilityFailureDetails](docs/RuleEligibilityFailureDetails.md)
|
|
@@ -1155,7 +1178,6 @@ Class | Method | HTTP request | Description
|
|
|
1155
1178
|
- [TalonOne::StrikethroughCustomEffectPerItemProps](docs/StrikethroughCustomEffectPerItemProps.md)
|
|
1156
1179
|
- [TalonOne::StrikethroughDebugResponse](docs/StrikethroughDebugResponse.md)
|
|
1157
1180
|
- [TalonOne::StrikethroughEffect](docs/StrikethroughEffect.md)
|
|
1158
|
-
- [TalonOne::StrikethroughEffectProps](docs/StrikethroughEffectProps.md)
|
|
1159
1181
|
- [TalonOne::StrikethroughGroupBlock](docs/StrikethroughGroupBlock.md)
|
|
1160
1182
|
- [TalonOne::StrikethroughLabelingNotification](docs/StrikethroughLabelingNotification.md)
|
|
1161
1183
|
- [TalonOne::StrikethroughRuleV2](docs/StrikethroughRuleV2.md)
|
|
@@ -1164,6 +1186,7 @@ Class | Method | HTTP request | Description
|
|
|
1164
1186
|
- [TalonOne::StrikethroughTrigger](docs/StrikethroughTrigger.md)
|
|
1165
1187
|
- [TalonOne::SummarizeCampaignStoreBudget200Response](docs/SummarizeCampaignStoreBudget200Response.md)
|
|
1166
1188
|
- [TalonOne::SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.md)
|
|
1189
|
+
- [TalonOne::SupportCustomerProfile](docs/SupportCustomerProfile.md)
|
|
1167
1190
|
- [TalonOne::SupportRequest](docs/SupportRequest.md)
|
|
1168
1191
|
- [TalonOne::SupportRequestInput](docs/SupportRequestInput.md)
|
|
1169
1192
|
- [TalonOne::TalangAttribute](docs/TalangAttribute.md)
|
|
@@ -1171,6 +1194,7 @@ Class | Method | HTTP request | Description
|
|
|
1171
1194
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
|
1172
1195
|
- [TalonOne::TemplateDef](docs/TemplateDef.md)
|
|
1173
1196
|
- [TalonOne::TemplateLimitConfig](docs/TemplateLimitConfig.md)
|
|
1197
|
+
- [TalonOne::TemplateParameter](docs/TemplateParameter.md)
|
|
1174
1198
|
- [TalonOne::Tier](docs/Tier.md)
|
|
1175
1199
|
- [TalonOne::TierDowngradeData](docs/TierDowngradeData.md)
|
|
1176
1200
|
- [TalonOne::TierDowngradeNotification](docs/TierDowngradeNotification.md)
|
|
@@ -1192,6 +1216,7 @@ Class | Method | HTTP request | Description
|
|
|
1192
1216
|
- [TalonOne::TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md)
|
|
1193
1217
|
- [TalonOne::TwoFAConfig](docs/TwoFAConfig.md)
|
|
1194
1218
|
- [TalonOne::UnaryCheckAttributeBlock](docs/UnaryCheckAttributeBlock.md)
|
|
1219
|
+
- [TalonOne::UnlockRewardEffectProps](docs/UnlockRewardEffectProps.md)
|
|
1195
1220
|
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
|
|
1196
1221
|
- [TalonOne::UpdateAchievement](docs/UpdateAchievement.md)
|
|
1197
1222
|
- [TalonOne::UpdateAchievementProgressBlock](docs/UpdateAchievementProgressBlock.md)
|
|
@@ -1239,6 +1264,7 @@ Class | Method | HTTP request | Description
|
|
|
1239
1264
|
- [TalonOne::UpdateStore](docs/UpdateStore.md)
|
|
1240
1265
|
- [TalonOne::UpdateSupportRequest](docs/UpdateSupportRequest.md)
|
|
1241
1266
|
- [TalonOne::UpdateUser](docs/UpdateUser.md)
|
|
1267
|
+
- [TalonOne::UseRewardEffectProps](docs/UseRewardEffectProps.md)
|
|
1242
1268
|
- [TalonOne::User](docs/User.md)
|
|
1243
1269
|
- [TalonOne::UserEntity](docs/UserEntity.md)
|
|
1244
1270
|
- [TalonOne::ValueMap](docs/ValueMap.md)
|
|
@@ -13,7 +13,9 @@
|
|
|
13
13
|
| **name** | **String** | The internal name of the achievement used in API requests. | |
|
|
14
14
|
| **title** | **String** | The display name of the achievement in the Campaign Manager. | |
|
|
15
15
|
| **description** | **String** | The description of the achievement in the Campaign Manager. | |
|
|
16
|
-
| **campaign_id** | **Integer** | The ID
|
|
16
|
+
| **campaign_id** | **Integer** | This property is **deprecated**. Use `campaignIds` (Integration API) or `referencedByCampaigns` (Management API) instead. The first campaign ID in `campaignIds`. Only returned when `campaignIds` is not empty. | |
|
|
17
|
+
| **campaign_ids** | **Array<Integer>** | The IDs of the campaigns that reference this achievement, in ascending order. | |
|
|
18
|
+
| **referenced_by_campaigns** | [**Array<CampaignReference>**](CampaignReference.md) | The campaigns that reference this achievement, in ascending order of their `id`. | |
|
|
17
19
|
| **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] |
|
|
18
20
|
| **achievement_recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | |
|
|
19
21
|
| **achievement_activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | |
|
|
@@ -37,6 +39,8 @@ instance = TalonOne::AchievementProgressWithDefinition.new(
|
|
|
37
39
|
title: 50% off on 50th purchase.,
|
|
38
40
|
description: 50% off for every 50th purchase in a year.,
|
|
39
41
|
campaign_id: 3,
|
|
42
|
+
campaign_ids: [1, 14, 27],
|
|
43
|
+
referenced_by_campaigns: null,
|
|
40
44
|
target: 10,
|
|
41
45
|
achievement_recurrence_policy: no_recurrence,
|
|
42
46
|
achievement_activation_policy: fixed_schedule,
|
|
@@ -17,7 +17,8 @@
|
|
|
17
17
|
| **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] |
|
|
18
18
|
| **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] |
|
|
19
19
|
| **allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
|
|
20
|
-
| **campaign_id** | **Integer** | The ID
|
|
20
|
+
| **campaign_id** | **Integer** | This property is **deprecated**. Use `campaignIds` instead. The first campaign ID in `campaignIds`. Only returned when `campaignIds` is not empty. | [optional] |
|
|
21
|
+
| **campaign_ids** | **Array<Integer>** | The IDs of the campaigns that reference this achievement, in ascending order. | |
|
|
21
22
|
| **status** | **String** | The status of the achievement. | [optional] |
|
|
22
23
|
| **current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional] |
|
|
23
24
|
|
|
@@ -41,6 +42,7 @@ instance = TalonOne::AchievementStatusEntry.new(
|
|
|
41
42
|
end_date: 2024-02-15T15:04:05Z07:00,
|
|
42
43
|
allow_rollback_after_completion: false,
|
|
43
44
|
campaign_id: 1,
|
|
45
|
+
campaign_ids: [1, 14, 27],
|
|
44
46
|
status: active,
|
|
45
47
|
current_progress: null
|
|
46
48
|
)
|
data/docs/AchievementV2.md
CHANGED
|
@@ -6,17 +6,17 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **Integer** | The internal ID of this entity. | |
|
|
8
8
|
| **created** | **Time** | The time this entity was created. | |
|
|
9
|
-
| **name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
|
|
10
|
-
| **title** | **String** | The display name for the achievement in the Campaign Manager. |
|
|
11
|
-
| **description** | **String** | A description of the achievement. |
|
|
12
|
-
| **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
|
|
9
|
+
| **name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | [optional] |
|
|
10
|
+
| **title** | **String** | The display name for the achievement in the Campaign Manager. | [optional] |
|
|
11
|
+
| **description** | **String** | A description of the achievement. | [optional] |
|
|
12
|
+
| **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] |
|
|
13
13
|
| **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional] |
|
|
14
|
-
| **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
|
|
15
|
-
| **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
|
|
14
|
+
| **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional] |
|
|
15
|
+
| **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] |
|
|
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
|
-
| **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. |
|
|
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. | [optional] |
|
|
20
20
|
| **user_id** | **Integer** | The ID of the user that created this achievement. | |
|
|
21
21
|
| **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional] |
|
|
22
22
|
| **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional] |
|
|
@@ -24,6 +24,8 @@
|
|
|
24
24
|
| **status** | **String** | The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. | [optional] |
|
|
25
25
|
| **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. | |
|
|
26
26
|
| **timezone** | **String** | A string containing an IANA timezone descriptor. | |
|
|
27
|
+
| **campaign_id** | **Integer** | This property is **deprecated**. Use `referencedByCampaigns` instead. The ID of the first campaign in `referencedByCampaigns`. Only returned when `referencedByCampaigns` is not empty. | [optional] |
|
|
28
|
+
| **referenced_by_campaigns** | [**Array<CampaignReference>**](CampaignReference.md) | The campaigns that reference this achievement. They are sorted in ascending order by their id. | |
|
|
27
29
|
|
|
28
30
|
## Example
|
|
29
31
|
|
|
@@ -50,7 +52,9 @@ instance = TalonOne::AchievementV2.new(
|
|
|
50
52
|
has_progress: null,
|
|
51
53
|
status: active,
|
|
52
54
|
sandbox: true,
|
|
53
|
-
timezone: Europe/Berlin
|
|
55
|
+
timezone: Europe/Berlin,
|
|
56
|
+
campaign_id: 3,
|
|
57
|
+
referenced_by_campaigns: null
|
|
54
58
|
)
|
|
55
59
|
```
|
|
56
60
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# TalonOne::AddLoyaltyPointsSupport
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **points** | **Float** | Amount of loyalty points. | |
|
|
8
|
+
| **name** | **String** | Name / reason for the point addition. | [optional] |
|
|
9
|
+
| **validity_duration** | **String** | The time format is either: - `unlimited` or, - an **integer** followed by one letter indicating the time unit. Examples: `unlimited`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted. | [optional] |
|
|
10
|
+
| **valid_until** | **Time** | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional] |
|
|
11
|
+
| **pending_duration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - `on_action` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`, `on_action`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] |
|
|
12
|
+
| **pending_until** | **Time** | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional] |
|
|
13
|
+
| **subledger_id** | **String** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional] |
|
|
14
|
+
| **application_id** | **Integer** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional] |
|
|
15
|
+
| **support_request_id** | **Integer** | ID of the support request to approve. When provided by an admin, the points are added on behalf of the support user who created the request. | [optional] |
|
|
16
|
+
| **processing_note** | **String** | Note from the admin approving the support request. Stored as the processing note on the support request record. This is only used when a supportRequestId is passed. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'talon_one_sdk'
|
|
22
|
+
|
|
23
|
+
instance = TalonOne::AddLoyaltyPointsSupport.new(
|
|
24
|
+
points: 300,
|
|
25
|
+
name: Compensation,
|
|
26
|
+
validity_duration: 5D,
|
|
27
|
+
valid_until: 2021-07-20T22:00:00Z,
|
|
28
|
+
pending_duration: 12h,
|
|
29
|
+
pending_until: 2021-07-20T22:00:00Z,
|
|
30
|
+
subledger_id: sub-123,
|
|
31
|
+
application_id: 322,
|
|
32
|
+
support_request_id: 42,
|
|
33
|
+
processing_note: Approved after manual review.
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TalonOne::ApplicationMembership
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **application_id** | **Integer** | The ID of the Application the customer belongs to. | |
|
|
8
|
+
| **application_name** | **String** | The name of the Application the customer belongs to. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'talon_one_sdk'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::ApplicationMembership.new(
|
|
16
|
+
application_id: 1,
|
|
17
|
+
application_name: My Application
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/ApplicationReferee.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **application_id** | **Integer** | The ID of the Application that owns this entity. | |
|
|
8
8
|
| **session_id** | **String** | Integration ID of the session in which the customer redeemed the referral. | |
|
|
9
|
+
| **advanced_event_integration_id** | **String** | The unique ID of the advanced event in which the customer redeemed the referral. Omitted when the referral was redeemed through a customer session rather than an advanced event. | [optional] |
|
|
9
10
|
| **advocate_integration_id** | **String** | Integration ID of the Advocate's Profile. | |
|
|
10
11
|
| **friend_integration_id** | **String** | Integration ID of the Friend's Profile. | |
|
|
11
12
|
| **code** | **String** | Advocate's referral code. | |
|
|
@@ -19,6 +20,7 @@ require 'talon_one_sdk'
|
|
|
19
20
|
instance = TalonOne::ApplicationReferee.new(
|
|
20
21
|
application_id: 322,
|
|
21
22
|
session_id: null,
|
|
23
|
+
advanced_event_integration_id: advanced_event_1234,
|
|
22
24
|
advocate_integration_id: null,
|
|
23
25
|
friend_integration_id: null,
|
|
24
26
|
code: null,
|
data/docs/BestPriorPrice.md
CHANGED
|
@@ -8,7 +8,6 @@
|
|
|
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 ''] |
|
|
12
11
|
| **price** | **Float** | Price of the item. | |
|
|
13
12
|
| **metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | | |
|
|
14
13
|
| **target** | [**LabelTarget**](LabelTarget.md) | | |
|
|
@@ -23,7 +22,6 @@ instance = TalonOne::BestPriorPrice.new(
|
|
|
23
22
|
sku: SKU7345278,
|
|
24
23
|
observed_at: 2025-11-10T23:00:00Z,
|
|
25
24
|
context_ids: [SpringSale, SummerSale2025],
|
|
26
|
-
context_id: ,
|
|
27
25
|
price: 99.99,
|
|
28
26
|
metadata: null,
|
|
29
27
|
target: null
|
data/docs/Bundle.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# TalonOne::Bundle
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | An identifier derived from the bundle content. | |
|
|
8
|
+
| **name** | **String** | The name of the bundle. | |
|
|
9
|
+
| **type** | **String** | A binding of type `bundle`. | |
|
|
10
|
+
| **sources** | **Array<String>** | The selector sources of bundle items. Each source is expressed as a `{{$selectorName}}` reference. | |
|
|
11
|
+
| **counts** | **Array<Integer>** | The number of items to retrieve from each corresponding source in `sources`. | |
|
|
12
|
+
| **matchers** | **Array<String>** | Attribute names that the bundled items must share. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'talon_one_sdk'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::Bundle.new(
|
|
20
|
+
id: 1b671a64-40d5-491e-99b0-da01ff1f3341,
|
|
21
|
+
name: meal_deal,
|
|
22
|
+
type: bundle,
|
|
23
|
+
sources: [{{$mains}}, {{$drinks}}],
|
|
24
|
+
counts: [1, 2],
|
|
25
|
+
matchers: [color]
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TalonOne::CampaignReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | The ID of the campaign that references this achievement. | |
|
|
8
|
+
| **application_id** | **Integer** | The ID of the Application the campaign belongs to. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'talon_one_sdk'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::CampaignReference.new(
|
|
16
|
+
id: 1,
|
|
17
|
+
application_id: 2
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
| **id** | **Integer** | ID of the loyalty ledger transaction. | |
|
|
19
19
|
| **ruleset_id** | **Integer** | The ID of the ruleset containing the rule that triggered this effect. | [optional] |
|
|
20
20
|
| **rule_name** | **String** | The name of the rule that triggered this effect. | [optional] |
|
|
21
|
-
| **validity_duration** | **String** | The duration for which the points remain active, relative to the
|
|
21
|
+
| **validity_duration** | **String** | The duration for which the points remain active, relative to the activation date. **Note**: This only applies to points for which `awaitsActivation` is `true` and `expiryDate` is not set. | [optional] |
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
data/docs/CatalogAction.md
CHANGED
|
@@ -14,15 +14,49 @@ require 'talon_one_sdk'
|
|
|
14
14
|
TalonOne::CatalogAction.openapi_one_of
|
|
15
15
|
# =>
|
|
16
16
|
# [
|
|
17
|
-
# :'
|
|
18
|
-
# :'
|
|
19
|
-
# :'
|
|
20
|
-
# :'
|
|
21
|
-
# :'
|
|
22
|
-
# :'
|
|
17
|
+
# :'CatalogActionAdd',
|
|
18
|
+
# :'CatalogActionAddPriceAdjustment',
|
|
19
|
+
# :'CatalogActionPatch',
|
|
20
|
+
# :'CatalogActionPatchMany',
|
|
21
|
+
# :'CatalogActionRemove',
|
|
22
|
+
# :'CatalogActionRemoveMany'
|
|
23
23
|
# ]
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
+
### `openapi_discriminator_name`
|
|
27
|
+
|
|
28
|
+
Returns the discriminator's property name.
|
|
29
|
+
|
|
30
|
+
#### Example
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'talon_one_sdk'
|
|
34
|
+
|
|
35
|
+
TalonOne::CatalogAction.openapi_discriminator_name
|
|
36
|
+
# => :'type'
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `openapi_discriminator_name`
|
|
40
|
+
|
|
41
|
+
Returns the discriminator's mapping.
|
|
42
|
+
|
|
43
|
+
#### Example
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
require 'talon_one_sdk'
|
|
47
|
+
|
|
48
|
+
TalonOne::CatalogAction.openapi_discriminator_mapping
|
|
49
|
+
# =>
|
|
50
|
+
# {
|
|
51
|
+
# :'ADD' => :'CatalogActionAdd',
|
|
52
|
+
# :'ADD_PRICE_ADJUSTMENT' => :'CatalogActionAddPriceAdjustment',
|
|
53
|
+
# :'PATCH' => :'CatalogActionPatch',
|
|
54
|
+
# :'PATCH_MANY' => :'CatalogActionPatchMany',
|
|
55
|
+
# :'REMOVE' => :'CatalogActionRemove',
|
|
56
|
+
# :'REMOVE_MANY' => :'CatalogActionRemoveMany'
|
|
57
|
+
# }
|
|
58
|
+
```
|
|
59
|
+
|
|
26
60
|
### build
|
|
27
61
|
|
|
28
62
|
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
@@ -33,7 +67,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
|
|
|
33
67
|
require 'talon_one_sdk'
|
|
34
68
|
|
|
35
69
|
TalonOne::CatalogAction.build(data)
|
|
36
|
-
# => #<
|
|
70
|
+
# => #<CatalogActionAdd:0x00007fdd4aab02a0>
|
|
37
71
|
|
|
38
72
|
TalonOne::CatalogAction.build(data_that_doesnt_match)
|
|
39
73
|
# => nil
|
|
@@ -47,11 +81,11 @@ TalonOne::CatalogAction.build(data_that_doesnt_match)
|
|
|
47
81
|
|
|
48
82
|
#### Return type
|
|
49
83
|
|
|
50
|
-
- `
|
|
51
|
-
- `
|
|
52
|
-
- `
|
|
53
|
-
- `
|
|
54
|
-
- `
|
|
55
|
-
- `
|
|
84
|
+
- `CatalogActionAdd`
|
|
85
|
+
- `CatalogActionAddPriceAdjustment`
|
|
86
|
+
- `CatalogActionPatch`
|
|
87
|
+
- `CatalogActionPatchMany`
|
|
88
|
+
- `CatalogActionRemove`
|
|
89
|
+
- `CatalogActionRemoveMany`
|
|
56
90
|
- `nil` (if no type matches)
|
|
57
91
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# TalonOne::
|
|
1
|
+
# TalonOne::CatalogActionAdd
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **
|
|
7
|
+
| **type** | **String** | A catalog sync action discriminator of type `ADD`. | |
|
|
8
8
|
| **payload** | [**AddItemCatalogAction**](AddItemCatalogAction.md) | The payload of sync action. | |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'talon_one_sdk'
|
|
14
14
|
|
|
15
|
-
instance = TalonOne::
|
|
15
|
+
instance = TalonOne::CatalogActionAdd.new(
|
|
16
16
|
type: null,
|
|
17
17
|
payload: null
|
|
18
18
|
)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TalonOne::CatalogActionAddPriceAdjustment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | A catalog sync action discriminator of type `ADD_PRICE_ADJUSTMENT`. | |
|
|
8
|
+
| **payload** | [**AddPriceAdjustmentCatalogAction**](AddPriceAdjustmentCatalogAction.md) | The payload of sync action. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'talon_one_sdk'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::CatalogActionAddPriceAdjustment.new(
|
|
16
|
+
type: null,
|
|
17
|
+
payload: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|