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/AudienceCustomer.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,21 @@
|
|
|
1
|
+
# TalonOne::AudienceReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the audience. |
|
|
8
|
+
**integration** | **String** | The third-party integration of the audience. | [optional]
|
|
9
|
+
**integration_id** | **String** | The ID of this audience in the third-party integration. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::AudienceReference.new(id: null,
|
|
17
|
+
integration: null,
|
|
18
|
+
integration_id: 382370BKDB946)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/BaseLoyaltyProgram.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. | [optional]
|
|
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. | [optional]
|
|
12
12
|
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
|
|
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. | [optional]
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::BestPriorPrice
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**sku** | **String** | sku |
|
|
8
|
+
**observed_at** | **DateTime** | The date and time when the best price was observed. |
|
|
9
|
+
**context_id** | **String** | The context ID of the context active at the time of observation. |
|
|
10
|
+
**price** | **Float** | Price of the item. |
|
|
11
|
+
**metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | |
|
|
12
|
+
**target** | [**Object**](.md) | |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::BestPriorPrice.new(sku: NVR-GN-GV-UUP,
|
|
20
|
+
observed_at: 2020-11-10T23:00Z,
|
|
21
|
+
context_id: Summer Sale 2007,
|
|
22
|
+
price: 99.99,
|
|
23
|
+
metadata: null,
|
|
24
|
+
target: null)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::BestPriorPriceMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**influencing_campaign_i_ds** | **Array<Integer>** | | [optional]
|
|
8
|
+
**adjustment_reference_id** | **String** | Identifier related to the `referenceId` used during a `ADD_PRICE_ADJUSTMENT` action using the [Sync cart item catalog endpoint](https://docs.talon.one/integration-api#tag/Catalogs/operation/syncCatalog). | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::BestPriorPriceMetadata.new(influencing_campaign_i_ds: null,
|
|
16
|
+
adjustment_reference_id: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::BestPriorPriceRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**skus** | **Array<String>** | List of product SKUs to check when determining the best prior price. |
|
|
8
|
+
**timeframe_end_date** | **DateTime** | The end date and time that defines the latest time for retrieving historical SKU prices. |
|
|
9
|
+
**timeframe** | **Integer** | The number of days prior to the timeframeEndDate. Only prices within this look back period are considered for the best prior price evaluation. |
|
|
10
|
+
**strict_end_date** | **Boolean** | Indicates whether the timeframe includes the start of the current sale. - When `false`, the timeframe includes the start date of the current sale. - When `true`, the timeframe striclty uses the number of days specified in `timeframe`. |
|
|
11
|
+
**target** | [**BestPriorPriceRequestTarget**](BestPriorPriceRequestTarget.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::BestPriorPriceRequest.new(skus: [comma, period],
|
|
19
|
+
timeframe_end_date: 2020-11-10T23:00Z,
|
|
20
|
+
timeframe: 30,
|
|
21
|
+
strict_end_date: true,
|
|
22
|
+
target: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::BestPriorPriceRequestTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**target_type** | **String** | The type of price target. |
|
|
8
|
+
**audience_id** | **Integer** | The AudienceID of an audience. Must be used with \"AUDIENCE\" target type. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::BestPriorPriceRequestTarget.new(target_type: AUDIENCE,
|
|
16
|
+
audience_id: 4)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignCollectionEditedNotificationItem>**](CampaignCollectionEditedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignCollectionEditedNotification.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = TalonOne::CampaignCollectionEditedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::CampaignCollectionEditedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
10
|
+
**collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::CampaignCollectionEditedNotificationItem.new(event: campaign_state_changed,
|
|
18
|
+
campaign: null,
|
|
19
|
+
ruleset: null,
|
|
20
|
+
collection: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignCreatedNotificationItem>**](CampaignCreatedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignCreatedNotification.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = TalonOne::CampaignCreatedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::CampaignCreatedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
10
|
+
**evaluation_position** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::CampaignCreatedNotificationItem.new(event: campaign_state_changed,
|
|
18
|
+
campaign: null,
|
|
19
|
+
ruleset: null,
|
|
20
|
+
evaluation_position: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -4,16 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignDeletedNotificationItem>**](CampaignDeletedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
9
10
|
|
|
10
11
|
## Code Sample
|
|
11
12
|
|
|
12
13
|
```ruby
|
|
13
14
|
require 'TalonOne'
|
|
14
15
|
|
|
15
|
-
instance = TalonOne::CampaignDeletedNotification.new(
|
|
16
|
-
|
|
16
|
+
instance = TalonOne::CampaignDeletedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignDeletedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**deleted_at** | **DateTime** | Time when the campaign was deleted. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignDeletedNotificationItem.new(event: campaign_state_changed,
|
|
17
|
+
campaign: null,
|
|
18
|
+
deleted_at: 2022-11-10T23:00Z)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignEditedNotificationItem>**](CampaignEditedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignEditedNotification.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = TalonOne::CampaignEditedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::CampaignEditedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**old_campaign** | [**Campaign**](Campaign.md) | |
|
|
10
|
+
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::CampaignEditedNotificationItem.new(event: campaign_state_changed,
|
|
18
|
+
campaign: null,
|
|
19
|
+
old_campaign: null,
|
|
20
|
+
ruleset: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignEvaluationTreeChangedMessage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<ApplicationNotification>**](ApplicationNotification.md) | The array of changes. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignEvaluationTreeChangedMessage.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::CampaignNotificationBase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::CampaignNotificationBase.new(notification_type: CampaignNotification,
|
|
16
|
+
total_result_size: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignNotificationGeneric
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | **Array<Object>** | A list of campaign notification data. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignNotificationGeneric.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::CampaignNotificationItemBase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::CampaignNotificationItemBase.new(event: campaign_state_changed)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -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 5]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignRulesetChangedNotificationItem>**](CampaignRulesetChangedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignRulesetChangedNotification.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = TalonOne::CampaignRulesetChangedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::CampaignRulesetChangedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**old_ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
10
|
+
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::CampaignRulesetChangedNotificationItem.new(event: campaign_state_changed,
|
|
18
|
+
campaign: null,
|
|
19
|
+
old_ruleset: null,
|
|
20
|
+
ruleset: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -4,20 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
7
|
+
**notification_type** | **String** | The type of the notification |
|
|
8
|
+
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
+
**data** | [**Array<CampaignStateChangedNotificationItem>**](CampaignStateChangedNotificationItem.md) | A list of campaign notification data. | [optional]
|
|
11
10
|
|
|
12
11
|
## Code Sample
|
|
13
12
|
|
|
14
13
|
```ruby
|
|
15
14
|
require 'TalonOne'
|
|
16
15
|
|
|
17
|
-
instance = TalonOne::CampaignStateChangedNotification.new(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
ruleset: null)
|
|
16
|
+
instance = TalonOne::CampaignStateChangedNotification.new(notification_type: CampaignNotification,
|
|
17
|
+
total_result_size: null,
|
|
18
|
+
data: null)
|
|
21
19
|
```
|
|
22
20
|
|
|
23
21
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::CampaignStateChangedNotificationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
|
|
8
|
+
**campaign** | [**Campaign**](Campaign.md) | |
|
|
9
|
+
**old_state** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
|
|
10
|
+
**new_state** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
|
|
11
|
+
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::CampaignStateChangedNotificationItem.new(event: campaign_state_changed,
|
|
19
|
+
campaign: null,
|
|
20
|
+
old_state: disabled,
|
|
21
|
+
new_state: running,
|
|
22
|
+
ruleset: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# TalonOne::CardAddedDeductedPointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**profile_integration_i_ds** | **Array<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 or deducted. |
|
|
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
|
+
**card_identifier** | **String** | Loyalty card identification number. |
|
|
21
|
+
**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. |
|
|
22
|
+
|
|
23
|
+
## Code Sample
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'TalonOne'
|
|
27
|
+
|
|
28
|
+
instance = TalonOne::CardAddedDeductedPointsNotification.new(profile_integration_i_ds: [yJSObdNNtOetCHWHPFuz, test-user-4zoj1c],
|
|
29
|
+
loyalty_program_id: 5,
|
|
30
|
+
subledger_id: sub-123,
|
|
31
|
+
amount: 10.99,
|
|
32
|
+
reason: Compensation,
|
|
33
|
+
type_of_change: null,
|
|
34
|
+
employee_name: Franziska Schneider,
|
|
35
|
+
user_id: 25,
|
|
36
|
+
operation: null,
|
|
37
|
+
start_date: 2023-01-24T14:15:22Z,
|
|
38
|
+
expiry_date: 2024-01-24T14:15:22Z,
|
|
39
|
+
session_integration_id: cc53e4fa-547f-4f5e-8333-76e05c381f67,
|
|
40
|
+
notification_type: null,
|
|
41
|
+
card_identifier: 123-456-789ATBC,
|
|
42
|
+
users_per_card_limit: 10)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**triggers** | [**Array<CardExpiringPointsNotificationTrigger>**](CardExpiringPointsNotificationTrigger.md) | |
|
|
9
9
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
10
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
10
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **Integer** | ID of the transaction that adds loyalty points. |
|
|
8
|
+
**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. |
|
|
8
9
|
**created** | **DateTime** | Date and time the loyalty card points were added. |
|
|
9
10
|
**program_id** | **Integer** | ID of the loyalty program. |
|
|
10
11
|
**customer_profile_id** | **String** | Integration ID of the customer profile linked to the card. | [optional]
|
|
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
|
|
|
21
22
|
require 'TalonOne'
|
|
22
23
|
|
|
23
24
|
instance = TalonOne::CardLedgerPointsEntryIntegrationAPI.new(id: 123,
|
|
25
|
+
transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
|
|
24
26
|
created: null,
|
|
25
27
|
program_id: 324,
|
|
26
28
|
customer_profile_id: URNGV8294NV,
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. |
|
|
7
8
|
**created** | **DateTime** | Date and time the loyalty card transaction occurred. |
|
|
8
9
|
**program_id** | **Integer** | ID of the loyalty program. |
|
|
9
10
|
**card_identifier** | **String** | The alphanumeric identifier of the loyalty card. |
|
|
@@ -23,7 +24,8 @@ Name | Type | Description | Notes
|
|
|
23
24
|
```ruby
|
|
24
25
|
require 'TalonOne'
|
|
25
26
|
|
|
26
|
-
instance = TalonOne::CardLedgerTransactionLogEntry.new(
|
|
27
|
+
instance = TalonOne::CardLedgerTransactionLogEntry.new(transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
|
|
28
|
+
created: null,
|
|
27
29
|
program_id: 324,
|
|
28
30
|
card_identifier: summer-loyalty-card-0543,
|
|
29
31
|
application_id: 322,
|