talon_one 10.0.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/autorelease.yml +123 -0
- data/README.md +55 -11
- data/docker-compose.yml +2 -2
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +2 -0
- data/docs/AchievementBase.md +3 -1
- data/docs/AchievementProgressWithDefinition.md +3 -1
- data/docs/AchievementStatusEntry.md +2 -0
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/ApplicationCustomer.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/AudienceCustomer.md +1 -1
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BestPriorPrice.md +27 -0
- data/docs/BestPriorPriceMetadata.md +19 -0
- data/docs/BestPriorPriceRequest.md +25 -0
- data/docs/BestPriorPriceRequestTarget.md +19 -0
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeletedNotification.md +6 -4
- data/docs/CampaignDeletedNotificationItem.md +21 -0
- data/docs/CampaignEditedNotification.md +6 -6
- data/docs/CampaignEditedNotificationItem.md +23 -0
- data/docs/CampaignEvaluationTreeChangedMessage.md +21 -0
- data/docs/CampaignNotificationBase.md +19 -0
- data/docs/CampaignNotificationGeneric.md +21 -0
- data/docs/CampaignNotificationItemBase.md +17 -0
- data/docs/CampaignNotificationPolicy.md +1 -1
- data/docs/CampaignRulesetChangedNotification.md +6 -6
- data/docs/CampaignRulesetChangedNotificationItem.md +23 -0
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CardAddedDeductedPointsNotification.md +45 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +1 -1
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/CardLedgerTransactionLogEntry.md +3 -1
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +3 -1
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomerProfile.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +1 -1
- data/docs/ExpiringCardPointsData.md +29 -0
- data/docs/ExpiringCardPointsNotification.md +21 -0
- data/docs/ExpiringCouponsData.md +35 -0
- data/docs/ExpiringCouponsNotification.md +21 -0
- data/docs/ExpiringCouponsNotificationPolicy.md +1 -1
- data/docs/ExpiringPointsData.md +25 -0
- data/docs/ExpiringPointsNotification.md +21 -0
- data/docs/ExpiringPointsNotificationPolicy.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +2 -4
- data/docs/ExtendedCoupon.md +61 -0
- data/docs/GenerateAuditLogSummary.md +17 -0
- data/docs/GenerateCampaignDescription.md +3 -1
- data/docs/GenerateCouponFailureDetailedSummary.md +25 -0
- data/docs/GenerateCouponFailureSummary.md +19 -0
- data/docs/GenerateUserSessionSummary.md +19 -0
- data/docs/GetIntegrationCouponRequest.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +4 -2
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +2 -4
- data/docs/InlineResponse20045.md +5 -3
- data/docs/InlineResponse20046.md +2 -4
- data/docs/InlineResponse20047.md +2 -6
- data/docs/InlineResponse20048.md +4 -2
- data/docs/InlineResponse20049.md +4 -2
- data/docs/IntegrationApi.md +88 -3
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/ManagementApi.md +1083 -366
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +3 -1
- data/docs/NewPriceType.md +4 -4
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +3 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/PriceDetail.md +2 -0
- data/docs/PriceType.md +4 -4
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TierDowngradeData.md +31 -0
- data/docs/TierDowngradeNotification.md +21 -0
- data/docs/TierDowngradeNotificationPolicy.md +1 -1
- data/docs/TierUpgradeData.md +35 -0
- data/docs/TierUpgradeNotification.md +21 -0
- data/docs/TierUpgradeNotificationPolicy.md +1 -1
- data/docs/TierWillDowngradeData.md +31 -0
- data/docs/TierWillDowngradeNotification.md +21 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +1 -1
- data/docs/UpdateAchievement.md +3 -1
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/Webhook.md +3 -1
- data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
- data/lib/talon_one/api/integration_api.rb +104 -2
- data/lib/talon_one/api/management_api.rb +226 -400
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +11 -1
- data/lib/talon_one/models/achievement_base.rb +14 -4
- data/lib/talon_one/models/achievement_progress_with_definition.rb +14 -4
- data/lib/talon_one/models/achievement_status_entry.rb +11 -1
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/added_deducted_points_notification.rb +478 -0
- data/lib/talon_one/models/analytics_sku.rb +23 -3
- data/lib/talon_one/models/application_customer.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/audience_customer.rb +1 -1
- data/lib/talon_one/models/audience_reference.rb +256 -0
- data/lib/talon_one/models/base_loyalty_program.rb +1 -1
- data/lib/talon_one/models/best_prior_price.rb +285 -0
- data/lib/talon_one/models/best_prior_price_metadata.rb +219 -0
- data/lib/talon_one/models/best_prior_price_request.rb +268 -0
- data/lib/talon_one/models/best_prior_price_request_target.rb +257 -0
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_collection_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_created_notification.rb +30 -26
- data/lib/talon_one/models/campaign_created_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +33 -21
- data/lib/talon_one/models/campaign_deleted_notification_item.rb +242 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +239 -0
- data/lib/talon_one/models/campaign_notification_base.rb +227 -0
- data/lib/talon_one/models/campaign_notification_generic.rb +244 -0
- data/lib/talon_one/models/campaign_notification_item_base.rb +212 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +2 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +32 -23
- data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb +245 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +30 -42
- data/lib/talon_one/models/campaign_state_changed_notification_item.rb +266 -0
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +510 -0
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/coupons_notification_data.rb +278 -0
- data/lib/talon_one/models/coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/create_achievement.rb +14 -4
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/customer_profile.rb +1 -1
- data/lib/talon_one/models/deduct_loyalty_points.rb +0 -9
- data/lib/talon_one/models/delete_coupons_data.rb +310 -0
- data/lib/talon_one/models/effect.rb +0 -1
- data/lib/talon_one/models/expiring_card_points_data.rb +342 -0
- data/lib/talon_one/models/expiring_card_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_data.rb +369 -0
- data/lib/talon_one/models/expiring_coupons_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/expiring_points_data.rb +291 -0
- data/lib/talon_one/models/expiring_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +9 -24
- data/lib/talon_one/models/extended_coupon.rb +578 -0
- data/lib/talon_one/models/generate_audit_log_summary.rb +212 -0
- data/lib/talon_one/models/generate_campaign_description.rb +16 -1
- data/lib/talon_one/models/generate_coupon_failure_detailed_summary.rb +286 -0
- data/lib/talon_one/models/generate_coupon_failure_summary.rb +222 -0
- data/lib/talon_one/models/generate_user_session_summary.rb +227 -0
- data/lib/talon_one/models/get_integration_coupon_request.rb +2 -0
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +11 -7
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +7 -11
- data/lib/talon_one/models/inline_response20045.rb +11 -7
- data/lib/talon_one/models/inline_response20046.rb +2 -21
- data/lib/talon_one/models/inline_response20047.rb +2 -25
- data/lib/talon_one/models/inline_response20048.rb +16 -2
- data/lib/talon_one/models/inline_response20049.rb +21 -2
- data/lib/talon_one/models/jwt.rb +228 -0
- data/lib/talon_one/models/label_target_audience.rb +260 -0
- data/lib/talon_one/models/label_target_none.rb +246 -0
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +17 -2
- data/lib/talon_one/models/loyalty_dashboard_data.rb +16 -1
- data/lib/talon_one/models/loyalty_ledger_entry_expiry_date_change.rb +238 -0
- data/lib/talon_one/models/loyalty_program.rb +1 -1
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/new_loyalty_program.rb +1 -1
- data/lib/talon_one/models/new_message_test.rb +28 -43
- data/lib/talon_one/models/new_price_adjustment.rb +33 -4
- data/lib/talon_one/models/new_price_type.rb +3 -3
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +14 -4
- data/lib/talon_one/models/pending_active_points_data.rb +308 -0
- data/lib/talon_one/models/pending_active_points_notification.rb +277 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/price_detail.rb +11 -1
- data/lib/talon_one/models/price_type.rb +3 -3
- data/lib/talon_one/models/price_type_reference_detail.rb +286 -0
- data/lib/talon_one/models/price_type_references.rb +224 -0
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/secondary_deployment.rb +367 -0
- data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/strikethrough_changed_item.rb +13 -1
- data/lib/talon_one/models/strikethrough_effect.rb +46 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +19 -4
- data/lib/talon_one/models/tier_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_upgrade_data.rb +353 -0
- data/lib/talon_one/models/tier_upgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_will_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_will_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/update_achievement.rb +14 -4
- data/lib/talon_one/models/update_coupons_data.rb +296 -0
- data/lib/talon_one/models/update_loyalty_program.rb +1 -1
- data/lib/talon_one/models/update_price_type.rb +239 -0
- data/lib/talon_one/models/webhook.rb +14 -4
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +51 -6
- data/spec/api/integration_api_spec.rb +23 -1
- data/spec/api/management_api_spec.rb +18 -54
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +6 -0
- data/spec/models/achievement_progress_with_definition_spec.rb +6 -0
- data/spec/models/achievement_spec.rb +6 -0
- data/spec/models/achievement_status_entry_spec.rb +6 -0
- data/spec/models/added_deducted_points_notification_spec.rb +125 -0
- data/spec/models/analytics_sku_spec.rb +12 -0
- data/spec/models/async_coupons_data_spec.rb +65 -0
- data/spec/models/audience_reference_spec.rb +53 -0
- data/spec/models/best_prior_price_metadata_spec.rb +47 -0
- data/spec/models/best_prior_price_request_spec.rb +65 -0
- data/spec/models/best_prior_price_request_target_spec.rb +51 -0
- data/spec/models/best_prior_price_spec.rb +71 -0
- data/spec/models/campaign_collection_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_collection_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_created_notification_item_spec.rb +59 -0
- data/spec/models/campaign_created_notification_spec.rb +3 -3
- data/spec/models/campaign_deleted_notification_item_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +53 -0
- data/spec/models/campaign_notification_base_spec.rb +47 -0
- data/spec/models/campaign_notification_generic_spec.rb +53 -0
- data/spec/models/campaign_notification_item_base_spec.rb +41 -0
- data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +59 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_state_changed_notification_item_spec.rb +65 -0
- data/spec/models/campaign_state_changed_notification_spec.rb +3 -9
- data/spec/models/card_added_deducted_points_notification_spec.rb +137 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +6 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +6 -0
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/expiring_card_points_data_spec.rb +77 -0
- data/spec/models/expiring_card_points_notification_spec.rb +57 -0
- data/spec/models/expiring_coupons_data_spec.rb +95 -0
- data/spec/models/expiring_coupons_notification_spec.rb +57 -0
- data/spec/models/expiring_points_data_spec.rb +65 -0
- data/spec/models/expiring_points_notification_spec.rb +57 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +1 -7
- data/spec/models/extended_coupon_spec.rb +173 -0
- data/spec/models/generate_audit_log_summary_spec.rb +41 -0
- data/spec/models/generate_campaign_description_spec.rb +6 -0
- data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +65 -0
- data/spec/models/generate_coupon_failure_summary_spec.rb +47 -0
- data/spec/models/generate_user_session_summary_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +6 -0
- data/spec/models/inline_response20044_spec.rb +0 -6
- data/spec/models/inline_response20045_spec.rb +6 -0
- data/spec/models/inline_response20046_spec.rb +0 -6
- data/spec/models/inline_response20047_spec.rb +0 -12
- data/spec/models/inline_response20048_spec.rb +6 -0
- data/spec/models/inline_response20049_spec.rb +6 -0
- data/spec/models/jwt_spec.rb +47 -0
- data/spec/models/label_target_audience_spec.rb +51 -0
- data/spec/models/label_target_none_spec.rb +45 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +53 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +10 -14
- data/spec/models/new_price_adjustment_spec.rb +6 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/pending_active_points_data_spec.rb +77 -0
- data/spec/models/pending_active_points_notification_spec.rb +57 -0
- data/spec/models/price_detail_spec.rb +6 -0
- data/spec/models/price_type_reference_detail_spec.rb +63 -0
- data/spec/models/price_type_references_spec.rb +47 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/secondary_deployment_spec.rb +87 -0
- data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/strikethrough_changed_item_spec.rb +6 -0
- data/spec/models/strikethrough_effect_spec.rb +24 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/tier_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_downgrade_notification_spec.rb +57 -0
- data/spec/models/tier_upgrade_data_spec.rb +95 -0
- data/spec/models/tier_upgrade_notification_spec.rb +57 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_will_downgrade_notification_spec.rb +57 -0
- data/spec/models/update_achievement_spec.rb +6 -0
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +206 -2
- data/.github/dependabot.yml +0 -10
data/docs/InlineResponse20045.md
CHANGED
|
@@ -4,15 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
7
|
+
**has_more** | **Boolean** | | [optional]
|
|
8
|
+
**total_result_size** | **Integer** | | [optional]
|
|
9
|
+
**data** | [**Array<Store>**](Store.md) | |
|
|
9
10
|
|
|
10
11
|
## Code Sample
|
|
11
12
|
|
|
12
13
|
```ruby
|
|
13
14
|
require 'TalonOne'
|
|
14
15
|
|
|
15
|
-
instance = TalonOne::InlineResponse20045.new(
|
|
16
|
+
instance = TalonOne::InlineResponse20045.new(has_more: null,
|
|
17
|
+
total_result_size: 1,
|
|
16
18
|
data: null)
|
|
17
19
|
```
|
|
18
20
|
|
data/docs/InlineResponse20046.md
CHANGED
|
@@ -4,16 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**data** | [**Array<RoleV2>**](RoleV2.md) | |
|
|
7
|
+
**data** | [**Array<ListCampaignStoreBudgets>**](ListCampaignStoreBudgets.md) | | [optional]
|
|
9
8
|
|
|
10
9
|
## Code Sample
|
|
11
10
|
|
|
12
11
|
```ruby
|
|
13
12
|
require 'TalonOne'
|
|
14
13
|
|
|
15
|
-
instance = TalonOne::InlineResponse20046.new(
|
|
16
|
-
data: null)
|
|
14
|
+
instance = TalonOne::InlineResponse20046.new(data: null)
|
|
17
15
|
```
|
|
18
16
|
|
|
19
17
|
|
data/docs/InlineResponse20047.md
CHANGED
|
@@ -4,18 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**total_result_size** | **Integer** | | [optional]
|
|
9
|
-
**data** | [**Array<Store>**](Store.md) | |
|
|
7
|
+
**data** | [**Array<SummaryCampaignStoreBudget>**](SummaryCampaignStoreBudget.md) | | [optional]
|
|
10
8
|
|
|
11
9
|
## Code Sample
|
|
12
10
|
|
|
13
11
|
```ruby
|
|
14
12
|
require 'TalonOne'
|
|
15
13
|
|
|
16
|
-
instance = TalonOne::InlineResponse20047.new(
|
|
17
|
-
total_result_size: 1,
|
|
18
|
-
data: null)
|
|
14
|
+
instance = TalonOne::InlineResponse20047.new(data: null)
|
|
19
15
|
```
|
|
20
16
|
|
|
21
17
|
|
data/docs/InlineResponse20048.md
CHANGED
|
@@ -4,14 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
7
|
+
**has_more** | **Boolean** | | [optional]
|
|
8
|
+
**data** | [**Array<Achievement>**](Achievement.md) | |
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
10
11
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'TalonOne'
|
|
13
14
|
|
|
14
|
-
instance = TalonOne::InlineResponse20048.new(
|
|
15
|
+
instance = TalonOne::InlineResponse20048.new(has_more: null,
|
|
16
|
+
data: null)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
data/docs/InlineResponse20049.md
CHANGED
|
@@ -4,14 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
7
|
+
**has_more** | **Boolean** | |
|
|
8
|
+
**data** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) | |
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
10
11
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'TalonOne'
|
|
13
14
|
|
|
14
|
-
instance = TalonOne::InlineResponse20049.new(
|
|
15
|
+
instance = TalonOne::InlineResponse20049.new(has_more: true,
|
|
16
|
+
data: null)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
data/docs/IntegrationApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**best_prior_price**](IntegrationApi.md#best_prior_price) | **POST** /v1/best_prior_price | Fetch best prior price
|
|
7
8
|
[**create_audience_v2**](IntegrationApi.md#create_audience_v2) | **POST** /v2/audiences | Create audience
|
|
8
9
|
[**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create coupon reservation
|
|
9
10
|
[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create referral code for an advocate
|
|
@@ -38,6 +39,70 @@ Method | HTTP request | Description
|
|
|
38
39
|
|
|
39
40
|
|
|
40
41
|
|
|
42
|
+
## best_prior_price
|
|
43
|
+
|
|
44
|
+
> Array<BestPriorPrice> best_prior_price(body)
|
|
45
|
+
|
|
46
|
+
Fetch best prior price
|
|
47
|
+
|
|
48
|
+
Returns the best prior price based on historical pricing data for the specified SKUs within a defined timeframe.
|
|
49
|
+
|
|
50
|
+
### Example
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
# load the gem
|
|
54
|
+
require 'talon_one'
|
|
55
|
+
# setup authorization
|
|
56
|
+
TalonOne.configure do |config|
|
|
57
|
+
# Configure API key authorization: api_key_v1
|
|
58
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
59
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
60
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
61
|
+
|
|
62
|
+
# Configure API key authorization: management_key
|
|
63
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
66
|
+
|
|
67
|
+
# Configure API key authorization: manager_auth
|
|
68
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
69
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
70
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
74
|
+
body = TalonOne::BestPriorPriceRequest.new # BestPriorPriceRequest | body
|
|
75
|
+
|
|
76
|
+
begin
|
|
77
|
+
#Fetch best prior price
|
|
78
|
+
result = api_instance.best_prior_price(body)
|
|
79
|
+
p result
|
|
80
|
+
rescue TalonOne::ApiError => e
|
|
81
|
+
puts "Exception when calling IntegrationApi->best_prior_price: #{e}"
|
|
82
|
+
end
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
Name | Type | Description | Notes
|
|
89
|
+
------------- | ------------- | ------------- | -------------
|
|
90
|
+
**body** | [**BestPriorPriceRequest**](BestPriorPriceRequest.md)| body |
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
[**Array<BestPriorPrice>**](BestPriorPrice.md)
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: application/json
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
41
106
|
## create_audience_v2
|
|
42
107
|
|
|
43
108
|
> Audience create_audience_v2(body)
|
|
@@ -943,8 +1008,11 @@ loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty
|
|
|
943
1008
|
opts = {
|
|
944
1009
|
status: 'active', # String | Filter points based on their status.
|
|
945
1010
|
subledger_id: ['subledger_id_example'], # Array<String> | Filter results by one or more subledger IDs. Must be exact match.
|
|
1011
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1012
|
+
transaction_uui_ds: ['transaction_uui_ds_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
946
1013
|
page_size: 50, # Integer | The number of items in the response.
|
|
947
|
-
skip: 56 # Integer | The number of items to skip when paging through large result sets.
|
|
1014
|
+
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
1015
|
+
sort: 'sort_example' # String | The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
|
|
948
1016
|
}
|
|
949
1017
|
|
|
950
1018
|
begin
|
|
@@ -965,8 +1033,11 @@ Name | Type | Description | Notes
|
|
|
965
1033
|
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
|
966
1034
|
**status** | **String**| Filter points based on their status. | [optional] [default to 'active']
|
|
967
1035
|
**subledger_id** | [**Array<String>**](String.md)| Filter results by one or more subledger IDs. Must be exact match. | [optional]
|
|
1036
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
1037
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
968
1038
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
|
969
1039
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
1040
|
+
**sort** | **String**| The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. | [optional]
|
|
970
1041
|
|
|
971
1042
|
### Return type
|
|
972
1043
|
|
|
@@ -1011,6 +1082,8 @@ opts = {
|
|
|
1011
1082
|
loyalty_transaction_type: 'loyalty_transaction_type_example', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
1012
1083
|
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
1013
1084
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
1085
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1086
|
+
transaction_uui_ds: ['transaction_uui_ds_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
1014
1087
|
page_size: 50, # Integer | The number of items in the response.
|
|
1015
1088
|
skip: 56 # Integer | The number of items to skip when paging through large result sets.
|
|
1016
1089
|
}
|
|
@@ -1035,6 +1108,8 @@ Name | Type | Description | Notes
|
|
|
1035
1108
|
**loyalty_transaction_type** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional]
|
|
1036
1109
|
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
|
1037
1110
|
**end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
|
1111
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
1112
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
1038
1113
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
|
1039
1114
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
1040
1115
|
|
|
@@ -1079,8 +1154,11 @@ integration_id = 'integration_id_example' # String | The integration identifier
|
|
|
1079
1154
|
opts = {
|
|
1080
1155
|
status: 'active', # String | Filter points based on their status.
|
|
1081
1156
|
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
1157
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1158
|
+
transaction_uui_ds: ['transaction_uui_ds_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
1082
1159
|
page_size: 50, # Integer | The number of items in the response.
|
|
1083
|
-
skip: 56 # Integer | The number of items to skip when paging through large result sets.
|
|
1160
|
+
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
1161
|
+
sort: 'sort_example' # String | The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
|
|
1084
1162
|
}
|
|
1085
1163
|
|
|
1086
1164
|
begin
|
|
@@ -1101,8 +1179,11 @@ Name | Type | Description | Notes
|
|
|
1101
1179
|
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
|
1102
1180
|
**status** | **String**| Filter points based on their status. | [optional] [default to 'active']
|
|
1103
1181
|
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
1182
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
1183
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
1104
1184
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
|
1105
1185
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
1186
|
+
**sort** | **String**| The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. | [optional]
|
|
1106
1187
|
|
|
1107
1188
|
### Return type
|
|
1108
1189
|
|
|
@@ -1143,6 +1224,8 @@ api_instance = TalonOne::IntegrationApi.new
|
|
|
1143
1224
|
loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1144
1225
|
integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
1145
1226
|
opts = {
|
|
1227
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1228
|
+
transaction_uui_ds: ['transaction_uui_ds_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
1146
1229
|
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
1147
1230
|
loyalty_transaction_type: 'loyalty_transaction_type_example', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
1148
1231
|
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
@@ -1167,6 +1250,8 @@ Name | Type | Description | Notes
|
|
|
1167
1250
|
------------- | ------------- | ------------- | -------------
|
|
1168
1251
|
**loyalty_program_id** | **Integer**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
1169
1252
|
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
|
1253
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
1254
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
1170
1255
|
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
1171
1256
|
**loyalty_transaction_type** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional]
|
|
1172
1257
|
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
|
@@ -1306,7 +1391,7 @@ Name | Type | Description | Notes
|
|
|
1306
1391
|
|
|
1307
1392
|
Reopen customer session
|
|
1308
1393
|
|
|
1309
|
-
Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. -
|
|
1394
|
+
Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a>tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
|
|
1310
1395
|
|
|
1311
1396
|
### Example
|
|
1312
1397
|
|
data/docs/JWT.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::JWT
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**access_token** | **String** | Access token used to authenticate a user in Talon.One. |
|
|
8
|
+
**expires_in** | **Integer** | Time until the token expires (in seconds). |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::JWT.new(access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9,
|
|
16
|
+
expires_in: 1000)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::LabelTargetAudience
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | |
|
|
8
|
+
**audience** | [**AudienceReference**](AudienceReference.md) | |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::LabelTargetAudience.new(type: null,
|
|
16
|
+
audience: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::LabelTargetNone
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::LabelTargetNone.new(type: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **Integer** | ID of the transaction that adds loyalty points. |
|
|
8
|
+
**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. |
|
|
8
9
|
**created** | **DateTime** | Date and time the loyalty points were added. |
|
|
9
10
|
**program_id** | **Integer** | ID of the loyalty program. |
|
|
10
11
|
**customer_session_id** | **String** | ID of the customer session where points were added. | [optional]
|
|
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
20
21
|
require 'TalonOne'
|
|
21
22
|
|
|
22
23
|
instance = TalonOne::LedgerPointsEntryIntegrationAPI.new(id: 123,
|
|
24
|
+
transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
|
|
23
25
|
created: null,
|
|
24
26
|
program_id: 324,
|
|
25
27
|
customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. |
|
|
7
8
|
**created** | **DateTime** | Date and time the loyalty transaction occurred. |
|
|
8
9
|
**program_id** | **Integer** | ID of the loyalty program. |
|
|
9
10
|
**customer_session_id** | **String** | ID of the customer session where the transaction occurred. | [optional]
|
|
@@ -23,7 +24,8 @@ Name | Type | Description | Notes
|
|
|
23
24
|
```ruby
|
|
24
25
|
require 'TalonOne'
|
|
25
26
|
|
|
26
|
-
instance = TalonOne::LedgerTransactionLogEntryIntegrationAPI.new(
|
|
27
|
+
instance = TalonOne::LedgerTransactionLogEntryIntegrationAPI.new(transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
|
|
28
|
+
created: null,
|
|
27
29
|
program_id: 324,
|
|
28
30
|
customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,
|
|
29
31
|
type: addition,
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**total_pending_points** | **Float** | Total of pending points for this loyalty program. |
|
|
10
10
|
**total_spent_points** | **Float** | Total of spent points for this loyalty program. |
|
|
11
11
|
**total_expired_points** | **Float** | Total of expired points for this loyalty program. |
|
|
12
|
+
**total_negative_points** | **Float** | Total of negative points for this loyalty program. |
|
|
12
13
|
**total_members** | **Float** | Number of loyalty program members. |
|
|
13
14
|
**new_members** | **Float** | Number of members who joined on this day. |
|
|
14
15
|
**spent_points** | [**LoyaltyDashboardPointsBreakdown**](LoyaltyDashboardPointsBreakdown.md) | |
|
|
@@ -24,6 +25,7 @@ instance = TalonOne::LoyaltyDashboardData.new(date: null,
|
|
|
24
25
|
total_pending_points: 548.0,
|
|
25
26
|
total_spent_points: 25668.0,
|
|
26
27
|
total_expired_points: 1156.0,
|
|
28
|
+
total_negative_points: 32.0,
|
|
27
29
|
total_members: 2582.0,
|
|
28
30
|
new_members: 3.0,
|
|
29
31
|
spent_points: null,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::LoyaltyLedgerEntryExpiryDateChange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_uuid** | **String** | The identifier of the transaction affected by the extension or update. |
|
|
8
|
+
**previous_expiry_date** | **DateTime** | Expiry date of the transactions before applying the extension or update. | [optional]
|
|
9
|
+
**new_expiry_date** | **DateTime** | Expiry date of the transaction after applying the extension or update. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::LoyaltyLedgerEntryExpiryDateChange.new(transaction_uuid: null,
|
|
17
|
+
previous_expiry_date: null,
|
|
18
|
+
new_expiry_date: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/LoyaltyProgram.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**description** | **String** | Description of our Loyalty Program. |
|
|
11
11
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. |
|
|
12
12
|
**default_validity** | **String** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
|
13
|
-
**default_pending** | **String** | The default duration of the pending time after which points should be valid.
|
|
13
|
+
**default_pending** | **String** | The default duration of the pending time after which points should be valid. Accepted values: 'immediate', 'on_action' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
|
14
14
|
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |
|
|
15
15
|
**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
|
|
16
16
|
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **Integer** | ID of the loyalty ledger transaction. |
|
|
8
|
+
**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. |
|
|
8
9
|
**program_id** | **Integer** | ID of the loyalty program. |
|
|
9
10
|
**campaign_id** | **Integer** | ID of the campaign. | [optional]
|
|
10
11
|
**created** | **DateTime** | Date and time the loyalty transaction occurred. |
|
|
@@ -30,6 +31,7 @@ Name | Type | Description | Notes
|
|
|
30
31
|
require 'TalonOne'
|
|
31
32
|
|
|
32
33
|
instance = TalonOne::LoyaltyProgramTransaction.new(id: 123,
|
|
34
|
+
transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
|
|
33
35
|
program_id: 324,
|
|
34
36
|
campaign_id: 324,
|
|
35
37
|
created: null,
|