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/NewLoyaltyProgram.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**description** | **String** | Description of our Loyalty Program. | [optional]
|
|
9
9
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
|
|
10
10
|
**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. |
|
|
11
|
-
**default_pending** | **String** | The default duration of the pending time after which points should be valid.
|
|
11
|
+
**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. |
|
|
12
12
|
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |
|
|
13
13
|
**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]
|
|
14
14
|
**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. |
|
data/docs/NewMessageTest.md
CHANGED
|
@@ -4,26 +4,26 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**type** | **String** | The message type. |
|
|
8
|
-
**_query_params** | **Hash<String, String>** | Array of query parameters. | [optional]
|
|
9
7
|
**headers** | **Hash<String, String>** | List of API HTTP headers for the given message. | [optional]
|
|
10
8
|
**verb** | **String** | API method for this message. |
|
|
11
9
|
**url** | **String** | API URL for the given message. |
|
|
12
10
|
**payload** | **String** | API payload of this message. | [optional]
|
|
11
|
+
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. | [optional]
|
|
12
|
+
**application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. | [optional]
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
17
|
require 'TalonOne'
|
|
18
18
|
|
|
19
|
-
instance = TalonOne::NewMessageTest.new(
|
|
20
|
-
_query_params: {"param1":"value1","param2":"value2"},
|
|
21
|
-
headers: {"content-type":"application/json"},
|
|
19
|
+
instance = TalonOne::NewMessageTest.new(headers: {"content-type":"application/json"},
|
|
22
20
|
verb: POST,
|
|
23
21
|
url: www.my-company.com/my-endpoint-name,
|
|
24
22
|
payload: {
|
|
25
23
|
"integrationId": "${$Profile.IntegrationId}"
|
|
26
|
-
}
|
|
24
|
+
},
|
|
25
|
+
params: [],
|
|
26
|
+
application_ids: null)
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
|
data/docs/NewPriceAdjustment.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**calculated_at** | **DateTime** | The time at which this price was calculated. If provided, this is used to determine the most recent price adjustment to choose if price adjustments overlap. Defaults to internal creation time if not provided. | [optional]
|
|
11
11
|
**effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional]
|
|
12
12
|
**effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional]
|
|
13
|
+
**context_id** | **String** | Identifier of the context of this price adjustment (e.g. summer sale). | [optional]
|
|
13
14
|
|
|
14
15
|
## Code Sample
|
|
15
16
|
|
|
@@ -21,7 +22,8 @@ instance = TalonOne::NewPriceAdjustment.new(price_type: member,
|
|
|
21
22
|
reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
|
|
22
23
|
calculated_at: 2021-09-12T10:12:42Z,
|
|
23
24
|
effective_from: 2021-09-12T10:12:42Z,
|
|
24
|
-
effective_until: 2021-09-12T10:12:42Z
|
|
25
|
+
effective_until: 2021-09-12T10:12:42Z,
|
|
26
|
+
context_id: Summer2025)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
|
data/docs/NewPriceType.md
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The API name of the price type. This is an immutable value. |
|
|
8
|
-
**title** | **String** | The
|
|
9
|
-
**description** | **String** |
|
|
10
|
-
**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences
|
|
8
|
+
**title** | **String** | The name displayed in the Campaign Manager for the price type. |
|
|
9
|
+
**description** | **String** | A description of the price type. | [optional]
|
|
10
|
+
**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences targeted by this price type. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ require 'TalonOne'
|
|
|
16
16
|
|
|
17
17
|
instance = TalonOne::NewPriceType.new(name: member,
|
|
18
18
|
title: Member Price,
|
|
19
|
-
description:
|
|
19
|
+
description: The price available exclusively to members.,
|
|
20
20
|
targeted_audiences_ids: [1, 2, 3])
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::NewSecondaryDeployment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The name of the deployment. Used as subdomain, e.g. experimental.your-company.europe-west1.talon.one |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::NewSecondaryDeployment.new(name: experimental)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/NewWebhook.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**payload** | **String** | API payload (supports templating using parameters) for this webhook. | [optional]
|
|
15
15
|
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. |
|
|
16
16
|
**enabled** | **Boolean** | Enables or disables webhook from showing in the Rule Builder. |
|
|
17
|
+
**authentication_id** | **Integer** | The ID of the credential that this webhook is using. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -31,7 +32,8 @@ instance = TalonOne::NewWebhook.new(application_ids: null,
|
|
|
31
32
|
"message": "${message}"
|
|
32
33
|
},
|
|
33
34
|
params: [],
|
|
34
|
-
enabled: true
|
|
35
|
+
enabled: true,
|
|
36
|
+
authentication_id: 1)
|
|
35
37
|
```
|
|
36
38
|
|
|
37
39
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TalonOne::PendingActivePointsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
8
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
9
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose loyalty points are becoming active. |
|
|
10
|
+
**points** | **Float** | The amount of pending loyalty points becoming active. |
|
|
11
|
+
**active_on** | **DateTime** | The date and time the loyalty points become active. | [optional]
|
|
12
|
+
**expire_on** | **DateTime** | The date and time the loyalty points expire. | [optional]
|
|
13
|
+
**session_integration_id** | **String** | The integration ID of the session through which the points were earned. | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'TalonOne'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::PendingActivePointsData.new(loyalty_program_id: 5,
|
|
21
|
+
subledger_id: SL001,
|
|
22
|
+
customer_profile_id: URNGV8294NV,
|
|
23
|
+
points: 10.99,
|
|
24
|
+
active_on: 2023-08-20T12:22+02:00,
|
|
25
|
+
expire_on: 2023-09-01T12:23+02:00,
|
|
26
|
+
session_integration_id: cc53e4fa-547f-4f5e-8333-76e05c381f67)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::PendingActivePointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<PendingActivePointsData>**](PendingActivePointsData.md) | The array of pending points. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::PendingActivePointsNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
data/docs/PriceDetail.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**price** | **Float** | The value of this price type. | [optional]
|
|
8
|
+
**adjustment_context_id** | **String** | The context identifier of the selected price adjustment. | [optional]
|
|
8
9
|
**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. | [optional]
|
|
9
10
|
**adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional]
|
|
10
11
|
**adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional]
|
|
@@ -15,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
15
16
|
require 'TalonOne'
|
|
16
17
|
|
|
17
18
|
instance = TalonOne::PriceDetail.new(price: 90.0,
|
|
19
|
+
adjustment_context_id: summer25,
|
|
18
20
|
adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
|
|
19
21
|
adjustment_effective_from: 2025-05-25T00:00Z,
|
|
20
22
|
adjustment_effective_until: 2025-05-30T00:00Z)
|
data/docs/PriceType.md
CHANGED
|
@@ -8,11 +8,11 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this price type. | [optional]
|
|
10
10
|
**name** | **String** | The API name of the price type. This is an immutable value. |
|
|
11
|
-
**title** | **String** | The
|
|
12
|
-
**description** | **String** |
|
|
11
|
+
**title** | **String** | The name displayed in the Campaign Manager for the price type. |
|
|
12
|
+
**description** | **String** | A description of the price type. | [optional]
|
|
13
13
|
**modified** | **DateTime** | The date and time when the price type was last modified. |
|
|
14
14
|
**subscribed_catalogs_ids** | **Array<Integer>** | A list of the IDs of the catalogs that are subscribed to this price type. |
|
|
15
|
-
**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences
|
|
15
|
+
**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences targeted by this price type. |
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
@@ -24,7 +24,7 @@ instance = TalonOne::PriceType.new(id: 6,
|
|
|
24
24
|
account_id: 1,
|
|
25
25
|
name: member,
|
|
26
26
|
title: Member Price,
|
|
27
|
-
description:
|
|
27
|
+
description: The price available exclusively to members.,
|
|
28
28
|
modified: 2021-09-12T10:12:42Z,
|
|
29
29
|
subscribed_catalogs_ids: [1, 2, 3],
|
|
30
30
|
targeted_audiences_ids: [1, 2, 3])
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::PriceTypeReferenceDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**referencing_type** | **String** | The entity type that references the price type. For example, a campaign or an Application cart item filter. |
|
|
8
|
+
**referencing_id** | **Integer** | The ID of the entity that references the price type. |
|
|
9
|
+
**referencing_name** | **String** | The name of the entity that references the price type. |
|
|
10
|
+
**application_id** | **Integer** | The ID of the Application that contains the entity that references the price type. | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::PriceTypeReferenceDetail.new(referencing_type: null,
|
|
18
|
+
referencing_id: 1,
|
|
19
|
+
referencing_name: Summer promotions,
|
|
20
|
+
application_id: 322)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::PriceTypeReferences
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**price_type_id** | **Integer** | The ID of the price type. |
|
|
8
|
+
**references** | [**Array<PriceTypeReferenceDetail>**](PriceTypeReferenceDetail.md) | A list of entities that reference the price type, including details about the entities. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::PriceTypeReferences.new(price_type_id: 6,
|
|
16
|
+
references: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/RoleV2RolesGroup.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**applications** | [**Hash<String, RoleV2ApplicationDetails>**](RoleV2ApplicationDetails.md) | A map of the link between the Application, campaign, or draft campaign-related permission set and the Application ID the permissions apply to. | [optional]
|
|
8
8
|
**loyalty_programs** | **Hash<String, String>** | A map of the link between the loyalty program-related permission set and the Application ID the permissions apply to. | [optional]
|
|
9
9
|
**campaign_access_groups** | **Hash<String, String>** | A map of the link between the campaign access group-related permission set and the Application ID the permissions apply to. | [optional]
|
|
10
|
+
**account** | **String** | Name of the account-level permission set | [optional]
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
@@ -15,7 +16,8 @@ require 'TalonOne'
|
|
|
15
16
|
|
|
16
17
|
instance = TalonOne::RoleV2RolesGroup.new(applications: {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}},
|
|
17
18
|
loyalty_programs: {10=Loyalty program manager permission set},
|
|
18
|
-
campaign_access_groups: {5=Campaign access group manager permission set}
|
|
19
|
+
campaign_access_groups: {5=Campaign access group manager permission set},
|
|
20
|
+
account: null)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::SecondaryDeployment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
|
|
8
|
+
**name** | **String** | The name of the deployment. Used as subdomain, e.g. experimental.your-company.europe-west1.talon.one |
|
|
9
|
+
**user_id** | **Integer** | The ID of the user who created the deployment. |
|
|
10
|
+
**status** | **String** | The status of the deployment. |
|
|
11
|
+
**created_at** | **DateTime** | Timestamp when the deployment was created. |
|
|
12
|
+
**active_at** | **DateTime** | Timestamp when the deployment became active. | [optional]
|
|
13
|
+
**failed_at** | **DateTime** | Timestamp when the deployment failed. | [optional]
|
|
14
|
+
**deleted_at** | **DateTime** | Timestamp when the deployment was deleted. | [optional]
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::SecondaryDeployment.new(id: 6,
|
|
22
|
+
name: experimental,
|
|
23
|
+
user_id: 4,
|
|
24
|
+
status: active,
|
|
25
|
+
created_at: 2023-01-16T16:00:00.700763Z,
|
|
26
|
+
active_at: 2023-01-17T16:00:00.700763Z,
|
|
27
|
+
failed_at: 2023-01-17T16:00:00.700763Z,
|
|
28
|
+
deleted_at: 2023-01-18T16:00:00.700763Z)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::SetLoyaltyPointsExpiryDateEffectProps
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**program_id** | **Integer** | ID of the loyalty program that contains these points. |
|
|
8
|
+
**sub_ledger_id** | **String** | API name of the loyalty program subledger that contains these points. |
|
|
9
|
+
**new_expiry_date** | **DateTime** | The specified expiry date and time for all active and pending point transactions in the loyalty program subledger. |
|
|
10
|
+
**affected_transactions** | [**Array<LoyaltyLedgerEntryExpiryDateChange>**](LoyaltyLedgerEntryExpiryDateChange.md) | List of transactions affected by the expiry date update. | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::SetLoyaltyPointsExpiryDateEffectProps.new(program_id: null,
|
|
18
|
+
sub_ledger_id: null,
|
|
19
|
+
new_expiry_date: 2024-07-24T14:15:22Z,
|
|
20
|
+
affected_transactions: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**sku** | **String** | The unique SKU of the changed item. |
|
|
10
10
|
**version** | **Integer** | The version of the changed item. |
|
|
11
11
|
**price** | **Float** | The price of the changed item. |
|
|
12
|
+
**prices** | [**Hash<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. | [optional]
|
|
12
13
|
**evaluated_at** | **DateTime** | The evaluation time of the changed item. |
|
|
13
14
|
**effects** | [**Array<StrikethroughEffect>**](StrikethroughEffect.md) | | [optional]
|
|
14
15
|
|
|
@@ -22,6 +23,7 @@ instance = TalonOne::StrikethroughChangedItem.new(id: 1,
|
|
|
22
23
|
sku: SKU1241028,
|
|
23
24
|
version: 6,
|
|
24
25
|
price: 99.99,
|
|
26
|
+
prices: {"member":{"price":90,"adjustmentReferenceId":"68851723-e6fa-488f-ace9-112581e6c19b","adjustmentEffectiveFrom":"2025-05-25T00:00:00Z","adjustmentEffectiveUntil":"2025-05-30T00:00:00Z"},"base":{"price":100}},
|
|
25
27
|
evaluated_at: 2020-06-10T09:05:27.993483Z,
|
|
26
28
|
effects: null)
|
|
27
29
|
```
|
data/docs/StrikethroughEffect.md
CHANGED
|
@@ -12,6 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**props** | [**Object**](.md) | |
|
|
13
13
|
**start_time** | **DateTime** | The start of the time frame where the effect is active in UTC. | [optional]
|
|
14
14
|
**end_time** | **DateTime** | The end of the time frame where the effect is active in UTC. | [optional]
|
|
15
|
+
**selected_price_type** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional]
|
|
16
|
+
**selected_price** | **Float** | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional]
|
|
17
|
+
**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this cart item. | [optional]
|
|
18
|
+
**targets** | **Array<Object>** | A list of entities (e.g. audiences) targeted by this effect. | [optional]
|
|
15
19
|
|
|
16
20
|
## Code Sample
|
|
17
21
|
|
|
@@ -25,7 +29,11 @@ instance = TalonOne::StrikethroughEffect.new(campaign_id: 3,
|
|
|
25
29
|
type: setDiscountPerItem,
|
|
26
30
|
props: null,
|
|
27
31
|
start_time: 2021-07-20T22:00Z,
|
|
28
|
-
end_time: 2021-10-01T02:00Z
|
|
32
|
+
end_time: 2021-10-01T02:00Z,
|
|
33
|
+
selected_price_type: member,
|
|
34
|
+
selected_price: 100.0,
|
|
35
|
+
adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
|
|
36
|
+
targets: null)
|
|
29
37
|
```
|
|
30
38
|
|
|
31
39
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**total_batches** | **Integer** | The total number of batches for the notification. |
|
|
12
12
|
**trigger** | [**StrikethroughTrigger**](StrikethroughTrigger.md) | |
|
|
13
13
|
**changed_items** | [**Array<StrikethroughChangedItem>**](StrikethroughChangedItem.md) | |
|
|
14
|
+
**notification_type** | **String** | The type of the notification |
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = TalonOne::StrikethroughLabelingNotification.new(version: null,
|
|
|
23
24
|
current_batch: 1,
|
|
24
25
|
total_batches: 10,
|
|
25
26
|
trigger: null,
|
|
26
|
-
changed_items: null
|
|
27
|
+
changed_items: null,
|
|
28
|
+
notification_type: null)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::TierDowngradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was downgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. | [optional]
|
|
11
|
+
**current_points** | **Float** | The number of points the customer had at the time of tier downgrade. |
|
|
12
|
+
**old_tier** | **String** | The name of the customer's previous tier. |
|
|
13
|
+
**tier_expiration_date** | **DateTime** | The exact date and time the tier expires. | [optional]
|
|
14
|
+
**timestamp_of_tier_change** | **DateTime** | The exact date and time the tier was changed. |
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::TierDowngradeData.new(customer_profile_id: URNGV8294NV,
|
|
22
|
+
loyalty_program_id: 5,
|
|
23
|
+
subledger_id: SL001,
|
|
24
|
+
current_tier: Silver,
|
|
25
|
+
current_points: 120.55,
|
|
26
|
+
old_tier: Gold,
|
|
27
|
+
tier_expiration_date: 2023-12-01T12:23+02:00,
|
|
28
|
+
timestamp_of_tier_change: 2023-10-26T12:23+02:00)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierDowngradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierDowngradeData>**](TierDowngradeData.md) | The array of tier downgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierDowngradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the notification. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# TalonOne::TierUpgradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was upgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. |
|
|
11
|
+
**current_points** | **Float** | The number of points the customer had at the time of tier upgrade. |
|
|
12
|
+
**old_tier** | **String** | The name of the customer's previous tier. | [optional]
|
|
13
|
+
**points_required_to_the_next_tier** | **Float** | The number of points needed for a customer to reach the next tier. | [optional]
|
|
14
|
+
**next_tier** | **String** | The name of the customer's next tier. | [optional]
|
|
15
|
+
**tier_expiration_date** | **DateTime** | The exact date and time the tier expires. |
|
|
16
|
+
**timestamp_of_tier_change** | **DateTime** | The exact date and time the tier was changed. |
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'TalonOne'
|
|
22
|
+
|
|
23
|
+
instance = TalonOne::TierUpgradeData.new(customer_profile_id: URNGV8294NV,
|
|
24
|
+
loyalty_program_id: 5,
|
|
25
|
+
subledger_id: SL001,
|
|
26
|
+
current_tier: Silver,
|
|
27
|
+
current_points: 120.55,
|
|
28
|
+
old_tier: Bronze,
|
|
29
|
+
points_required_to_the_next_tier: 23.51,
|
|
30
|
+
next_tier: Gold,
|
|
31
|
+
tier_expiration_date: 2023-12-01T12:23+02:00,
|
|
32
|
+
timestamp_of_tier_change: 2023-10-26T12:23+02:00)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierUpgradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierUpgradeData>**](TierUpgradeData.md) | The array of tier upgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierUpgradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::TierWillDowngradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was downgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. |
|
|
11
|
+
**current_points** | **Float** | The number of points the customer will have after the tier downgrade. |
|
|
12
|
+
**points_required_to_remain** | **Float** | The number of points needed for a customer to remain on the same tier. |
|
|
13
|
+
**next_tier** | **String** | The name of the customer's next tier. | [optional]
|
|
14
|
+
**tier_expiration_date** | **DateTime** | The date and time the tier expires. | [optional]
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::TierWillDowngradeData.new(customer_profile_id: URNGV8294NV,
|
|
22
|
+
loyalty_program_id: 5,
|
|
23
|
+
subledger_id: SL001,
|
|
24
|
+
current_tier: Silver,
|
|
25
|
+
current_points: 120.55,
|
|
26
|
+
points_required_to_remain: 23.51,
|
|
27
|
+
next_tier: Bronze,
|
|
28
|
+
tier_expiration_date: 2023-12-01T12:23+02:00)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierWillDowngradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierWillDowngradeData>**](TierWillDowngradeData.md) | The array of upcoming tier downgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierWillDowngradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the notification. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
**triggers** | [**Array<TierWillDowngradeNotificationTrigger>**](TierWillDowngradeNotificationTrigger.md) | |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
data/docs/UpdateAchievement.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::UpdateAchievement.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
|
|