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
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Talon.One API
|
|
3
3
|
|
|
4
|
-
#Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you
|
|
4
|
+
#Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document:
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 4.3.1
|
|
@@ -32,12 +32,26 @@ describe 'ManagementApi' do
|
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# unit tests for add_loyalty_card_points
|
|
36
|
+
# Add points to card in a given loyalty program
|
|
37
|
+
# Add points to the given loyalty card in the specified card-based loyalty program.
|
|
38
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
39
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
40
|
+
# @param body body
|
|
41
|
+
# @param [Hash] opts the optional parameters
|
|
42
|
+
# @return [nil]
|
|
43
|
+
describe 'add_loyalty_card_points test' do
|
|
44
|
+
it 'should work' do
|
|
45
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
35
49
|
# unit tests for add_loyalty_points
|
|
36
|
-
# Add points
|
|
37
|
-
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api
|
|
50
|
+
# Add points to customer profile
|
|
51
|
+
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
|
38
52
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
39
53
|
# @param integration_id The identifier of the profile.
|
|
40
|
-
# @param body
|
|
54
|
+
# @param body body
|
|
41
55
|
# @param [Hash] opts the optional parameters
|
|
42
56
|
# @return [nil]
|
|
43
57
|
describe 'add_loyalty_points test' do
|
|
@@ -47,13 +61,13 @@ describe 'ManagementApi' do
|
|
|
47
61
|
end
|
|
48
62
|
|
|
49
63
|
# unit tests for copy_campaign_to_applications
|
|
50
|
-
# Copy the campaign into the specified
|
|
51
|
-
# Copy the campaign into all specified
|
|
64
|
+
# Copy the campaign into the specified Application
|
|
65
|
+
# Copy the campaign into all specified Applications.
|
|
52
66
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
53
67
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
54
|
-
# @param body
|
|
68
|
+
# @param body body
|
|
55
69
|
# @param [Hash] opts the optional parameters
|
|
56
|
-
# @return [
|
|
70
|
+
# @return [InlineResponse2003]
|
|
57
71
|
describe 'copy_campaign_to_applications test' do
|
|
58
72
|
it 'should work' do
|
|
59
73
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -63,7 +77,7 @@ describe 'ManagementApi' do
|
|
|
63
77
|
# unit tests for create_account_collection
|
|
64
78
|
# Create account-level collection
|
|
65
79
|
# Create account-level collection.
|
|
66
|
-
# @param body
|
|
80
|
+
# @param body body
|
|
67
81
|
# @param [Hash] opts the optional parameters
|
|
68
82
|
# @return [Collection]
|
|
69
83
|
describe 'create_account_collection test' do
|
|
@@ -74,8 +88,8 @@ describe 'ManagementApi' do
|
|
|
74
88
|
|
|
75
89
|
# unit tests for create_additional_cost
|
|
76
90
|
# Create additional cost
|
|
77
|
-
# Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs
|
|
78
|
-
# @param body
|
|
91
|
+
# Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required.
|
|
92
|
+
# @param body body
|
|
79
93
|
# @param [Hash] opts the optional parameters
|
|
80
94
|
# @return [AccountAdditionalCost]
|
|
81
95
|
describe 'create_additional_cost test' do
|
|
@@ -86,8 +100,8 @@ describe 'ManagementApi' do
|
|
|
86
100
|
|
|
87
101
|
# unit tests for create_attribute
|
|
88
102
|
# Create custom attribute
|
|
89
|
-
# Create a _custom attribute_ in this account. Custom attributes allow you to
|
|
90
|
-
# @param body
|
|
103
|
+
# Create a _custom attribute_ in this account. [Custom attributes](https://docs.talon.one/docs/dev/concepts/attributes) allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all Applications in your account and are never required.
|
|
104
|
+
# @param body body
|
|
91
105
|
# @param [Hash] opts the optional parameters
|
|
92
106
|
# @return [Attribute]
|
|
93
107
|
describe 'create_attribute test' do
|
|
@@ -100,7 +114,7 @@ describe 'ManagementApi' do
|
|
|
100
114
|
# Create campaign from campaign template
|
|
101
115
|
# Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.
|
|
102
116
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
103
|
-
# @param body
|
|
117
|
+
# @param body body
|
|
104
118
|
# @param [Hash] opts the optional parameters
|
|
105
119
|
# @return [CreateTemplateCampaignResponse]
|
|
106
120
|
describe 'create_campaign_from_template test' do
|
|
@@ -114,7 +128,7 @@ describe 'ManagementApi' do
|
|
|
114
128
|
# Create a collection.
|
|
115
129
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
116
130
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
117
|
-
# @param body
|
|
131
|
+
# @param body body
|
|
118
132
|
# @param [Hash] opts the optional parameters
|
|
119
133
|
# @return [Collection]
|
|
120
134
|
describe 'create_collection test' do
|
|
@@ -128,10 +142,10 @@ describe 'ManagementApi' do
|
|
|
128
142
|
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
|
129
143
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
130
144
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
131
|
-
# @param body
|
|
145
|
+
# @param body body
|
|
132
146
|
# @param [Hash] opts the optional parameters
|
|
133
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains
|
|
134
|
-
# @return [
|
|
147
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
|
148
|
+
# @return [InlineResponse2006]
|
|
135
149
|
describe 'create_coupons test' do
|
|
136
150
|
it 'should work' do
|
|
137
151
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -140,10 +154,10 @@ describe 'ManagementApi' do
|
|
|
140
154
|
|
|
141
155
|
# unit tests for create_coupons_async
|
|
142
156
|
# Create coupons asynchronously
|
|
143
|
-
# Create
|
|
157
|
+
# Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. If you want to create less than 20,001 coupons, you can use the [Create coupons](https://docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint.
|
|
144
158
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
145
159
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
146
|
-
# @param body
|
|
160
|
+
# @param body body
|
|
147
161
|
# @param [Hash] opts the optional parameters
|
|
148
162
|
# @return [AsyncCouponCreationResponse]
|
|
149
163
|
describe 'create_coupons_async test' do
|
|
@@ -157,20 +171,33 @@ describe 'ManagementApi' do
|
|
|
157
171
|
# Create coupons according to some pattern for up to 1000 recipients.
|
|
158
172
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
159
173
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
160
|
-
# @param body
|
|
174
|
+
# @param body body
|
|
161
175
|
# @param [Hash] opts the optional parameters
|
|
162
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains
|
|
163
|
-
# @return [
|
|
176
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
|
177
|
+
# @return [InlineResponse2006]
|
|
164
178
|
describe 'create_coupons_for_multiple_recipients test' do
|
|
165
179
|
it 'should work' do
|
|
166
180
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
167
181
|
end
|
|
168
182
|
end
|
|
169
183
|
|
|
184
|
+
# unit tests for create_notification_webhook
|
|
185
|
+
# Create notification about campaign-related changes
|
|
186
|
+
# Create a [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). A notification about campaign-related changes is different from regular webhooks in that it is Application-scoped and has a predefined payload. [Regular webhooks](https://docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. **Tip:** - You can create these notifications using the Campaign Manager. See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). - You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_created/post).
|
|
187
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
188
|
+
# @param body body
|
|
189
|
+
# @param [Hash] opts the optional parameters
|
|
190
|
+
# @return [NotificationWebhook]
|
|
191
|
+
describe 'create_notification_webhook test' do
|
|
192
|
+
it 'should work' do
|
|
193
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
194
|
+
end
|
|
195
|
+
end
|
|
196
|
+
|
|
170
197
|
# unit tests for create_password_recovery_email
|
|
171
198
|
# Request a password reset
|
|
172
|
-
# Send an email with a password recovery link to the email address of an existing account.
|
|
173
|
-
# @param body
|
|
199
|
+
# Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
|
|
200
|
+
# @param body body
|
|
174
201
|
# @param [Hash] opts the optional parameters
|
|
175
202
|
# @return [NewPasswordEmail]
|
|
176
203
|
describe 'create_password_recovery_email test' do
|
|
@@ -181,8 +208,8 @@ describe 'ManagementApi' do
|
|
|
181
208
|
|
|
182
209
|
# unit tests for create_session
|
|
183
210
|
# Create session
|
|
184
|
-
# Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup.
|
|
185
|
-
# @param body
|
|
211
|
+
# Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
|
|
212
|
+
# @param body body
|
|
186
213
|
# @param [Hash] opts the optional parameters
|
|
187
214
|
# @return [Session]
|
|
188
215
|
describe 'create_session test' do
|
|
@@ -191,10 +218,24 @@ describe 'ManagementApi' do
|
|
|
191
218
|
end
|
|
192
219
|
end
|
|
193
220
|
|
|
221
|
+
# unit tests for deduct_loyalty_card_points
|
|
222
|
+
# Deduct points from card in a given loyalty program.
|
|
223
|
+
# Deduct points from the given loyalty card in the specified card-based loyalty program.
|
|
224
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
225
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
226
|
+
# @param body body
|
|
227
|
+
# @param [Hash] opts the optional parameters
|
|
228
|
+
# @return [nil]
|
|
229
|
+
describe 'deduct_loyalty_card_points test' do
|
|
230
|
+
it 'should work' do
|
|
231
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
|
|
194
235
|
# unit tests for delete_account_collection
|
|
195
236
|
# Delete account-level collection
|
|
196
|
-
# Delete the given account-level collection
|
|
197
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
237
|
+
# Delete the given account-level collection.
|
|
238
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
198
239
|
# @param [Hash] opts the optional parameters
|
|
199
240
|
# @return [nil]
|
|
200
241
|
describe 'delete_account_collection test' do
|
|
@@ -221,7 +262,7 @@ describe 'ManagementApi' do
|
|
|
221
262
|
# Delete the given collection.
|
|
222
263
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
223
264
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
224
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
265
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
225
266
|
# @param [Hash] opts the optional parameters
|
|
226
267
|
# @return [nil]
|
|
227
268
|
describe 'delete_collection test' do
|
|
@@ -235,7 +276,7 @@ describe 'ManagementApi' do
|
|
|
235
276
|
# Delete the specified coupon.
|
|
236
277
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
237
278
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
238
|
-
# @param coupon_id The ID of the coupon code
|
|
279
|
+
# @param coupon_id The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
|
|
239
280
|
# @param [Hash] opts the optional parameters
|
|
240
281
|
# @return [nil]
|
|
241
282
|
describe 'delete_coupon test' do
|
|
@@ -257,10 +298,10 @@ describe 'ManagementApi' do
|
|
|
257
298
|
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
258
299
|
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
259
300
|
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
260
|
-
# @option opts [String] :valid - `expired`: Matches coupons in which the
|
|
301
|
+
# @option opts [String] :valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
|
261
302
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
|
262
303
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
|
263
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the
|
|
304
|
+
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
|
264
305
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.
|
|
265
306
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
|
266
307
|
# @return [nil]
|
|
@@ -272,9 +313,9 @@ describe 'ManagementApi' do
|
|
|
272
313
|
|
|
273
314
|
# unit tests for delete_loyalty_card
|
|
274
315
|
# Delete loyalty card
|
|
275
|
-
# Delete the
|
|
276
|
-
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs
|
|
277
|
-
# @param loyalty_card_identifier Identifier of the loyalty card.
|
|
316
|
+
# Delete the given loyalty card.
|
|
317
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
318
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
278
319
|
# @param [Hash] opts the optional parameters
|
|
279
320
|
# @return [nil]
|
|
280
321
|
describe 'delete_loyalty_card test' do
|
|
@@ -283,12 +324,25 @@ describe 'ManagementApi' do
|
|
|
283
324
|
end
|
|
284
325
|
end
|
|
285
326
|
|
|
327
|
+
# unit tests for delete_notification_webhook
|
|
328
|
+
# Delete notification about campaign-related changes
|
|
329
|
+
# Remove the given existing [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications).
|
|
330
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
331
|
+
# @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
|
|
332
|
+
# @param [Hash] opts the optional parameters
|
|
333
|
+
# @return [nil]
|
|
334
|
+
describe 'delete_notification_webhook test' do
|
|
335
|
+
it 'should work' do
|
|
336
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
337
|
+
end
|
|
338
|
+
end
|
|
339
|
+
|
|
286
340
|
# unit tests for delete_referral
|
|
287
341
|
# Delete referral
|
|
288
342
|
# Delete the specified referral.
|
|
289
343
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
290
344
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
291
|
-
# @param referral_id The ID of the referral code
|
|
345
|
+
# @param referral_id The ID of the referral code.
|
|
292
346
|
# @param [Hash] opts the optional parameters
|
|
293
347
|
# @return [nil]
|
|
294
348
|
describe 'delete_referral test' do
|
|
@@ -309,9 +363,9 @@ describe 'ManagementApi' do
|
|
|
309
363
|
end
|
|
310
364
|
|
|
311
365
|
# unit tests for export_account_collection_items
|
|
312
|
-
# Export account-level collection items
|
|
313
|
-
# Download a file containing an account-level collection
|
|
314
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
366
|
+
# Export account-level collection's items
|
|
367
|
+
# Download a CSV file containing items from an account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
|
368
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
315
369
|
# @param [Hash] opts the optional parameters
|
|
316
370
|
# @return [String]
|
|
317
371
|
describe 'export_account_collection_items test' do
|
|
@@ -321,11 +375,11 @@ describe 'ManagementApi' do
|
|
|
321
375
|
end
|
|
322
376
|
|
|
323
377
|
# unit tests for export_collection_items
|
|
324
|
-
# Export a collection's items
|
|
325
|
-
# Download a file containing a collection's items.
|
|
378
|
+
# Export a collection's items
|
|
379
|
+
# Download a CSV file containing a collection's items. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
|
326
380
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
327
381
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
328
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
382
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
329
383
|
# @param [Hash] opts the optional parameters
|
|
330
384
|
# @return [String]
|
|
331
385
|
describe 'export_collection_items test' do
|
|
@@ -335,18 +389,18 @@ describe 'ManagementApi' do
|
|
|
335
389
|
end
|
|
336
390
|
|
|
337
391
|
# unit tests for export_coupons
|
|
338
|
-
# Export coupons
|
|
339
|
-
# Download a file containing the coupons that match the given properties.
|
|
392
|
+
# Export coupons
|
|
393
|
+
# Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
|
|
340
394
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
341
395
|
# @param [Hash] opts the optional parameters
|
|
342
396
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
|
343
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
397
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
344
398
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
345
399
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
346
400
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
347
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the
|
|
401
|
+
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
|
348
402
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
349
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the
|
|
403
|
+
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
|
350
404
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
351
405
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
|
352
406
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
|
@@ -360,8 +414,8 @@ describe 'ManagementApi' do
|
|
|
360
414
|
end
|
|
361
415
|
|
|
362
416
|
# unit tests for export_customer_sessions
|
|
363
|
-
# Export customer sessions
|
|
364
|
-
# Download a file containing the customer sessions that match the request.
|
|
417
|
+
# Export customer sessions
|
|
418
|
+
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of the session. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `coupons`: Coupon codes in the session.
|
|
365
419
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
366
420
|
# @param [Hash] opts the optional parameters
|
|
367
421
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
|
@@ -377,8 +431,8 @@ describe 'ManagementApi' do
|
|
|
377
431
|
end
|
|
378
432
|
|
|
379
433
|
# unit tests for export_effects
|
|
380
|
-
# Export triggered effects
|
|
381
|
-
# Download a file containing the triggered effects that match the given attributes.
|
|
434
|
+
# Export triggered effects
|
|
435
|
+
# Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue.
|
|
382
436
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
383
437
|
# @param [Hash] opts the optional parameters
|
|
384
438
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
|
@@ -393,10 +447,11 @@ describe 'ManagementApi' do
|
|
|
393
447
|
end
|
|
394
448
|
|
|
395
449
|
# unit tests for export_loyalty_balance
|
|
396
|
-
# Export customer loyalty balance to
|
|
397
|
-
# Download a file
|
|
450
|
+
# Export customer loyalty balance to CSV
|
|
451
|
+
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
|
398
452
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
399
453
|
# @param [Hash] opts the optional parameters
|
|
454
|
+
# @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
|
|
400
455
|
# @return [String]
|
|
401
456
|
describe 'export_loyalty_balance test' do
|
|
402
457
|
it 'should work' do
|
|
@@ -404,11 +459,53 @@ describe 'ManagementApi' do
|
|
|
404
459
|
end
|
|
405
460
|
end
|
|
406
461
|
|
|
462
|
+
# unit tests for export_loyalty_balances
|
|
463
|
+
# Export customer loyalty balances
|
|
464
|
+
# Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
|
|
465
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
|
466
|
+
# @param [Hash] opts the optional parameters
|
|
467
|
+
# @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
|
|
468
|
+
# @return [String]
|
|
469
|
+
describe 'export_loyalty_balances test' do
|
|
470
|
+
it 'should work' do
|
|
471
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
472
|
+
end
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
# unit tests for export_loyalty_card_balances
|
|
476
|
+
# Export loyalty card transaction logs to CSV
|
|
477
|
+
# Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
|
|
478
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
479
|
+
# @param [Hash] opts the optional parameters
|
|
480
|
+
# @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
|
|
481
|
+
# @return [String]
|
|
482
|
+
describe 'export_loyalty_card_balances test' do
|
|
483
|
+
it 'should work' do
|
|
484
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
485
|
+
end
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
# unit tests for export_loyalty_card_ledger
|
|
489
|
+
# Export a loyalty card ledger log
|
|
490
|
+
# Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
|
491
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
492
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
493
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
494
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
495
|
+
# @param [Hash] opts the optional parameters
|
|
496
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
|
497
|
+
# @return [String]
|
|
498
|
+
describe 'export_loyalty_card_ledger test' do
|
|
499
|
+
it 'should work' do
|
|
500
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
501
|
+
end
|
|
502
|
+
end
|
|
503
|
+
|
|
407
504
|
# unit tests for export_loyalty_ledger
|
|
408
|
-
# Export
|
|
409
|
-
# Download a file
|
|
410
|
-
# @param range_start Only return results from after this timestamp
|
|
411
|
-
# @param range_end Only return results from before this timestamp
|
|
505
|
+
# Export customer's transaction logs
|
|
506
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The type of the loyalty program. - `name`: The name of the loyalty program. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived.
|
|
507
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
508
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
412
509
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
413
510
|
# @param integration_id The identifier of the profile.
|
|
414
511
|
# @param [Hash] opts the optional parameters
|
|
@@ -421,14 +518,14 @@ describe 'ManagementApi' do
|
|
|
421
518
|
end
|
|
422
519
|
|
|
423
520
|
# unit tests for export_referrals
|
|
424
|
-
# Export referrals
|
|
425
|
-
# Download a file containing the referrals that match the given parameters.
|
|
521
|
+
# Export referrals
|
|
522
|
+
# Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
|
|
426
523
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
427
524
|
# @param [Hash] opts the optional parameters
|
|
428
525
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
|
429
526
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
430
527
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
431
|
-
# @option opts [String] :valid - `expired`: Matches referrals in which the
|
|
528
|
+
# @option opts [String] :valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
|
|
432
529
|
# @option opts [String] :usable - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
|
|
433
530
|
# @option opts [String] :batch_id Filter results by batches of referrals
|
|
434
531
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
|
@@ -441,18 +538,18 @@ describe 'ManagementApi' do
|
|
|
441
538
|
|
|
442
539
|
# unit tests for get_access_logs_without_total_count
|
|
443
540
|
# Get access logs for Application
|
|
444
|
-
# Retrieve the list of API calls to
|
|
541
|
+
# Retrieve the list of API calls sent to the specified Application.
|
|
445
542
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
446
|
-
# @param range_start Only return results from after this timestamp
|
|
447
|
-
# @param range_end Only return results from before this timestamp
|
|
543
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
544
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
448
545
|
# @param [Hash] opts the optional parameters
|
|
449
546
|
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
|
450
547
|
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
|
451
548
|
# @option opts [String] :status Filter results by HTTP status codes.
|
|
452
|
-
# @option opts [Integer] :page_size The number of items
|
|
549
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
453
550
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
454
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
455
|
-
# @return [
|
|
551
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
552
|
+
# @return [InlineResponse20017]
|
|
456
553
|
describe 'get_access_logs_without_total_count test' do
|
|
457
554
|
it 'should work' do
|
|
458
555
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -462,7 +559,7 @@ describe 'ManagementApi' do
|
|
|
462
559
|
# unit tests for get_account
|
|
463
560
|
# Get account details
|
|
464
561
|
# Return the details of your companies Talon.One account.
|
|
465
|
-
# @param account_id The identifier of the account. Retrieve it via the [List users in account
|
|
562
|
+
# @param account_id The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
|
|
466
563
|
# @param [Hash] opts the optional parameters
|
|
467
564
|
# @return [Account]
|
|
468
565
|
describe 'get_account test' do
|
|
@@ -474,7 +571,7 @@ describe 'ManagementApi' do
|
|
|
474
571
|
# unit tests for get_account_analytics
|
|
475
572
|
# Get account analytics
|
|
476
573
|
# Return the analytics of your Talon.One account.
|
|
477
|
-
# @param account_id The identifier of the account. Retrieve it via the [List users in account
|
|
574
|
+
# @param account_id The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
|
|
478
575
|
# @param [Hash] opts the optional parameters
|
|
479
576
|
# @return [AccountAnalytics]
|
|
480
577
|
describe 'get_account_analytics test' do
|
|
@@ -485,8 +582,8 @@ describe 'ManagementApi' do
|
|
|
485
582
|
|
|
486
583
|
# unit tests for get_account_collection
|
|
487
584
|
# Get account-level collection
|
|
488
|
-
# Retrieve
|
|
489
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
585
|
+
# Retrieve a given account-level collection.
|
|
586
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
490
587
|
# @param [Hash] opts the optional parameters
|
|
491
588
|
# @return [Collection]
|
|
492
589
|
describe 'get_account_collection test' do
|
|
@@ -498,7 +595,7 @@ describe 'ManagementApi' do
|
|
|
498
595
|
# unit tests for get_additional_cost
|
|
499
596
|
# Get additional cost
|
|
500
597
|
# Returns the additional cost.
|
|
501
|
-
# @param additional_cost_id
|
|
598
|
+
# @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
|
|
502
599
|
# @param [Hash] opts the optional parameters
|
|
503
600
|
# @return [AccountAdditionalCost]
|
|
504
601
|
describe 'get_additional_cost test' do
|
|
@@ -511,10 +608,10 @@ describe 'ManagementApi' do
|
|
|
511
608
|
# List additional costs
|
|
512
609
|
# Returns all the defined additional costs for the account.
|
|
513
610
|
# @param [Hash] opts the optional parameters
|
|
514
|
-
# @option opts [Integer] :page_size The number of items
|
|
611
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
515
612
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
516
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
517
|
-
# @return [
|
|
613
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
614
|
+
# @return [InlineResponse20031]
|
|
518
615
|
describe 'get_additional_costs test' do
|
|
519
616
|
it 'should work' do
|
|
520
617
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -524,16 +621,16 @@ describe 'ManagementApi' do
|
|
|
524
621
|
# unit tests for get_all_access_logs
|
|
525
622
|
# List access logs
|
|
526
623
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
|
527
|
-
# @param range_start Only return results from after this timestamp
|
|
528
|
-
# @param range_end Only return results from before this timestamp
|
|
624
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
625
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
529
626
|
# @param [Hash] opts the optional parameters
|
|
530
627
|
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
|
531
628
|
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
|
532
629
|
# @option opts [String] :status Filter results by HTTP status codes.
|
|
533
|
-
# @option opts [Integer] :page_size The number of items
|
|
630
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
534
631
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
535
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
536
|
-
# @return [
|
|
632
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
633
|
+
# @return [InlineResponse20018]
|
|
537
634
|
describe 'get_all_access_logs test' do
|
|
538
635
|
it 'should work' do
|
|
539
636
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -544,7 +641,7 @@ describe 'ManagementApi' do
|
|
|
544
641
|
# List roles
|
|
545
642
|
# List all roles.
|
|
546
643
|
# @param [Hash] opts the optional parameters
|
|
547
|
-
# @return [
|
|
644
|
+
# @return [InlineResponse20039]
|
|
548
645
|
describe 'get_all_roles test' do
|
|
549
646
|
it 'should work' do
|
|
550
647
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -552,7 +649,7 @@ describe 'ManagementApi' do
|
|
|
552
649
|
end
|
|
553
650
|
|
|
554
651
|
# unit tests for get_application
|
|
555
|
-
# Get
|
|
652
|
+
# Get Application
|
|
556
653
|
# Get the application specified by the ID.
|
|
557
654
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
558
655
|
# @param [Hash] opts the optional parameters
|
|
@@ -564,8 +661,8 @@ describe 'ManagementApi' do
|
|
|
564
661
|
end
|
|
565
662
|
|
|
566
663
|
# unit tests for get_application_api_health
|
|
567
|
-
# Get
|
|
568
|
-
# Display the health of the
|
|
664
|
+
# Get Application health
|
|
665
|
+
# Display the health of the Application and show the last time the Application was used. You can also display this information from the **Settings** of an Application, in the **Developer Settings** menu. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
|
|
569
666
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
570
667
|
# @param [Hash] opts the optional parameters
|
|
571
668
|
# @return [ApplicationApiHealth]
|
|
@@ -579,7 +676,7 @@ describe 'ManagementApi' do
|
|
|
579
676
|
# Get application's customer
|
|
580
677
|
# Retrieve the customers of the specified application.
|
|
581
678
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
582
|
-
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List
|
|
679
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
583
680
|
# @param [Hash] opts the optional parameters
|
|
584
681
|
# @return [ApplicationCustomer]
|
|
585
682
|
describe 'get_application_customer test' do
|
|
@@ -594,11 +691,11 @@ describe 'ManagementApi' do
|
|
|
594
691
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
595
692
|
# @param integration_id The Integration ID of the Advocate's Profile.
|
|
596
693
|
# @param [Hash] opts the optional parameters
|
|
597
|
-
# @option opts [Integer] :page_size The number of items
|
|
694
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
598
695
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
599
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
696
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
600
697
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
601
|
-
# @return [
|
|
698
|
+
# @return [InlineResponse20029]
|
|
602
699
|
describe 'get_application_customer_friends test' do
|
|
603
700
|
it 'should work' do
|
|
604
701
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -611,10 +708,10 @@ describe 'ManagementApi' do
|
|
|
611
708
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
612
709
|
# @param [Hash] opts the optional parameters
|
|
613
710
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
|
614
|
-
# @option opts [Integer] :page_size The number of items
|
|
711
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
615
712
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
616
713
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
617
|
-
# @return [
|
|
714
|
+
# @return [InlineResponse20020]
|
|
618
715
|
describe 'get_application_customers test' do
|
|
619
716
|
it 'should work' do
|
|
620
717
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -625,12 +722,12 @@ describe 'ManagementApi' do
|
|
|
625
722
|
# List application customers matching the given attributes
|
|
626
723
|
# Get a list of the application customers matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
|
|
627
724
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
628
|
-
# @param body
|
|
725
|
+
# @param body body
|
|
629
726
|
# @param [Hash] opts the optional parameters
|
|
630
|
-
# @option opts [Integer] :page_size The number of items
|
|
727
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
631
728
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
632
729
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
633
|
-
# @return [
|
|
730
|
+
# @return [InlineResponse20021]
|
|
634
731
|
describe 'get_application_customers_by_attributes test' do
|
|
635
732
|
it 'should work' do
|
|
636
733
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -639,13 +736,13 @@ describe 'ManagementApi' do
|
|
|
639
736
|
|
|
640
737
|
# unit tests for get_application_event_types
|
|
641
738
|
# List Applications event types
|
|
642
|
-
# Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api
|
|
739
|
+
# Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#operation/trackEvent)
|
|
643
740
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
644
741
|
# @param [Hash] opts the optional parameters
|
|
645
|
-
# @option opts [Integer] :page_size The number of items
|
|
742
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
646
743
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
647
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
648
|
-
# @return [
|
|
744
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
745
|
+
# @return [InlineResponse20027]
|
|
649
746
|
describe 'get_application_event_types test' do
|
|
650
747
|
it 'should work' do
|
|
651
748
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -654,12 +751,12 @@ describe 'ManagementApi' do
|
|
|
654
751
|
|
|
655
752
|
# unit tests for get_application_events_without_total_count
|
|
656
753
|
# List Applications events
|
|
657
|
-
# Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only
|
|
754
|
+
# Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
|
|
658
755
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
659
756
|
# @param [Hash] opts the optional parameters
|
|
660
|
-
# @option opts [Integer] :page_size The number of items
|
|
757
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
661
758
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
662
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
759
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
663
760
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
|
664
761
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
|
665
762
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
|
@@ -671,7 +768,7 @@ describe 'ManagementApi' do
|
|
|
671
768
|
# @option opts [String] :referral_code Referral code
|
|
672
769
|
# @option opts [String] :rule_query Rule name filter for events
|
|
673
770
|
# @option opts [String] :campaign_query Campaign name filter for events
|
|
674
|
-
# @return [
|
|
771
|
+
# @return [InlineResponse20026]
|
|
675
772
|
describe 'get_application_events_without_total_count test' do
|
|
676
773
|
it 'should work' do
|
|
677
774
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -680,9 +777,9 @@ describe 'ManagementApi' do
|
|
|
680
777
|
|
|
681
778
|
# unit tests for get_application_session
|
|
682
779
|
# Get Application session
|
|
683
|
-
# Get the details of the given session. You can list the sessions with the [List Application sessions](#operation/getApplicationSessions) endpoint.
|
|
780
|
+
# Get the details of the given session. You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
|
|
684
781
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
685
|
-
# @param session_id The **internal** ID of the session. You can get the ID with the [List Application sessions
|
|
782
|
+
# @param session_id The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
|
|
686
783
|
# @param [Hash] opts the optional parameters
|
|
687
784
|
# @return [ApplicationSession]
|
|
688
785
|
describe 'get_application_session test' do
|
|
@@ -696,9 +793,9 @@ describe 'ManagementApi' do
|
|
|
696
793
|
# List all the sessions of the specified Application.
|
|
697
794
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
698
795
|
# @param [Hash] opts the optional parameters
|
|
699
|
-
# @option opts [Integer] :page_size The number of items
|
|
796
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
700
797
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
701
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
798
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
702
799
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
|
703
800
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
|
704
801
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
|
@@ -706,7 +803,7 @@ describe 'ManagementApi' do
|
|
|
706
803
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
|
707
804
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
|
708
805
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
|
709
|
-
# @return [
|
|
806
|
+
# @return [InlineResponse20025]
|
|
710
807
|
describe 'get_application_sessions test' do
|
|
711
808
|
it 'should work' do
|
|
712
809
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -714,13 +811,13 @@ describe 'ManagementApi' do
|
|
|
714
811
|
end
|
|
715
812
|
|
|
716
813
|
# unit tests for get_applications
|
|
717
|
-
# List
|
|
814
|
+
# List Applications
|
|
718
815
|
# List all applications in the current account.
|
|
719
816
|
# @param [Hash] opts the optional parameters
|
|
720
|
-
# @option opts [Integer] :page_size The number of items
|
|
817
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
721
818
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
722
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
723
|
-
# @return [
|
|
819
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
820
|
+
# @return [InlineResponse2002]
|
|
724
821
|
describe 'get_applications test' do
|
|
725
822
|
it 'should work' do
|
|
726
823
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -729,8 +826,8 @@ describe 'ManagementApi' do
|
|
|
729
826
|
|
|
730
827
|
# unit tests for get_attribute
|
|
731
828
|
# Get custom attribute
|
|
732
|
-
#
|
|
733
|
-
# @param attribute_id
|
|
829
|
+
# Retrieve the specified custom attribute.
|
|
830
|
+
# @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
|
734
831
|
# @param [Hash] opts the optional parameters
|
|
735
832
|
# @return [Attribute]
|
|
736
833
|
describe 'get_attribute test' do
|
|
@@ -741,13 +838,13 @@ describe 'ManagementApi' do
|
|
|
741
838
|
|
|
742
839
|
# unit tests for get_attributes
|
|
743
840
|
# List custom attributes
|
|
744
|
-
#
|
|
841
|
+
# Return all the custom attributes for the account.
|
|
745
842
|
# @param [Hash] opts the optional parameters
|
|
746
|
-
# @option opts [Integer] :page_size The number of items
|
|
843
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
747
844
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
748
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
749
|
-
# @option opts [String] :entity Returned attributes will be filtered by supplied entity
|
|
750
|
-
# @return [
|
|
845
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
846
|
+
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
|
847
|
+
# @return [InlineResponse20030]
|
|
751
848
|
describe 'get_attributes test' do
|
|
752
849
|
it 'should work' do
|
|
753
850
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -756,13 +853,13 @@ describe 'ManagementApi' do
|
|
|
756
853
|
|
|
757
854
|
# unit tests for get_audiences
|
|
758
855
|
# List audiences
|
|
759
|
-
# Get
|
|
856
|
+
# Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
|
|
760
857
|
# @param [Hash] opts the optional parameters
|
|
761
|
-
# @option opts [Integer] :page_size The number of items
|
|
858
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
762
859
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
763
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
860
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
764
861
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
765
|
-
# @return [
|
|
862
|
+
# @return [InlineResponse20028]
|
|
766
863
|
describe 'get_audiences test' do
|
|
767
864
|
it 'should work' do
|
|
768
865
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -787,11 +884,11 @@ describe 'ManagementApi' do
|
|
|
787
884
|
# Retrieve statistical data about the performance of the given campaign.
|
|
788
885
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
789
886
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
790
|
-
# @param range_start Only return results from after this timestamp
|
|
791
|
-
# @param range_end Only return results from before this timestamp
|
|
887
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
888
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
792
889
|
# @param [Hash] opts the optional parameters
|
|
793
890
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
|
794
|
-
# @return [
|
|
891
|
+
# @return [InlineResponse20019]
|
|
795
892
|
describe 'get_campaign_analytics test' do
|
|
796
893
|
it 'should work' do
|
|
797
894
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -802,27 +899,45 @@ describe 'ManagementApi' do
|
|
|
802
899
|
# List campaigns that match the given attributes
|
|
803
900
|
# Get a list of all the campaigns that match a set of attributes.
|
|
804
901
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
805
|
-
# @param body
|
|
902
|
+
# @param body body
|
|
806
903
|
# @param [Hash] opts the optional parameters
|
|
807
|
-
# @option opts [Integer] :page_size The number of items
|
|
904
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
808
905
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
809
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
906
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
810
907
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
|
811
|
-
# @return [
|
|
908
|
+
# @return [InlineResponse2003]
|
|
812
909
|
describe 'get_campaign_by_attributes test' do
|
|
813
910
|
it 'should work' do
|
|
814
911
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
815
912
|
end
|
|
816
913
|
end
|
|
817
914
|
|
|
915
|
+
# unit tests for get_campaign_templates
|
|
916
|
+
# List campaign templates
|
|
917
|
+
# Retrieve a list of campaign templates.
|
|
918
|
+
# @param [Hash] opts the optional parameters
|
|
919
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
920
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
921
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
922
|
+
# @option opts [String] :state Filter results by the state of the campaign template.
|
|
923
|
+
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
|
924
|
+
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
|
925
|
+
# @option opts [Integer] :user_id Filter results by user ID.
|
|
926
|
+
# @return [InlineResponse2009]
|
|
927
|
+
describe 'get_campaign_templates test' do
|
|
928
|
+
it 'should work' do
|
|
929
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
930
|
+
end
|
|
931
|
+
end
|
|
932
|
+
|
|
818
933
|
# unit tests for get_campaigns
|
|
819
934
|
# List campaigns
|
|
820
935
|
# List the campaigns of the specified application that match your filter criteria.
|
|
821
936
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
822
937
|
# @param [Hash] opts the optional parameters
|
|
823
|
-
# @option opts [Integer] :page_size The number of items
|
|
938
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
824
939
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
825
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
940
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
826
941
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
|
827
942
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
|
828
943
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
|
@@ -830,7 +945,7 @@ describe 'ManagementApi' do
|
|
|
830
945
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
831
946
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
|
832
947
|
# @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
|
|
833
|
-
# @return [
|
|
948
|
+
# @return [InlineResponse2003]
|
|
834
949
|
describe 'get_campaigns test' do
|
|
835
950
|
it 'should work' do
|
|
836
951
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -838,20 +953,21 @@ describe 'ManagementApi' do
|
|
|
838
953
|
end
|
|
839
954
|
|
|
840
955
|
# unit tests for get_changes
|
|
841
|
-
# Get audit
|
|
842
|
-
#
|
|
956
|
+
# Get audit logs for an account
|
|
957
|
+
# Retrieve the audit logs displayed in **Accounts > Audit logs**.
|
|
843
958
|
# @param [Hash] opts the optional parameters
|
|
844
|
-
# @option opts [Integer] :page_size The number of items
|
|
959
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
845
960
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
846
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
961
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
847
962
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
848
963
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
|
849
|
-
# @option opts [Integer] :user_id Filter results
|
|
964
|
+
# @option opts [Integer] :user_id Filter results by user ID.
|
|
850
965
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
851
966
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
852
967
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
968
|
+
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
|
853
969
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
|
854
|
-
# @return [
|
|
970
|
+
# @return [InlineResponse20037]
|
|
855
971
|
describe 'get_changes test' do
|
|
856
972
|
it 'should work' do
|
|
857
973
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -860,10 +976,10 @@ describe 'ManagementApi' do
|
|
|
860
976
|
|
|
861
977
|
# unit tests for get_collection
|
|
862
978
|
# Get collection
|
|
863
|
-
# Retrieve
|
|
979
|
+
# Retrieve a given collection.
|
|
864
980
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
865
981
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
866
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
982
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
867
983
|
# @param [Hash] opts the optional parameters
|
|
868
984
|
# @return [Collection]
|
|
869
985
|
describe 'get_collection test' do
|
|
@@ -872,25 +988,39 @@ describe 'ManagementApi' do
|
|
|
872
988
|
end
|
|
873
989
|
end
|
|
874
990
|
|
|
991
|
+
# unit tests for get_collection_items
|
|
992
|
+
# Get collection items
|
|
993
|
+
# Retrieve the items from the given collection.
|
|
994
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
995
|
+
# @param [Hash] opts the optional parameters
|
|
996
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
997
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
998
|
+
# @return [InlineResponse20015]
|
|
999
|
+
describe 'get_collection_items test' do
|
|
1000
|
+
it 'should work' do
|
|
1001
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1002
|
+
end
|
|
1003
|
+
end
|
|
1004
|
+
|
|
875
1005
|
# unit tests for get_coupons_without_total_count
|
|
876
1006
|
# List coupons
|
|
877
1007
|
# List all the coupons matching the specified criteria.
|
|
878
1008
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
879
1009
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
880
1010
|
# @param [Hash] opts the optional parameters
|
|
881
|
-
# @option opts [Integer] :page_size The number of items
|
|
1011
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
882
1012
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
883
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1013
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
884
1014
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
885
1015
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
886
1016
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
887
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the
|
|
1017
|
+
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
|
888
1018
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
889
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the
|
|
1019
|
+
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
|
890
1020
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
891
1021
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
|
892
1022
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
|
893
|
-
# @return [
|
|
1023
|
+
# @return [InlineResponse2007]
|
|
894
1024
|
describe 'get_coupons_without_total_count test' do
|
|
895
1025
|
it 'should work' do
|
|
896
1026
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -900,12 +1030,12 @@ describe 'ManagementApi' do
|
|
|
900
1030
|
# unit tests for get_customer_activity_report
|
|
901
1031
|
# Get customer's activity report
|
|
902
1032
|
# Fetch the summary report of a given customer in the given application, in a time range.
|
|
903
|
-
# @param range_start Only return results from after this timestamp
|
|
904
|
-
# @param range_end Only return results from before this timestamp
|
|
1033
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
1034
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
905
1035
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
906
|
-
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List
|
|
1036
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
907
1037
|
# @param [Hash] opts the optional parameters
|
|
908
|
-
# @option opts [Integer] :page_size The number of items
|
|
1038
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
909
1039
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
910
1040
|
# @return [CustomerActivityReport]
|
|
911
1041
|
describe 'get_customer_activity_report test' do
|
|
@@ -916,19 +1046,19 @@ describe 'ManagementApi' do
|
|
|
916
1046
|
|
|
917
1047
|
# unit tests for get_customer_activity_reports_without_total_count
|
|
918
1048
|
# Get Activity Reports for Application Customers
|
|
919
|
-
# Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only
|
|
920
|
-
# @param range_start Only return results from after this timestamp
|
|
921
|
-
# @param range_end Only return results from before this timestamp
|
|
1049
|
+
# Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
|
|
1050
|
+
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
|
1051
|
+
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
|
922
1052
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
923
1053
|
# @param [Hash] opts the optional parameters
|
|
924
|
-
# @option opts [Integer] :page_size The number of items
|
|
1054
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
925
1055
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
926
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1056
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
927
1057
|
# @option opts [String] :name Only return reports matching the customer name
|
|
928
1058
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
|
929
1059
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
|
930
1060
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
|
931
|
-
# @return [
|
|
1061
|
+
# @return [InlineResponse20024]
|
|
932
1062
|
describe 'get_customer_activity_reports_without_total_count test' do
|
|
933
1063
|
it 'should work' do
|
|
934
1064
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -939,11 +1069,11 @@ describe 'ManagementApi' do
|
|
|
939
1069
|
# Get customer's analytics report
|
|
940
1070
|
# Fetch analytics for a given customer in the given application.
|
|
941
1071
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
942
|
-
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List
|
|
1072
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
943
1073
|
# @param [Hash] opts the optional parameters
|
|
944
|
-
# @option opts [Integer] :page_size The number of items
|
|
1074
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
945
1075
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
946
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1076
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
947
1077
|
# @return [CustomerAnalytics]
|
|
948
1078
|
describe 'get_customer_analytics test' do
|
|
949
1079
|
it 'should work' do
|
|
@@ -953,8 +1083,8 @@ describe 'ManagementApi' do
|
|
|
953
1083
|
|
|
954
1084
|
# unit tests for get_customer_profile
|
|
955
1085
|
# Get customer profile
|
|
956
|
-
# Return the details of the specified customer profile.
|
|
957
|
-
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List
|
|
1086
|
+
# Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
|
|
1087
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
958
1088
|
# @param [Hash] opts the optional parameters
|
|
959
1089
|
# @return [CustomerProfile]
|
|
960
1090
|
describe 'get_customer_profile test' do
|
|
@@ -967,9 +1097,10 @@ describe 'ManagementApi' do
|
|
|
967
1097
|
# List customer profiles
|
|
968
1098
|
# List all customer profiles.
|
|
969
1099
|
# @param [Hash] opts the optional parameters
|
|
970
|
-
# @option opts [Integer] :page_size The number of items
|
|
1100
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
971
1101
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
972
|
-
# @
|
|
1102
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
|
1103
|
+
# @return [InlineResponse20023]
|
|
973
1104
|
describe 'get_customer_profiles test' do
|
|
974
1105
|
it 'should work' do
|
|
975
1106
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -979,11 +1110,12 @@ describe 'ManagementApi' do
|
|
|
979
1110
|
# unit tests for get_customers_by_attributes
|
|
980
1111
|
# List customer profiles matching the given attributes
|
|
981
1112
|
# Get a list of the customer profiles matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
|
|
982
|
-
# @param body
|
|
1113
|
+
# @param body body
|
|
983
1114
|
# @param [Hash] opts the optional parameters
|
|
984
|
-
# @option opts [Integer] :page_size The number of items
|
|
1115
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
985
1116
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
986
|
-
# @
|
|
1117
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
|
1118
|
+
# @return [InlineResponse20022]
|
|
987
1119
|
describe 'get_customers_by_attributes test' do
|
|
988
1120
|
it 'should work' do
|
|
989
1121
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -996,10 +1128,10 @@ describe 'ManagementApi' do
|
|
|
996
1128
|
# @param [Hash] opts the optional parameters
|
|
997
1129
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
|
998
1130
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
|
999
|
-
# @option opts [Integer] :page_size The number of items
|
|
1131
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1000
1132
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1001
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1002
|
-
# @return [
|
|
1133
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1134
|
+
# @return [InlineResponse20035]
|
|
1003
1135
|
describe 'get_event_types test' do
|
|
1004
1136
|
it 'should work' do
|
|
1005
1137
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1010,21 +1142,69 @@ describe 'ManagementApi' do
|
|
|
1010
1142
|
# Get exports
|
|
1011
1143
|
# List all past exports
|
|
1012
1144
|
# @param [Hash] opts the optional parameters
|
|
1013
|
-
# @option opts [Integer] :page_size The number of items
|
|
1145
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1014
1146
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1015
1147
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
1016
1148
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
|
1017
1149
|
# @option opts [String] :entity The name of the entity type that was exported.
|
|
1018
|
-
# @return [
|
|
1150
|
+
# @return [InlineResponse20038]
|
|
1019
1151
|
describe 'get_exports test' do
|
|
1020
1152
|
it 'should work' do
|
|
1021
1153
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1022
1154
|
end
|
|
1023
1155
|
end
|
|
1024
1156
|
|
|
1157
|
+
# unit tests for get_loyalty_card
|
|
1158
|
+
# Get loyalty card
|
|
1159
|
+
# Get the given loyalty card.
|
|
1160
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1161
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
1162
|
+
# @param [Hash] opts the optional parameters
|
|
1163
|
+
# @return [LoyaltyCard]
|
|
1164
|
+
describe 'get_loyalty_card test' do
|
|
1165
|
+
it 'should work' do
|
|
1166
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1167
|
+
end
|
|
1168
|
+
end
|
|
1169
|
+
|
|
1170
|
+
# unit tests for get_loyalty_card_transaction_logs
|
|
1171
|
+
# Get loyalty card transaction logs
|
|
1172
|
+
# Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
|
1173
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1174
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
1175
|
+
# @param [Hash] opts the optional parameters
|
|
1176
|
+
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
1177
|
+
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
1178
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1179
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1180
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
1181
|
+
# @return [InlineResponse20013]
|
|
1182
|
+
describe 'get_loyalty_card_transaction_logs test' do
|
|
1183
|
+
it 'should work' do
|
|
1184
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1185
|
+
end
|
|
1186
|
+
end
|
|
1187
|
+
|
|
1188
|
+
# unit tests for get_loyalty_cards
|
|
1189
|
+
# List loyalty cards
|
|
1190
|
+
# For the given card-based loyalty program, list the loyalty cards that match your filter criteria.
|
|
1191
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1192
|
+
# @param [Hash] opts the optional parameters
|
|
1193
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1194
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1195
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1196
|
+
# @option opts [String] :identifier Optional query parameter to search cards by identifier.
|
|
1197
|
+
# @option opts [Integer] :profile_id Filter by the profile ID.
|
|
1198
|
+
# @return [InlineResponse20012]
|
|
1199
|
+
describe 'get_loyalty_cards test' do
|
|
1200
|
+
it 'should work' do
|
|
1201
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1202
|
+
end
|
|
1203
|
+
end
|
|
1204
|
+
|
|
1025
1205
|
# unit tests for get_loyalty_points
|
|
1026
|
-
# Get
|
|
1027
|
-
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api
|
|
1206
|
+
# Get customer's full loyalty ledger
|
|
1207
|
+
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
|
1028
1208
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
1029
1209
|
# @param integration_id The identifier of the profile.
|
|
1030
1210
|
# @param [Hash] opts the optional parameters
|
|
@@ -1037,8 +1217,8 @@ describe 'ManagementApi' do
|
|
|
1037
1217
|
|
|
1038
1218
|
# unit tests for get_loyalty_program
|
|
1039
1219
|
# Get loyalty program
|
|
1040
|
-
# Get the specified [loyalty program](https://
|
|
1041
|
-
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs
|
|
1220
|
+
# Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
|
|
1221
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1042
1222
|
# @param [Hash] opts the optional parameters
|
|
1043
1223
|
# @return [LoyaltyProgram]
|
|
1044
1224
|
describe 'get_loyalty_program test' do
|
|
@@ -1047,11 +1227,29 @@ describe 'ManagementApi' do
|
|
|
1047
1227
|
end
|
|
1048
1228
|
end
|
|
1049
1229
|
|
|
1230
|
+
# unit tests for get_loyalty_program_transactions
|
|
1231
|
+
# List loyalty program transactions
|
|
1232
|
+
# Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
|
1233
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1234
|
+
# @param [Hash] opts the optional parameters
|
|
1235
|
+
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
1236
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
1237
|
+
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
1238
|
+
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
1239
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1240
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1241
|
+
# @return [InlineResponse20011]
|
|
1242
|
+
describe 'get_loyalty_program_transactions test' do
|
|
1243
|
+
it 'should work' do
|
|
1244
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1245
|
+
end
|
|
1246
|
+
end
|
|
1247
|
+
|
|
1050
1248
|
# unit tests for get_loyalty_programs
|
|
1051
1249
|
# List loyalty programs
|
|
1052
1250
|
# List the loyalty programs of the account.
|
|
1053
1251
|
# @param [Hash] opts the optional parameters
|
|
1054
|
-
# @return [
|
|
1252
|
+
# @return [InlineResponse20010]
|
|
1055
1253
|
describe 'get_loyalty_programs test' do
|
|
1056
1254
|
it 'should work' do
|
|
1057
1255
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1059,9 +1257,9 @@ describe 'ManagementApi' do
|
|
|
1059
1257
|
end
|
|
1060
1258
|
|
|
1061
1259
|
# unit tests for get_loyalty_statistics
|
|
1062
|
-
# Get loyalty program statistics
|
|
1063
|
-
# Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points and expired points.
|
|
1064
|
-
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs
|
|
1260
|
+
# Get loyalty program statistics
|
|
1261
|
+
# Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
|
1262
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1065
1263
|
# @param [Hash] opts the optional parameters
|
|
1066
1264
|
# @return [LoyaltyStatistics]
|
|
1067
1265
|
describe 'get_loyalty_statistics test' do
|
|
@@ -1070,22 +1268,47 @@ describe 'ManagementApi' do
|
|
|
1070
1268
|
end
|
|
1071
1269
|
end
|
|
1072
1270
|
|
|
1271
|
+
# unit tests for get_notification_webhook
|
|
1272
|
+
# Get notification about campaign-related changes
|
|
1273
|
+
# Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications).
|
|
1274
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1275
|
+
# @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
|
|
1276
|
+
# @param [Hash] opts the optional parameters
|
|
1277
|
+
# @return [NotificationWebhook]
|
|
1278
|
+
describe 'get_notification_webhook test' do
|
|
1279
|
+
it 'should work' do
|
|
1280
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1281
|
+
end
|
|
1282
|
+
end
|
|
1283
|
+
|
|
1284
|
+
# unit tests for get_notification_webhooks
|
|
1285
|
+
# List notifications about campaign-related changes
|
|
1286
|
+
# List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application.
|
|
1287
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1288
|
+
# @param [Hash] opts the optional parameters
|
|
1289
|
+
# @return [InlineResponse2004]
|
|
1290
|
+
describe 'get_notification_webhooks test' do
|
|
1291
|
+
it 'should work' do
|
|
1292
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1293
|
+
end
|
|
1294
|
+
end
|
|
1295
|
+
|
|
1073
1296
|
# unit tests for get_referrals_without_total_count
|
|
1074
1297
|
# List referrals
|
|
1075
1298
|
# List all referrals of the specified campaign.
|
|
1076
1299
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1077
1300
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1078
1301
|
# @param [Hash] opts the optional parameters
|
|
1079
|
-
# @option opts [Integer] :page_size The number of items
|
|
1302
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1080
1303
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1081
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1304
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1082
1305
|
# @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
1083
1306
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1084
1307
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1085
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the
|
|
1308
|
+
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
|
1086
1309
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
|
1087
1310
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
|
1088
|
-
# @return [
|
|
1311
|
+
# @return [InlineResponse2008]
|
|
1089
1312
|
describe 'get_referrals_without_total_count test' do
|
|
1090
1313
|
it 'should work' do
|
|
1091
1314
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1109,7 +1332,7 @@ describe 'ManagementApi' do
|
|
|
1109
1332
|
# Retrieve the specified ruleset.
|
|
1110
1333
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1111
1334
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1112
|
-
# @param ruleset_id
|
|
1335
|
+
# @param ruleset_id The ID of the ruleset.
|
|
1113
1336
|
# @param [Hash] opts the optional parameters
|
|
1114
1337
|
# @return [Ruleset]
|
|
1115
1338
|
describe 'get_ruleset test' do
|
|
@@ -1124,10 +1347,10 @@ describe 'ManagementApi' do
|
|
|
1124
1347
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1125
1348
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1126
1349
|
# @param [Hash] opts the optional parameters
|
|
1127
|
-
# @option opts [Integer] :page_size The number of items
|
|
1350
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1128
1351
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1129
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1130
|
-
# @return [
|
|
1352
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1353
|
+
# @return [InlineResponse2005]
|
|
1131
1354
|
describe 'get_rulesets test' do
|
|
1132
1355
|
it 'should work' do
|
|
1133
1356
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1150,10 +1373,10 @@ describe 'ManagementApi' do
|
|
|
1150
1373
|
# List users in account
|
|
1151
1374
|
# Retrieve all users in your account.
|
|
1152
1375
|
# @param [Hash] opts the optional parameters
|
|
1153
|
-
# @option opts [Integer] :page_size The number of items
|
|
1376
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1154
1377
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1155
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1156
|
-
# @return [
|
|
1378
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1379
|
+
# @return [InlineResponse20036]
|
|
1157
1380
|
describe 'get_users test' do
|
|
1158
1381
|
it 'should work' do
|
|
1159
1382
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1163,7 +1386,7 @@ describe 'ManagementApi' do
|
|
|
1163
1386
|
# unit tests for get_webhook
|
|
1164
1387
|
# Get webhook
|
|
1165
1388
|
# Returns a webhook by its id.
|
|
1166
|
-
# @param webhook_id
|
|
1389
|
+
# @param webhook_id The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**.
|
|
1167
1390
|
# @param [Hash] opts the optional parameters
|
|
1168
1391
|
# @return [Webhook]
|
|
1169
1392
|
describe 'get_webhook test' do
|
|
@@ -1174,18 +1397,18 @@ describe 'ManagementApi' do
|
|
|
1174
1397
|
|
|
1175
1398
|
# unit tests for get_webhook_activation_logs
|
|
1176
1399
|
# List webhook activation log entries
|
|
1177
|
-
# Webhook activation log entries
|
|
1400
|
+
# Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks).
|
|
1178
1401
|
# @param [Hash] opts the optional parameters
|
|
1179
|
-
# @option opts [Integer] :page_size The number of items
|
|
1402
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1180
1403
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1181
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1404
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1182
1405
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
|
1183
1406
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
|
1184
1407
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
1185
1408
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
|
1186
1409
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1187
1410
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1188
|
-
# @return [
|
|
1411
|
+
# @return [InlineResponse20033]
|
|
1189
1412
|
describe 'get_webhook_activation_logs test' do
|
|
1190
1413
|
it 'should work' do
|
|
1191
1414
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1196,9 +1419,9 @@ describe 'ManagementApi' do
|
|
|
1196
1419
|
# List webhook log entries
|
|
1197
1420
|
# Retrieve all webhook log entries.
|
|
1198
1421
|
# @param [Hash] opts the optional parameters
|
|
1199
|
-
# @option opts [Integer] :page_size The number of items
|
|
1422
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1200
1423
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1201
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1424
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1202
1425
|
# @option opts [String] :status Filter results by HTTP status codes.
|
|
1203
1426
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
|
1204
1427
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
@@ -1206,7 +1429,7 @@ describe 'ManagementApi' do
|
|
|
1206
1429
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
|
1207
1430
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1208
1431
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1209
|
-
# @return [
|
|
1432
|
+
# @return [InlineResponse20034]
|
|
1210
1433
|
describe 'get_webhook_logs test' do
|
|
1211
1434
|
it 'should work' do
|
|
1212
1435
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1217,11 +1440,11 @@ describe 'ManagementApi' do
|
|
|
1217
1440
|
# List webhooks
|
|
1218
1441
|
# List all webhooks.
|
|
1219
1442
|
# @param [Hash] opts the optional parameters
|
|
1220
|
-
# @option opts [String] :application_ids Filter by one or more application
|
|
1221
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1222
|
-
# @option opts [Integer] :page_size The number of items
|
|
1443
|
+
# @option opts [String] :application_ids Filter by one or more application IDs separated by a comma.
|
|
1444
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1445
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1223
1446
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1224
|
-
# @return [
|
|
1447
|
+
# @return [InlineResponse20032]
|
|
1225
1448
|
describe 'get_webhooks test' do
|
|
1226
1449
|
it 'should work' do
|
|
1227
1450
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1229,9 +1452,9 @@ describe 'ManagementApi' do
|
|
|
1229
1452
|
end
|
|
1230
1453
|
|
|
1231
1454
|
# unit tests for import_account_collection
|
|
1232
|
-
# Import data in existing account-level collection
|
|
1455
|
+
# Import data in existing account-level collection
|
|
1233
1456
|
# Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
|
1234
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
1457
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
1235
1458
|
# @param [Hash] opts the optional parameters
|
|
1236
1459
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1237
1460
|
# @return [Import]
|
|
@@ -1243,8 +1466,8 @@ describe 'ManagementApi' do
|
|
|
1243
1466
|
|
|
1244
1467
|
# unit tests for import_allowed_list
|
|
1245
1468
|
# Import allowed values for attribute
|
|
1246
|
-
# Upload a CSV file containing a list of
|
|
1247
|
-
# @param attribute_id
|
|
1469
|
+
# Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
|
|
1470
|
+
# @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
|
1248
1471
|
# @param [Hash] opts the optional parameters
|
|
1249
1472
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1250
1473
|
# @return [Import]
|
|
@@ -1255,11 +1478,11 @@ describe 'ManagementApi' do
|
|
|
1255
1478
|
end
|
|
1256
1479
|
|
|
1257
1480
|
# unit tests for import_collection
|
|
1258
|
-
# Import data in existing collection
|
|
1481
|
+
# Import data in existing collection
|
|
1259
1482
|
# Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
|
1260
1483
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1261
1484
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1262
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
1485
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
1263
1486
|
# @param [Hash] opts the optional parameters
|
|
1264
1487
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1265
1488
|
# @return [Import]
|
|
@@ -1270,8 +1493,8 @@ describe 'ManagementApi' do
|
|
|
1270
1493
|
end
|
|
1271
1494
|
|
|
1272
1495
|
# unit tests for import_coupons
|
|
1273
|
-
# Import coupons
|
|
1274
|
-
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file
|
|
1496
|
+
# Import coupons
|
|
1497
|
+
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the customer who receives the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the coupon entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
|
|
1275
1498
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1276
1499
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1277
1500
|
# @param [Hash] opts the optional parameters
|
|
@@ -1283,10 +1506,23 @@ describe 'ManagementApi' do
|
|
|
1283
1506
|
end
|
|
1284
1507
|
end
|
|
1285
1508
|
|
|
1509
|
+
# unit tests for import_loyalty_cards
|
|
1510
|
+
# Import loyalty cards
|
|
1511
|
+
# Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
|
|
1512
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1513
|
+
# @param [Hash] opts the optional parameters
|
|
1514
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1515
|
+
# @return [Import]
|
|
1516
|
+
describe 'import_loyalty_cards test' do
|
|
1517
|
+
it 'should work' do
|
|
1518
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1519
|
+
end
|
|
1520
|
+
end
|
|
1521
|
+
|
|
1286
1522
|
# unit tests for import_loyalty_points
|
|
1287
|
-
# Import loyalty points
|
|
1288
|
-
# Upload a CSV file containing the
|
|
1289
|
-
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs
|
|
1523
|
+
# Import loyalty points
|
|
1524
|
+
# Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the loyalty program type, you can import the points into a given customer profile or into a given _active_ loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate`: The earliest date when the points can be redeemed. On this date and until the expiration date, the points are `active`. - `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
|
1525
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1290
1526
|
# @param [Hash] opts the optional parameters
|
|
1291
1527
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1292
1528
|
# @return [Import]
|
|
@@ -1298,8 +1534,8 @@ describe 'ManagementApi' do
|
|
|
1298
1534
|
|
|
1299
1535
|
# unit tests for import_pool_giveaways
|
|
1300
1536
|
# Import giveaway codes into a giveaway pool
|
|
1301
|
-
# Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file
|
|
1302
|
-
# @param pool_id
|
|
1537
|
+
# Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): the code of your giveaway, for instance, a gift card redemption code. - `startdate`: the start date in RFC3339 of the code redemption period. - `enddate`: the last date in RFC3339 of the code redemption period. - `attributes`: A json object describing _custom_ giveaway attribute names and their values. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated to the giveaway entity, set it with `\"{\"\"provider\"\": \"\"myPartnerCompany\"\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
|
|
1538
|
+
# @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
|
|
1303
1539
|
# @param [Hash] opts the optional parameters
|
|
1304
1540
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
|
1305
1541
|
# @return [Import]
|
|
@@ -1310,8 +1546,8 @@ describe 'ManagementApi' do
|
|
|
1310
1546
|
end
|
|
1311
1547
|
|
|
1312
1548
|
# unit tests for import_referrals
|
|
1313
|
-
# Import referrals
|
|
1314
|
-
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file
|
|
1549
|
+
# Import referrals
|
|
1550
|
+
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the referral entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
|
|
1315
1551
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1316
1552
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1317
1553
|
# @param [Hash] opts the optional parameters
|
|
@@ -1327,12 +1563,12 @@ describe 'ManagementApi' do
|
|
|
1327
1563
|
# List collections in account
|
|
1328
1564
|
# List collections in account.
|
|
1329
1565
|
# @param [Hash] opts the optional parameters
|
|
1330
|
-
# @option opts [Integer] :page_size The number of items
|
|
1566
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1331
1567
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1332
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1568
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1333
1569
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
1334
1570
|
# @option opts [String] :name Filter by the name of the Collection.
|
|
1335
|
-
# @return [
|
|
1571
|
+
# @return [InlineResponse20014]
|
|
1336
1572
|
describe 'list_account_collections test' do
|
|
1337
1573
|
it 'should work' do
|
|
1338
1574
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1345,12 +1581,12 @@ describe 'ManagementApi' do
|
|
|
1345
1581
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1346
1582
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1347
1583
|
# @param [Hash] opts the optional parameters
|
|
1348
|
-
# @option opts [Integer] :page_size The number of items
|
|
1584
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1349
1585
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1350
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1586
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1351
1587
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
1352
1588
|
# @option opts [String] :name Filter by the name of the Collection.
|
|
1353
|
-
# @return [
|
|
1589
|
+
# @return [InlineResponse20016]
|
|
1354
1590
|
describe 'list_collections test' do
|
|
1355
1591
|
it 'should work' do
|
|
1356
1592
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1362,24 +1598,50 @@ describe 'ManagementApi' do
|
|
|
1362
1598
|
# List collections from all campaigns in the Application.
|
|
1363
1599
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1364
1600
|
# @param [Hash] opts the optional parameters
|
|
1365
|
-
# @option opts [Integer] :page_size The number of items
|
|
1601
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1366
1602
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1367
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1603
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1368
1604
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
1369
1605
|
# @option opts [String] :name Filter by the name of the Collection.
|
|
1370
|
-
# @return [
|
|
1606
|
+
# @return [InlineResponse20016]
|
|
1371
1607
|
describe 'list_collections_in_application test' do
|
|
1372
1608
|
it 'should work' do
|
|
1373
1609
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1374
1610
|
end
|
|
1375
1611
|
end
|
|
1376
1612
|
|
|
1613
|
+
# unit tests for post_added_deducted_points_notification
|
|
1614
|
+
# Create notification about added or deducted loyalty points
|
|
1615
|
+
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications).
|
|
1616
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1617
|
+
# @param body body
|
|
1618
|
+
# @param [Hash] opts the optional parameters
|
|
1619
|
+
# @return [BaseNotification]
|
|
1620
|
+
describe 'post_added_deducted_points_notification test' do
|
|
1621
|
+
it 'should work' do
|
|
1622
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1623
|
+
end
|
|
1624
|
+
end
|
|
1625
|
+
|
|
1626
|
+
# unit tests for post_catalogs_strikethrough_notification
|
|
1627
|
+
# Create strikethrough notification
|
|
1628
|
+
# Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
|
1629
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1630
|
+
# @param body body
|
|
1631
|
+
# @param [Hash] opts the optional parameters
|
|
1632
|
+
# @return [BaseNotification]
|
|
1633
|
+
describe 'post_catalogs_strikethrough_notification test' do
|
|
1634
|
+
it 'should work' do
|
|
1635
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1636
|
+
end
|
|
1637
|
+
end
|
|
1638
|
+
|
|
1377
1639
|
# unit tests for remove_loyalty_points
|
|
1378
|
-
# Deduct points
|
|
1379
|
-
#
|
|
1640
|
+
# Deduct points from customer profile
|
|
1641
|
+
# Deduct points from the specified loyalty program and specified customer profile. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
|
1380
1642
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
1381
1643
|
# @param integration_id The identifier of the profile.
|
|
1382
|
-
# @param body
|
|
1644
|
+
# @param body body
|
|
1383
1645
|
# @param [Hash] opts the optional parameters
|
|
1384
1646
|
# @return [nil]
|
|
1385
1647
|
describe 'remove_loyalty_points test' do
|
|
@@ -1391,7 +1653,7 @@ describe 'ManagementApi' do
|
|
|
1391
1653
|
# unit tests for reset_password
|
|
1392
1654
|
# Reset password
|
|
1393
1655
|
# Consumes the supplied password reset token and updates the password for the associated account.
|
|
1394
|
-
# @param body
|
|
1656
|
+
# @param body body
|
|
1395
1657
|
# @param [Hash] opts the optional parameters
|
|
1396
1658
|
# @return [NewPassword]
|
|
1397
1659
|
describe 'reset_password test' do
|
|
@@ -1404,22 +1666,22 @@ describe 'ManagementApi' do
|
|
|
1404
1666
|
# List coupons that match the given attributes (without total count)
|
|
1405
1667
|
# List the coupons whose attributes match the query criteria in all **active** campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
|
|
1406
1668
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1407
|
-
# @param body
|
|
1669
|
+
# @param body body
|
|
1408
1670
|
# @param [Hash] opts the optional parameters
|
|
1409
|
-
# @option opts [Integer] :page_size The number of items
|
|
1671
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1410
1672
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1411
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1673
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1412
1674
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
1413
1675
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1414
1676
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1415
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the
|
|
1677
|
+
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
|
1416
1678
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
1417
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the
|
|
1679
|
+
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
|
1418
1680
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
1419
1681
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
|
1420
1682
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
|
1421
1683
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
|
1422
|
-
# @return [
|
|
1684
|
+
# @return [InlineResponse2007]
|
|
1423
1685
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
|
1424
1686
|
it 'should work' do
|
|
1425
1687
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1431,32 +1693,46 @@ describe 'ManagementApi' do
|
|
|
1431
1693
|
# List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
|
|
1432
1694
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1433
1695
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1434
|
-
# @param body
|
|
1696
|
+
# @param body body
|
|
1435
1697
|
# @param [Hash] opts the optional parameters
|
|
1436
|
-
# @option opts [Integer] :page_size The number of items
|
|
1698
|
+
# @option opts [Integer] :page_size The number of items in this response.
|
|
1437
1699
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
|
1438
|
-
# @option opts [String] :sort The field by which results should be sorted.
|
|
1700
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
|
1439
1701
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
1440
1702
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1441
1703
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
|
|
1442
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the
|
|
1704
|
+
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
|
1443
1705
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
1444
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the
|
|
1706
|
+
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
|
1445
1707
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
1446
1708
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
|
1447
1709
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
|
1448
|
-
# @return [
|
|
1710
|
+
# @return [InlineResponse2007]
|
|
1449
1711
|
describe 'search_coupons_advanced_without_total_count test' do
|
|
1450
1712
|
it 'should work' do
|
|
1451
1713
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1452
1714
|
end
|
|
1453
1715
|
end
|
|
1454
1716
|
|
|
1717
|
+
# unit tests for transfer_loyalty_card
|
|
1718
|
+
# Transfer loyalty card data
|
|
1719
|
+
# Transfer card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
|
1720
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1721
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
1722
|
+
# @param body body
|
|
1723
|
+
# @param [Hash] opts the optional parameters
|
|
1724
|
+
# @return [nil]
|
|
1725
|
+
describe 'transfer_loyalty_card test' do
|
|
1726
|
+
it 'should work' do
|
|
1727
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1728
|
+
end
|
|
1729
|
+
end
|
|
1730
|
+
|
|
1455
1731
|
# unit tests for update_account_collection
|
|
1456
|
-
# Update account-level collection
|
|
1457
|
-
# Edit the description of the account-level collection and enable or disable the collection in
|
|
1458
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
1459
|
-
# @param body
|
|
1732
|
+
# Update account-level collection
|
|
1733
|
+
# Edit the description of the account-level collection and enable or disable the collection in the specified Applications.
|
|
1734
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
1735
|
+
# @param body body
|
|
1460
1736
|
# @param [Hash] opts the optional parameters
|
|
1461
1737
|
# @return [Collection]
|
|
1462
1738
|
describe 'update_account_collection test' do
|
|
@@ -1468,8 +1744,8 @@ describe 'ManagementApi' do
|
|
|
1468
1744
|
# unit tests for update_additional_cost
|
|
1469
1745
|
# Update additional cost
|
|
1470
1746
|
# Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
|
|
1471
|
-
# @param additional_cost_id
|
|
1472
|
-
# @param body
|
|
1747
|
+
# @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
|
|
1748
|
+
# @param body body
|
|
1473
1749
|
# @param [Hash] opts the optional parameters
|
|
1474
1750
|
# @return [AccountAdditionalCost]
|
|
1475
1751
|
describe 'update_additional_cost test' do
|
|
@@ -1480,9 +1756,9 @@ describe 'ManagementApi' do
|
|
|
1480
1756
|
|
|
1481
1757
|
# unit tests for update_attribute
|
|
1482
1758
|
# Update custom attribute
|
|
1483
|
-
#
|
|
1484
|
-
# @param attribute_id
|
|
1485
|
-
# @param body
|
|
1759
|
+
# Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description. To change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute.
|
|
1760
|
+
# @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
|
1761
|
+
# @param body body
|
|
1486
1762
|
# @param [Hash] opts the optional parameters
|
|
1487
1763
|
# @return [Attribute]
|
|
1488
1764
|
describe 'update_attribute test' do
|
|
@@ -1496,7 +1772,7 @@ describe 'ManagementApi' do
|
|
|
1496
1772
|
# Update the given campaign.
|
|
1497
1773
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1498
1774
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1499
|
-
# @param body
|
|
1775
|
+
# @param body body
|
|
1500
1776
|
# @param [Hash] opts the optional parameters
|
|
1501
1777
|
# @return [Campaign]
|
|
1502
1778
|
describe 'update_campaign test' do
|
|
@@ -1510,8 +1786,8 @@ describe 'ManagementApi' do
|
|
|
1510
1786
|
# Edit the description of the collection.
|
|
1511
1787
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1512
1788
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1513
|
-
# @param collection_id The ID of the collection. You can get it with the [List collection in account
|
|
1514
|
-
# @param body
|
|
1789
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
|
|
1790
|
+
# @param body body
|
|
1515
1791
|
# @param [Hash] opts the optional parameters
|
|
1516
1792
|
# @return [Collection]
|
|
1517
1793
|
describe 'update_collection test' do
|
|
@@ -1522,11 +1798,11 @@ describe 'ManagementApi' do
|
|
|
1522
1798
|
|
|
1523
1799
|
# unit tests for update_coupon
|
|
1524
1800
|
# Update coupon
|
|
1525
|
-
# Update the specified coupon.
|
|
1801
|
+
# Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint only, any property you do not explicitly set in your request will be set to <code>null</code>.</p> </div>
|
|
1526
1802
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1527
1803
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1528
|
-
# @param coupon_id The ID of the coupon code
|
|
1529
|
-
# @param body
|
|
1804
|
+
# @param coupon_id The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
|
|
1805
|
+
# @param body body
|
|
1530
1806
|
# @param [Hash] opts the optional parameters
|
|
1531
1807
|
# @return [Coupon]
|
|
1532
1808
|
describe 'update_coupon test' do
|
|
@@ -1537,10 +1813,10 @@ describe 'ManagementApi' do
|
|
|
1537
1813
|
|
|
1538
1814
|
# unit tests for update_coupon_batch
|
|
1539
1815
|
# Update coupons
|
|
1540
|
-
# Update all coupons
|
|
1816
|
+
# Update all coupons, or a specific batch of coupons, in a campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
|
|
1541
1817
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1542
1818
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1543
|
-
# @param body
|
|
1819
|
+
# @param body body
|
|
1544
1820
|
# @param [Hash] opts the optional parameters
|
|
1545
1821
|
# @return [nil]
|
|
1546
1822
|
describe 'update_coupon_batch test' do
|
|
@@ -1549,13 +1825,41 @@ describe 'ManagementApi' do
|
|
|
1549
1825
|
end
|
|
1550
1826
|
end
|
|
1551
1827
|
|
|
1828
|
+
# unit tests for update_loyalty_card
|
|
1829
|
+
# Update loyalty card status
|
|
1830
|
+
# Update the status of the given loyalty card. A card can be _active_ or _inactive_.
|
|
1831
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1832
|
+
# @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
1833
|
+
# @param body body
|
|
1834
|
+
# @param [Hash] opts the optional parameters
|
|
1835
|
+
# @return [LoyaltyCard]
|
|
1836
|
+
describe 'update_loyalty_card test' do
|
|
1837
|
+
it 'should work' do
|
|
1838
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1839
|
+
end
|
|
1840
|
+
end
|
|
1841
|
+
|
|
1842
|
+
# unit tests for update_notification_webhook
|
|
1843
|
+
# Update notification about campaign-related changes
|
|
1844
|
+
# Update the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). **Tip:** You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_edited/post).
|
|
1845
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1846
|
+
# @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
|
|
1847
|
+
# @param body body
|
|
1848
|
+
# @param [Hash] opts the optional parameters
|
|
1849
|
+
# @return [NotificationWebhook]
|
|
1850
|
+
describe 'update_notification_webhook test' do
|
|
1851
|
+
it 'should work' do
|
|
1852
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1853
|
+
end
|
|
1854
|
+
end
|
|
1855
|
+
|
|
1552
1856
|
# unit tests for update_referral
|
|
1553
1857
|
# Update referral
|
|
1554
1858
|
# Update the specified referral.
|
|
1555
1859
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1556
1860
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1557
|
-
# @param referral_id The ID of the referral code
|
|
1558
|
-
# @param body
|
|
1861
|
+
# @param referral_id The ID of the referral code.
|
|
1862
|
+
# @param body body
|
|
1559
1863
|
# @param [Hash] opts the optional parameters
|
|
1560
1864
|
# @return [Referral]
|
|
1561
1865
|
describe 'update_referral test' do
|