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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f74fa5975b81ab01f5c0e55b992e7e1d951c5657bcd904936d76a9f914f7a4d
|
|
4
|
+
data.tar.gz: ca5865b76152174e0fc3120690ab0ca719886e93ec64a958d1f282d16799d843
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 63c0fc005a8af24b03a6c4c30f2853813b35813e6b2e45d162858e511db0cffe1b522e27312dcef15b6648a274ba4b9738fa77ed9ec19435b07bf0b5c7030864
|
|
7
|
+
data.tar.gz: 7b609c738db98e005b2e620e30ce014f69aede5fac508745dd19f0d1c9d9f30f6f4195ba13cb7ce1e4779e23bae2bdfe9127ebb0b51dd360c773bc0856e7b1e8
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
name: Auto-release on master
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [master]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: write
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
release:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0 # get full history so we can diff
|
|
18
|
+
|
|
19
|
+
- name: Extract version from commit message
|
|
20
|
+
id: get_version
|
|
21
|
+
run: |
|
|
22
|
+
msg='${{ github.event.head_commit.message }}'
|
|
23
|
+
if [[ "$msg" =~ update[[:space:]]+to[[:space:]]+([0-9]+\.[0-9]+\.[0-9]+) ]]; then
|
|
24
|
+
ver="${BASH_REMATCH[1]}"
|
|
25
|
+
echo "version=$ver" >> $GITHUB_OUTPUT
|
|
26
|
+
else
|
|
27
|
+
echo "Commit message does not match pattern - skipping release."
|
|
28
|
+
echo "version=" >> $GITHUB_OUTPUT
|
|
29
|
+
fi
|
|
30
|
+
|
|
31
|
+
- name: Skip when no version
|
|
32
|
+
if: ${{ steps.get_version.outputs.version == '' }}
|
|
33
|
+
run: echo "Nothing to do."
|
|
34
|
+
|
|
35
|
+
- name: Get diff of README endpoint section
|
|
36
|
+
if: ${{ steps.get_version.outputs.version != '' }}
|
|
37
|
+
id: get_diff
|
|
38
|
+
run: |
|
|
39
|
+
# Get section from old commit
|
|
40
|
+
git show HEAD^:README.md | awk '/^## Documentation for API endpoints/ {f=1; next} /^## / && f {exit} f' > old.txt || true
|
|
41
|
+
|
|
42
|
+
# Get section from current commit
|
|
43
|
+
awk '/^## Documentation for API endpoints/ {f=1; next} /^## / && f {exit} f' README.md > new.txt || true
|
|
44
|
+
|
|
45
|
+
# Normalize and diff
|
|
46
|
+
diff -u old.txt new.txt > endpoints.diff || true
|
|
47
|
+
|
|
48
|
+
echo "diff written"
|
|
49
|
+
cat endpoints.diff
|
|
50
|
+
|
|
51
|
+
- name: Generate release notes
|
|
52
|
+
if: ${{ steps.get_version.outputs.version != '' }}
|
|
53
|
+
id: relnotes
|
|
54
|
+
run: |
|
|
55
|
+
ADD=()
|
|
56
|
+
REMOVE=()
|
|
57
|
+
|
|
58
|
+
# Extract only meaningful +/- lines (skip diff headers)
|
|
59
|
+
while IFS= read -r line; do
|
|
60
|
+
clean="${line:1}" # strip leading + or -
|
|
61
|
+
clean="${clean#*ManagementApi* | }" # strip the prefix
|
|
62
|
+
if [[ "$line" == +* ]]; then
|
|
63
|
+
ADD+=("$clean")
|
|
64
|
+
elif [[ "$line" == -* ]]; then
|
|
65
|
+
REMOVE+=("$clean")
|
|
66
|
+
fi
|
|
67
|
+
done < <(grep '^[+-]' endpoints.diff | grep -v '^+++' | grep -v '^---')
|
|
68
|
+
|
|
69
|
+
{
|
|
70
|
+
echo "## Summary"
|
|
71
|
+
echo "### Added endpoints"
|
|
72
|
+
if [ ${#ADD[@]} -eq 0 ]; then
|
|
73
|
+
echo "- None"
|
|
74
|
+
else
|
|
75
|
+
printf -- "- %s\n" "${ADD[@]}"
|
|
76
|
+
fi
|
|
77
|
+
|
|
78
|
+
echo ""
|
|
79
|
+
echo "### Removed endpoints"
|
|
80
|
+
if [ ${#REMOVE[@]} -eq 0 ]; then
|
|
81
|
+
echo "- None"
|
|
82
|
+
else
|
|
83
|
+
printf -- "- %s\n" "${REMOVE[@]}"
|
|
84
|
+
fi
|
|
85
|
+
} > release-notes.md
|
|
86
|
+
|
|
87
|
+
echo "notes_file=release-notes.md" >> "$GITHUB_OUTPUT"
|
|
88
|
+
- uses: ruby/setup-ruby@v1
|
|
89
|
+
with:
|
|
90
|
+
ruby-version: "3"
|
|
91
|
+
|
|
92
|
+
- name: publish gem
|
|
93
|
+
if: ${{ steps.get_version.outputs.version != '' }}
|
|
94
|
+
env:
|
|
95
|
+
GEM_HOST_API_KEY: ${{ secrets.RUBYGEM_PUBLISHING_KEY }}
|
|
96
|
+
run: |
|
|
97
|
+
bundle install
|
|
98
|
+
gem build talon_one.gemspec
|
|
99
|
+
gem push talon_one-*.gem
|
|
100
|
+
|
|
101
|
+
- name: Create Git tag
|
|
102
|
+
if: ${{ steps.get_version.outputs.version != '' }}
|
|
103
|
+
run: |
|
|
104
|
+
ver="${{ steps.get_version.outputs.version }}"
|
|
105
|
+
git tag -f "$ver" "$GITHUB_SHA"
|
|
106
|
+
git push -f origin "refs/tags/$ver"
|
|
107
|
+
|
|
108
|
+
- name: Create GitHub release
|
|
109
|
+
if: ${{ steps.get_version.outputs.version != '' }}
|
|
110
|
+
env:
|
|
111
|
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
112
|
+
run: |
|
|
113
|
+
ver="${{ steps.get_version.outputs.version }}"
|
|
114
|
+
notes_file="${{ steps.relnotes.outputs.notes_file }}"
|
|
115
|
+
|
|
116
|
+
if gh release view "$ver" &>/dev/null; then
|
|
117
|
+
gh release delete "$ver" --yes
|
|
118
|
+
fi
|
|
119
|
+
|
|
120
|
+
gh release create "$ver" \
|
|
121
|
+
--title "$ver" \
|
|
122
|
+
--notes-file "$notes_file" \
|
|
123
|
+
--target "$GITHUB_SHA"
|
data/README.md
CHANGED
|
@@ -9,7 +9,7 @@ This SDK supports all of the operations of Talon.One's Integration API and Manag
|
|
|
9
9
|
Add this to the Gemfile:
|
|
10
10
|
|
|
11
11
|
```shell
|
|
12
|
-
gem 'talon_one', '~>
|
|
12
|
+
gem 'talon_one', '~> 11.0.0'
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
### Build a gem
|
|
@@ -25,10 +25,10 @@ gem build talon_one.gemspec
|
|
|
25
25
|
To install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./talon_one-
|
|
28
|
+
gem install ./talon_one-11.0.0.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
For development, run `gem install --dev ./talon_one-
|
|
31
|
+
For development, run `gem install --dev ./talon_one-11.0.0.gem` to install the development dependencies.
|
|
32
32
|
|
|
33
33
|
### RubyGems
|
|
34
34
|
|
|
@@ -173,6 +173,7 @@ All URLs are relative to `https://yourbaseurl.talon.one`.
|
|
|
173
173
|
|
|
174
174
|
Class | Method | HTTP request | Description
|
|
175
175
|
------------ | ------------- | ------------- | -------------
|
|
176
|
+
*TalonOne::IntegrationApi* | [**best_prior_price**](docs/IntegrationApi.md#best_prior_price) | **POST** /v1/best_prior_price | Fetch best prior price
|
|
176
177
|
*TalonOne::IntegrationApi* | [**create_audience_v2**](docs/IntegrationApi.md#create_audience_v2) | **POST** /v2/audiences | Create audience
|
|
177
178
|
*TalonOne::IntegrationApi* | [**create_coupon_reservation**](docs/IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create coupon reservation
|
|
178
179
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create referral code for an advocate
|
|
@@ -320,8 +321,6 @@ Class | Method | HTTP request | Description
|
|
|
320
321
|
*TalonOne::ManagementApi* | [**get_user**](docs/ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get user
|
|
321
322
|
*TalonOne::ManagementApi* | [**get_users**](docs/ManagementApi.md#get_users) | **GET** /v1/users | List users in account
|
|
322
323
|
*TalonOne::ManagementApi* | [**get_webhook**](docs/ManagementApi.md#get_webhook) | **GET** /v1/webhooks/{webhookId} | Get webhook
|
|
323
|
-
*TalonOne::ManagementApi* | [**get_webhook_activation_logs**](docs/ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List webhook activation log entries
|
|
324
|
-
*TalonOne::ManagementApi* | [**get_webhook_logs**](docs/ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List webhook log entries
|
|
325
324
|
*TalonOne::ManagementApi* | [**get_webhooks**](docs/ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List webhooks
|
|
326
325
|
*TalonOne::ManagementApi* | [**import_account_collection**](docs/ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
|
327
326
|
*TalonOne::ManagementApi* | [**import_allowed_list**](docs/ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
|
@@ -410,6 +409,7 @@ Class | Method | HTTP request | Description
|
|
|
410
409
|
- [TalonOne::AddPriceAdjustmentCatalogAction](docs/AddPriceAdjustmentCatalogAction.md)
|
|
411
410
|
- [TalonOne::AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md)
|
|
412
411
|
- [TalonOne::AddedDeductedPointsBalancesNotificationPolicy](docs/AddedDeductedPointsBalancesNotificationPolicy.md)
|
|
412
|
+
- [TalonOne::AddedDeductedPointsNotification](docs/AddedDeductedPointsNotification.md)
|
|
413
413
|
- [TalonOne::AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md)
|
|
414
414
|
- [TalonOne::AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md)
|
|
415
415
|
- [TalonOne::AdditionalCost](docs/AdditionalCost.md)
|
|
@@ -439,6 +439,7 @@ Class | Method | HTTP request | Description
|
|
|
439
439
|
- [TalonOne::ApplicationStoreEntity](docs/ApplicationStoreEntity.md)
|
|
440
440
|
- [TalonOne::AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md)
|
|
441
441
|
- [TalonOne::AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md)
|
|
442
|
+
- [TalonOne::AsyncCouponsData](docs/AsyncCouponsData.md)
|
|
442
443
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
443
444
|
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
444
445
|
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
@@ -447,6 +448,7 @@ Class | Method | HTTP request | Description
|
|
|
447
448
|
- [TalonOne::AudienceCustomer](docs/AudienceCustomer.md)
|
|
448
449
|
- [TalonOne::AudienceIntegrationID](docs/AudienceIntegrationID.md)
|
|
449
450
|
- [TalonOne::AudienceMembership](docs/AudienceMembership.md)
|
|
451
|
+
- [TalonOne::AudienceReference](docs/AudienceReference.md)
|
|
450
452
|
- [TalonOne::AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md)
|
|
451
453
|
- [TalonOne::BaseCampaign](docs/BaseCampaign.md)
|
|
452
454
|
- [TalonOne::BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md)
|
|
@@ -455,9 +457,12 @@ Class | Method | HTTP request | Description
|
|
|
455
457
|
- [TalonOne::BaseNotificationWebhook](docs/BaseNotificationWebhook.md)
|
|
456
458
|
- [TalonOne::BaseNotifications](docs/BaseNotifications.md)
|
|
457
459
|
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
|
460
|
+
- [TalonOne::BestPriorPrice](docs/BestPriorPrice.md)
|
|
461
|
+
- [TalonOne::BestPriorPriceMetadata](docs/BestPriorPriceMetadata.md)
|
|
462
|
+
- [TalonOne::BestPriorPriceRequest](docs/BestPriorPriceRequest.md)
|
|
463
|
+
- [TalonOne::BestPriorPriceRequestTarget](docs/BestPriorPriceRequestTarget.md)
|
|
458
464
|
- [TalonOne::Binding](docs/Binding.md)
|
|
459
465
|
- [TalonOne::BulkApplicationNotification](docs/BulkApplicationNotification.md)
|
|
460
|
-
- [TalonOne::BulkCampaignNotification](docs/BulkCampaignNotification.md)
|
|
461
466
|
- [TalonOne::BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md)
|
|
462
467
|
- [TalonOne::Campaign](docs/Campaign.md)
|
|
463
468
|
- [TalonOne::CampaignActivationRequest](docs/CampaignActivationRequest.md)
|
|
@@ -465,28 +470,37 @@ Class | Method | HTTP request | Description
|
|
|
465
470
|
- [TalonOne::CampaignBudget](docs/CampaignBudget.md)
|
|
466
471
|
- [TalonOne::CampaignCollection](docs/CampaignCollection.md)
|
|
467
472
|
- [TalonOne::CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md)
|
|
473
|
+
- [TalonOne::CampaignCollectionEditedNotificationItem](docs/CampaignCollectionEditedNotificationItem.md)
|
|
468
474
|
- [TalonOne::CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md)
|
|
469
475
|
- [TalonOne::CampaignCopy](docs/CampaignCopy.md)
|
|
470
476
|
- [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
|
|
477
|
+
- [TalonOne::CampaignCreatedNotificationItem](docs/CampaignCreatedNotificationItem.md)
|
|
471
478
|
- [TalonOne::CampaignDeactivationRequest](docs/CampaignDeactivationRequest.md)
|
|
472
479
|
- [TalonOne::CampaignDeletedNotification](docs/CampaignDeletedNotification.md)
|
|
480
|
+
- [TalonOne::CampaignDeletedNotificationItem](docs/CampaignDeletedNotificationItem.md)
|
|
473
481
|
- [TalonOne::CampaignDetail](docs/CampaignDetail.md)
|
|
474
482
|
- [TalonOne::CampaignEditedNotification](docs/CampaignEditedNotification.md)
|
|
483
|
+
- [TalonOne::CampaignEditedNotificationItem](docs/CampaignEditedNotificationItem.md)
|
|
475
484
|
- [TalonOne::CampaignEntity](docs/CampaignEntity.md)
|
|
476
485
|
- [TalonOne::CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md)
|
|
477
486
|
- [TalonOne::CampaignEvaluationPosition](docs/CampaignEvaluationPosition.md)
|
|
487
|
+
- [TalonOne::CampaignEvaluationTreeChangedMessage](docs/CampaignEvaluationTreeChangedMessage.md)
|
|
478
488
|
- [TalonOne::CampaignEvaluationTreeChangedNotification](docs/CampaignEvaluationTreeChangedNotification.md)
|
|
479
489
|
- [TalonOne::CampaignGroup](docs/CampaignGroup.md)
|
|
480
490
|
- [TalonOne::CampaignGroupEntity](docs/CampaignGroupEntity.md)
|
|
481
|
-
- [TalonOne::
|
|
491
|
+
- [TalonOne::CampaignNotificationBase](docs/CampaignNotificationBase.md)
|
|
492
|
+
- [TalonOne::CampaignNotificationGeneric](docs/CampaignNotificationGeneric.md)
|
|
493
|
+
- [TalonOne::CampaignNotificationItemBase](docs/CampaignNotificationItemBase.md)
|
|
482
494
|
- [TalonOne::CampaignNotificationPolicy](docs/CampaignNotificationPolicy.md)
|
|
483
495
|
- [TalonOne::CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md)
|
|
496
|
+
- [TalonOne::CampaignRulesetChangedNotificationItem](docs/CampaignRulesetChangedNotificationItem.md)
|
|
484
497
|
- [TalonOne::CampaignSearch](docs/CampaignSearch.md)
|
|
485
498
|
- [TalonOne::CampaignSet](docs/CampaignSet.md)
|
|
486
499
|
- [TalonOne::CampaignSetBranchNode](docs/CampaignSetBranchNode.md)
|
|
487
500
|
- [TalonOne::CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
|
|
488
501
|
- [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
|
|
489
502
|
- [TalonOne::CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md)
|
|
503
|
+
- [TalonOne::CampaignStateChangedNotificationItem](docs/CampaignStateChangedNotificationItem.md)
|
|
490
504
|
- [TalonOne::CampaignStoreBudget](docs/CampaignStoreBudget.md)
|
|
491
505
|
- [TalonOne::CampaignStoreBudgetLimitConfig](docs/CampaignStoreBudgetLimitConfig.md)
|
|
492
506
|
- [TalonOne::CampaignTemplate](docs/CampaignTemplate.md)
|
|
@@ -495,6 +509,7 @@ Class | Method | HTTP request | Description
|
|
|
495
509
|
- [TalonOne::CampaignTemplateParams](docs/CampaignTemplateParams.md)
|
|
496
510
|
- [TalonOne::CampaignVersions](docs/CampaignVersions.md)
|
|
497
511
|
- [TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy](docs/CardAddedDeductedPointsBalancesNotificationPolicy.md)
|
|
512
|
+
- [TalonOne::CardAddedDeductedPointsNotification](docs/CardAddedDeductedPointsNotification.md)
|
|
498
513
|
- [TalonOne::CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md)
|
|
499
514
|
- [TalonOne::CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md)
|
|
500
515
|
- [TalonOne::CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md)
|
|
@@ -527,9 +542,11 @@ Class | Method | HTTP request | Description
|
|
|
527
542
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
528
543
|
- [TalonOne::CouponSearch](docs/CouponSearch.md)
|
|
529
544
|
- [TalonOne::CouponValue](docs/CouponValue.md)
|
|
545
|
+
- [TalonOne::CouponsNotificationData](docs/CouponsNotificationData.md)
|
|
530
546
|
- [TalonOne::CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md)
|
|
531
547
|
- [TalonOne::CreateAchievement](docs/CreateAchievement.md)
|
|
532
548
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
|
549
|
+
- [TalonOne::CreateCouponData](docs/CreateCouponData.md)
|
|
533
550
|
- [TalonOne::CreateManagementKey](docs/CreateManagementKey.md)
|
|
534
551
|
- [TalonOne::CreateTemplateCampaign](docs/CreateTemplateCampaign.md)
|
|
535
552
|
- [TalonOne::CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md)
|
|
@@ -550,6 +567,7 @@ Class | Method | HTTP request | Description
|
|
|
550
567
|
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
|
551
568
|
- [TalonOne::DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md)
|
|
552
569
|
- [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
|
|
570
|
+
- [TalonOne::DeleteCouponsData](docs/DeleteCouponsData.md)
|
|
553
571
|
- [TalonOne::DeleteUserRequest](docs/DeleteUserRequest.md)
|
|
554
572
|
- [TalonOne::Effect](docs/Effect.md)
|
|
555
573
|
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
|
@@ -566,22 +584,33 @@ Class | Method | HTTP request | Description
|
|
|
566
584
|
- [TalonOne::Event](docs/Event.md)
|
|
567
585
|
- [TalonOne::EventType](docs/EventType.md)
|
|
568
586
|
- [TalonOne::EventV2](docs/EventV2.md)
|
|
587
|
+
- [TalonOne::ExpiringCardPointsData](docs/ExpiringCardPointsData.md)
|
|
588
|
+
- [TalonOne::ExpiringCardPointsNotification](docs/ExpiringCardPointsNotification.md)
|
|
589
|
+
- [TalonOne::ExpiringCouponsData](docs/ExpiringCouponsData.md)
|
|
590
|
+
- [TalonOne::ExpiringCouponsNotification](docs/ExpiringCouponsNotification.md)
|
|
569
591
|
- [TalonOne::ExpiringCouponsNotificationPolicy](docs/ExpiringCouponsNotificationPolicy.md)
|
|
570
592
|
- [TalonOne::ExpiringCouponsNotificationTrigger](docs/ExpiringCouponsNotificationTrigger.md)
|
|
593
|
+
- [TalonOne::ExpiringPointsData](docs/ExpiringPointsData.md)
|
|
594
|
+
- [TalonOne::ExpiringPointsNotification](docs/ExpiringPointsNotification.md)
|
|
571
595
|
- [TalonOne::ExpiringPointsNotificationPolicy](docs/ExpiringPointsNotificationPolicy.md)
|
|
572
596
|
- [TalonOne::ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md)
|
|
573
597
|
- [TalonOne::Export](docs/Export.md)
|
|
574
598
|
- [TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps](docs/ExtendLoyaltyPointsExpiryDateEffectProps.md)
|
|
599
|
+
- [TalonOne::ExtendedCoupon](docs/ExtendedCoupon.md)
|
|
575
600
|
- [TalonOne::FeatureFlag](docs/FeatureFlag.md)
|
|
576
601
|
- [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
|
|
577
602
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
|
578
603
|
- [TalonOne::FunctionDef](docs/FunctionDef.md)
|
|
604
|
+
- [TalonOne::GenerateAuditLogSummary](docs/GenerateAuditLogSummary.md)
|
|
579
605
|
- [TalonOne::GenerateCampaignDescription](docs/GenerateCampaignDescription.md)
|
|
580
606
|
- [TalonOne::GenerateCampaignTags](docs/GenerateCampaignTags.md)
|
|
607
|
+
- [TalonOne::GenerateCouponFailureDetailedSummary](docs/GenerateCouponFailureDetailedSummary.md)
|
|
608
|
+
- [TalonOne::GenerateCouponFailureSummary](docs/GenerateCouponFailureSummary.md)
|
|
581
609
|
- [TalonOne::GenerateItemFilterDescription](docs/GenerateItemFilterDescription.md)
|
|
582
610
|
- [TalonOne::GenerateLoyaltyCard](docs/GenerateLoyaltyCard.md)
|
|
583
611
|
- [TalonOne::GenerateRuleTitle](docs/GenerateRuleTitle.md)
|
|
584
612
|
- [TalonOne::GenerateRuleTitleRule](docs/GenerateRuleTitleRule.md)
|
|
613
|
+
- [TalonOne::GenerateUserSessionSummary](docs/GenerateUserSessionSummary.md)
|
|
585
614
|
- [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
|
|
586
615
|
- [TalonOne::Giveaway](docs/Giveaway.md)
|
|
587
616
|
- [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
|
|
@@ -636,8 +665,6 @@ Class | Method | HTTP request | Description
|
|
|
636
665
|
- [TalonOne::InlineResponse20048](docs/InlineResponse20048.md)
|
|
637
666
|
- [TalonOne::InlineResponse20049](docs/InlineResponse20049.md)
|
|
638
667
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
|
639
|
-
- [TalonOne::InlineResponse20050](docs/InlineResponse20050.md)
|
|
640
|
-
- [TalonOne::InlineResponse20051](docs/InlineResponse20051.md)
|
|
641
668
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
|
642
669
|
- [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
|
|
643
670
|
- [TalonOne::InlineResponse2008](docs/InlineResponse2008.md)
|
|
@@ -658,6 +685,9 @@ Class | Method | HTTP request | Description
|
|
|
658
685
|
- [TalonOne::InventoryCoupon](docs/InventoryCoupon.md)
|
|
659
686
|
- [TalonOne::InventoryReferral](docs/InventoryReferral.md)
|
|
660
687
|
- [TalonOne::ItemAttribute](docs/ItemAttribute.md)
|
|
688
|
+
- [TalonOne::JWT](docs/JWT.md)
|
|
689
|
+
- [TalonOne::LabelTargetAudience](docs/LabelTargetAudience.md)
|
|
690
|
+
- [TalonOne::LabelTargetNone](docs/LabelTargetNone.md)
|
|
661
691
|
- [TalonOne::LedgerEntry](docs/LedgerEntry.md)
|
|
662
692
|
- [TalonOne::LedgerInfo](docs/LedgerInfo.md)
|
|
663
693
|
- [TalonOne::LedgerPointsEntryIntegrationAPI](docs/LedgerPointsEntryIntegrationAPI.md)
|
|
@@ -683,6 +713,7 @@ Class | Method | HTTP request | Description
|
|
|
683
713
|
- [TalonOne::LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md)
|
|
684
714
|
- [TalonOne::LoyaltyLedger](docs/LoyaltyLedger.md)
|
|
685
715
|
- [TalonOne::LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md)
|
|
716
|
+
- [TalonOne::LoyaltyLedgerEntryExpiryDateChange](docs/LoyaltyLedgerEntryExpiryDateChange.md)
|
|
686
717
|
- [TalonOne::LoyaltyLedgerEntryFlags](docs/LoyaltyLedgerEntryFlags.md)
|
|
687
718
|
- [TalonOne::LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md)
|
|
688
719
|
- [TalonOne::LoyaltyMembership](docs/LoyaltyMembership.md)
|
|
@@ -768,6 +799,7 @@ Class | Method | HTTP request | Description
|
|
|
768
799
|
- [TalonOne::NewRoleV2](docs/NewRoleV2.md)
|
|
769
800
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
|
770
801
|
- [TalonOne::NewSamlConnection](docs/NewSamlConnection.md)
|
|
802
|
+
- [TalonOne::NewSecondaryDeployment](docs/NewSecondaryDeployment.md)
|
|
771
803
|
- [TalonOne::NewStore](docs/NewStore.md)
|
|
772
804
|
- [TalonOne::NewTemplateDef](docs/NewTemplateDef.md)
|
|
773
805
|
- [TalonOne::NewUser](docs/NewUser.md)
|
|
@@ -792,10 +824,14 @@ Class | Method | HTTP request | Description
|
|
|
792
824
|
- [TalonOne::OutgoingIntegrationTypes](docs/OutgoingIntegrationTypes.md)
|
|
793
825
|
- [TalonOne::PatchItemCatalogAction](docs/PatchItemCatalogAction.md)
|
|
794
826
|
- [TalonOne::PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md)
|
|
827
|
+
- [TalonOne::PendingActivePointsData](docs/PendingActivePointsData.md)
|
|
828
|
+
- [TalonOne::PendingActivePointsNotification](docs/PendingActivePointsNotification.md)
|
|
795
829
|
- [TalonOne::PendingPointsNotificationPolicy](docs/PendingPointsNotificationPolicy.md)
|
|
796
830
|
- [TalonOne::Picklist](docs/Picklist.md)
|
|
797
831
|
- [TalonOne::PriceDetail](docs/PriceDetail.md)
|
|
798
832
|
- [TalonOne::PriceType](docs/PriceType.md)
|
|
833
|
+
- [TalonOne::PriceTypeReferenceDetail](docs/PriceTypeReferenceDetail.md)
|
|
834
|
+
- [TalonOne::PriceTypeReferences](docs/PriceTypeReferences.md)
|
|
799
835
|
- [TalonOne::Product](docs/Product.md)
|
|
800
836
|
- [TalonOne::ProductSearchMatch](docs/ProductSearchMatch.md)
|
|
801
837
|
- [TalonOne::ProductUnitAnalytics](docs/ProductUnitAnalytics.md)
|
|
@@ -865,11 +901,13 @@ Class | Method | HTTP request | Description
|
|
|
865
901
|
- [TalonOne::ScimServiceProviderConfigResponseSort](docs/ScimServiceProviderConfigResponseSort.md)
|
|
866
902
|
- [TalonOne::ScimUser](docs/ScimUser.md)
|
|
867
903
|
- [TalonOne::ScimUsersListResponse](docs/ScimUsersListResponse.md)
|
|
904
|
+
- [TalonOne::SecondaryDeployment](docs/SecondaryDeployment.md)
|
|
868
905
|
- [TalonOne::Session](docs/Session.md)
|
|
869
906
|
- [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
|
|
870
907
|
- [TalonOne::SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md)
|
|
871
908
|
- [TalonOne::SetDiscountPerAdditionalCostPerItemEffectProps](docs/SetDiscountPerAdditionalCostPerItemEffectProps.md)
|
|
872
909
|
- [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
|
|
910
|
+
- [TalonOne::SetLoyaltyPointsExpiryDateEffectProps](docs/SetLoyaltyPointsExpiryDateEffectProps.md)
|
|
873
911
|
- [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
|
|
874
912
|
- [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
|
|
875
913
|
- [TalonOne::SkuUnitAnalytics](docs/SkuUnitAnalytics.md)
|
|
@@ -890,8 +928,14 @@ Class | Method | HTTP request | Description
|
|
|
890
928
|
- [TalonOne::TemplateDef](docs/TemplateDef.md)
|
|
891
929
|
- [TalonOne::TemplateLimitConfig](docs/TemplateLimitConfig.md)
|
|
892
930
|
- [TalonOne::Tier](docs/Tier.md)
|
|
931
|
+
- [TalonOne::TierDowngradeData](docs/TierDowngradeData.md)
|
|
932
|
+
- [TalonOne::TierDowngradeNotification](docs/TierDowngradeNotification.md)
|
|
893
933
|
- [TalonOne::TierDowngradeNotificationPolicy](docs/TierDowngradeNotificationPolicy.md)
|
|
934
|
+
- [TalonOne::TierUpgradeData](docs/TierUpgradeData.md)
|
|
935
|
+
- [TalonOne::TierUpgradeNotification](docs/TierUpgradeNotification.md)
|
|
894
936
|
- [TalonOne::TierUpgradeNotificationPolicy](docs/TierUpgradeNotificationPolicy.md)
|
|
937
|
+
- [TalonOne::TierWillDowngradeData](docs/TierWillDowngradeData.md)
|
|
938
|
+
- [TalonOne::TierWillDowngradeNotification](docs/TierWillDowngradeNotification.md)
|
|
895
939
|
- [TalonOne::TierWillDowngradeNotificationPolicy](docs/TierWillDowngradeNotificationPolicy.md)
|
|
896
940
|
- [TalonOne::TierWillDowngradeNotificationTrigger](docs/TierWillDowngradeNotificationTrigger.md)
|
|
897
941
|
- [TalonOne::TimePoint](docs/TimePoint.md)
|
|
@@ -915,10 +959,12 @@ Class | Method | HTTP request | Description
|
|
|
915
959
|
- [TalonOne::UpdateCollection](docs/UpdateCollection.md)
|
|
916
960
|
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
|
|
917
961
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
|
962
|
+
- [TalonOne::UpdateCouponsData](docs/UpdateCouponsData.md)
|
|
918
963
|
- [TalonOne::UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md)
|
|
919
964
|
- [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
|
|
920
965
|
- [TalonOne::UpdateLoyaltyProgramTier](docs/UpdateLoyaltyProgramTier.md)
|
|
921
966
|
- [TalonOne::UpdatePicklist](docs/UpdatePicklist.md)
|
|
967
|
+
- [TalonOne::UpdatePriceType](docs/UpdatePriceType.md)
|
|
922
968
|
- [TalonOne::UpdateReferral](docs/UpdateReferral.md)
|
|
923
969
|
- [TalonOne::UpdateReferralBatch](docs/UpdateReferralBatch.md)
|
|
924
970
|
- [TalonOne::UpdateRole](docs/UpdateRole.md)
|
|
@@ -928,13 +974,11 @@ Class | Method | HTTP request | Description
|
|
|
928
974
|
- [TalonOne::UserEntity](docs/UserEntity.md)
|
|
929
975
|
- [TalonOne::ValueMap](docs/ValueMap.md)
|
|
930
976
|
- [TalonOne::Webhook](docs/Webhook.md)
|
|
931
|
-
- [TalonOne::WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md)
|
|
932
977
|
- [TalonOne::WebhookAuthentication](docs/WebhookAuthentication.md)
|
|
933
978
|
- [TalonOne::WebhookAuthenticationBase](docs/WebhookAuthenticationBase.md)
|
|
934
979
|
- [TalonOne::WebhookAuthenticationDataBasic](docs/WebhookAuthenticationDataBasic.md)
|
|
935
980
|
- [TalonOne::WebhookAuthenticationDataCustom](docs/WebhookAuthenticationDataCustom.md)
|
|
936
981
|
- [TalonOne::WebhookAuthenticationWebhookRef](docs/WebhookAuthenticationWebhookRef.md)
|
|
937
|
-
- [TalonOne::WebhookLogEntry](docs/WebhookLogEntry.md)
|
|
938
982
|
- [TalonOne::WebhookWithOutgoingIntegrationDetails](docs/WebhookWithOutgoingIntegrationDetails.md)
|
|
939
983
|
- [TalonOne::WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md)
|
|
940
984
|
|
data/docker-compose.yml
CHANGED
|
@@ -27,9 +27,9 @@ services:
|
|
|
27
27
|
restart: "on-failure:10"
|
|
28
28
|
|
|
29
29
|
database-service:
|
|
30
|
-
image: docker.io/
|
|
30
|
+
image: docker.io/bitnamilegacy/postgresql:15
|
|
31
31
|
volumes:
|
|
32
|
-
-
|
|
32
|
+
- "postgresql_master_data:/bitnami/postgresql"
|
|
33
33
|
ports:
|
|
34
34
|
- "5433:5432"
|
|
35
35
|
environment:
|
data/docs/AccountLimits.md
CHANGED
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**users** | **Integer** | Total number of allowed users in the account. |
|
|
17
17
|
**api_volume** | **Integer** | Allowed volume of API requests to the account. |
|
|
18
18
|
**promotion_types** | **Array<String>** | Array of promotion types that are employed in the account. |
|
|
19
|
+
**secondary_deployment_price** | **Integer** | The price for a secondary deployment according to contractual agreements. |
|
|
20
|
+
**currency_code** | **String** | The currency of the contract. |
|
|
19
21
|
|
|
20
22
|
## Code Sample
|
|
21
23
|
|
|
@@ -33,7 +35,9 @@ instance = TalonOne::AccountLimits.new(live_applications: null,
|
|
|
33
35
|
webhooks: null,
|
|
34
36
|
users: null,
|
|
35
37
|
api_volume: null,
|
|
36
|
-
promotion_types: null
|
|
38
|
+
promotion_types: null,
|
|
39
|
+
secondary_deployment_price: null,
|
|
40
|
+
currency_code: null)
|
|
37
41
|
```
|
|
38
42
|
|
|
39
43
|
|
data/docs/Achievement.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
17
17
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
18
18
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
19
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
19
20
|
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
|
|
20
21
|
**user_id** | **Integer** | ID of the user that created this achievement. |
|
|
21
22
|
**created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
|
|
@@ -39,6 +40,7 @@ instance = TalonOne::Achievement.new(id: 6,
|
|
|
39
40
|
activation_policy: fixed_schedule,
|
|
40
41
|
fixed_start_date: null,
|
|
41
42
|
end_date: null,
|
|
43
|
+
allow_rollback_after_completion: false,
|
|
42
44
|
campaign_id: 1,
|
|
43
45
|
user_id: 1234,
|
|
44
46
|
created_by: John Doe,
|
data/docs/AchievementBase.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
15
15
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
16
16
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
17
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = TalonOne::AchievementBase.new(name: Order50Discount,
|
|
|
29
30
|
recurrence_policy: no_recurrence,
|
|
30
31
|
activation_policy: fixed_schedule,
|
|
31
32
|
fixed_start_date: null,
|
|
32
|
-
end_date: null
|
|
33
|
+
end_date: null,
|
|
34
|
+
allow_rollback_after_completion: false)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**achievement_activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
|
|
20
20
|
**achievement_fixed_start_date** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
|
|
21
21
|
**achievement_end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
|
|
22
|
+
**achievement_allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
22
23
|
|
|
23
24
|
## Code Sample
|
|
24
25
|
|
|
@@ -39,7 +40,8 @@ instance = TalonOne::AchievementProgressWithDefinition.new(status: completed,
|
|
|
39
40
|
achievement_recurrence_policy: no_recurrence,
|
|
40
41
|
achievement_activation_policy: fixed_schedule,
|
|
41
42
|
achievement_fixed_start_date: null,
|
|
42
|
-
achievement_end_date: null
|
|
43
|
+
achievement_end_date: null,
|
|
44
|
+
achievement_allow_rollback_after_completion: false)
|
|
43
45
|
```
|
|
44
46
|
|
|
45
47
|
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
17
17
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
18
18
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
19
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
19
20
|
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
|
|
20
21
|
**status** | **String** | The status of the achievement. | [optional]
|
|
21
22
|
**current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
|
|
@@ -37,6 +38,7 @@ instance = TalonOne::AchievementStatusEntry.new(id: 6,
|
|
|
37
38
|
activation_policy: fixed_schedule,
|
|
38
39
|
fixed_start_date: null,
|
|
39
40
|
end_date: null,
|
|
41
|
+
allow_rollback_after_completion: false,
|
|
40
42
|
campaign_id: 1,
|
|
41
43
|
status: active,
|
|
42
44
|
current_progress: null)
|
data/docs/AddLoyaltyPoints.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Name / reason for the point addition. | [optional]
|
|
9
9
|
**validity_duration** | **String** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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
10
|
**valid_until** | **DateTime** | 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, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `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. | [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
12
|
**pending_until** | **DateTime** | 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
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
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]
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# TalonOne::AddedDeductedPointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**profile_integration_id** | **String** | The integration ID of the customer profile to whom points were added or deducted. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added. |
|
|
10
|
+
**amount** | **Float** | The amount of added or deducted loyalty points. |
|
|
11
|
+
**reason** | **String** | The reason for the points addition or deduction. |
|
|
12
|
+
**type_of_change** | **String** | The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: - [The Campaign Manager](/docs/product/getting-started) - [Management API](/management-api#tag/Loyalty) - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) |
|
|
13
|
+
**employee_name** | **String** | The name of the employee who added or deducted points. |
|
|
14
|
+
**user_id** | **Integer** | The ID of the employee who added or deducted points. |
|
|
15
|
+
**operation** | **String** | The action (addition or deduction) made with loyalty points. |
|
|
16
|
+
**start_date** | **DateTime** | The start date for loyalty points. | [optional]
|
|
17
|
+
**expiry_date** | **DateTime** | The expiration date for loyalty points. | [optional]
|
|
18
|
+
**session_integration_id** | **String** | The integration ID of the session through which the points were earned or lost. |
|
|
19
|
+
**notification_type** | **String** | The type of notification. |
|
|
20
|
+
|
|
21
|
+
## Code Sample
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'TalonOne'
|
|
25
|
+
|
|
26
|
+
instance = TalonOne::AddedDeductedPointsNotification.new(profile_integration_id: URNGV8294NV,
|
|
27
|
+
loyalty_program_id: 5,
|
|
28
|
+
subledger_id: sub-123,
|
|
29
|
+
amount: 10.99,
|
|
30
|
+
reason: Compensation,
|
|
31
|
+
type_of_change: null,
|
|
32
|
+
employee_name: Franziska Schneider,
|
|
33
|
+
user_id: 25,
|
|
34
|
+
operation: null,
|
|
35
|
+
start_date: 2023-01-24T14:15:22Z,
|
|
36
|
+
expiry_date: 2024-01-24T14:15:22Z,
|
|
37
|
+
session_integration_id: cc53e4fa-547f-4f5e-8333-76e05c381f67,
|
|
38
|
+
notification_type: null)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
|
data/docs/AnalyticsSKU.md
CHANGED
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** | The ID of the SKU linked to the
|
|
8
|
-
**sku** | **String** | The SKU linked to the
|
|
7
|
+
**id** | **Integer** | The ID of the SKU linked to the Application. |
|
|
8
|
+
**sku** | **String** | The SKU linked to the Application. |
|
|
9
9
|
**last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
|
|
10
|
+
**catalog_id** | **Integer** | The ID of the catalog that contains the SKU. | [optional]
|
|
11
|
+
**product_id** | **Integer** | The ID of the product that the SKU belongs to. | [optional]
|
|
10
12
|
**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
|
11
13
|
|
|
12
14
|
## Code Sample
|
|
@@ -17,6 +19,8 @@ require 'TalonOne'
|
|
|
17
19
|
instance = TalonOne::AnalyticsSKU.new(id: 1,
|
|
18
20
|
sku: SKU-123,
|
|
19
21
|
last_updated: 2024-02-01T00:00Z,
|
|
22
|
+
catalog_id: 1,
|
|
23
|
+
product_id: 1,
|
|
20
24
|
units_sold: null)
|
|
21
25
|
```
|
|
22
26
|
|
data/docs/ApplicationCustomer.md
CHANGED
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
|
12
12
|
**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
|
|
13
13
|
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
|
14
|
-
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED
|
|
14
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional]
|
|
15
15
|
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|
|
16
16
|
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
|
|
17
17
|
**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::AsyncCouponsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**batch_id** | **String** | The ID of the batch to which the coupon belongs. **Note:** The Batch ID is generated when coupons are created. |
|
|
8
|
+
**type_of_change** | **String** | |
|
|
9
|
+
**operation** | **String** | |
|
|
10
|
+
**employee_name** | **String** | |
|
|
11
|
+
**notification_type** | **String** | The type of the notification |
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::AsyncCouponsData.new(batch_id: haanlypn,
|
|
19
|
+
type_of_change: campaign_manager,
|
|
20
|
+
operation: AsyncCouponsCreated,
|
|
21
|
+
employee_name: Franziska Schneider,
|
|
22
|
+
notification_type: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|