talon_one 9.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 +89 -9
- data/docker-compose.yml +2 -2
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +4 -2
- data/docs/AchievementBase.md +4 -2
- data/docs/AchievementProgressWithDefinition.md +4 -2
- data/docs/AchievementStatusEntry.md +4 -2
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCustomer.md +3 -3
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +3 -3
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BaseNotificationWebhook.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/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeactivationRequest.md +17 -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/CampaignGroup.md +1 -1
- 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/CampaignSet.md +1 -1
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -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/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +4 -2
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +3 -3
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +7 -1
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.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/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +23 -0
- 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/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/Import.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/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +91 -6
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +1819 -339
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +29 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +5 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +25 -0
- data/docs/PriceType.md +33 -0
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TemplateDef.md +1 -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 +4 -2
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/User.md +1 -1
- data/docs/Webhook.md +6 -2
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +5 -1
- data/lib/talon_one/api/integration_api.rb +110 -8
- data/lib/talon_one/api/management_api.rb +1123 -429
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +15 -5
- data/lib/talon_one/models/achievement_base.rb +17 -7
- data/lib/talon_one/models/achievement_progress_with_definition.rb +17 -7
- data/lib/talon_one/models/achievement_status_entry.rb +15 -5
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- 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.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +3 -3
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +3 -3
- 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/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.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/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- 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_collection_without_payload.rb +1 -1
- 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_deactivation_request.rb +214 -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_group.rb +1 -1
- 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_set.rb +1 -1
- 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/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_template.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -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/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- 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 +17 -7
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +3 -3
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.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 +31 -2
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -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/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +255 -0
- 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/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +1 -1
- 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_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- 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_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- 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_card.rb +1 -1
- 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_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- 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 +297 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +29 -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/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +247 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- 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/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- 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/store.rb +1 -1
- 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/template_def.rb +1 -1
- 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 +17 -7
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- 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/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +30 -5
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +27 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +73 -4
- data/spec/api/integration_api_spec.rb +26 -4
- data/spec/api/management_api_spec.rb +179 -51
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +7 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +7 -1
- data/spec/models/achievement_spec.rb +7 -1
- data/spec/models/achievement_status_entry_spec.rb +7 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -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/base_notification_spec.rb +1 -1
- 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/binding_spec.rb +24 -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_deactivation_request_spec.rb +41 -0
- 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_balances_notification_policy_spec.rb +51 -0
- 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/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +7 -1
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -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 +59 -0
- 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_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_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 +77 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +12 -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 +65 -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/price_type_spec.rb +89 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -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 +7 -1
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +12 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +12 -0
- metadata +305 -3
- data/.github/dependabot.yml +0 -10
data/docs/AchievementBase.md
CHANGED
|
@@ -10,10 +10,11 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
|
11
11
|
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
|
12
12
|
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
|
13
|
-
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
|
|
13
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
|
14
14
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
15
15
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
16
16
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
17
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = TalonOne::AchievementBase.new(name: Order50Discount,
|
|
|
29
30
|
recurrence_policy: no_recurrence,
|
|
30
31
|
activation_policy: fixed_schedule,
|
|
31
32
|
fixed_start_date: null,
|
|
32
|
-
end_date: null
|
|
33
|
+
end_date: null,
|
|
34
|
+
allow_rollback_after_completion: false)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -15,10 +15,11 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**description** | **String** | The description of the achievement in the Campaign Manager. |
|
|
16
16
|
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
|
|
17
17
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
|
18
|
-
**achievement_recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. |
|
|
18
|
+
**achievement_recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
|
|
19
19
|
**achievement_activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
|
|
20
20
|
**achievement_fixed_start_date** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
|
|
21
21
|
**achievement_end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
|
|
22
|
+
**achievement_allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
22
23
|
|
|
23
24
|
## Code Sample
|
|
24
25
|
|
|
@@ -39,7 +40,8 @@ instance = TalonOne::AchievementProgressWithDefinition.new(status: completed,
|
|
|
39
40
|
achievement_recurrence_policy: no_recurrence,
|
|
40
41
|
achievement_activation_policy: fixed_schedule,
|
|
41
42
|
achievement_fixed_start_date: null,
|
|
42
|
-
achievement_end_date: null
|
|
43
|
+
achievement_end_date: null,
|
|
44
|
+
achievement_allow_rollback_after_completion: false)
|
|
43
45
|
```
|
|
44
46
|
|
|
45
47
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
|
|
10
10
|
**title** | **String** | The display name for the achievement in the Campaign Manager. |
|
|
@@ -12,10 +12,11 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
|
|
13
13
|
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
|
14
14
|
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
|
15
|
-
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
|
|
15
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
|
16
16
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
17
17
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
18
18
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
19
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
19
20
|
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
|
|
20
21
|
**status** | **String** | The status of the achievement. | [optional]
|
|
21
22
|
**current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
|
|
@@ -37,6 +38,7 @@ instance = TalonOne::AchievementStatusEntry.new(id: 6,
|
|
|
37
38
|
activation_policy: fixed_schedule,
|
|
38
39
|
fixed_start_date: null,
|
|
39
40
|
end_date: null,
|
|
41
|
+
allow_rollback_after_completion: false,
|
|
40
42
|
campaign_id: 1,
|
|
41
43
|
status: active,
|
|
42
44
|
current_progress: null)
|
data/docs/AddLoyaltyPoints.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Name / reason for the point addition. | [optional]
|
|
9
9
|
**validity_duration** | **String** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted. | [optional]
|
|
10
10
|
**valid_until** | **DateTime** | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional]
|
|
11
|
-
**pending_duration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
|
|
11
|
+
**pending_duration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - `on_action` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`, `on_action`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
|
|
12
12
|
**pending_until** | **DateTime** | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional]
|
|
13
13
|
**subledger_id** | **String** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional]
|
|
14
14
|
**application_id** | **Integer** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional]
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AddPriceAdjustmentCatalogAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**sku** | **String** | The SKU of the item for which the price is being adjusted. |
|
|
8
|
+
**adjustments** | [**Array<NewPriceAdjustment>**](NewPriceAdjustment.md) | A list of adjustments to apply to a given item. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AddPriceAdjustmentCatalogAction.new(sku: SKU1241028,
|
|
16
|
+
adjustments: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AddedDeductedPointsBalancesNotificationPolicy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | Notification name. |
|
|
8
|
+
**scopes** | **Array<String>** | |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AddedDeductedPointsBalancesNotificationPolicy.new(name: Christmas Sale,
|
|
16
|
+
scopes: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# TalonOne::AddedDeductedPointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**profile_integration_id** | **String** | The integration ID of the customer profile to whom points were added or deducted. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added. |
|
|
10
|
+
**amount** | **Float** | The amount of added or deducted loyalty points. |
|
|
11
|
+
**reason** | **String** | The reason for the points addition or deduction. |
|
|
12
|
+
**type_of_change** | **String** | The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: - [The Campaign Manager](/docs/product/getting-started) - [Management API](/management-api#tag/Loyalty) - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) |
|
|
13
|
+
**employee_name** | **String** | The name of the employee who added or deducted points. |
|
|
14
|
+
**user_id** | **Integer** | The ID of the employee who added or deducted points. |
|
|
15
|
+
**operation** | **String** | The action (addition or deduction) made with loyalty points. |
|
|
16
|
+
**start_date** | **DateTime** | The start date for loyalty points. | [optional]
|
|
17
|
+
**expiry_date** | **DateTime** | The expiration date for loyalty points. | [optional]
|
|
18
|
+
**session_integration_id** | **String** | The integration ID of the session through which the points were earned or lost. |
|
|
19
|
+
**notification_type** | **String** | The type of notification. |
|
|
20
|
+
|
|
21
|
+
## Code Sample
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'TalonOne'
|
|
25
|
+
|
|
26
|
+
instance = TalonOne::AddedDeductedPointsNotification.new(profile_integration_id: URNGV8294NV,
|
|
27
|
+
loyalty_program_id: 5,
|
|
28
|
+
subledger_id: sub-123,
|
|
29
|
+
amount: 10.99,
|
|
30
|
+
reason: Compensation,
|
|
31
|
+
type_of_change: null,
|
|
32
|
+
employee_name: Franziska Schneider,
|
|
33
|
+
user_id: 25,
|
|
34
|
+
operation: null,
|
|
35
|
+
start_date: 2023-01-24T14:15:22Z,
|
|
36
|
+
expiry_date: 2024-01-24T14:15:22Z,
|
|
37
|
+
session_integration_id: cc53e4fa-547f-4f5e-8333-76e05c381f67,
|
|
38
|
+
notification_type: null)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
|
data/docs/AnalyticsSKU.md
CHANGED
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** | The ID of the SKU linked to the
|
|
8
|
-
**sku** | **String** | The SKU linked to the
|
|
7
|
+
**id** | **Integer** | The ID of the SKU linked to the Application. |
|
|
8
|
+
**sku** | **String** | The SKU linked to the Application. |
|
|
9
9
|
**last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
|
|
10
|
+
**catalog_id** | **Integer** | The ID of the catalog that contains the SKU. | [optional]
|
|
11
|
+
**product_id** | **Integer** | The ID of the product that the SKU belongs to. | [optional]
|
|
10
12
|
**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
|
11
13
|
|
|
12
14
|
## Code Sample
|
|
@@ -17,6 +19,8 @@ require 'TalonOne'
|
|
|
17
19
|
instance = TalonOne::AnalyticsSKU.new(id: 1,
|
|
18
20
|
sku: SKU-123,
|
|
19
21
|
last_updated: 2024-02-01T00:00Z,
|
|
22
|
+
catalog_id: 1,
|
|
23
|
+
product_id: 1,
|
|
20
24
|
units_sold: null)
|
|
21
25
|
```
|
|
22
26
|
|
data/docs/Application.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
data/docs/ApplicationCIF.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**name** | **String** | The name of the Application cart item filter used in API requests. |
|
|
10
10
|
**description** | **String** | A short description of the Application cart item filter. | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional]
|
|
10
10
|
**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
|
data/docs/ApplicationCustomer.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
10
10
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
|
12
|
-
**closed_sessions** | **Integer** | The total
|
|
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]
|
data/docs/ApplicationEvent.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
|
10
10
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
data/docs/ApplicationSession.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
10
10
|
**store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::AsyncCouponsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**batch_id** | **String** | The ID of the batch to which the coupon belongs. **Note:** The Batch ID is generated when coupons are created. |
|
|
8
|
+
**type_of_change** | **String** | |
|
|
9
|
+
**operation** | **String** | |
|
|
10
|
+
**employee_name** | **String** | |
|
|
11
|
+
**notification_type** | **String** | The type of the notification |
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::AsyncCouponsData.new(batch_id: haanlypn,
|
|
19
|
+
type_of_change: campaign_manager,
|
|
20
|
+
operation: AsyncCouponsCreated,
|
|
21
|
+
employee_name: Franziska Schneider,
|
|
22
|
+
notification_type: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
data/docs/Attribute.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
10
10
|
**entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. |
|
data/docs/Audience.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
8
|
-
**id** | **Integer** |
|
|
8
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
9
9
|
**created** | **DateTime** | The time this entity was created. |
|
|
10
10
|
**name** | **String** | The human-friendly display name for this audience. |
|
|
11
11
|
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
|
data/docs/AudienceCustomer.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
10
10
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
|
12
|
-
**closed_sessions** | **Integer** | The total
|
|
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]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**url** | **String** | API URL for the given webhook-based notification. |
|
|
@@ -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
|
+
|
data/docs/Binding.md
CHANGED
|
@@ -8,6 +8,10 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **String** | The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` | [optional]
|
|
9
9
|
**expression** | **Array<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. |
|
|
10
10
|
**value_type** | **String** | Can be one of the following: - `string` - `number` - `boolean` | [optional]
|
|
11
|
+
**min_value** | **Float** | The minimum value allowed for this placeholder. | [optional]
|
|
12
|
+
**max_value** | **Float** | The maximum value allowed for this placeholder. | [optional]
|
|
13
|
+
**attribute_id** | **Integer** | Id of the attribute attached to the placeholder. | [optional]
|
|
14
|
+
**description** | **String** | Describes the placeholder field and value in the template. This description can be used when creating campaigns from this template. | [optional]
|
|
11
15
|
|
|
12
16
|
## Code Sample
|
|
13
17
|
|
|
@@ -17,7 +21,11 @@ require 'TalonOne'
|
|
|
17
21
|
instance = TalonOne::Binding.new(name: my property,
|
|
18
22
|
type: templateParameter,
|
|
19
23
|
expression: [string1, string2],
|
|
20
|
-
value_type: string
|
|
24
|
+
value_type: string,
|
|
25
|
+
min_value: 0.0,
|
|
26
|
+
max_value: 19.9,
|
|
27
|
+
attribute_id: 100,
|
|
28
|
+
description: This is a template parameter of type `number`.)
|
|
21
29
|
```
|
|
22
30
|
|
|
23
31
|
|
data/docs/CampaignCollection.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
@@ -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,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
@@ -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
|
|