talon_one 2.5.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +164 -56
- data/docs/AcceptCouponEffectProps.md +1 -1
- data/docs/AcceptReferralEffectProps.md +1 -1
- data/docs/AccessLogEntry.md +15 -10
- data/docs/Account.md +6 -6
- data/docs/AccountAdditionalCost.md +10 -10
- data/docs/AccountAnalytics.md +19 -19
- data/docs/AccountDashboardStatistic.md +27 -0
- data/docs/AccountDashboardStatisticApiCalls.md +19 -0
- data/docs/AccountDashboardStatisticCampaigns.md +19 -0
- data/docs/AccountDashboardStatisticDiscount.md +21 -0
- data/docs/AccountDashboardStatisticLoyaltyPoints.md +19 -0
- data/docs/AccountDashboardStatisticReferrals.md +19 -0
- data/docs/AccountDashboardStatisticRevenue.md +21 -0
- data/docs/AccountLimits.md +12 -12
- data/docs/AddFreeItemEffectProps.md +2 -2
- data/docs/AddItemCatalogAction.md +23 -0
- data/docs/AddLoyaltyPoints.md +31 -0
- data/docs/AddLoyaltyPointsEffectProps.md +8 -4
- data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/Application.md +13 -13
- data/docs/ApplicationAPIKey.md +7 -7
- data/docs/ApplicationApiHealth.md +2 -2
- data/docs/ApplicationCampaignStats.md +6 -6
- data/docs/ApplicationCustomer.md +9 -7
- data/docs/ApplicationEvent.md +3 -3
- data/docs/ApplicationReferee.md +4 -4
- data/docs/ApplicationSession.md +5 -5
- data/docs/ApplicationSessionEntity.md +1 -1
- data/docs/Attribute.md +17 -13
- data/docs/Audience.md +14 -6
- data/docs/AudienceAnalytics.md +19 -0
- data/docs/AudienceCustomer.md +41 -0
- data/docs/AudienceIntegrationID.md +17 -0
- data/docs/AudienceMembership.md +2 -2
- data/docs/AwardGiveawayEffectProps.md +5 -5
- data/docs/BaseLoyaltyProgram.md +7 -5
- data/docs/BaseNotification.md +21 -0
- data/docs/BaseNotificationEntity.md +17 -0
- data/docs/BaseNotificationWebhook.md +25 -0
- data/docs/BaseNotifications.md +17 -0
- data/docs/BaseSamlConnection.md +1 -1
- data/docs/BulkApplicationNotification.md +1 -1
- data/docs/BulkCampaignNotification.md +1 -1
- data/docs/Campaign.md +27 -25
- data/docs/CampaignActivationRequest.md +17 -0
- data/docs/CampaignAnalytics.md +8 -8
- data/docs/CampaignCollection.md +3 -3
- data/docs/CampaignCollectionWithoutPayload.md +3 -3
- data/docs/CampaignCopy.md +8 -8
- data/docs/CampaignCreatedNotification.md +5 -1
- data/docs/CampaignDeletedNotification.md +3 -1
- data/docs/CampaignEditedNotification.md +3 -1
- data/docs/CampaignGroup.md +8 -8
- data/docs/CampaignNotification.md +1 -1
- data/docs/CampaignPrioritiesChangedNotification.md +4 -4
- data/docs/CampaignRulesetChangedNotification.md +1 -1
- data/docs/CampaignSearch.md +1 -1
- data/docs/CampaignSet.md +7 -5
- data/docs/CampaignSetBranchNode.md +6 -6
- data/docs/CampaignSetIDs.md +1 -1
- data/docs/CampaignSetLeafNode.md +1 -1
- data/docs/CampaignSetNode.md +1 -1
- data/docs/CampaignSetV2.md +4 -4
- data/docs/CampaignStateChangedNotification.md +4 -2
- data/docs/CampaignTemplate.md +23 -21
- data/docs/CampaignTemplateParams.md +5 -3
- data/docs/CardLedgerTransactionLogEntry.md +41 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
- data/docs/CartItem.md +15 -13
- data/docs/Catalog.md +8 -8
- data/docs/CatalogAction.md +19 -0
- data/docs/CatalogActionFilter.md +21 -0
- data/docs/CatalogItem.md +29 -0
- data/docs/CatalogSyncRequest.md +19 -0
- data/docs/CatalogsStrikethroughNotificationPolicy.md +17 -0
- data/docs/Change.md +10 -8
- data/docs/ChangeProfilePassword.md +2 -2
- data/docs/CodeGeneratorSettings.md +2 -2
- data/docs/Collection.md +3 -3
- data/docs/CollectionItem.md +17 -0
- data/docs/CollectionWithoutPayload.md +3 -3
- data/docs/Coupon.md +18 -12
- data/docs/CouponConstraints.md +6 -4
- data/docs/CouponCreatedEffectProps.md +2 -2
- data/docs/CouponCreationJob.md +16 -14
- data/docs/CouponReservations.md +2 -2
- data/docs/CouponSearch.md +1 -1
- data/docs/CouponsNotificationPolicy.md +19 -0
- data/docs/CreateApplicationAPIKey.md +2 -2
- data/docs/CreateManagementKey.md +23 -0
- data/docs/CreateTemplateCampaign.md +2 -0
- data/docs/CustomEffect.md +8 -6
- data/docs/CustomEffectProps.md +11 -3
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerAnalytics.md +7 -7
- data/docs/CustomerProfile.md +10 -8
- data/docs/CustomerProfileIntegrationRequestV2.md +4 -2
- data/docs/CustomerProfileUpdateV2Response.md +17 -0
- data/docs/CustomerSession.md +10 -10
- data/docs/CustomerSessionV2.md +17 -15
- data/docs/DeductLoyaltyPoints.md +23 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +7 -7
- data/docs/Effect.md +9 -7
- data/docs/EffectEntity.md +9 -7
- data/docs/Endpoint.md +17 -0
- data/docs/Entity.md +2 -2
- data/docs/EntityWithTalangVisibleID.md +2 -2
- data/docs/Environment.md +3 -3
- data/docs/ErrorSource.md +1 -1
- data/docs/EvaluableCampaignIds.md +17 -0
- data/docs/Event.md +6 -6
- data/docs/EventType.md +8 -8
- data/docs/EventV2.md +6 -4
- data/docs/ExpiringPointsNotificationPolicy.md +19 -0
- data/docs/ExpiringPointsNotificationTrigger.md +19 -0
- data/docs/Export.md +5 -5
- data/docs/FeatureFlag.md +7 -7
- data/docs/FeedNotification.md +6 -6
- data/docs/FrontendState.md +16 -0
- data/docs/Giveaway.md +10 -6
- data/docs/GiveawaysPool.md +8 -6
- data/docs/Import.md +4 -4
- data/docs/ImportEntity.md +1 -1
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +3 -5
- data/docs/InlineResponse20014.md +4 -2
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +4 -2
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +2 -2
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse20020.md +4 -4
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +5 -3
- data/docs/InlineResponse20023.md +3 -3
- data/docs/InlineResponse20024.md +3 -3
- data/docs/InlineResponse20025.md +3 -3
- data/docs/InlineResponse20026.md +3 -3
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +5 -3
- data/docs/InlineResponse20029.md +4 -4
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse20030.md +2 -2
- data/docs/InlineResponse20031.md +2 -2
- data/docs/InlineResponse20032.md +19 -0
- data/docs/InlineResponse20033.md +19 -0
- data/docs/InlineResponse20034.md +19 -0
- data/docs/InlineResponse20035.md +19 -0
- data/docs/InlineResponse20036.md +19 -0
- data/docs/InlineResponse20037.md +21 -0
- data/docs/InlineResponse20038.md +19 -0
- data/docs/InlineResponse20039.md +19 -0
- data/docs/InlineResponse2004.md +2 -2
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +3 -5
- data/docs/InlineResponse2009.md +3 -5
- data/docs/InlineResponse201.md +1 -1
- data/docs/IntegrationApi.md +516 -87
- data/docs/IntegrationCoupon.md +59 -0
- data/docs/IntegrationCustomerSessionResponse.md +3 -1
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +2 -2
- data/docs/IntegrationEventV2Request.md +6 -4
- data/docs/IntegrationProfileEntity.md +1 -1
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +2 -2
- data/docs/InventoryCoupon.md +18 -12
- data/docs/InventoryReferral.md +6 -6
- data/docs/ItemAttribute.md +21 -0
- data/docs/LedgerEntry.md +12 -12
- data/docs/LedgerInfo.md +12 -12
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
- data/docs/LimitCounter.md +9 -9
- data/docs/LoyaltyBalance.md +23 -0
- data/docs/LoyaltyBalances.md +19 -0
- data/docs/LoyaltyCard.md +13 -9
- data/docs/LoyaltyCardProfileRegistration.md +3 -3
- data/docs/LoyaltyCardRegistration.md +1 -1
- data/docs/LoyaltyDashboardData.md +6 -6
- data/docs/LoyaltyDashboardPointsBreakdown.md +2 -2
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +17 -15
- data/docs/LoyaltyLedgerTransactions.md +19 -0
- data/docs/LoyaltyProgram.md +8 -6
- data/docs/LoyaltyProgramBalance.md +11 -9
- data/docs/LoyaltyProgramLedgers.md +4 -4
- data/docs/LoyaltyProgramTransaction.md +49 -0
- data/docs/LoyaltyStatistics.md +6 -6
- data/docs/LoyaltySubLedger.md +1 -1
- data/docs/LoyaltyTier.md +3 -3
- data/docs/ManagementApi.md +2620 -735
- data/docs/ManagementKey.md +31 -0
- data/docs/ModelReturn.md +3 -3
- data/docs/MultipleAudiences.md +19 -0
- data/docs/MultipleAudiencesItem.md +25 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +2 -2
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/MultipleNewAudiences.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAdditionalCost.md +8 -8
- data/docs/NewApplication.md +10 -10
- data/docs/NewApplicationAPIKey.md +8 -8
- data/docs/NewAttribute.md +15 -11
- data/docs/NewAudience.md +12 -4
- data/docs/NewBaseNotification.md +19 -0
- data/docs/NewCampaign.md +6 -6
- data/docs/NewCampaignGroup.md +5 -5
- data/docs/NewCampaignSet.md +2 -2
- data/docs/NewCampaignSetV2.md +2 -2
- data/docs/NewCampaignTemplate.md +7 -5
- data/docs/NewCatalog.md +5 -5
- data/docs/NewCouponCreationJob.md +8 -6
- data/docs/NewCoupons.md +14 -10
- data/docs/NewCouponsForMultipleRecipients.md +12 -10
- data/docs/NewCustomEffect.md +3 -1
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +6 -6
- data/docs/NewCustomerSessionV2.md +7 -5
- data/docs/NewEvent.md +2 -2
- data/docs/NewEventType.md +6 -6
- data/docs/NewGiveawaysPool.md +6 -4
- data/docs/NewInternalAudience.md +21 -0
- data/docs/NewInvitation.md +4 -4
- data/docs/NewLoyaltyProgram.md +7 -5
- data/docs/NewLoyaltyTier.md +1 -1
- data/docs/NewManagementKey.md +33 -0
- data/docs/NewMultipleAudiencesItem.md +19 -0
- data/docs/NewNotificationWebhook.md +4 -4
- data/docs/NewPassword.md +2 -2
- data/docs/NewPicklist.md +19 -0
- data/docs/NewReferral.md +3 -3
- data/docs/NewReferralsForMultipleAdvocates.md +4 -4
- data/docs/NewReturn.md +1 -1
- data/docs/NewRole.md +8 -8
- data/docs/NewRuleset.md +3 -1
- data/docs/NewSamlConnection.md +1 -1
- data/docs/NewWebhook.md +16 -14
- data/docs/Notification.md +3 -3
- data/docs/NotificationWebhook.md +7 -7
- data/docs/OutgoingIntegrationBrazePolicy.md +19 -0
- data/docs/OutgoingIntegrationConfiguration.md +21 -0
- data/docs/OutgoingIntegrationType.md +25 -0
- data/docs/OutgoingIntegrationTypes.md +17 -0
- data/docs/OutgoingIntegrationWebhookTemplate.md +27 -0
- data/docs/OutgoingIntegrationWebhookTemplates.md +17 -0
- data/docs/PatchItemCatalogAction.md +23 -0
- data/docs/PatchManyItemsCatalogAction.md +21 -0
- data/docs/Picklist.md +31 -0
- data/docs/PriorityPosition.md +19 -0
- data/docs/ProfileAudiencesChanges.md +2 -2
- data/docs/RedeemReferralEffectProps.md +2 -2
- data/docs/Referral.md +6 -6
- data/docs/ReferralConstraints.md +1 -1
- data/docs/ReferralCreatedEffectProps.md +1 -1
- data/docs/ReferralRejectionReason.md +1 -1
- data/docs/RejectCouponEffectProps.md +5 -5
- data/docs/RejectReferralEffectProps.md +5 -5
- data/docs/RemoveItemCatalogAction.md +17 -0
- data/docs/RemoveManyItemsCatalogAction.md +17 -0
- data/docs/ReserveCouponEffectProps.md +21 -0
- data/docs/ReturnIntegrationRequest.md +1 -1
- data/docs/ReturnedCartItem.md +1 -1
- data/docs/Role.md +13 -13
- data/docs/RoleAssign.md +4 -4
- data/docs/RoleMembership.md +2 -2
- data/docs/RoleV2.md +25 -0
- data/docs/RoleV2ApplicationDetails.md +21 -0
- data/docs/RoleV2PermissionSet.md +19 -0
- data/docs/RoleV2Permissions.md +19 -0
- data/docs/RoleV2PermissionsRoles.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +8 -8
- data/docs/RollbackCouponEffectProps.md +1 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +10 -10
- data/docs/RollbackDiscountEffectProps.md +3 -3
- data/docs/RollbackReferralEffectProps.md +1 -1
- data/docs/Rule.md +5 -1
- data/docs/RuleFailureReason.md +12 -12
- data/docs/Ruleset.md +7 -5
- data/docs/SamlConnection.md +3 -3
- data/docs/Session.md +2 -2
- data/docs/SetDiscountEffectProps.md +4 -4
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +5 -5
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +5 -5
- data/docs/SetDiscountPerItemEffectProps.md +9 -5
- data/docs/ShowBundleMetadataEffectProps.md +3 -3
- data/docs/ShowNotificationEffectProps.md +3 -3
- data/docs/StrikethroughChangedItem.md +29 -0
- data/docs/StrikethroughEffect.md +27 -0
- data/docs/StrikethroughLabelingNotification.md +25 -0
- data/docs/StrikethroughSetDiscountPerItemEffectProps.md +19 -0
- data/docs/StrikethroughTrigger.md +25 -0
- data/docs/TalangAttribute.md +33 -0
- data/docs/TalangAttributeVisibility.md +19 -0
- data/docs/TemplateArgDef.md +5 -1
- data/docs/TemplateDef.md +2 -2
- data/docs/Tier.md +2 -2
- data/docs/TransferLoyaltyCard.md +17 -0
- data/docs/TriggerWebhookEffectProps.md +2 -2
- data/docs/UpdateAccount.md +2 -2
- data/docs/UpdateApplication.md +9 -9
- data/docs/UpdateAttributeEffectProps.md +2 -2
- data/docs/UpdateAudience.md +1 -1
- data/docs/UpdateCampaign.md +12 -12
- data/docs/UpdateCampaignGroup.md +5 -5
- data/docs/UpdateCampaignTemplate.md +16 -14
- data/docs/UpdateCatalog.md +2 -2
- data/docs/UpdateCoupon.md +12 -8
- data/docs/UpdateCouponBatch.md +7 -5
- data/docs/UpdateCustomEffect.md +3 -1
- data/docs/UpdateLoyaltyCard.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +7 -5
- data/docs/UpdatePicklist.md +19 -0
- data/docs/UpdateReferral.md +3 -3
- data/docs/UpdateReferralBatch.md +2 -2
- data/docs/UpdateRole.md +8 -8
- data/docs/UpdateUser.md +7 -7
- data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
- data/docs/User.md +5 -5
- data/docs/UserEntity.md +2 -2
- data/docs/UserFeedNotifications.md +2 -2
- data/docs/Webhook.md +19 -17
- data/docs/WebhookActivationLogEntry.md +9 -9
- data/docs/WebhookLogEntry.md +18 -15
- data/docs/WillAwardGiveawayEffectProps.md +3 -3
- data/lib/talon_one/api/integration_api.rb +640 -99
- data/lib/talon_one/api/management_api.rb +2413 -780
- data/lib/talon_one/api_client.rb +2 -2
- data/lib/talon_one/api_error.rb +2 -2
- data/lib/talon_one/configuration.rb +12 -5
- data/lib/talon_one/models/accept_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/accept_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/access_log_entry.rb +6 -6
- data/lib/talon_one/models/account.rb +8 -8
- data/lib/talon_one/models/account_additional_cost.rb +7 -7
- data/lib/talon_one/models/account_analytics.rb +21 -21
- data/lib/talon_one/models/account_dashboard_statistic.rb +271 -0
- data/lib/talon_one/models/account_dashboard_statistic_api_calls.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_discount.rb +242 -0
- data/lib/talon_one/models/account_dashboard_statistic_loyalty_points.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_referrals.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_revenue.rb +242 -0
- data/lib/talon_one/models/account_entity.rb +2 -2
- data/lib/talon_one/models/account_limits.rb +14 -14
- data/lib/talon_one/models/add_free_item_effect_props.rb +4 -4
- data/lib/talon_one/models/add_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/add_loyalty_points.rb +311 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +43 -8
- data/lib/talon_one/models/added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/additional_cost.rb +2 -2
- data/lib/talon_one/models/api_error.rb +2 -2
- data/lib/talon_one/models/application.rb +7 -7
- data/lib/talon_one/models/application_api_health.rb +5 -5
- data/lib/talon_one/models/application_api_key.rb +11 -11
- data/lib/talon_one/models/application_campaign_stats.rb +9 -9
- data/lib/talon_one/models/application_customer.rb +20 -10
- data/lib/talon_one/models/application_customer_entity.rb +2 -2
- data/lib/talon_one/models/application_entity.rb +2 -2
- data/lib/talon_one/models/application_event.rb +5 -5
- data/lib/talon_one/models/application_notification.rb +2 -2
- data/lib/talon_one/models/application_referee.rb +6 -6
- data/lib/talon_one/models/application_session.rb +7 -7
- data/lib/talon_one/models/application_session_entity.rb +2 -2
- data/lib/talon_one/models/async_coupon_creation_response.rb +2 -2
- data/lib/talon_one/models/attribute.rb +30 -6
- data/lib/talon_one/models/attributes_mandatory.rb +2 -2
- data/lib/talon_one/models/attributes_settings.rb +2 -2
- data/lib/talon_one/models/audience.rb +50 -10
- data/lib/talon_one/models/audience_analytics.rb +218 -0
- data/lib/talon_one/models/audience_customer.rb +395 -0
- data/lib/talon_one/models/{loyalty_projection_data.rb → audience_integration_id.rb} +33 -59
- data/lib/talon_one/models/audience_membership.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/models/base_loyalty_program.rb +19 -9
- data/lib/talon_one/models/base_notification.rb +260 -0
- data/lib/talon_one/models/base_notification_entity.rb +211 -0
- data/lib/talon_one/models/base_notification_webhook.rb +275 -0
- data/lib/talon_one/models/base_notifications.rb +209 -0
- data/lib/talon_one/models/base_saml_connection.rb +2 -2
- data/lib/talon_one/models/binding.rb +2 -2
- data/lib/talon_one/models/bulk_application_notification.rb +2 -2
- data/lib/talon_one/models/bulk_campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign.rb +18 -8
- data/lib/talon_one/models/campaign_activation_request.rb +214 -0
- data/lib/talon_one/models/campaign_analytics.rb +2 -2
- data/lib/talon_one/models/campaign_collection.rb +5 -5
- data/lib/talon_one/models/campaign_collection_without_payload.rb +5 -5
- data/lib/talon_one/models/campaign_copy.rb +4 -4
- data/lib/talon_one/models/campaign_created_notification.rb +29 -6
- data/lib/talon_one/models/campaign_deleted_notification.rb +21 -6
- data/lib/talon_one/models/campaign_edited_notification.rb +15 -6
- data/lib/talon_one/models/campaign_entity.rb +2 -2
- data/lib/talon_one/models/campaign_group.rb +7 -7
- data/lib/talon_one/models/campaign_group_entity.rb +2 -2
- data/lib/talon_one/models/campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +17 -22
- data/lib/talon_one/models/campaign_priorities_v2.rb +2 -2
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +2 -7
- data/lib/talon_one/models/campaign_search.rb +3 -3
- data/lib/talon_one/models/campaign_set.rb +19 -9
- data/lib/talon_one/models/campaign_set_branch_node.rb +5 -5
- data/lib/talon_one/models/campaign_set_i_ds.rb +2 -2
- data/lib/talon_one/models/campaign_set_leaf_node.rb +3 -3
- data/lib/talon_one/models/campaign_set_node.rb +2 -2
- data/lib/talon_one/models/campaign_set_v2.rb +5 -5
- data/lib/talon_one/models/campaign_state_changed_notification.rb +15 -6
- data/lib/talon_one/models/campaign_template.rb +25 -15
- data/lib/talon_one/models/campaign_template_collection.rb +2 -2
- data/lib/talon_one/models/campaign_template_params.rb +16 -6
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +508 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +508 -0
- data/lib/talon_one/models/cart_item.rb +28 -47
- data/lib/talon_one/models/catalog.rb +7 -7
- data/lib/talon_one/models/catalog_action.rb +261 -0
- data/lib/talon_one/models/catalog_action_filter.rb +277 -0
- data/lib/talon_one/models/catalog_item.rb +313 -0
- data/lib/talon_one/models/catalog_sync_request.rb +238 -0
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +231 -0
- data/lib/talon_one/models/change.rb +20 -10
- data/lib/talon_one/models/change_profile_password.rb +2 -2
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +5 -5
- data/lib/talon_one/models/collection_item.rb +212 -0
- data/lib/talon_one/models/collection_without_payload.rb +5 -5
- data/lib/talon_one/models/coupon.rb +68 -12
- data/lib/talon_one/models/coupon_constraints.rb +39 -5
- data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
- data/lib/talon_one/models/coupon_creation_job.rb +58 -15
- data/lib/talon_one/models/coupon_limit_configs.rb +2 -2
- data/lib/talon_one/models/coupon_rejection_reason.rb +4 -4
- data/lib/talon_one/models/coupon_reservations.rb +3 -3
- data/lib/talon_one/models/coupon_search.rb +3 -3
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
- data/lib/talon_one/models/create_application_api_key.rb +6 -6
- data/lib/talon_one/models/create_management_key.rb +256 -0
- data/lib/talon_one/models/create_template_campaign.rb +15 -3
- data/lib/talon_one/models/create_template_campaign_response.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +17 -7
- data/lib/talon_one/models/custom_effect_props.rb +44 -4
- data/lib/talon_one/models/customer_activity_report.rb +5 -5
- data/lib/talon_one/models/customer_analytics.rb +10 -10
- data/lib/talon_one/models/customer_inventory.rb +2 -2
- data/lib/talon_one/models/customer_profile.rb +23 -13
- data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +2 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
- data/lib/talon_one/models/customer_session.rb +8 -8
- data/lib/talon_one/models/customer_session_v2.rb +27 -15
- data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +23 -33
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/effect.rb +20 -9
- data/lib/talon_one/models/effect_entity.rb +23 -13
- data/lib/talon_one/models/email_entity.rb +2 -2
- data/lib/talon_one/models/endpoint.rb +212 -0
- data/lib/talon_one/models/entity.rb +4 -4
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +2 -2
- data/lib/talon_one/models/environment.rb +5 -5
- data/lib/talon_one/models/error_effect_props.rb +2 -2
- data/lib/talon_one/models/error_response.rb +2 -2
- data/lib/talon_one/models/error_response_with_status.rb +2 -2
- data/lib/talon_one/models/error_source.rb +3 -3
- data/lib/talon_one/models/evaluable_campaign_ids.rb +209 -0
- data/lib/talon_one/models/event.rb +6 -6
- data/lib/talon_one/models/event_type.rb +7 -7
- data/lib/talon_one/models/event_v2.rb +18 -6
- data/lib/talon_one/models/expiring_points_notification_policy.rb +247 -0
- data/lib/talon_one/models/expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/export.rb +6 -6
- data/lib/talon_one/models/feature_flag.rb +6 -6
- data/lib/talon_one/models/features_feed.rb +2 -2
- data/lib/talon_one/models/feed_notification.rb +9 -9
- data/lib/talon_one/models/frontend_state.rb +39 -0
- data/lib/talon_one/models/func_arg_def.rb +4 -4
- data/lib/talon_one/models/function_def.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +28 -8
- data/lib/talon_one/models/giveaways_pool.rb +22 -7
- data/lib/talon_one/models/import.rb +5 -5
- data/lib/talon_one/models/import_entity.rb +2 -2
- data/lib/talon_one/models/inline_response200.rb +2 -2
- data/lib/talon_one/models/inline_response2001.rb +13 -13
- data/lib/talon_one/models/inline_response20010.rb +13 -13
- data/lib/talon_one/models/inline_response20011.rb +13 -13
- data/lib/talon_one/models/inline_response20012.rb +13 -13
- data/lib/talon_one/models/inline_response20013.rb +11 -13
- data/lib/talon_one/models/inline_response20014.rb +13 -9
- data/lib/talon_one/models/inline_response20015.rb +3 -3
- data/lib/talon_one/models/inline_response20016.rb +13 -9
- data/lib/talon_one/models/inline_response20017.rb +8 -3
- data/lib/talon_one/models/inline_response20018.rb +13 -13
- data/lib/talon_one/models/inline_response20019.rb +3 -3
- data/lib/talon_one/models/inline_response2002.rb +3 -3
- data/lib/talon_one/models/inline_response20020.rb +13 -13
- data/lib/talon_one/models/inline_response20021.rb +3 -13
- data/lib/talon_one/models/inline_response20022.rb +13 -9
- data/lib/talon_one/models/inline_response20023.rb +13 -13
- data/lib/talon_one/models/inline_response20024.rb +13 -13
- data/lib/talon_one/models/inline_response20025.rb +10 -15
- data/lib/talon_one/models/inline_response20026.rb +13 -13
- data/lib/talon_one/models/inline_response20027.rb +3 -3
- data/lib/talon_one/models/inline_response20028.rb +13 -9
- data/lib/talon_one/models/inline_response20029.rb +13 -13
- data/lib/talon_one/models/inline_response2003.rb +3 -3
- data/lib/talon_one/models/inline_response20030.rb +3 -3
- data/lib/talon_one/models/inline_response20031.rb +3 -3
- data/lib/talon_one/models/inline_response20032.rb +227 -0
- data/lib/talon_one/models/inline_response20033.rb +227 -0
- data/lib/talon_one/models/inline_response20034.rb +227 -0
- data/lib/talon_one/models/inline_response20035.rb +227 -0
- data/lib/talon_one/models/inline_response20036.rb +227 -0
- data/lib/talon_one/models/inline_response20037.rb +231 -0
- data/lib/talon_one/models/inline_response20038.rb +227 -0
- data/lib/talon_one/models/inline_response20039.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +3 -3
- data/lib/talon_one/models/inline_response2005.rb +13 -13
- data/lib/talon_one/models/inline_response2006.rb +13 -13
- data/lib/talon_one/models/inline_response2007.rb +13 -13
- data/lib/talon_one/models/inline_response2008.rb +9 -13
- data/lib/talon_one/models/inline_response2009.rb +9 -13
- data/lib/talon_one/models/inline_response201.rb +2 -2
- data/lib/talon_one/models/integration_coupon.rb +569 -0
- data/lib/talon_one/models/integration_customer_session_response.rb +17 -6
- data/lib/talon_one/models/integration_entity.rb +4 -4
- data/lib/talon_one/models/integration_event.rb +3 -3
- data/lib/talon_one/models/integration_event_v2_request.rb +18 -6
- data/lib/talon_one/models/integration_profile_entity.rb +3 -3
- data/lib/talon_one/models/integration_request.rb +3 -3
- data/lib/talon_one/models/integration_state.rb +2 -2
- data/lib/talon_one/models/integration_state_v2.rb +5 -4
- data/lib/talon_one/models/inventory_coupon.rb +65 -9
- data/lib/talon_one/models/inventory_referral.rb +6 -6
- data/lib/talon_one/models/item_attribute.rb +243 -0
- data/lib/talon_one/models/ledger_entry.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +21 -20
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +474 -0
- data/lib/talon_one/models/library_attribute.rb +2 -2
- data/lib/talon_one/models/limit_config.rb +2 -2
- data/lib/talon_one/models/limit_counter.rb +4 -4
- data/lib/talon_one/models/login_params.rb +2 -2
- data/lib/talon_one/models/loyalty.rb +2 -2
- data/lib/talon_one/models/loyalty_balance.rb +238 -0
- data/lib/talon_one/models/loyalty_balances.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +81 -12
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +4 -4
- data/lib/talon_one/models/loyalty_card_registration.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_data.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger_entry.rb +18 -8
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +220 -0
- data/lib/talon_one/models/loyalty_membership.rb +2 -2
- data/lib/talon_one/models/loyalty_program.rb +23 -8
- data/lib/talon_one/models/loyalty_program_balance.rb +21 -11
- data/lib/talon_one/models/loyalty_program_entity.rb +2 -2
- data/lib/talon_one/models/loyalty_program_ledgers.rb +6 -6
- data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
- data/lib/talon_one/models/loyalty_statistics.rb +2 -2
- data/lib/talon_one/models/loyalty_sub_ledger.rb +3 -3
- data/lib/talon_one/models/loyalty_tier.rb +5 -5
- data/lib/talon_one/models/management_key.rb +317 -0
- data/lib/talon_one/models/manager_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +2 -2
- data/lib/talon_one/models/model_return.rb +5 -5
- data/lib/talon_one/models/multi_application_entity.rb +2 -2
- data/lib/talon_one/models/multiple_attribute.rb +2 -2
- data/lib/talon_one/models/{loyalty_projection.rb → multiple_audiences.rb} +27 -38
- data/lib/talon_one/models/multiple_audiences_item.rb +354 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +2 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +4 -4
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
- data/lib/talon_one/models/multiple_new_attribute.rb +2 -2
- data/lib/talon_one/models/multiple_new_audiences.rb +213 -0
- data/lib/talon_one/models/mutable_entity.rb +3 -3
- data/lib/talon_one/models/new_account.rb +2 -2
- data/lib/talon_one/models/new_account_sign_up.rb +2 -2
- data/lib/talon_one/models/new_additional_cost.rb +5 -5
- data/lib/talon_one/models/new_application.rb +4 -4
- data/lib/talon_one/models/new_application_api_key.rb +12 -12
- data/lib/talon_one/models/new_attribute.rb +31 -7
- data/lib/talon_one/models/new_audience.rb +49 -8
- data/lib/talon_one/models/new_base_notification.rb +226 -0
- data/lib/talon_one/models/new_campaign.rb +6 -6
- data/lib/talon_one/models/new_campaign_collection.rb +2 -2
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_set.rb +3 -3
- data/lib/talon_one/models/new_campaign_set_v2.rb +3 -3
- data/lib/talon_one/models/new_campaign_template.rb +20 -10
- data/lib/talon_one/models/new_catalog.rb +4 -4
- data/lib/talon_one/models/new_collection.rb +2 -2
- data/lib/talon_one/models/new_coupon_creation_job.rb +50 -7
- data/lib/talon_one/models/new_coupons.rb +57 -11
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +41 -7
- data/lib/talon_one/models/new_custom_effect.rb +14 -4
- data/lib/talon_one/models/new_customer_profile.rb +3 -3
- data/lib/talon_one/models/new_customer_session.rb +5 -5
- data/lib/talon_one/models/new_customer_session_v2.rb +21 -9
- data/lib/talon_one/models/new_event.rb +3 -3
- data/lib/talon_one/models/new_event_type.rb +5 -5
- data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
- data/lib/talon_one/models/new_internal_audience.rb +251 -0
- data/lib/talon_one/models/new_invitation.rb +5 -5
- data/lib/talon_one/models/new_invite_email.rb +2 -2
- data/lib/talon_one/models/new_loyalty_program.rb +22 -7
- data/lib/talon_one/models/new_loyalty_tier.rb +4 -4
- data/lib/talon_one/models/new_management_key.rb +332 -0
- data/lib/talon_one/models/new_multiple_audiences_item.rb +266 -0
- data/lib/talon_one/models/new_notification_webhook.rb +4 -4
- data/lib/talon_one/models/new_password.rb +2 -2
- data/lib/talon_one/models/new_password_email.rb +2 -2
- data/lib/talon_one/models/new_picklist.rb +263 -0
- data/lib/talon_one/models/new_referral.rb +4 -4
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +3 -3
- data/lib/talon_one/models/new_role.rb +6 -6
- data/lib/talon_one/models/new_ruleset.rb +15 -3
- data/lib/talon_one/models/new_saml_connection.rb +2 -2
- data/lib/talon_one/models/new_template_def.rb +2 -2
- data/lib/talon_one/models/new_user.rb +2 -2
- data/lib/talon_one/models/new_webhook.rb +9 -9
- data/lib/talon_one/models/notification.rb +5 -5
- data/lib/talon_one/models/notification_webhook.rb +7 -7
- data/lib/talon_one/models/outgoing_integration_braze_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +241 -0
- data/lib/talon_one/models/outgoing_integration_type.rb +357 -0
- data/lib/talon_one/models/outgoing_integration_types.rb +209 -0
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +328 -0
- data/lib/talon_one/models/outgoing_integration_webhook_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/patch_many_items_catalog_action.rb +230 -0
- data/lib/talon_one/models/picklist.rb +339 -0
- data/lib/talon_one/models/priority_position.rb +264 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +2 -2
- data/lib/talon_one/models/redeem_referral_effect_props.rb +5 -5
- data/lib/talon_one/models/referral.rb +6 -6
- data/lib/talon_one/models/referral_constraints.rb +3 -3
- data/lib/talon_one/models/referral_created_effect_props.rb +3 -3
- data/lib/talon_one/models/referral_rejection_reason.rb +4 -4
- data/lib/talon_one/models/reject_coupon_effect_props.rb +7 -7
- data/lib/talon_one/models/reject_referral_effect_props.rb +7 -7
- data/lib/talon_one/models/remove_item_catalog_action.rb +213 -0
- data/lib/talon_one/models/remove_many_items_catalog_action.rb +210 -0
- data/lib/talon_one/models/reserve_coupon_effect_props.rb +243 -0
- data/lib/talon_one/models/return_integration_request.rb +3 -3
- data/lib/talon_one/models/returned_cart_item.rb +3 -3
- data/lib/talon_one/models/role.rb +10 -10
- data/lib/talon_one/models/role_assign.rb +4 -4
- data/lib/talon_one/models/role_membership.rb +4 -4
- data/lib/talon_one/models/role_v2.rb +248 -0
- data/lib/talon_one/models/role_v2_application_details.rb +227 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +228 -0
- data/lib/talon_one/models/role_v2_permissions.rb +218 -0
- data/lib/talon_one/models/role_v2_permissions_roles.rb +230 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +25 -10
- data/lib/talon_one/models/rollback_discount_effect_props.rb +5 -5
- data/lib/talon_one/models/rollback_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/rule.rb +23 -3
- data/lib/talon_one/models/rule_failure_reason.rb +14 -14
- data/lib/talon_one/models/ruleset.rb +18 -6
- data/lib/talon_one/models/saml_connection.rb +4 -4
- data/lib/talon_one/models/saml_connection_metadata.rb +2 -2
- data/lib/talon_one/models/saml_login_endpoint.rb +2 -2
- data/lib/talon_one/models/session.rb +3 -3
- data/lib/talon_one/models/set_discount_effect_props.rb +6 -6
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +30 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +6 -6
- data/lib/talon_one/models/show_notification_effect_props.rb +5 -5
- data/lib/talon_one/models/slot_def.rb +2 -2
- data/lib/talon_one/models/strikethrough_changed_item.rb +318 -0
- data/lib/talon_one/models/strikethrough_effect.rb +287 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +273 -0
- data/lib/talon_one/models/strikethrough_set_discount_per_item_effect_props.rb +228 -0
- data/lib/talon_one/models/strikethrough_trigger.rb +273 -0
- data/lib/talon_one/models/talang_attribute.rb +363 -0
- data/lib/talon_one/models/talang_attribute_visibility.rb +221 -0
- data/lib/talon_one/models/template_arg_def.rb +28 -8
- data/lib/talon_one/models/template_def.rb +4 -4
- data/lib/talon_one/models/template_limit_config.rb +2 -2
- data/lib/talon_one/models/tier.rb +4 -4
- data/lib/talon_one/models/transfer_loyalty_card.rb +231 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +4 -4
- data/lib/talon_one/models/update_account.rb +4 -4
- data/lib/talon_one/models/update_application.rb +3 -3
- data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
- data/lib/talon_one/models/update_audience.rb +2 -2
- data/lib/talon_one/models/update_campaign.rb +4 -4
- data/lib/talon_one/models/update_campaign_collection.rb +2 -2
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +23 -13
- data/lib/talon_one/models/update_catalog.rb +4 -4
- data/lib/talon_one/models/update_collection.rb +2 -2
- data/lib/talon_one/models/update_coupon.rb +56 -10
- data/lib/talon_one/models/update_coupon_batch.rb +40 -6
- data/lib/talon_one/models/update_custom_effect.rb +14 -4
- data/lib/talon_one/models/update_loyalty_card.rb +3 -3
- data/lib/talon_one/models/update_loyalty_program.rb +17 -7
- data/lib/talon_one/models/update_picklist.rb +264 -0
- data/lib/talon_one/models/update_referral.rb +5 -5
- data/lib/talon_one/models/update_referral_batch.rb +4 -4
- data/lib/talon_one/models/update_role.rb +6 -6
- data/lib/talon_one/models/update_user.rb +5 -5
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +4 -4
- data/lib/talon_one/models/user.rb +7 -7
- data/lib/talon_one/models/user_entity.rb +3 -3
- data/lib/talon_one/models/user_feed_notifications.rb +5 -5
- data/lib/talon_one/models/webhook.rb +12 -12
- data/lib/talon_one/models/webhook_activation_log_entry.rb +7 -7
- data/lib/talon_one/models/webhook_log_entry.rb +8 -8
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/version.rb +3 -3
- data/lib/talon_one.rb +88 -5
- data/spec/api/integration_api_spec.rb +151 -49
- data/spec/api/management_api_spec.rb +564 -260
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/accept_coupon_effect_props_spec.rb +2 -2
- data/spec/models/accept_referral_effect_props_spec.rb +2 -2
- data/spec/models/access_log_entry_spec.rb +2 -2
- data/spec/models/account_additional_cost_spec.rb +2 -2
- data/spec/models/account_analytics_spec.rb +2 -2
- data/spec/models/account_dashboard_statistic_api_calls_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_discount_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_referrals_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_revenue_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_spec.rb +71 -0
- data/spec/models/account_entity_spec.rb +2 -2
- data/spec/models/account_limits_spec.rb +2 -2
- data/spec/models/account_spec.rb +2 -2
- data/spec/models/add_free_item_effect_props_spec.rb +2 -2
- data/spec/models/{loyalty_projection_data_spec.rb → add_item_catalog_action_spec.rb} +12 -12
- data/spec/models/add_loyalty_points_effect_props_spec.rb +14 -2
- data/spec/models/add_loyalty_points_spec.rb +83 -0
- data/spec/models/added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/additional_cost_spec.rb +2 -2
- data/spec/models/api_error_spec.rb +2 -2
- data/spec/models/application_api_health_spec.rb +2 -2
- data/spec/models/application_api_key_spec.rb +3 -3
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_customer_entity_spec.rb +2 -2
- data/spec/models/application_customer_spec.rb +8 -2
- data/spec/models/application_entity_spec.rb +2 -2
- data/spec/models/application_event_spec.rb +2 -2
- data/spec/models/application_notification_spec.rb +2 -2
- data/spec/models/application_referee_spec.rb +2 -2
- data/spec/models/application_session_entity_spec.rb +2 -2
- data/spec/models/application_session_spec.rb +2 -2
- data/spec/models/application_spec.rb +2 -2
- data/spec/models/async_coupon_creation_response_spec.rb +2 -2
- data/spec/models/attribute_spec.rb +18 -2
- data/spec/models/attributes_mandatory_spec.rb +2 -2
- data/spec/models/attributes_settings_spec.rb +2 -2
- data/spec/models/audience_analytics_spec.rb +47 -0
- data/spec/models/audience_customer_spec.rb +113 -0
- data/spec/models/audience_integration_id_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +2 -2
- data/spec/models/audience_spec.rb +26 -2
- data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
- data/spec/models/base_loyalty_program_spec.rb +8 -2
- data/spec/models/base_notification_entity_spec.rb +41 -0
- data/spec/models/{loyalty_projection_spec.rb → base_notification_spec.rb} +11 -11
- data/spec/models/base_notification_webhook_spec.rb +65 -0
- data/spec/models/base_notifications_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +2 -2
- data/spec/models/binding_spec.rb +2 -2
- data/spec/models/bulk_application_notification_spec.rb +2 -2
- data/spec/models/bulk_campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_activation_request_spec.rb +41 -0
- data/spec/models/campaign_analytics_spec.rb +2 -2
- data/spec/models/campaign_collection_spec.rb +2 -2
- data/spec/models/campaign_collection_without_payload_spec.rb +2 -2
- data/spec/models/campaign_copy_spec.rb +2 -2
- data/spec/models/campaign_created_notification_spec.rb +14 -2
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_spec.rb +8 -2
- data/spec/models/campaign_entity_spec.rb +2 -2
- data/spec/models/campaign_group_entity_spec.rb +2 -2
- data/spec/models/campaign_group_spec.rb +2 -2
- data/spec/models/campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_priorities_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_priorities_v2_spec.rb +2 -2
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +2 -2
- data/spec/models/campaign_search_spec.rb +2 -2
- data/spec/models/campaign_set_branch_node_spec.rb +2 -2
- data/spec/models/campaign_set_i_ds_spec.rb +2 -2
- data/spec/models/campaign_set_leaf_node_spec.rb +2 -2
- data/spec/models/campaign_set_node_spec.rb +2 -2
- data/spec/models/campaign_set_spec.rb +8 -2
- data/spec/models/campaign_set_v2_spec.rb +2 -2
- data/spec/models/campaign_spec.rb +9 -3
- data/spec/models/campaign_state_changed_notification_spec.rb +8 -2
- data/spec/models/campaign_template_collection_spec.rb +2 -2
- data/spec/models/campaign_template_params_spec.rb +8 -2
- data/spec/models/campaign_template_spec.rb +9 -3
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +117 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +117 -0
- data/spec/models/cart_item_spec.rb +8 -2
- data/spec/models/catalog_action_filter_spec.rb +57 -0
- data/spec/models/catalog_action_spec.rb +51 -0
- data/spec/models/catalog_item_spec.rb +77 -0
- data/spec/models/catalog_spec.rb +2 -2
- data/spec/models/catalog_sync_request_spec.rb +47 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +41 -0
- data/spec/models/change_profile_password_spec.rb +2 -2
- data/spec/models/change_spec.rb +8 -2
- data/spec/models/code_generator_settings_spec.rb +2 -2
- data/spec/models/collection_item_spec.rb +41 -0
- data/spec/models/collection_spec.rb +2 -2
- data/spec/models/collection_without_payload_spec.rb +2 -2
- data/spec/models/coupon_constraints_spec.rb +8 -2
- data/spec/models/coupon_created_effect_props_spec.rb +2 -2
- data/spec/models/coupon_creation_job_spec.rb +8 -2
- data/spec/models/coupon_limit_configs_spec.rb +2 -2
- data/spec/models/coupon_rejection_reason_spec.rb +3 -3
- data/spec/models/coupon_reservations_spec.rb +2 -2
- data/spec/models/coupon_search_spec.rb +2 -2
- data/spec/models/coupon_spec.rb +20 -2
- data/spec/models/coupon_value_spec.rb +2 -2
- data/spec/models/coupons_notification_policy_spec.rb +51 -0
- data/spec/models/create_application_api_key_spec.rb +3 -3
- data/spec/models/create_management_key_spec.rb +59 -0
- data/spec/models/create_template_campaign_response_spec.rb +2 -2
- data/spec/models/create_template_campaign_spec.rb +8 -2
- data/spec/models/custom_effect_props_spec.rb +26 -2
- data/spec/models/custom_effect_spec.rb +8 -2
- data/spec/models/customer_activity_report_spec.rb +2 -2
- data/spec/models/customer_analytics_spec.rb +2 -2
- data/spec/models/customer_inventory_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_item_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_spec.rb +2 -2
- data/spec/models/customer_profile_integration_request_v2_spec.rb +8 -2
- data/spec/models/customer_profile_search_query_spec.rb +2 -2
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
- data/spec/models/customer_session_spec.rb +2 -2
- data/spec/models/customer_session_v2_spec.rb +8 -2
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/deduct_loyalty_points_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +8 -2
- data/spec/models/effect_spec.rb +8 -2
- data/spec/models/email_entity_spec.rb +2 -2
- data/spec/models/endpoint_spec.rb +41 -0
- data/spec/models/entity_spec.rb +2 -2
- data/spec/models/entity_with_talang_visible_id_spec.rb +2 -2
- data/spec/models/environment_spec.rb +2 -2
- data/spec/models/error_effect_props_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_response_with_status_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/evaluable_campaign_ids_spec.rb +41 -0
- data/spec/models/event_spec.rb +2 -2
- data/spec/models/event_type_spec.rb +2 -2
- data/spec/models/event_v2_spec.rb +8 -2
- data/spec/models/expiring_points_notification_policy_spec.rb +47 -0
- data/spec/models/expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/features_feed_spec.rb +2 -2
- data/spec/models/feed_notification_spec.rb +2 -2
- data/spec/models/frontend_state_spec.rb +35 -0
- data/spec/models/func_arg_def_spec.rb +3 -3
- data/spec/models/function_def_spec.rb +2 -2
- data/spec/models/giveaway_spec.rb +14 -2
- data/spec/models/giveaways_pool_spec.rb +8 -2
- data/spec/models/import_entity_spec.rb +2 -2
- data/spec/models/import_spec.rb +2 -2
- data/spec/models/inline_response20010_spec.rb +3 -3
- data/spec/models/inline_response20011_spec.rb +3 -3
- data/spec/models/inline_response20012_spec.rb +3 -3
- data/spec/models/inline_response20013_spec.rb +2 -8
- data/spec/models/inline_response20014_spec.rb +8 -2
- data/spec/models/inline_response20015_spec.rb +2 -2
- data/spec/models/inline_response20016_spec.rb +8 -2
- data/spec/models/inline_response20017_spec.rb +2 -2
- data/spec/models/inline_response20018_spec.rb +3 -3
- data/spec/models/inline_response20019_spec.rb +2 -2
- data/spec/models/inline_response2001_spec.rb +3 -3
- data/spec/models/inline_response20020_spec.rb +4 -4
- data/spec/models/inline_response20021_spec.rb +2 -2
- data/spec/models/inline_response20022_spec.rb +8 -2
- data/spec/models/inline_response20023_spec.rb +3 -3
- data/spec/models/inline_response20024_spec.rb +3 -3
- data/spec/models/inline_response20025_spec.rb +3 -3
- data/spec/models/inline_response20026_spec.rb +3 -3
- data/spec/models/inline_response20027_spec.rb +2 -2
- data/spec/models/inline_response20028_spec.rb +8 -2
- data/spec/models/inline_response20029_spec.rb +4 -4
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response20030_spec.rb +2 -2
- data/spec/models/inline_response20031_spec.rb +2 -2
- data/spec/models/inline_response20032_spec.rb +47 -0
- data/spec/models/inline_response20033_spec.rb +47 -0
- data/spec/models/inline_response20034_spec.rb +47 -0
- data/spec/models/inline_response20035_spec.rb +47 -0
- data/spec/models/inline_response20036_spec.rb +47 -0
- data/spec/models/inline_response20037_spec.rb +53 -0
- data/spec/models/inline_response20038_spec.rb +47 -0
- data/spec/models/inline_response20039_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +3 -3
- data/spec/models/inline_response2006_spec.rb +3 -3
- data/spec/models/inline_response2007_spec.rb +3 -3
- data/spec/models/inline_response2008_spec.rb +2 -8
- data/spec/models/inline_response2009_spec.rb +2 -8
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/inline_response201_spec.rb +2 -2
- data/spec/models/integration_coupon_spec.rb +167 -0
- data/spec/models/integration_customer_session_response_spec.rb +8 -2
- data/spec/models/integration_entity_spec.rb +2 -2
- data/spec/models/integration_event_spec.rb +2 -2
- data/spec/models/integration_event_v2_request_spec.rb +8 -2
- data/spec/models/integration_profile_entity_spec.rb +2 -2
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +2 -2
- data/spec/models/integration_state_v2_spec.rb +2 -2
- data/spec/models/inventory_coupon_spec.rb +20 -2
- data/spec/models/inventory_referral_spec.rb +2 -2
- data/spec/models/item_attribute_spec.rb +53 -0
- data/spec/models/ledger_entry_spec.rb +2 -2
- data/spec/models/ledger_info_spec.rb +5 -5
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +111 -0
- data/spec/models/library_attribute_spec.rb +2 -2
- data/spec/models/limit_config_spec.rb +2 -2
- data/spec/models/limit_counter_spec.rb +2 -2
- data/spec/models/login_params_spec.rb +2 -2
- data/spec/models/loyalty_balance_spec.rb +59 -0
- data/spec/models/loyalty_balances_spec.rb +47 -0
- data/spec/models/loyalty_card_profile_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_spec.rb +14 -2
- data/spec/models/loyalty_dashboard_data_spec.rb +2 -2
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +2 -2
- data/spec/models/loyalty_ledger_entry_spec.rb +8 -2
- data/spec/models/loyalty_ledger_spec.rb +2 -2
- data/spec/models/loyalty_ledger_transactions_spec.rb +47 -0
- data/spec/models/loyalty_membership_spec.rb +2 -2
- data/spec/models/loyalty_program_balance_spec.rb +8 -2
- data/spec/models/loyalty_program_entity_spec.rb +2 -2
- data/spec/models/loyalty_program_ledgers_spec.rb +2 -2
- data/spec/models/loyalty_program_spec.rb +8 -2
- data/spec/models/loyalty_program_transaction_spec.rb +141 -0
- data/spec/models/loyalty_spec.rb +2 -2
- data/spec/models/loyalty_statistics_spec.rb +2 -2
- data/spec/models/loyalty_sub_ledger_spec.rb +2 -2
- data/spec/models/loyalty_tier_spec.rb +2 -2
- data/spec/models/management_key_spec.rb +83 -0
- data/spec/models/manager_config_spec.rb +2 -2
- data/spec/models/meta_spec.rb +2 -2
- data/spec/models/model_return_spec.rb +2 -2
- data/spec/models/multi_application_entity_spec.rb +2 -2
- data/spec/models/multiple_attribute_spec.rb +2 -2
- data/spec/models/multiple_audiences_item_spec.rb +69 -0
- data/spec/models/multiple_audiences_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +2 -2
- data/spec/models/multiple_new_attribute_spec.rb +2 -2
- data/spec/models/multiple_new_audiences_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +2 -2
- data/spec/models/new_account_sign_up_spec.rb +2 -2
- data/spec/models/new_account_spec.rb +2 -2
- data/spec/models/new_additional_cost_spec.rb +2 -2
- data/spec/models/new_application_api_key_spec.rb +3 -3
- data/spec/models/new_application_spec.rb +2 -2
- data/spec/models/new_attribute_spec.rb +18 -2
- data/spec/models/new_audience_spec.rb +26 -2
- data/spec/models/new_base_notification_spec.rb +47 -0
- data/spec/models/new_campaign_collection_spec.rb +2 -2
- data/spec/models/new_campaign_group_spec.rb +2 -2
- data/spec/models/new_campaign_set_spec.rb +2 -2
- data/spec/models/new_campaign_set_v2_spec.rb +2 -2
- data/spec/models/new_campaign_spec.rb +3 -3
- data/spec/models/new_campaign_template_spec.rb +9 -3
- data/spec/models/new_catalog_spec.rb +2 -2
- data/spec/models/new_collection_spec.rb +2 -2
- data/spec/models/new_coupon_creation_job_spec.rb +8 -2
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
- data/spec/models/new_coupons_spec.rb +14 -2
- data/spec/models/new_custom_effect_spec.rb +8 -2
- data/spec/models/new_customer_profile_spec.rb +2 -2
- data/spec/models/new_customer_session_spec.rb +2 -2
- data/spec/models/new_customer_session_v2_spec.rb +8 -2
- data/spec/models/new_event_spec.rb +2 -2
- data/spec/models/new_event_type_spec.rb +2 -2
- data/spec/models/new_giveaways_pool_spec.rb +8 -2
- data/spec/models/new_internal_audience_spec.rb +53 -0
- data/spec/models/new_invitation_spec.rb +2 -2
- data/spec/models/new_invite_email_spec.rb +2 -2
- data/spec/models/new_loyalty_program_spec.rb +8 -2
- data/spec/models/new_loyalty_tier_spec.rb +2 -2
- data/spec/models/new_management_key_spec.rb +89 -0
- data/spec/models/new_multiple_audiences_item_spec.rb +47 -0
- data/spec/models/new_notification_webhook_spec.rb +2 -2
- data/spec/models/new_password_email_spec.rb +2 -2
- data/spec/models/new_password_spec.rb +2 -2
- data/spec/models/new_picklist_spec.rb +51 -0
- data/spec/models/new_referral_spec.rb +2 -2
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +2 -2
- data/spec/models/new_return_spec.rb +2 -2
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +8 -2
- data/spec/models/new_saml_connection_spec.rb +2 -2
- data/spec/models/new_template_def_spec.rb +2 -2
- data/spec/models/new_user_spec.rb +2 -2
- data/spec/models/new_webhook_spec.rb +2 -2
- data/spec/models/notification_spec.rb +2 -2
- data/spec/models/notification_webhook_spec.rb +2 -2
- data/spec/models/outgoing_integration_braze_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +53 -0
- data/spec/models/outgoing_integration_type_spec.rb +65 -0
- data/spec/models/outgoing_integration_types_spec.rb +41 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +65 -0
- data/spec/models/outgoing_integration_webhook_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +59 -0
- data/spec/models/patch_many_items_catalog_action_spec.rb +53 -0
- data/spec/models/picklist_spec.rb +87 -0
- data/spec/models/priority_position_spec.rb +51 -0
- data/spec/models/profile_audiences_changes_spec.rb +2 -2
- data/spec/models/redeem_referral_effect_props_spec.rb +2 -2
- data/spec/models/referral_constraints_spec.rb +2 -2
- data/spec/models/referral_created_effect_props_spec.rb +2 -2
- data/spec/models/referral_rejection_reason_spec.rb +3 -3
- data/spec/models/referral_spec.rb +2 -2
- data/spec/models/reject_coupon_effect_props_spec.rb +2 -2
- data/spec/models/reject_referral_effect_props_spec.rb +2 -2
- data/spec/models/remove_item_catalog_action_spec.rb +41 -0
- data/spec/models/remove_many_items_catalog_action_spec.rb +41 -0
- data/spec/models/reserve_coupon_effect_props_spec.rb +53 -0
- data/spec/models/return_integration_request_spec.rb +2 -2
- data/spec/models/returned_cart_item_spec.rb +2 -2
- data/spec/models/role_assign_spec.rb +2 -2
- data/spec/models/role_membership_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_v2_application_details_spec.rb +53 -0
- data/spec/models/role_v2_permission_set_spec.rb +47 -0
- data/spec/models/role_v2_permissions_roles_spec.rb +53 -0
- data/spec/models/role_v2_permissions_spec.rb +47 -0
- data/spec/models/{loyalty_points_spec.rb → role_v2_spec.rb} +13 -13
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_discount_effect_props_spec.rb +2 -2
- data/spec/models/rollback_referral_effect_props_spec.rb +2 -2
- data/spec/models/rule_failure_reason_spec.rb +2 -2
- data/spec/models/rule_spec.rb +14 -2
- data/spec/models/ruleset_spec.rb +8 -2
- data/spec/models/saml_connection_metadata_spec.rb +2 -2
- data/spec/models/saml_connection_spec.rb +2 -2
- data/spec/models/saml_login_endpoint_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/set_discount_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_item_effect_props_spec.rb +14 -2
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +2 -2
- data/spec/models/show_notification_effect_props_spec.rb +2 -2
- data/spec/models/slot_def_spec.rb +2 -2
- data/spec/models/strikethrough_changed_item_spec.rb +77 -0
- data/spec/models/strikethrough_effect_spec.rb +71 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +65 -0
- data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +47 -0
- data/spec/models/strikethrough_trigger_spec.rb +65 -0
- data/spec/models/talang_attribute_spec.rb +97 -0
- data/spec/models/talang_attribute_visibility_spec.rb +47 -0
- data/spec/models/template_arg_def_spec.rb +15 -3
- data/spec/models/template_def_spec.rb +2 -2
- data/spec/models/template_limit_config_spec.rb +2 -2
- data/spec/models/tier_spec.rb +2 -2
- data/spec/models/transfer_loyalty_card_spec.rb +41 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +2 -2
- data/spec/models/update_account_spec.rb +2 -2
- data/spec/models/update_application_spec.rb +2 -2
- data/spec/models/update_attribute_effect_props_spec.rb +2 -2
- data/spec/models/update_audience_spec.rb +2 -2
- data/spec/models/update_campaign_collection_spec.rb +2 -2
- data/spec/models/update_campaign_group_spec.rb +2 -2
- data/spec/models/update_campaign_spec.rb +3 -3
- data/spec/models/update_campaign_template_spec.rb +9 -3
- data/spec/models/update_catalog_spec.rb +2 -2
- data/spec/models/update_collection_spec.rb +2 -2
- data/spec/models/update_coupon_batch_spec.rb +8 -2
- data/spec/models/update_coupon_spec.rb +14 -2
- data/spec/models/update_custom_effect_spec.rb +8 -2
- data/spec/models/update_loyalty_card_spec.rb +2 -2
- data/spec/models/update_loyalty_program_spec.rb +8 -2
- data/spec/models/update_picklist_spec.rb +51 -0
- data/spec/models/update_referral_batch_spec.rb +2 -2
- data/spec/models/update_referral_spec.rb +2 -2
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +2 -2
- data/spec/models/update_user_spec.rb +2 -2
- data/spec/models/user_entity_spec.rb +2 -2
- data/spec/models/user_feed_notifications_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/webhook_activation_log_entry_spec.rb +2 -2
- data/spec/models/webhook_log_entry_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/will_award_giveaway_effect_props_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/talon_one.gemspec +2 -2
- metadata +346 -14
- data/docs/LoyaltyPoints.md +0 -25
- data/docs/LoyaltyProjection.md +0 -21
- data/docs/LoyaltyProjectionData.md +0 -23
data/docs/UpdateAudience.md
CHANGED
data/docs/UpdateCampaign.md
CHANGED
|
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**description** | **String** | A detailed description of the campaign. | [optional]
|
|
9
9
|
**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional]
|
|
10
10
|
**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional]
|
|
11
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
|
|
11
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
|
|
12
12
|
**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to 'enabled']
|
|
13
13
|
**active_ruleset_id** | **Integer** | ID of Ruleset this campaign applies on customer session evaluation. | [optional]
|
|
14
14
|
**tags** | **Array<String>** | A list of tags for the campaign. |
|
|
15
15
|
**features** | **Array<String>** | A list of features for the campaign. |
|
|
16
16
|
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
17
17
|
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
18
|
-
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign |
|
|
18
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign. |
|
|
19
19
|
**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional]
|
|
20
20
|
|
|
21
21
|
## Code Sample
|
|
@@ -23,19 +23,19 @@ Name | Type | Description | Notes
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'TalonOne'
|
|
25
25
|
|
|
26
|
-
instance = TalonOne::UpdateCampaign.new(name:
|
|
27
|
-
description:
|
|
28
|
-
start_time:
|
|
29
|
-
end_time:
|
|
30
|
-
attributes:
|
|
31
|
-
state:
|
|
32
|
-
active_ruleset_id:
|
|
33
|
-
tags:
|
|
34
|
-
features:
|
|
26
|
+
instance = TalonOne::UpdateCampaign.new(name: Summer promotions,
|
|
27
|
+
description: Campaign for all summer 2021 promotions,
|
|
28
|
+
start_time: 2021-07-20T22:00Z,
|
|
29
|
+
end_time: 2021-10-01T02:00Z,
|
|
30
|
+
attributes: {"myattribute":20},
|
|
31
|
+
state: disabled,
|
|
32
|
+
active_ruleset_id: 2,
|
|
33
|
+
tags: [Summer, Shoes],
|
|
34
|
+
features: [coupons, loyalty],
|
|
35
35
|
coupon_settings: null,
|
|
36
36
|
referral_settings: null,
|
|
37
37
|
limits: null,
|
|
38
|
-
campaign_groups:
|
|
38
|
+
campaign_groups: [4, 5])
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
|
data/docs/UpdateCampaignGroup.md
CHANGED
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of this campaign group. |
|
|
8
8
|
**description** | **String** | A longer description of the campaign group. | [optional]
|
|
9
|
-
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for | [optional]
|
|
10
|
-
**campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns | [optional]
|
|
9
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for. | [optional]
|
|
10
|
+
**campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
17
|
instance = TalonOne::UpdateCampaignGroup.new(name: null,
|
|
18
|
-
description:
|
|
19
|
-
subscribed_applications_ids:
|
|
20
|
-
campaign_ids:
|
|
18
|
+
description: My campaign group.,
|
|
19
|
+
subscribed_applications_ids: [1, 2, 3],
|
|
20
|
+
campaign_ids: [4, 6, 8])
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
|
@@ -7,39 +7,41 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The campaign template name. |
|
|
8
8
|
**description** | **String** | Customer-facing text that explains the objective of the template. |
|
|
9
9
|
**instructions** | **String** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. |
|
|
10
|
-
**campaign_attributes** | [**Object**](.md) | The
|
|
11
|
-
**coupon_attributes** | [**Object**](.md) | The
|
|
12
|
-
**state** | **String** | Only
|
|
13
|
-
**active_ruleset_id** | **Integer** | The ID of the
|
|
10
|
+
**campaign_attributes** | [**Object**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional]
|
|
11
|
+
**coupon_attributes** | [**Object**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional]
|
|
12
|
+
**state** | **String** | Only campaign templates in 'available' state may be used to create campaigns. |
|
|
13
|
+
**active_ruleset_id** | **Integer** | The ID of the ruleset this campaign template will use. | [optional]
|
|
14
14
|
**tags** | **Array<String>** | A list of tags for the campaign template. | [optional]
|
|
15
15
|
**features** | **Array<String>** | A list of features for the campaign template. | [optional]
|
|
16
16
|
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
17
17
|
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
18
|
-
**limits** | [**Array<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that
|
|
19
|
-
**template_params** | [**Array<CampaignTemplateParams>**](CampaignTemplateParams.md) |
|
|
20
|
-
**applications_ids** | **Array<Integer>** | A list of
|
|
18
|
+
**limits** | [**Array<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional]
|
|
19
|
+
**template_params** | [**Array<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional]
|
|
20
|
+
**applications_ids** | **Array<Integer>** | A list of IDs of the Applications that are subscribed to this campaign template. |
|
|
21
21
|
**campaign_collections** | [**Array<CampaignTemplateCollection>**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional]
|
|
22
|
+
**default_campaign_group_id** | **Integer** | The default campaign group ID. | [optional]
|
|
22
23
|
|
|
23
24
|
## Code Sample
|
|
24
25
|
|
|
25
26
|
```ruby
|
|
26
27
|
require 'TalonOne'
|
|
27
28
|
|
|
28
|
-
instance = TalonOne::UpdateCampaignTemplate.new(name:
|
|
29
|
-
description:
|
|
30
|
-
instructions:
|
|
29
|
+
instance = TalonOne::UpdateCampaignTemplate.new(name: Discount campaign,
|
|
30
|
+
description: This is a template for a discount campaign.,
|
|
31
|
+
instructions: Use this template for discount campaigns. Set the campaign properties according to the campaign goals, and don't forget to set an end date.,
|
|
31
32
|
campaign_attributes: null,
|
|
32
33
|
coupon_attributes: null,
|
|
33
34
|
state: null,
|
|
34
|
-
active_ruleset_id:
|
|
35
|
-
tags:
|
|
35
|
+
active_ruleset_id: 5,
|
|
36
|
+
tags: [discount],
|
|
36
37
|
features: null,
|
|
37
38
|
coupon_settings: null,
|
|
38
39
|
referral_settings: null,
|
|
39
40
|
limits: null,
|
|
40
41
|
template_params: null,
|
|
41
|
-
applications_ids:
|
|
42
|
-
campaign_collections: null
|
|
42
|
+
applications_ids: [1, 2, 3],
|
|
43
|
+
campaign_collections: null,
|
|
44
|
+
default_campaign_group_id: 42)
|
|
43
45
|
```
|
|
44
46
|
|
|
45
47
|
|
data/docs/UpdateCatalog.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**description** | **String** | A description of this cart
|
|
8
|
-
**name** | **String** | Name of this cart
|
|
7
|
+
**description** | **String** | A description of this cart item catalog. | [optional]
|
|
8
|
+
**name** | **String** | Name of this cart item catalog. | [optional]
|
|
9
9
|
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this catalog. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
data/docs/UpdateCoupon.md
CHANGED
|
@@ -5,12 +5,14 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional]
|
|
8
|
-
**discount_limit** | **Float** | The
|
|
8
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
9
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
9
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
-
**expiry_date** | **DateTime** |
|
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
11
12
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
|
12
|
-
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional]
|
|
13
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
13
|
+
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
|
|
14
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
15
|
+
**is_reservation_mandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true]
|
|
14
16
|
|
|
15
17
|
## Code Sample
|
|
16
18
|
|
|
@@ -19,11 +21,13 @@ require 'TalonOne'
|
|
|
19
21
|
|
|
20
22
|
instance = TalonOne::UpdateCoupon.new(usage_limit: 100,
|
|
21
23
|
discount_limit: 30.0,
|
|
22
|
-
|
|
23
|
-
|
|
24
|
+
reservation_limit: 45,
|
|
25
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
26
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
24
27
|
limits: null,
|
|
25
|
-
recipient_integration_id:
|
|
26
|
-
attributes: null
|
|
28
|
+
recipient_integration_id: URNGV8294NV,
|
|
29
|
+
attributes: null,
|
|
30
|
+
is_reservation_mandatory: false)
|
|
27
31
|
```
|
|
28
32
|
|
|
29
33
|
|
data/docs/UpdateCouponBatch.md
CHANGED
|
@@ -5,10 +5,11 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional]
|
|
8
|
-
**discount_limit** | **Float** | The
|
|
8
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
9
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
9
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
-
**expiry_date** | **DateTime** |
|
|
11
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
12
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
12
13
|
**batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
|
|
13
14
|
|
|
14
15
|
## Code Sample
|
|
@@ -18,8 +19,9 @@ require 'TalonOne'
|
|
|
18
19
|
|
|
19
20
|
instance = TalonOne::UpdateCouponBatch.new(usage_limit: 100,
|
|
20
21
|
discount_limit: 30.0,
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
reservation_limit: 45,
|
|
23
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
24
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
23
25
|
attributes: null,
|
|
24
26
|
batch_id: null)
|
|
25
27
|
```
|
data/docs/UpdateCustomEffect.md
CHANGED
|
@@ -5,12 +5,13 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. |
|
|
8
|
+
**is_per_item** | **Boolean** | Indicates if this effect is per item or not. | [optional]
|
|
8
9
|
**name** | **String** | The name of this effect. |
|
|
9
10
|
**title** | **String** | The title of this effect. |
|
|
10
11
|
**payload** | **String** | The JSON payload of this effect. |
|
|
11
12
|
**description** | **String** | The description of this effect. | [optional]
|
|
12
13
|
**enabled** | **Boolean** | Determines if this effect is active. |
|
|
13
|
-
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional]
|
|
14
|
+
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
18
19
|
require 'TalonOne'
|
|
19
20
|
|
|
20
21
|
instance = TalonOne::UpdateCustomEffect.new(application_ids: null,
|
|
22
|
+
is_per_item: null,
|
|
21
23
|
name: null,
|
|
22
24
|
title: null,
|
|
23
25
|
payload: null,
|
data/docs/UpdateLoyaltyCard.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**status** | **String** | Status of the loyalty card. Can be one of: ['active', '
|
|
7
|
+
**status** | **String** | Status of the loyalty card. Can be one of: ['active', 'inactive'] |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'TalonOne'
|
|
13
13
|
|
|
14
|
-
instance = TalonOne::UpdateLoyaltyCard.new(status:
|
|
14
|
+
instance = TalonOne::UpdateLoyaltyCard.new(status: active)
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
|
|
@@ -7,11 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**title** | **String** | The display title for the Loyalty Program. | [optional]
|
|
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
|
-
**default_validity** | **String** |
|
|
11
|
-
**default_pending** | **String** |
|
|
12
|
-
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | [optional]
|
|
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. Can be 'immediate' 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
|
+
**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]
|
|
15
|
+
**tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
|
|
15
16
|
|
|
16
17
|
## Code Sample
|
|
17
18
|
|
|
@@ -21,10 +22,11 @@ require 'TalonOne'
|
|
|
21
22
|
instance = TalonOne::UpdateLoyaltyProgram.new(title: Point collection,
|
|
22
23
|
description: Customers collect 10 points per 1$ spent,
|
|
23
24
|
subscribed_applications: [132, 97],
|
|
24
|
-
default_validity:
|
|
25
|
+
default_validity: 2W_U,
|
|
25
26
|
default_pending: immediate,
|
|
26
27
|
allow_subledger: false,
|
|
27
28
|
users_per_card_limit: 111,
|
|
29
|
+
sandbox: true,
|
|
28
30
|
tiers: null)
|
|
29
31
|
```
|
|
30
32
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::UpdatePicklist
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. |
|
|
8
|
+
**values** | **Array<String>** | The list of allowed values provided by this picklist. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::UpdatePicklist.new(type: 2012-11-01T22:08:41+00:00,
|
|
16
|
+
values: [Jeans, Shirt, Coat])
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/UpdateReferral.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional]
|
|
7
|
+
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile. | [optional]
|
|
8
8
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
9
|
-
**expiry_date** | **DateTime** |
|
|
9
|
+
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
10
10
|
**usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional]
|
|
11
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
11
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
data/docs/UpdateReferralBatch.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
7
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
8
8
|
**batch_id** | **String** | The id of the batch the referral belongs to. |
|
|
9
9
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
10
|
-
**expiry_date** | **DateTime** |
|
|
10
|
+
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
11
11
|
**usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
data/docs/UpdateRole.md
CHANGED
|
@@ -4,20 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | Name of the role | [optional]
|
|
8
|
-
**description** | **String** | Description of the role | [optional]
|
|
9
|
-
**acl** | **String** |
|
|
10
|
-
**members** | **Array<Integer>** | An array of user identifiers | [optional]
|
|
7
|
+
**name** | **String** | Name of the role. | [optional]
|
|
8
|
+
**description** | **String** | Description of the role. | [optional]
|
|
9
|
+
**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [optional]
|
|
10
|
+
**members** | **Array<Integer>** | An array of user identifiers. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::UpdateRole.new(name:
|
|
18
|
-
description:
|
|
19
|
-
acl:
|
|
20
|
-
members:
|
|
17
|
+
instance = TalonOne::UpdateRole.new(name: Campaign Manager,
|
|
18
|
+
description: Manages the campaigns,
|
|
19
|
+
acl: ,
|
|
20
|
+
members: [48, 562, 475, 18])
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/UpdateUser.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** |
|
|
8
|
-
**policy** | **String** |
|
|
7
|
+
**name** | **String** | The user name. | [optional]
|
|
8
|
+
**policy** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [optional]
|
|
9
9
|
**state** | **String** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional]
|
|
10
|
-
**roles** | **Array<Integer>** |
|
|
10
|
+
**roles** | **Array<Integer>** | List of roles to assign to the user. | [optional]
|
|
11
11
|
**application_notification_subscriptions** | [**Object**](.md) | | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
@@ -15,10 +15,10 @@ Name | Type | Description | Notes
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'TalonOne'
|
|
17
17
|
|
|
18
|
-
instance = TalonOne::UpdateUser.new(name:
|
|
19
|
-
policy:
|
|
20
|
-
state:
|
|
21
|
-
roles:
|
|
18
|
+
instance = TalonOne::UpdateUser.new(name: John Doe,
|
|
19
|
+
policy: ,
|
|
20
|
+
state: deactivated,
|
|
21
|
+
roles: [1, 3],
|
|
22
22
|
application_notification_subscriptions: null)
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**new_latest_feed_timestamp** | **DateTime** | New timestamp to update for the current user |
|
|
7
|
+
**new_latest_feed_timestamp** | **DateTime** | New timestamp to update for the current user. |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
data/docs/User.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
9
|
-
**modified** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**email** | **String** | The email address associated with your account. |
|
|
11
11
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
12
12
|
**invite_token** | **String** | Invite token, empty if the user as already accepted their invite. |
|
|
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**name** | **String** | Full name |
|
|
15
15
|
**policy** | [**Object**](.md) | User ACL Policy |
|
|
16
16
|
**latest_feed_timestamp** | **DateTime** | Latest timestamp the user has been notified for feed. | [optional]
|
|
17
|
-
**roles** | **Array<Integer>** | Contains a list of all roles the user is a member of | [optional]
|
|
17
|
+
**roles** | **Array<Integer>** | Contains a list of all roles the user is a member of. | [optional]
|
|
18
18
|
**application_notification_subscriptions** | [**Object**](.md) | | [optional]
|
|
19
|
-
**auth_method** | **String** | The Authentication method for this user | [optional]
|
|
19
|
+
**auth_method** | **String** | The Authentication method for this user. | [optional]
|
|
20
20
|
|
|
21
21
|
## Code Sample
|
|
22
22
|
|
data/docs/UserEntity.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**user_id** | **Integer** | The ID of the
|
|
7
|
+
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'TalonOne'
|
|
13
13
|
|
|
14
|
-
instance = TalonOne::UserEntity.new(user_id:
|
|
14
|
+
instance = TalonOne::UserEntity.new(user_id: 388)
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**last_update** | **DateTime** | Timestamp of the last request for this list |
|
|
8
|
-
**notifications** | [**Array<FeedNotification>**](FeedNotification.md) | List of all notifications to notify the user about |
|
|
7
|
+
**last_update** | **DateTime** | Timestamp of the last request for this list. |
|
|
8
|
+
**notifications** | [**Array<FeedNotification>**](FeedNotification.md) | List of all notifications to notify the user about. |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
data/docs/Webhook.md
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
9
|
-
**modified** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. The IDs of the applications that are related to this entity. |
|
|
11
|
-
**title** | **String** |
|
|
12
|
-
**verb** | **String** | API method for this webhook |
|
|
13
|
-
**url** | **String** | API url (supports templating using parameters) for this webhook |
|
|
14
|
-
**headers** | **Array<String>** | List of API HTTP headers for this webhook |
|
|
15
|
-
**payload** | **String** | API payload (supports templating using parameters) for this webhook | [optional]
|
|
16
|
-
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions |
|
|
17
|
-
**enabled** | **Boolean** | Enables or disables webhook from showing in rule builder |
|
|
11
|
+
**title** | **String** | Name or title for this webhook. |
|
|
12
|
+
**verb** | **String** | API method for this webhook. |
|
|
13
|
+
**url** | **String** | API url (supports templating using parameters) for this webhook. |
|
|
14
|
+
**headers** | **Array<String>** | List of API HTTP headers for this webhook. |
|
|
15
|
+
**payload** | **String** | API payload (supports templating using parameters) for this webhook. | [optional]
|
|
16
|
+
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. |
|
|
17
|
+
**enabled** | **Boolean** | Enables or disables webhook from showing in rule builder. |
|
|
18
18
|
|
|
19
19
|
## Code Sample
|
|
20
20
|
|
|
@@ -25,13 +25,15 @@ instance = TalonOne::Webhook.new(id: 6,
|
|
|
25
25
|
created: 2020-06-10T09:05:27.993483Z,
|
|
26
26
|
modified: 2021-09-12T10:12:42Z,
|
|
27
27
|
application_ids: null,
|
|
28
|
-
title:
|
|
29
|
-
verb:
|
|
30
|
-
url:
|
|
31
|
-
headers:
|
|
32
|
-
payload:
|
|
33
|
-
|
|
34
|
-
|
|
28
|
+
title: Send message,
|
|
29
|
+
verb: POST,
|
|
30
|
+
url: www.my-company.com/my-endpoint-name,
|
|
31
|
+
headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],
|
|
32
|
+
payload: {
|
|
33
|
+
"message": "${message}"
|
|
34
|
+
},
|
|
35
|
+
params: [],
|
|
36
|
+
enabled: true)
|
|
35
37
|
```
|
|
36
38
|
|
|
37
39
|
|
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**integration_request_uuid** | **String** | UUID reference of the integration request that triggered the effect with the webhook |
|
|
8
|
-
**webhook_id** | **Integer** | ID of the webhook that triggered the request |
|
|
9
|
-
**application_id** | **Integer** | ID of the application that triggered the webhook |
|
|
10
|
-
**campaign_id** | **Integer** | ID of the campaign that triggered the webhook |
|
|
7
|
+
**integration_request_uuid** | **String** | UUID reference of the integration request that triggered the effect with the webhook. |
|
|
8
|
+
**webhook_id** | **Integer** | ID of the webhook that triggered the request. |
|
|
9
|
+
**application_id** | **Integer** | ID of the application that triggered the webhook. |
|
|
10
|
+
**campaign_id** | **Integer** | ID of the campaign that triggered the webhook. |
|
|
11
11
|
**created** | **DateTime** | Timestamp of request |
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
@@ -15,11 +15,11 @@ Name | Type | Description | Notes
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'TalonOne'
|
|
17
17
|
|
|
18
|
-
instance = TalonOne::WebhookActivationLogEntry.new(integration_request_uuid:
|
|
19
|
-
webhook_id:
|
|
20
|
-
application_id:
|
|
21
|
-
campaign_id:
|
|
22
|
-
created:
|
|
18
|
+
instance = TalonOne::WebhookActivationLogEntry.new(integration_request_uuid: 6d3699cf-95bd-444a-b62f-80d6e8391dc9,
|
|
19
|
+
webhook_id: 1,
|
|
20
|
+
application_id: 13,
|
|
21
|
+
campaign_id: 86,
|
|
22
|
+
created: 2023-03-21T13:55:08.571144Z)
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
|
data/docs/WebhookLogEntry.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **String** | UUID reference of the webhook request |
|
|
8
|
-
**integration_request_uuid** | **String** | UUID reference of the integration request linked to this webhook request |
|
|
9
|
-
**webhook_id** | **Integer** | ID of the webhook that triggered the request |
|
|
10
|
-
**application_id** | **Integer** | ID of the application that triggered the webhook | [optional]
|
|
7
|
+
**id** | **String** | UUID reference of the webhook request. |
|
|
8
|
+
**integration_request_uuid** | **String** | UUID reference of the integration request linked to this webhook request. |
|
|
9
|
+
**webhook_id** | **Integer** | ID of the webhook that triggered the request. |
|
|
10
|
+
**application_id** | **Integer** | ID of the application that triggered the webhook. | [optional]
|
|
11
11
|
**url** | **String** | Target url of request |
|
|
12
12
|
**request** | **String** | Request message |
|
|
13
13
|
**response** | **String** | Response message | [optional]
|
|
14
|
-
**status** | **Integer** | HTTP status code of response | [optional]
|
|
14
|
+
**status** | **Integer** | HTTP status code of response. | [optional]
|
|
15
15
|
**request_time** | **DateTime** | Timestamp of request |
|
|
16
16
|
**response_time** | **DateTime** | Timestamp of response | [optional]
|
|
17
17
|
|
|
@@ -20,16 +20,19 @@ Name | Type | Description | Notes
|
|
|
20
20
|
```ruby
|
|
21
21
|
require 'TalonOne'
|
|
22
22
|
|
|
23
|
-
instance = TalonOne::WebhookLogEntry.new(id:
|
|
24
|
-
integration_request_uuid:
|
|
25
|
-
webhook_id:
|
|
26
|
-
application_id:
|
|
27
|
-
url:
|
|
28
|
-
request:
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
23
|
+
instance = TalonOne::WebhookLogEntry.new(id: 2,
|
|
24
|
+
integration_request_uuid: 472075793,
|
|
25
|
+
webhook_id: 5,
|
|
26
|
+
application_id: 12,
|
|
27
|
+
url: www.my-company.com/my-endpoint-name,
|
|
28
|
+
request: {
|
|
29
|
+
mydata: "somevalue"
|
|
30
|
+
}
|
|
31
|
+
,
|
|
32
|
+
response: ,
|
|
33
|
+
status: 204,
|
|
34
|
+
request_time: 2021-07-20T22:00Z,
|
|
35
|
+
response_time: 2021-07-20T22:00:50Z)
|
|
33
36
|
```
|
|
34
37
|
|
|
35
38
|
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::WillAwardGiveawayEffectProps.new(pool_id:
|
|
17
|
-
pool_name:
|
|
18
|
-
recipient_integration_id:
|
|
16
|
+
instance = TalonOne::WillAwardGiveawayEffectProps.new(pool_id: 2,
|
|
17
|
+
pool_name: My pool,
|
|
18
|
+
recipient_integration_id: URNGV8294NV)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|