From b40ea7d575b5d6c9c61e7d52a2ff4bd6e87c91ac Mon Sep 17 00:00:00 2001 From: kkupreeva Date: Fri, 8 Dec 2023 13:50:14 +0100 Subject: [PATCH] update js sdk --- README.md | 78 +- docs/AccountAnalytics.md | 1 + docs/AccountDashboardStatisticCampaigns.md | 3 +- docs/Achievement.md | 18 + docs/AchievementAdditionalProperties.md | 10 + docs/AddLoyaltyPointsEffectProps.md | 2 +- docs/AddToAudienceEffectProps.md | 12 + docs/AdditionalCampaignProperties.md | 29 + docs/Application.md | 2 +- docs/ApplicationAPIKey.md | 2 + docs/ApplicationCustomer.md | 2 +- docs/ApplicationEvent.md | 2 + docs/ApplicationSession.md | 5 +- docs/ApplicationStoreEntity.md | 9 + docs/Attribute.md | 2 + docs/AudienceCustomer.md | 2 +- docs/BaseCampaign.md | 14 + docs/BaseCampaignForNotification.md | 73 ++ docs/BaseLoyaltyProgram.md | 2 +- docs/BaseNotification.md | 27 + docs/BaseNotificationEntity.md | 1 + docs/BaseNotificationWebhook.md | 1 + docs/BulkOperationOnCampaigns.md | 21 + docs/Campaign.md | 45 +- docs/CampaignBudget.md | 11 + docs/CampaignCreatedNotification.md | 2 +- docs/CampaignDeletedNotification.md | 2 +- docs/CampaignEditedNotification.md | 4 +- docs/CampaignEvaluationGroup.md | 14 +- docs/CampaignForNotification.md | 98 ++ docs/CampaignGroup.md | 8 +- docs/CampaignNotificationPolicy.md | 9 + docs/CampaignRulesetChangedNotification.md | 2 +- docs/CampaignSetBranchNode.md | 14 +- docs/CampaignStateChangedNotification.md | 2 +- docs/CampaignStateNotification.md | 108 ++ docs/CampaignTemplate.md | 12 + docs/CardLedgerPointsEntryIntegrationAPI.md | 18 + docs/CartItem.md | 4 +- docs/ChangeLoyaltyTierLevelEffectProps.md | 14 + docs/Coupon.md | 1 + docs/CreateAchievement.md | 14 + docs/CreateApplicationAPIKey.md | 2 + docs/CreateTemplateCampaign.md | 1 + docs/CustomEffectProps.md | 2 +- docs/CustomerProfile.md | 2 +- docs/CustomerProfileIntegrationResponseV2.md | 17 + docs/CustomerSession.md | 2 +- docs/CustomerSessionV2.md | 11 +- docs/Effect.md | 1 + docs/EffectEntity.md | 1 + docs/Event.md | 1 + docs/EventV2.md | 5 +- docs/ExpiringPointsNotificationPolicy.md | 1 + docs/InlineResponse20010.md | 2 +- docs/InlineResponse20011.md | 4 +- docs/InlineResponse20012.md | 4 +- docs/InlineResponse20013.md | 2 +- docs/InlineResponse20014.md | 4 +- docs/InlineResponse20015.md | 5 +- docs/InlineResponse20016.md | 5 +- docs/InlineResponse20017.md | 5 +- docs/InlineResponse20018.md | 5 +- docs/InlineResponse20019.md | 2 +- docs/InlineResponse20020.md | 2 +- docs/InlineResponse20021.md | 5 +- docs/InlineResponse20022.md | 2 +- docs/InlineResponse20023.md | 2 +- docs/InlineResponse20024.md | 3 +- docs/InlineResponse20025.md | 2 +- docs/InlineResponse20026.md | 4 +- docs/InlineResponse20027.md | 4 +- docs/InlineResponse20028.md | 4 +- docs/InlineResponse20029.md | 5 +- docs/InlineResponse2003.md | 4 +- docs/InlineResponse20030.md | 2 +- docs/InlineResponse20031.md | 5 +- docs/InlineResponse20032.md | 5 +- docs/InlineResponse20033.md | 5 +- docs/InlineResponse20034.md | 2 +- docs/InlineResponse20035.md | 2 +- docs/InlineResponse20036.md | 2 +- docs/InlineResponse20037.md | 2 +- docs/InlineResponse20038.md | 2 +- docs/InlineResponse20039.md | 5 +- docs/InlineResponse2004.md | 4 +- docs/InlineResponse20040.md | 5 +- docs/InlineResponse20041.md | 2 +- docs/InlineResponse20042.md | 10 + docs/InlineResponse20043.md | 11 + docs/InlineResponse2005.md | 2 +- docs/InlineResponse2006.md | 2 +- docs/InlineResponse2007.md | 2 +- docs/InlineResponse2008.md | 2 +- docs/InlineResponse2009.md | 2 +- docs/IntegrationApi.md | 180 ++- docs/IntegrationCoupon.md | 1 + docs/IntegrationEvent.md | 1 + docs/IntegrationEventV2Request.md | 5 +- docs/IntegrationStoreEntity.md | 9 + docs/InventoryCoupon.md | 1 + docs/LedgerPointsEntryIntegrationAPI.md | 17 + docs/LoyaltyProgram.md | 6 +- docs/LoyaltyProgramTransaction.md | 4 +- docs/ManagementApi.md | 856 +++++++------ docs/NewApplication.md | 2 +- docs/NewApplicationAPIKey.md | 2 + docs/NewAttribute.md | 2 + docs/NewBaseNotification.md | 1 + docs/NewCampaign.md | 13 + docs/NewCampaignEvaluationGroup.md | 14 +- docs/NewCampaignGroup.md | 8 +- docs/NewCampaignTemplate.md | 12 + docs/NewCoupons.md | 1 + docs/NewCustomerSession.md | 2 +- docs/NewCustomerSessionV2.md | 5 +- docs/NewEvent.md | 1 + docs/NewInvitation.md | 5 +- docs/NewLoyaltyProgram.md | 2 +- docs/NewNotificationTest.md | 56 + docs/NewNotificationWebhook.md | 1 + docs/NewRoleV2.md | 1 - docs/NewStore.md | 12 + docs/NotificationActivation.md | 9 + docs/NotificationTest.md | 10 + docs/OneTimeCode.md | 12 + docs/OutgoingIntegrationCleverTapPolicy.md | 11 + docs/OutgoingIntegrationIterablePolicy.md | 10 + docs/OutgoingIntegrationMoEngagePolicy.md | 12 + docs/RemoveFromAudienceEffectProps.md | 12 + docs/ReturnedCartItem.md | 2 +- docs/RoleAssign.md | 4 +- docs/RoleV2.md | 1 - docs/RoleV2ApplicationDetails.md | 1 + docs/RoleV2Base.md | 1 - docs/RoleV2PermissionSet.md | 2 +- docs/RollbackAddedLoyaltyPointsEffectProps.md | 2 +- docs/RollbackDiscountEffectProps.md | 2 +- docs/SSOConfig.md | 9 + docs/SamlLoginEndpoint.md | 1 + ...ountPerAdditionalCostPerItemEffectProps.md | 2 +- docs/SetDiscountPerItemEffectProps.md | 4 +- docs/Store.md | 17 + docs/TalangAttribute.md | 2 + docs/TierDowngradeNotificationPolicy.md | 9 + docs/TierUpgradeNotificationPolicy.md | 9 + docs/TierWillDowngradeNotificationPolicy.md | 10 + docs/TierWillDowngradeNotificationTrigger.md | 21 + docs/TimePoint.md | 14 + docs/TrackEventV2Response.md | 17 + docs/TwoFAConfig.md | 10 + docs/UpdateAchievement.md | 10 + docs/UpdateApplication.md | 2 +- docs/UpdateCampaign.md | 14 + docs/UpdateCampaignEvaluationGroup.md | 14 +- docs/UpdateCampaignGroup.md | 8 +- docs/UpdateCampaignTemplate.md | 12 + docs/UpdateCoupon.md | 1 + docs/UpdateCouponBatch.md | 4 +- docs/UpdateLoyaltyProgram.md | 2 +- docs/UpdateStore.md | 11 + docs/UpdateUser.md | 1 + docs/User.md | 3 + package.json | 2 +- src/ApiClient.js | 2 +- src/api/IntegrationApi.js | 228 +++- src/api/ManagementApi.js | 1124 ++++++++++------- src/index.js | 290 ++++- src/model/APIError.js | 2 +- src/model/AcceptCouponEffectProps.js | 2 +- src/model/AcceptReferralEffectProps.js | 2 +- src/model/AccessLogEntry.js | 2 +- src/model/Account.js | 2 +- src/model/AccountAdditionalCost.js | 2 +- src/model/AccountAnalytics.js | 19 +- src/model/AccountDashboardStatistic.js | 2 +- .../AccountDashboardStatisticApiCalls.js | 2 +- .../AccountDashboardStatisticCampaigns.js | 23 +- .../AccountDashboardStatisticDiscount.js | 2 +- .../AccountDashboardStatisticLoyaltyPoints.js | 2 +- .../AccountDashboardStatisticReferrals.js | 2 +- src/model/AccountDashboardStatisticRevenue.js | 2 +- src/model/AccountEntity.js | 2 +- src/model/AccountLimits.js | 2 +- src/model/Achievement.js | 172 +++ src/model/AchievementAdditionalProperties.js | 85 ++ src/model/AddFreeItemEffectProps.js | 2 +- src/model/AddItemCatalogAction.js | 2 +- src/model/AddLoyaltyPoints.js | 2 +- src/model/AddLoyaltyPointsEffectProps.js | 4 +- src/model/AddToAudienceEffectProps.js | 100 ++ .../AddedDeductedPointsNotificationPolicy.js | 2 +- src/model/AdditionalCampaignProperties.js | 255 ++++ src/model/AdditionalCost.js | 2 +- src/model/Application.js | 4 +- src/model/ApplicationAPIKey.js | 10 +- src/model/ApplicationApiHealth.js | 2 +- src/model/ApplicationCampaignStats.js | 2 +- src/model/ApplicationCustomer.js | 6 +- src/model/ApplicationCustomerEntity.js | 2 +- src/model/ApplicationEntity.js | 2 +- src/model/ApplicationEvent.js | 20 +- src/model/ApplicationNotification.js | 2 +- src/model/ApplicationReferee.js | 2 +- src/model/ApplicationSession.js | 43 +- src/model/ApplicationSessionEntity.js | 2 +- src/model/ApplicationStoreEntity.js | 72 ++ src/model/AsyncCouponCreationResponse.js | 2 +- src/model/Attribute.js | 10 +- src/model/AttributesMandatory.js | 2 +- src/model/AttributesSettings.js | 2 +- src/model/Audience.js | 2 +- src/model/AudienceAnalytics.js | 2 +- src/model/AudienceCustomer.js | 6 +- src/model/AudienceIntegrationID.js | 2 +- src/model/AudienceMembership.js | 2 +- src/model/AwardGiveawayEffectProps.js | 2 +- src/model/BaseCampaign.js | 51 +- src/model/BaseCampaignForNotification.js | 330 +++++ src/model/BaseLoyaltyProgram.js | 4 +- src/model/BaseNotification.js | 92 +- src/model/BaseNotificationEntity.js | 12 +- src/model/BaseNotificationWebhook.js | 12 +- src/model/BaseNotifications.js | 2 +- src/model/BaseSamlConnection.js | 2 +- src/model/Binding.js | 2 +- src/model/BulkApplicationNotification.js | 2 +- src/model/BulkCampaignNotification.js | 2 +- src/model/BulkOperationOnCampaigns.js | 106 ++ src/model/Campaign.js | 101 +- src/model/CampaignActivationRequest.js | 2 +- src/model/CampaignAnalytics.js | 2 +- src/model/CampaignBudget.js | 96 ++ src/model/CampaignCollection.js | 2 +- src/model/CampaignCollectionWithoutPayload.js | 2 +- src/model/CampaignCopy.js | 2 +- src/model/CampaignCreatedNotification.js | 10 +- src/model/CampaignDeletedNotification.js | 10 +- src/model/CampaignEditedNotification.js | 16 +- src/model/CampaignEntity.js | 2 +- src/model/CampaignEvaluationGroup.js | 43 +- src/model/CampaignEvaluationPosition.js | 2 +- ...mpaignEvaluationTreeChangedNotification.js | 2 +- src/model/CampaignForNotification.js | 571 +++++++++ src/model/CampaignGroup.js | 12 +- src/model/CampaignGroupEntity.js | 2 +- src/model/CampaignNotification.js | 2 +- src/model/CampaignNotificationPolicy.js | 74 ++ .../CampaignRulesetChangedNotification.js | 10 +- src/model/CampaignSearch.js | 2 +- src/model/CampaignSet.js | 2 +- src/model/CampaignSetBranchNode.js | 43 +- src/model/CampaignSetLeafNode.js | 2 +- src/model/CampaignSetNode.js | 2 +- src/model/CampaignStateChangedNotification.js | 10 +- src/model/CampaignStateNotification.js | 597 +++++++++ src/model/CampaignTemplate.js | 41 +- src/model/CampaignTemplateCollection.js | 2 +- src/model/CampaignTemplateParams.js | 2 +- .../CardLedgerPointsEntryIntegrationAPI.js | 170 +++ src/model/CardLedgerTransactionLogEntry.js | 2 +- ...LedgerTransactionLogEntryIntegrationAPI.js | 2 +- src/model/CartItem.js | 8 +- src/model/Catalog.js | 2 +- src/model/CatalogAction.js | 2 +- src/model/CatalogActionFilter.js | 2 +- src/model/CatalogItem.js | 2 +- src/model/CatalogSyncRequest.js | 2 +- ...CatalogsStrikethroughNotificationPolicy.js | 2 +- src/model/Change.js | 2 +- .../ChangeLoyaltyTierLevelEffectProps.js | 126 ++ src/model/ChangeProfilePassword.js | 2 +- src/model/CodeGeneratorSettings.js | 2 +- src/model/Collection.js | 2 +- src/model/CollectionItem.js | 2 +- src/model/CollectionWithoutPayload.js | 2 +- src/model/Coupon.js | 11 +- src/model/CouponConstraints.js | 2 +- src/model/CouponCreatedEffectProps.js | 2 +- src/model/CouponCreationJob.js | 2 +- src/model/CouponLimitConfigs.js | 2 +- src/model/CouponRejectionReason.js | 2 +- src/model/CouponReservations.js | 2 +- src/model/CouponSearch.js | 2 +- src/model/CouponValue.js | 2 +- src/model/CouponsNotificationPolicy.js | 2 +- src/model/CreateAchievement.js | 127 ++ src/model/CreateApplicationAPIKey.js | 10 +- src/model/CreateManagementKey.js | 2 +- src/model/CreateTemplateCampaign.js | 11 +- src/model/CreateTemplateCampaignResponse.js | 2 +- src/model/CustomEffect.js | 2 +- src/model/CustomEffectProps.js | 4 +- src/model/CustomerActivityReport.js | 2 +- src/model/CustomerAnalytics.js | 2 +- src/model/CustomerInventory.js | 2 +- src/model/CustomerProfile.js | 6 +- src/model/CustomerProfileAudienceRequest.js | 2 +- .../CustomerProfileAudienceRequestItem.js | 2 +- .../CustomerProfileIntegrationRequestV2.js | 2 +- .../CustomerProfileIntegrationResponseV2.js | 152 +++ src/model/CustomerProfileSearchQuery.js | 2 +- src/model/CustomerProfileUpdateV2Response.js | 2 +- src/model/CustomerSession.js | 6 +- src/model/CustomerSessionV2.js | 31 +- src/model/DeductLoyaltyPoints.js | 2 +- src/model/DeductLoyaltyPointsEffectProps.js | 2 +- src/model/Effect.js | 11 +- src/model/EffectEntity.js | 11 +- src/model/EmailEntity.js | 2 +- src/model/Endpoint.js | 2 +- src/model/Entity.js | 2 +- src/model/EntityWithTalangVisibleID.js | 2 +- src/model/Environment.js | 2 +- src/model/ErrorEffectProps.js | 2 +- src/model/ErrorResponse.js | 2 +- src/model/ErrorResponseWithStatus.js | 2 +- src/model/ErrorSource.js | 2 +- src/model/EvaluableCampaignIds.js | 2 +- src/model/Event.js | 11 +- src/model/EventType.js | 2 +- src/model/EventV2.js | 17 +- src/model/ExpiringPointsNotificationPolicy.js | 12 +- .../ExpiringPointsNotificationTrigger.js | 2 +- src/model/FeatureFlag.js | 2 +- src/model/FeaturesFeed.js | 2 +- src/model/FuncArgDef.js | 2 +- src/model/FunctionDef.js | 2 +- src/model/Giveaway.js | 2 +- src/model/GiveawaysPool.js | 2 +- src/model/IdentifiableEntity.js | 2 +- src/model/ImportEntity.js | 2 +- src/model/InlineResponse200.js | 2 +- src/model/InlineResponse2001.js | 2 +- src/model/InlineResponse20010.js | 10 +- src/model/InlineResponse20011.js | 28 +- src/model/InlineResponse20012.js | 28 +- src/model/InlineResponse20013.js | 10 +- src/model/InlineResponse20014.js | 14 +- src/model/InlineResponse20015.js | 28 +- src/model/InlineResponse20016.js | 26 +- src/model/InlineResponse20017.js | 26 +- src/model/InlineResponse20018.js | 26 +- src/model/InlineResponse20019.js | 20 +- src/model/InlineResponse2002.js | 2 +- src/model/InlineResponse20020.js | 10 +- src/model/InlineResponse20021.js | 26 +- src/model/InlineResponse20022.js | 16 +- src/model/InlineResponse20023.js | 10 +- src/model/InlineResponse20024.js | 18 +- src/model/InlineResponse20025.js | 10 +- src/model/InlineResponse20026.js | 18 +- src/model/InlineResponse20027.js | 18 +- src/model/InlineResponse20028.js | 27 +- src/model/InlineResponse20029.js | 25 +- src/model/InlineResponse2003.js | 28 +- src/model/InlineResponse20030.js | 10 +- src/model/InlineResponse20031.js | 26 +- src/model/InlineResponse20032.js | 26 +- src/model/InlineResponse20033.js | 26 +- src/model/InlineResponse20034.js | 10 +- src/model/InlineResponse20035.js | 10 +- src/model/InlineResponse20036.js | 10 +- src/model/InlineResponse20037.js | 10 +- src/model/InlineResponse20038.js | 10 +- src/model/InlineResponse20039.js | 26 +- src/model/InlineResponse2004.js | 28 +- src/model/InlineResponse20040.js | 26 +- src/model/InlineResponse20041.js | 10 +- src/model/InlineResponse20042.js | 84 ++ src/model/InlineResponse20043.js | 90 ++ src/model/InlineResponse2005.js | 10 +- src/model/InlineResponse2006.js | 10 +- src/model/InlineResponse2007.js | 10 +- src/model/InlineResponse2008.js | 20 +- src/model/InlineResponse2009.js | 10 +- src/model/InlineResponse201.js | 2 +- src/model/IntegrationCoupon.js | 11 +- .../IntegrationCustomerSessionResponse.js | 2 +- src/model/IntegrationEntity.js | 2 +- src/model/IntegrationEvent.js | 11 +- src/model/IntegrationEventV2Request.js | 17 +- src/model/IntegrationProfileEntity.js | 2 +- src/model/IntegrationRequest.js | 2 +- src/model/IntegrationState.js | 2 +- src/model/IntegrationStateV2.js | 2 +- src/model/IntegrationStoreEntity.js | 72 ++ src/model/InventoryCoupon.js | 11 +- src/model/InventoryReferral.js | 2 +- src/model/ItemAttribute.js | 2 +- src/model/LedgerEntry.js | 2 +- src/model/LedgerInfo.js | 2 +- src/model/LedgerPointsEntryIntegrationAPI.js | 161 +++ ...LedgerTransactionLogEntryIntegrationAPI.js | 2 +- src/model/LibraryAttribute.js | 2 +- src/model/LimitConfig.js | 2 +- src/model/LimitCounter.js | 2 +- src/model/LoginParams.js | 2 +- src/model/Loyalty.js | 2 +- src/model/LoyaltyBalance.js | 2 +- src/model/LoyaltyBalances.js | 2 +- src/model/LoyaltyCard.js | 2 +- src/model/LoyaltyCardProfileRegistration.js | 2 +- src/model/LoyaltyCardRegistration.js | 2 +- src/model/LoyaltyDashboardData.js | 2 +- src/model/LoyaltyDashboardPointsBreakdown.js | 2 +- src/model/LoyaltyLedger.js | 2 +- src/model/LoyaltyLedgerEntry.js | 2 +- src/model/LoyaltyLedgerTransactions.js | 2 +- src/model/LoyaltyMembership.js | 2 +- src/model/LoyaltyProgram.js | 8 +- src/model/LoyaltyProgramBalance.js | 2 +- src/model/LoyaltyProgramEntity.js | 2 +- src/model/LoyaltyProgramLedgers.js | 2 +- src/model/LoyaltyProgramSubledgers.js | 2 +- src/model/LoyaltyProgramTransaction.js | 6 +- src/model/LoyaltySubLedger.js | 2 +- src/model/LoyaltyTier.js | 2 +- src/model/ManagementKey.js | 2 +- src/model/ManagerConfig.js | 2 +- src/model/Meta.js | 2 +- src/model/ModelExport.js | 2 +- src/model/ModelImport.js | 2 +- src/model/ModelReturn.js | 2 +- src/model/MultiApplicationEntity.js | 2 +- src/model/MultipleAttribute.js | 2 +- src/model/MultipleAudiences.js | 2 +- src/model/MultipleAudiencesItem.js | 2 +- ...ltipleCustomerProfileIntegrationRequest.js | 2 +- ...leCustomerProfileIntegrationRequestItem.js | 2 +- ...pleCustomerProfileIntegrationResponseV2.js | 2 +- src/model/MultipleNewAttribute.js | 2 +- src/model/MultipleNewAudiences.js | 2 +- src/model/MutableEntity.js | 2 +- src/model/NewAccount.js | 2 +- src/model/NewAccountSignUp.js | 2 +- src/model/NewAdditionalCost.js | 2 +- src/model/NewApplication.js | 4 +- src/model/NewApplicationAPIKey.js | 10 +- src/model/NewAttribute.js | 10 +- src/model/NewAudience.js | 2 +- src/model/NewBaseNotification.js | 12 +- src/model/NewCampaign.js | 42 +- src/model/NewCampaignCollection.js | 2 +- src/model/NewCampaignEvaluationGroup.js | 43 +- src/model/NewCampaignGroup.js | 12 +- src/model/NewCampaignSet.js | 2 +- src/model/NewCampaignTemplate.js | 41 +- src/model/NewCatalog.js | 2 +- src/model/NewCollection.js | 2 +- src/model/NewCouponCreationJob.js | 2 +- src/model/NewCoupons.js | 11 +- src/model/NewCouponsForMultipleRecipients.js | 2 +- src/model/NewCustomEffect.js | 2 +- src/model/NewCustomerProfile.js | 2 +- src/model/NewCustomerSession.js | 4 +- src/model/NewCustomerSessionV2.js | 15 +- src/model/NewEvent.js | 11 +- src/model/NewEventType.js | 2 +- src/model/NewGiveawaysPool.js | 2 +- src/model/NewInternalAudience.js | 2 +- src/model/NewInvitation.js | 21 +- src/model/NewInviteEmail.js | 2 +- src/model/NewLoyaltyProgram.js | 4 +- src/model/NewLoyaltyTier.js | 2 +- src/model/NewManagementKey.js | 2 +- src/model/NewMultipleAudiencesItem.js | 2 +- src/model/NewNotificationTest.js | 227 ++++ src/model/NewNotificationWebhook.js | 12 +- src/model/NewOutgoingIntegrationWebhook.js | 2 +- src/model/NewPassword.js | 2 +- src/model/NewPasswordEmail.js | 2 +- src/model/NewPicklist.js | 2 +- src/model/NewReferral.js | 2 +- src/model/NewReferralsForMultipleAdvocates.js | 2 +- src/model/NewReturn.js | 2 +- src/model/NewRole.js | 2 +- src/model/NewRoleV2.js | 11 +- src/model/NewRuleset.js | 2 +- src/model/NewSamlConnection.js | 2 +- src/model/NewStore.js | 106 ++ src/model/NewTemplateDef.js | 2 +- src/model/NewUser.js | 2 +- src/model/NewWebhook.js | 2 +- src/model/Notification.js | 2 +- src/model/NotificationActivation.js | 74 ++ src/model/NotificationTest.js | 85 ++ src/model/OneTimeCode.js | 105 ++ src/model/OutgoingIntegrationBrazePolicy.js | 2 +- .../OutgoingIntegrationCleverTapPolicy.js | 96 ++ src/model/OutgoingIntegrationConfiguration.js | 2 +- .../OutgoingIntegrationIterablePolicy.js | 85 ++ .../OutgoingIntegrationMoEngagePolicy.js | 107 ++ src/model/OutgoingIntegrationTemplate.js | 2 +- ...grationTemplateWithConfigurationDetails.js | 2 +- src/model/OutgoingIntegrationTemplates.js | 2 +- src/model/OutgoingIntegrationType.js | 2 +- src/model/OutgoingIntegrationTypes.js | 2 +- src/model/PatchItemCatalogAction.js | 2 +- src/model/PatchManyItemsCatalogAction.js | 2 +- src/model/PendingPointsNotificationPolicy.js | 2 +- src/model/Picklist.js | 2 +- src/model/ProfileAudiencesChanges.js | 2 +- src/model/RedeemReferralEffectProps.js | 2 +- src/model/Referral.js | 2 +- src/model/ReferralConstraints.js | 2 +- src/model/ReferralCreatedEffectProps.js | 2 +- src/model/ReferralRejectionReason.js | 2 +- src/model/RejectCouponEffectProps.js | 2 +- src/model/RejectReferralEffectProps.js | 2 +- src/model/RemoveFromAudienceEffectProps.js | 100 ++ src/model/RemoveItemCatalogAction.js | 2 +- src/model/RemoveManyItemsCatalogAction.js | 2 +- src/model/ReopenSessionResponse.js | 2 +- src/model/ReserveCouponEffectProps.js | 2 +- src/model/ReturnIntegrationRequest.js | 2 +- src/model/ReturnedCartItem.js | 4 +- src/model/Role.js | 2 +- src/model/RoleAssign.js | 10 +- src/model/RoleMembership.js | 2 +- src/model/RoleV2.js | 11 +- src/model/RoleV2ApplicationDetails.js | 11 +- src/model/RoleV2Base.js | 11 +- src/model/RoleV2PermissionSet.js | 6 +- src/model/RoleV2Permissions.js | 2 +- src/model/RoleV2RolesGroup.js | 2 +- .../RollbackAddedLoyaltyPointsEffectProps.js | 4 +- src/model/RollbackCouponEffectProps.js | 2 +- ...ollbackDeductedLoyaltyPointsEffectProps.js | 2 +- src/model/RollbackDiscountEffectProps.js | 4 +- src/model/RollbackReferralEffectProps.js | 2 +- src/model/Rule.js | 2 +- src/model/RuleFailureReason.js | 2 +- src/model/Ruleset.js | 2 +- src/model/SSOConfig.js | 74 ++ src/model/SamlConnection.js | 2 +- src/model/SamlConnectionMetadata.js | 2 +- src/model/SamlLoginEndpoint.js | 19 +- src/model/Session.js | 2 +- src/model/SetDiscountEffectProps.js | 2 +- ...SetDiscountPerAdditionalCostEffectProps.js | 2 +- ...ountPerAdditionalCostPerItemEffectProps.js | 4 +- src/model/SetDiscountPerItemEffectProps.js | 22 +- src/model/ShowBundleMetadataEffectProps.js | 2 +- src/model/ShowNotificationEffectProps.js | 2 +- src/model/SlotDef.js | 2 +- src/model/Store.js | 159 +++ src/model/StrikethroughChangedItem.js | 2 +- .../StrikethroughCustomEffectPerItemProps.js | 2 +- src/model/StrikethroughEffect.js | 2 +- .../StrikethroughLabelingNotification.js | 2 +- ...ikethroughSetDiscountPerItemEffectProps.js | 2 +- src/model/StrikethroughTrigger.js | 2 +- src/model/TalangAttribute.js | 10 +- src/model/TalangAttributeVisibility.js | 2 +- src/model/TemplateArgDef.js | 2 +- src/model/TemplateDef.js | 2 +- src/model/TemplateLimitConfig.js | 2 +- src/model/Tier.js | 2 +- src/model/TierDowngradeNotificationPolicy.js | 74 ++ src/model/TierUpgradeNotificationPolicy.js | 74 ++ .../TierWillDowngradeNotificationPolicy.js | 85 ++ .../TierWillDowngradeNotificationTrigger.js | 106 ++ src/model/TimePoint.js | 124 ++ src/model/TrackEventV2Response.js | 152 +++ src/model/TransferLoyaltyCard.js | 2 +- src/model/TriggerWebhookEffectProps.js | 2 +- src/model/TwoFAConfig.js | 83 ++ src/model/UpdateAccount.js | 2 +- src/model/UpdateAchievement.js | 81 ++ src/model/UpdateApplication.js | 4 +- src/model/UpdateAttributeEffectProps.js | 2 +- src/model/UpdateAudience.js | 2 +- src/model/UpdateCampaign.js | 51 +- src/model/UpdateCampaignCollection.js | 2 +- src/model/UpdateCampaignEvaluationGroup.js | 43 +- src/model/UpdateCampaignGroup.js | 12 +- src/model/UpdateCampaignTemplate.js | 33 +- src/model/UpdateCatalog.js | 2 +- src/model/UpdateCollection.js | 2 +- src/model/UpdateCoupon.js | 11 +- src/model/UpdateCouponBatch.js | 6 +- src/model/UpdateCustomEffect.js | 2 +- src/model/UpdateLoyaltyCard.js | 2 +- src/model/UpdateLoyaltyProgram.js | 4 +- src/model/UpdatePicklist.js | 2 +- src/model/UpdateReferral.js | 2 +- src/model/UpdateReferralBatch.js | 2 +- src/model/UpdateRole.js | 2 +- src/model/UpdateStore.js | 94 ++ src/model/UpdateUser.js | 11 +- src/model/User.js | 29 +- src/model/UserEntity.js | 2 +- src/model/Webhook.js | 2 +- src/model/WebhookActivationLogEntry.js | 2 +- src/model/WebhookLogEntry.js | 2 +- .../WebhookWithOutgoingIntegrationDetails.js | 2 +- src/model/WillAwardGiveawayEffectProps.js | 2 +- test/api/IntegrationApi.spec.js | 20 + test/api/ManagementApi.spec.js | 112 +- test/model/AccountAnalytics.spec.js | 6 + ...AccountDashboardStatisticCampaigns.spec.js | 6 + test/model/Achievement.spec.js | 119 ++ .../AchievementAdditionalProperties.spec.js | 71 ++ test/model/AddToAudienceEffectProps.spec.js | 83 ++ .../AdditionalCampaignProperties.spec.js | 185 +++ test/model/ApplicationEvent.spec.js | 12 + test/model/ApplicationSession.spec.js | 18 +- test/model/ApplicationStoreEntity.spec.js | 65 + test/model/BaseCampaign.spec.js | 18 + .../model/BaseCampaignForNotification.spec.js | 155 +++ test/model/BaseNotification.spec.js | 12 + test/model/BaseNotificationEntity.spec.js | 6 + test/model/BaseNotificationWebhook.spec.js | 6 + test/model/BulkOperationOnCampaigns.spec.js | 71 ++ test/model/Campaign.spec.js | 24 + test/model/CampaignBudget.spec.js | 77 ++ test/model/CampaignEvaluationGroup.spec.js | 6 + test/model/CampaignForNotification.spec.js | 305 +++++ test/model/CampaignNotificationPolicy.spec.js | 65 + test/model/CampaignSetBranchNode.spec.js | 6 + test/model/CampaignStateNotification.spec.js | 311 +++++ test/model/CampaignTemplate.spec.js | 6 + ...ardLedgerPointsEntryIntegrationAPI.spec.js | 119 ++ .../ChangeLoyaltyTierLevelEffectProps.spec.js | 95 ++ test/model/Coupon.spec.js | 6 + test/model/CreateAchievement.spec.js | 95 ++ test/model/CreateTemplateCampaign.spec.js | 6 + ...stomerProfileIntegrationResponseV2.spec.js | 113 ++ test/model/CustomerSessionV2.spec.js | 6 + test/model/Effect.spec.js | 6 + test/model/EffectEntity.spec.js | 6 + test/model/Event.spec.js | 6 + test/model/EventV2.spec.js | 6 + .../ExpiringPointsNotificationPolicy.spec.js | 6 + test/model/InlineResponse20011.spec.js | 4 +- test/model/InlineResponse20012.spec.js | 4 +- test/model/InlineResponse20015.spec.js | 6 - test/model/InlineResponse20016.spec.js | 6 + test/model/InlineResponse20017.spec.js | 6 - test/model/InlineResponse20018.spec.js | 6 + test/model/InlineResponse20019.spec.js | 4 +- test/model/InlineResponse20021.spec.js | 6 - test/model/InlineResponse20022.spec.js | 8 +- test/model/InlineResponse20024.spec.js | 6 + test/model/InlineResponse20028.spec.js | 4 +- test/model/InlineResponse20029.spec.js | 6 - test/model/InlineResponse2003.spec.js | 4 +- test/model/InlineResponse20031.spec.js | 6 + test/model/InlineResponse20032.spec.js | 6 - test/model/InlineResponse20033.spec.js | 6 + test/model/InlineResponse20039.spec.js | 6 - test/model/InlineResponse2004.spec.js | 4 +- test/model/InlineResponse20040.spec.js | 6 + test/model/InlineResponse20042.spec.js | 71 ++ test/model/InlineResponse20043.spec.js | 77 ++ test/model/InlineResponse2008.spec.js | 4 +- test/model/IntegrationCoupon.spec.js | 6 + test/model/IntegrationEvent.spec.js | 6 + test/model/IntegrationEventV2Request.spec.js | 6 + test/model/IntegrationStoreEntity.spec.js | 65 + test/model/InventoryCoupon.spec.js | 6 + .../LedgerPointsEntryIntegrationAPI.spec.js | 113 ++ test/model/NewBaseNotification.spec.js | 6 + test/model/NewCampaign.spec.js | 12 + test/model/NewCampaignEvaluationGroup.spec.js | 6 + test/model/NewCampaignTemplate.spec.js | 6 + test/model/NewCoupons.spec.js | 6 + test/model/NewCustomerSessionV2.spec.js | 6 + test/model/NewEvent.spec.js | 6 + test/model/NewInvitation.spec.js | 6 + test/model/NewNotificationTest.spec.js | 95 ++ test/model/NewNotificationWebhook.spec.js | 6 + test/model/NewRoleV2.spec.js | 6 - test/model/NewStore.spec.js | 83 ++ test/model/NotificationActivation.spec.js | 65 + test/model/NotificationTest.spec.js | 71 ++ test/model/OneTimeCode.spec.js | 83 ++ ...OutgoingIntegrationCleverTapPolicy.spec.js | 77 ++ .../OutgoingIntegrationIterablePolicy.spec.js | 71 ++ .../OutgoingIntegrationMoEngagePolicy.spec.js | 83 ++ .../RemoveFromAudienceEffectProps.spec.js | 83 ++ test/model/RoleV2.spec.js | 6 - test/model/RoleV2ApplicationDetails.spec.js | 6 + test/model/RoleV2Base.spec.js | 6 - test/model/SSOConfig.spec.js | 65 + test/model/SamlLoginEndpoint.spec.js | 6 + .../SetDiscountPerItemEffectProps.spec.js | 12 + test/model/Store.spec.js | 113 ++ .../TierDowngradeNotificationPolicy.spec.js | 65 + .../TierUpgradeNotificationPolicy.spec.js | 65 + ...ierWillDowngradeNotificationPolicy.spec.js | 71 ++ ...erWillDowngradeNotificationTrigger.spec.js | 71 ++ test/model/TimePoint.spec.js | 95 ++ test/model/TrackEventV2Response.spec.js | 113 ++ test/model/TwoFAConfig.spec.js | 71 ++ test/model/UpdateAchievement.spec.js | 71 ++ test/model/UpdateCampaign.spec.js | 18 + .../UpdateCampaignEvaluationGroup.spec.js | 6 + test/model/UpdateCampaignTemplate.spec.js | 6 + test/model/UpdateCoupon.spec.js | 6 + test/model/UpdateStore.spec.js | 77 ++ test/model/UpdateUser.spec.js | 6 + test/model/User.spec.js | 18 + 704 files changed, 14554 insertions(+), 2137 deletions(-) create mode 100644 docs/Achievement.md create mode 100644 docs/AchievementAdditionalProperties.md create mode 100644 docs/AddToAudienceEffectProps.md create mode 100644 docs/AdditionalCampaignProperties.md create mode 100644 docs/ApplicationStoreEntity.md create mode 100644 docs/BaseCampaignForNotification.md create mode 100644 docs/BulkOperationOnCampaigns.md create mode 100644 docs/CampaignBudget.md create mode 100644 docs/CampaignForNotification.md create mode 100644 docs/CampaignNotificationPolicy.md create mode 100644 docs/CampaignStateNotification.md create mode 100644 docs/CardLedgerPointsEntryIntegrationAPI.md create mode 100644 docs/ChangeLoyaltyTierLevelEffectProps.md create mode 100644 docs/CreateAchievement.md create mode 100644 docs/CustomerProfileIntegrationResponseV2.md create mode 100644 docs/InlineResponse20042.md create mode 100644 docs/InlineResponse20043.md create mode 100644 docs/IntegrationStoreEntity.md create mode 100644 docs/LedgerPointsEntryIntegrationAPI.md create mode 100644 docs/NewNotificationTest.md create mode 100644 docs/NewStore.md create mode 100644 docs/NotificationActivation.md create mode 100644 docs/NotificationTest.md create mode 100644 docs/OneTimeCode.md create mode 100644 docs/OutgoingIntegrationCleverTapPolicy.md create mode 100644 docs/OutgoingIntegrationIterablePolicy.md create mode 100644 docs/OutgoingIntegrationMoEngagePolicy.md create mode 100644 docs/RemoveFromAudienceEffectProps.md create mode 100644 docs/SSOConfig.md create mode 100644 docs/Store.md create mode 100644 docs/TierDowngradeNotificationPolicy.md create mode 100644 docs/TierUpgradeNotificationPolicy.md create mode 100644 docs/TierWillDowngradeNotificationPolicy.md create mode 100644 docs/TierWillDowngradeNotificationTrigger.md create mode 100644 docs/TimePoint.md create mode 100644 docs/TrackEventV2Response.md create mode 100644 docs/TwoFAConfig.md create mode 100644 docs/UpdateAchievement.md create mode 100644 docs/UpdateStore.md create mode 100644 src/model/Achievement.js create mode 100644 src/model/AchievementAdditionalProperties.js create mode 100644 src/model/AddToAudienceEffectProps.js create mode 100644 src/model/AdditionalCampaignProperties.js create mode 100644 src/model/ApplicationStoreEntity.js create mode 100644 src/model/BaseCampaignForNotification.js create mode 100644 src/model/BulkOperationOnCampaigns.js create mode 100644 src/model/CampaignBudget.js create mode 100644 src/model/CampaignForNotification.js create mode 100644 src/model/CampaignNotificationPolicy.js create mode 100644 src/model/CampaignStateNotification.js create mode 100644 src/model/CardLedgerPointsEntryIntegrationAPI.js create mode 100644 src/model/ChangeLoyaltyTierLevelEffectProps.js create mode 100644 src/model/CreateAchievement.js create mode 100644 src/model/CustomerProfileIntegrationResponseV2.js create mode 100644 src/model/InlineResponse20042.js create mode 100644 src/model/InlineResponse20043.js create mode 100644 src/model/IntegrationStoreEntity.js create mode 100644 src/model/LedgerPointsEntryIntegrationAPI.js create mode 100644 src/model/NewNotificationTest.js create mode 100644 src/model/NewStore.js create mode 100644 src/model/NotificationActivation.js create mode 100644 src/model/NotificationTest.js create mode 100644 src/model/OneTimeCode.js create mode 100644 src/model/OutgoingIntegrationCleverTapPolicy.js create mode 100644 src/model/OutgoingIntegrationIterablePolicy.js create mode 100644 src/model/OutgoingIntegrationMoEngagePolicy.js create mode 100644 src/model/RemoveFromAudienceEffectProps.js create mode 100644 src/model/SSOConfig.js create mode 100644 src/model/Store.js create mode 100644 src/model/TierDowngradeNotificationPolicy.js create mode 100644 src/model/TierUpgradeNotificationPolicy.js create mode 100644 src/model/TierWillDowngradeNotificationPolicy.js create mode 100644 src/model/TierWillDowngradeNotificationTrigger.js create mode 100644 src/model/TimePoint.js create mode 100644 src/model/TrackEventV2Response.js create mode 100644 src/model/TwoFAConfig.js create mode 100644 src/model/UpdateAchievement.js create mode 100644 src/model/UpdateStore.js create mode 100644 test/model/Achievement.spec.js create mode 100644 test/model/AchievementAdditionalProperties.spec.js create mode 100644 test/model/AddToAudienceEffectProps.spec.js create mode 100644 test/model/AdditionalCampaignProperties.spec.js create mode 100644 test/model/ApplicationStoreEntity.spec.js create mode 100644 test/model/BaseCampaignForNotification.spec.js create mode 100644 test/model/BulkOperationOnCampaigns.spec.js create mode 100644 test/model/CampaignBudget.spec.js create mode 100644 test/model/CampaignForNotification.spec.js create mode 100644 test/model/CampaignNotificationPolicy.spec.js create mode 100644 test/model/CampaignStateNotification.spec.js create mode 100644 test/model/CardLedgerPointsEntryIntegrationAPI.spec.js create mode 100644 test/model/ChangeLoyaltyTierLevelEffectProps.spec.js create mode 100644 test/model/CreateAchievement.spec.js create mode 100644 test/model/CustomerProfileIntegrationResponseV2.spec.js create mode 100644 test/model/InlineResponse20042.spec.js create mode 100644 test/model/InlineResponse20043.spec.js create mode 100644 test/model/IntegrationStoreEntity.spec.js create mode 100644 test/model/LedgerPointsEntryIntegrationAPI.spec.js create mode 100644 test/model/NewNotificationTest.spec.js create mode 100644 test/model/NewStore.spec.js create mode 100644 test/model/NotificationActivation.spec.js create mode 100644 test/model/NotificationTest.spec.js create mode 100644 test/model/OneTimeCode.spec.js create mode 100644 test/model/OutgoingIntegrationCleverTapPolicy.spec.js create mode 100644 test/model/OutgoingIntegrationIterablePolicy.spec.js create mode 100644 test/model/OutgoingIntegrationMoEngagePolicy.spec.js create mode 100644 test/model/RemoveFromAudienceEffectProps.spec.js create mode 100644 test/model/SSOConfig.spec.js create mode 100644 test/model/Store.spec.js create mode 100644 test/model/TierDowngradeNotificationPolicy.spec.js create mode 100644 test/model/TierUpgradeNotificationPolicy.spec.js create mode 100644 test/model/TierWillDowngradeNotificationPolicy.spec.js create mode 100644 test/model/TierWillDowngradeNotificationTrigger.spec.js create mode 100644 test/model/TimePoint.spec.js create mode 100644 test/model/TrackEventV2Response.spec.js create mode 100644 test/model/TwoFAConfig.spec.js create mode 100644 test/model/UpdateAchievement.spec.js create mode 100644 test/model/UpdateStore.spec.js diff --git a/README.md b/README.md index fda3f99c..6e47c84f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 5.0.1 +- Package version: 6.0.0 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen ## Installation @@ -257,7 +257,9 @@ Class | Method | HTTP request | Description *TalonOne.IntegrationApi* | [**getCustomerSession**](docs/IntegrationApi.md#getCustomerSession) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session *TalonOne.IntegrationApi* | [**getLoyaltyBalances**](docs/IntegrationApi.md#getLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points *TalonOne.IntegrationApi* | [**getLoyaltyCardBalances**](docs/IntegrationApi.md#getLoyaltyCardBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances +*TalonOne.IntegrationApi* | [**getLoyaltyCardPoints**](docs/IntegrationApi.md#getLoyaltyCardPoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points *TalonOne.IntegrationApi* | [**getLoyaltyCardTransactions**](docs/IntegrationApi.md#getLoyaltyCardTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions +*TalonOne.IntegrationApi* | [**getLoyaltyProgramProfilePoints**](docs/IntegrationApi.md#getLoyaltyProgramProfilePoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points *TalonOne.IntegrationApi* | [**getLoyaltyProgramProfileTransactions**](docs/IntegrationApi.md#getLoyaltyProgramProfileTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions *TalonOne.IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved *TalonOne.IntegrationApi* | [**linkLoyaltyCardToProfile**](docs/IntegrationApi.md#linkLoyaltyCardToProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card @@ -278,27 +280,28 @@ Class | Method | HTTP request | Description *TalonOne.ManagementApi* | [**createAdditionalCost**](docs/ManagementApi.md#createAdditionalCost) | **POST** /v1/additional_costs | Create additional cost *TalonOne.ManagementApi* | [**createAttribute**](docs/ManagementApi.md#createAttribute) | **POST** /v1/attributes | Create custom attribute *TalonOne.ManagementApi* | [**createCampaignFromTemplate**](docs/ManagementApi.md#createCampaignFromTemplate) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template -*TalonOne.ManagementApi* | [**createCollection**](docs/ManagementApi.md#createCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create collection +*TalonOne.ManagementApi* | [**createCollection**](docs/ManagementApi.md#createCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection *TalonOne.ManagementApi* | [**createCoupons**](docs/ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons *TalonOne.ManagementApi* | [**createCouponsAsync**](docs/ManagementApi.md#createCouponsAsync) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously *TalonOne.ManagementApi* | [**createCouponsForMultipleRecipients**](docs/ManagementApi.md#createCouponsForMultipleRecipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients -*TalonOne.ManagementApi* | [**createNotificationWebhook**](docs/ManagementApi.md#createNotificationWebhook) | **POST** /v1/applications/{applicationId}/notification_webhooks | Create notification about campaign-related changes *TalonOne.ManagementApi* | [**createPasswordRecoveryEmail**](docs/ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset *TalonOne.ManagementApi* | [**createSession**](docs/ManagementApi.md#createSession) | **POST** /v1/sessions | Create session +*TalonOne.ManagementApi* | [**createStore**](docs/ManagementApi.md#createStore) | **POST** /v1/applications/{applicationId}/stores | Create store *TalonOne.ManagementApi* | [**deductLoyaltyCardPoints**](docs/ManagementApi.md#deductLoyaltyCardPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card *TalonOne.ManagementApi* | [**deleteAccountCollection**](docs/ManagementApi.md#deleteAccountCollection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection *TalonOne.ManagementApi* | [**deleteCampaign**](docs/ManagementApi.md#deleteCampaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign -*TalonOne.ManagementApi* | [**deleteCollection**](docs/ManagementApi.md#deleteCollection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete collection +*TalonOne.ManagementApi* | [**deleteCollection**](docs/ManagementApi.md#deleteCollection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection *TalonOne.ManagementApi* | [**deleteCoupon**](docs/ManagementApi.md#deleteCoupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon *TalonOne.ManagementApi* | [**deleteCoupons**](docs/ManagementApi.md#deleteCoupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons *TalonOne.ManagementApi* | [**deleteLoyaltyCard**](docs/ManagementApi.md#deleteLoyaltyCard) | **DELETE** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card -*TalonOne.ManagementApi* | [**deleteNotificationWebhook**](docs/ManagementApi.md#deleteNotificationWebhook) | **DELETE** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification about campaign-related changes *TalonOne.ManagementApi* | [**deleteReferral**](docs/ManagementApi.md#deleteReferral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral +*TalonOne.ManagementApi* | [**deleteStore**](docs/ManagementApi.md#deleteStore) | **DELETE** /v1/applications/{applicationId}/stores/{storeId} | Delete store *TalonOne.ManagementApi* | [**destroySession**](docs/ManagementApi.md#destroySession) | **DELETE** /v1/sessions | Destroy session *TalonOne.ManagementApi* | [**exportAccountCollectionItems**](docs/ManagementApi.md#exportAccountCollectionItems) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items -*TalonOne.ManagementApi* | [**exportCollectionItems**](docs/ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export a collection's items +*TalonOne.ManagementApi* | [**exportCollectionItems**](docs/ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items *TalonOne.ManagementApi* | [**exportCoupons**](docs/ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons *TalonOne.ManagementApi* | [**exportCustomerSessions**](docs/ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions +*TalonOne.ManagementApi* | [**exportCustomersTiers**](docs/ManagementApi.md#exportCustomersTiers) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers | Export customers' tier data *TalonOne.ManagementApi* | [**exportEffects**](docs/ManagementApi.md#exportEffects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered effects *TalonOne.ManagementApi* | [**exportLoyaltyBalance**](docs/ManagementApi.md#exportLoyaltyBalance) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV *TalonOne.ManagementApi* | [**exportLoyaltyBalances**](docs/ManagementApi.md#exportLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances @@ -335,7 +338,7 @@ Class | Method | HTTP request | Description *TalonOne.ManagementApi* | [**getCampaignTemplates**](docs/ManagementApi.md#getCampaignTemplates) | **GET** /v1/campaign_templates | List campaign templates *TalonOne.ManagementApi* | [**getCampaigns**](docs/ManagementApi.md#getCampaigns) | **GET** /v1/applications/{applicationId}/campaigns | List campaigns *TalonOne.ManagementApi* | [**getChanges**](docs/ManagementApi.md#getChanges) | **GET** /v1/changes | Get audit logs for an account -*TalonOne.ManagementApi* | [**getCollection**](docs/ManagementApi.md#getCollection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get collection +*TalonOne.ManagementApi* | [**getCollection**](docs/ManagementApi.md#getCollection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection *TalonOne.ManagementApi* | [**getCollectionItems**](docs/ManagementApi.md#getCollectionItems) | **GET** /v1/collections/{collectionId}/items | Get collection items *TalonOne.ManagementApi* | [**getCouponsWithoutTotalCount**](docs/ManagementApi.md#getCouponsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons *TalonOne.ManagementApi* | [**getCustomerActivityReport**](docs/ManagementApi.md#getCustomerActivityReport) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report @@ -354,21 +357,20 @@ Class | Method | HTTP request | Description *TalonOne.ManagementApi* | [**getLoyaltyProgramTransactions**](docs/ManagementApi.md#getLoyaltyProgramTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions *TalonOne.ManagementApi* | [**getLoyaltyPrograms**](docs/ManagementApi.md#getLoyaltyPrograms) | **GET** /v1/loyalty_programs | List loyalty programs *TalonOne.ManagementApi* | [**getLoyaltyStatistics**](docs/ManagementApi.md#getLoyaltyStatistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics -*TalonOne.ManagementApi* | [**getNotificationWebhook**](docs/ManagementApi.md#getNotificationWebhook) | **GET** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification about campaign-related changes -*TalonOne.ManagementApi* | [**getNotificationWebhooks**](docs/ManagementApi.md#getNotificationWebhooks) | **GET** /v1/applications/{applicationId}/notification_webhooks | List notifications about campaign-related changes *TalonOne.ManagementApi* | [**getReferralsWithoutTotalCount**](docs/ManagementApi.md#getReferralsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals *TalonOne.ManagementApi* | [**getRole**](docs/ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get role *TalonOne.ManagementApi* | [**getRuleset**](docs/ManagementApi.md#getRuleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset *TalonOne.ManagementApi* | [**getRulesets**](docs/ManagementApi.md#getRulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets +*TalonOne.ManagementApi* | [**getStore**](docs/ManagementApi.md#getStore) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store *TalonOne.ManagementApi* | [**getUser**](docs/ManagementApi.md#getUser) | **GET** /v1/users/{userId} | Get user *TalonOne.ManagementApi* | [**getUsers**](docs/ManagementApi.md#getUsers) | **GET** /v1/users | List users in account *TalonOne.ManagementApi* | [**getWebhook**](docs/ManagementApi.md#getWebhook) | **GET** /v1/webhooks/{webhookId} | Get webhook *TalonOne.ManagementApi* | [**getWebhookActivationLogs**](docs/ManagementApi.md#getWebhookActivationLogs) | **GET** /v1/webhook_activation_logs | List webhook activation log entries *TalonOne.ManagementApi* | [**getWebhookLogs**](docs/ManagementApi.md#getWebhookLogs) | **GET** /v1/webhook_logs | List webhook log entries *TalonOne.ManagementApi* | [**getWebhooks**](docs/ManagementApi.md#getWebhooks) | **GET** /v1/webhooks | List webhooks -*TalonOne.ManagementApi* | [**importAccountCollection**](docs/ManagementApi.md#importAccountCollection) | **POST** /v1/collections/{collectionId}/import | Import data in existing account-level collection +*TalonOne.ManagementApi* | [**importAccountCollection**](docs/ManagementApi.md#importAccountCollection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection *TalonOne.ManagementApi* | [**importAllowedList**](docs/ManagementApi.md#importAllowedList) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute -*TalonOne.ManagementApi* | [**importCollection**](docs/ManagementApi.md#importCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data in existing collection +*TalonOne.ManagementApi* | [**importCollection**](docs/ManagementApi.md#importCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection *TalonOne.ManagementApi* | [**importCoupons**](docs/ManagementApi.md#importCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons *TalonOne.ManagementApi* | [**importLoyaltyCards**](docs/ManagementApi.md#importLoyaltyCards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards *TalonOne.ManagementApi* | [**importLoyaltyCustomersTiers**](docs/ManagementApi.md#importLoyaltyCustomersTiers) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers @@ -377,10 +379,12 @@ Class | Method | HTTP request | Description *TalonOne.ManagementApi* | [**importReferrals**](docs/ManagementApi.md#importReferrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals *TalonOne.ManagementApi* | [**listAccountCollections**](docs/ManagementApi.md#listAccountCollections) | **GET** /v1/collections | List collections in account *TalonOne.ManagementApi* | [**listCatalogItems**](docs/ManagementApi.md#listCatalogItems) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog -*TalonOne.ManagementApi* | [**listCollections**](docs/ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections -*TalonOne.ManagementApi* | [**listCollectionsInApplication**](docs/ManagementApi.md#listCollectionsInApplication) | **GET** /v1/applications/{applicationId}/collections | List collections in application +*TalonOne.ManagementApi* | [**listCollections**](docs/ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign +*TalonOne.ManagementApi* | [**listCollectionsInApplication**](docs/ManagementApi.md#listCollectionsInApplication) | **GET** /v1/applications/{applicationId}/collections | List collections in Application +*TalonOne.ManagementApi* | [**listStores**](docs/ManagementApi.md#listStores) | **GET** /v1/applications/{applicationId}/stores | List stores +*TalonOne.ManagementApi* | [**notificationActivation**](docs/ManagementApi.md#notificationActivation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification *TalonOne.ManagementApi* | [**postAddedDeductedPointsNotification**](docs/ManagementApi.md#postAddedDeductedPointsNotification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points -*TalonOne.ManagementApi* | [**postCatalogsStrikethroughNotification**](docs/ManagementApi.md#postCatalogsStrikethroughNotification) | **POST** /v1/catalogs/{applicationId}/notifications/strikethrough | Create strikethrough notification +*TalonOne.ManagementApi* | [**postCatalogsStrikethroughNotification**](docs/ManagementApi.md#postCatalogsStrikethroughNotification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification *TalonOne.ManagementApi* | [**postPendingPointsNotification**](docs/ManagementApi.md#postPendingPointsNotification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points *TalonOne.ManagementApi* | [**removeLoyaltyPoints**](docs/ManagementApi.md#removeLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile *TalonOne.ManagementApi* | [**resetPassword**](docs/ManagementApi.md#resetPassword) | **POST** /v1/reset_password | Reset password @@ -391,12 +395,12 @@ Class | Method | HTTP request | Description *TalonOne.ManagementApi* | [**updateAdditionalCost**](docs/ManagementApi.md#updateAdditionalCost) | **PUT** /v1/additional_costs/{additionalCostId} | Update additional cost *TalonOne.ManagementApi* | [**updateAttribute**](docs/ManagementApi.md#updateAttribute) | **PUT** /v1/attributes/{attributeId} | Update custom attribute *TalonOne.ManagementApi* | [**updateCampaign**](docs/ManagementApi.md#updateCampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign -*TalonOne.ManagementApi* | [**updateCollection**](docs/ManagementApi.md#updateCollection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update collection description +*TalonOne.ManagementApi* | [**updateCollection**](docs/ManagementApi.md#updateCollection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update campaign-level collection's description *TalonOne.ManagementApi* | [**updateCoupon**](docs/ManagementApi.md#updateCoupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon *TalonOne.ManagementApi* | [**updateCouponBatch**](docs/ManagementApi.md#updateCouponBatch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons *TalonOne.ManagementApi* | [**updateLoyaltyCard**](docs/ManagementApi.md#updateLoyaltyCard) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status -*TalonOne.ManagementApi* | [**updateNotificationWebhook**](docs/ManagementApi.md#updateNotificationWebhook) | **PUT** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification about campaign-related changes *TalonOne.ManagementApi* | [**updateReferral**](docs/ManagementApi.md#updateReferral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral +*TalonOne.ManagementApi* | [**updateStore**](docs/ManagementApi.md#updateStore) | **PUT** /v1/applications/{applicationId}/stores/{storeId} | Update store ## Documentation for Models @@ -417,11 +421,15 @@ Class | Method | HTTP request | Description - [TalonOne.AccountDashboardStatisticRevenue](docs/AccountDashboardStatisticRevenue.md) - [TalonOne.AccountEntity](docs/AccountEntity.md) - [TalonOne.AccountLimits](docs/AccountLimits.md) + - [TalonOne.Achievement](docs/Achievement.md) + - [TalonOne.AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md) - [TalonOne.AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) - [TalonOne.AddItemCatalogAction](docs/AddItemCatalogAction.md) - [TalonOne.AddLoyaltyPoints](docs/AddLoyaltyPoints.md) - [TalonOne.AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) + - [TalonOne.AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md) - [TalonOne.AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md) + - [TalonOne.AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md) - [TalonOne.AdditionalCost](docs/AdditionalCost.md) - [TalonOne.Application](docs/Application.md) - [TalonOne.ApplicationAPIKey](docs/ApplicationAPIKey.md) @@ -435,6 +443,7 @@ Class | Method | HTTP request | Description - [TalonOne.ApplicationReferee](docs/ApplicationReferee.md) - [TalonOne.ApplicationSession](docs/ApplicationSession.md) - [TalonOne.ApplicationSessionEntity](docs/ApplicationSessionEntity.md) + - [TalonOne.ApplicationStoreEntity](docs/ApplicationStoreEntity.md) - [TalonOne.AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md) - [TalonOne.Attribute](docs/Attribute.md) - [TalonOne.AttributesMandatory](docs/AttributesMandatory.md) @@ -446,6 +455,7 @@ Class | Method | HTTP request | Description - [TalonOne.AudienceMembership](docs/AudienceMembership.md) - [TalonOne.AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md) - [TalonOne.BaseCampaign](docs/BaseCampaign.md) + - [TalonOne.BaseCampaignForNotification](docs/BaseCampaignForNotification.md) - [TalonOne.BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md) - [TalonOne.BaseNotification](docs/BaseNotification.md) - [TalonOne.BaseNotificationEntity](docs/BaseNotificationEntity.md) @@ -455,9 +465,11 @@ Class | Method | HTTP request | Description - [TalonOne.Binding](docs/Binding.md) - [TalonOne.BulkApplicationNotification](docs/BulkApplicationNotification.md) - [TalonOne.BulkCampaignNotification](docs/BulkCampaignNotification.md) + - [TalonOne.BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md) - [TalonOne.Campaign](docs/Campaign.md) - [TalonOne.CampaignActivationRequest](docs/CampaignActivationRequest.md) - [TalonOne.CampaignAnalytics](docs/CampaignAnalytics.md) + - [TalonOne.CampaignBudget](docs/CampaignBudget.md) - [TalonOne.CampaignCollection](docs/CampaignCollection.md) - [TalonOne.CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md) - [TalonOne.CampaignCopy](docs/CampaignCopy.md) @@ -468,9 +480,11 @@ Class | Method | HTTP request | Description - [TalonOne.CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md) - [TalonOne.CampaignEvaluationPosition](docs/CampaignEvaluationPosition.md) - [TalonOne.CampaignEvaluationTreeChangedNotification](docs/CampaignEvaluationTreeChangedNotification.md) + - [TalonOne.CampaignForNotification](docs/CampaignForNotification.md) - [TalonOne.CampaignGroup](docs/CampaignGroup.md) - [TalonOne.CampaignGroupEntity](docs/CampaignGroupEntity.md) - [TalonOne.CampaignNotification](docs/CampaignNotification.md) + - [TalonOne.CampaignNotificationPolicy](docs/CampaignNotificationPolicy.md) - [TalonOne.CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md) - [TalonOne.CampaignSearch](docs/CampaignSearch.md) - [TalonOne.CampaignSet](docs/CampaignSet.md) @@ -478,9 +492,11 @@ Class | Method | HTTP request | Description - [TalonOne.CampaignSetLeafNode](docs/CampaignSetLeafNode.md) - [TalonOne.CampaignSetNode](docs/CampaignSetNode.md) - [TalonOne.CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md) + - [TalonOne.CampaignStateNotification](docs/CampaignStateNotification.md) - [TalonOne.CampaignTemplate](docs/CampaignTemplate.md) - [TalonOne.CampaignTemplateCollection](docs/CampaignTemplateCollection.md) - [TalonOne.CampaignTemplateParams](docs/CampaignTemplateParams.md) + - [TalonOne.CardLedgerPointsEntryIntegrationAPI](docs/CardLedgerPointsEntryIntegrationAPI.md) - [TalonOne.CardLedgerTransactionLogEntry](docs/CardLedgerTransactionLogEntry.md) - [TalonOne.CardLedgerTransactionLogEntryIntegrationAPI](docs/CardLedgerTransactionLogEntryIntegrationAPI.md) - [TalonOne.CartItem](docs/CartItem.md) @@ -491,6 +507,7 @@ Class | Method | HTTP request | Description - [TalonOne.CatalogSyncRequest](docs/CatalogSyncRequest.md) - [TalonOne.CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md) - [TalonOne.Change](docs/Change.md) + - [TalonOne.ChangeLoyaltyTierLevelEffectProps](docs/ChangeLoyaltyTierLevelEffectProps.md) - [TalonOne.ChangeProfilePassword](docs/ChangeProfilePassword.md) - [TalonOne.CodeGeneratorSettings](docs/CodeGeneratorSettings.md) - [TalonOne.Collection](docs/Collection.md) @@ -506,6 +523,7 @@ Class | Method | HTTP request | Description - [TalonOne.CouponSearch](docs/CouponSearch.md) - [TalonOne.CouponValue](docs/CouponValue.md) - [TalonOne.CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md) + - [TalonOne.CreateAchievement](docs/CreateAchievement.md) - [TalonOne.CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md) - [TalonOne.CreateManagementKey](docs/CreateManagementKey.md) - [TalonOne.CreateTemplateCampaign](docs/CreateTemplateCampaign.md) @@ -519,6 +537,7 @@ Class | Method | HTTP request | Description - [TalonOne.CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md) - [TalonOne.CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md) - [TalonOne.CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md) + - [TalonOne.CustomerProfileIntegrationResponseV2](docs/CustomerProfileIntegrationResponseV2.md) - [TalonOne.CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md) - [TalonOne.CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md) - [TalonOne.CustomerSession](docs/CustomerSession.md) @@ -544,7 +563,6 @@ Class | Method | HTTP request | Description - [TalonOne.ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md) - [TalonOne.FeatureFlag](docs/FeatureFlag.md) - [TalonOne.FeaturesFeed](docs/FeaturesFeed.md) - - [TalonOne.FrontendState](docs/FrontendState.md) - [TalonOne.FuncArgDef](docs/FuncArgDef.md) - [TalonOne.FunctionDef](docs/FunctionDef.md) - [TalonOne.Giveaway](docs/Giveaway.md) @@ -588,6 +606,8 @@ Class | Method | HTTP request | Description - [TalonOne.InlineResponse2004](docs/InlineResponse2004.md) - [TalonOne.InlineResponse20040](docs/InlineResponse20040.md) - [TalonOne.InlineResponse20041](docs/InlineResponse20041.md) + - [TalonOne.InlineResponse20042](docs/InlineResponse20042.md) + - [TalonOne.InlineResponse20043](docs/InlineResponse20043.md) - [TalonOne.InlineResponse2005](docs/InlineResponse2005.md) - [TalonOne.InlineResponse2006](docs/InlineResponse2006.md) - [TalonOne.InlineResponse2007](docs/InlineResponse2007.md) @@ -603,11 +623,13 @@ Class | Method | HTTP request | Description - [TalonOne.IntegrationRequest](docs/IntegrationRequest.md) - [TalonOne.IntegrationState](docs/IntegrationState.md) - [TalonOne.IntegrationStateV2](docs/IntegrationStateV2.md) + - [TalonOne.IntegrationStoreEntity](docs/IntegrationStoreEntity.md) - [TalonOne.InventoryCoupon](docs/InventoryCoupon.md) - [TalonOne.InventoryReferral](docs/InventoryReferral.md) - [TalonOne.ItemAttribute](docs/ItemAttribute.md) - [TalonOne.LedgerEntry](docs/LedgerEntry.md) - [TalonOne.LedgerInfo](docs/LedgerInfo.md) + - [TalonOne.LedgerPointsEntryIntegrationAPI](docs/LedgerPointsEntryIntegrationAPI.md) - [TalonOne.LedgerTransactionLogEntryIntegrationAPI](docs/LedgerTransactionLogEntryIntegrationAPI.md) - [TalonOne.LibraryAttribute](docs/LibraryAttribute.md) - [TalonOne.LimitConfig](docs/LimitConfig.md) @@ -631,7 +653,6 @@ Class | Method | HTTP request | Description - [TalonOne.LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) - [TalonOne.LoyaltyProgramSubledgers](docs/LoyaltyProgramSubledgers.md) - [TalonOne.LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md) - - [TalonOne.LoyaltyStatistics](docs/LoyaltyStatistics.md) - [TalonOne.LoyaltySubLedger](docs/LoyaltySubLedger.md) - [TalonOne.LoyaltyTier](docs/LoyaltyTier.md) - [TalonOne.ManagementKey](docs/ManagementKey.md) @@ -683,6 +704,7 @@ Class | Method | HTTP request | Description - [TalonOne.NewLoyaltyTier](docs/NewLoyaltyTier.md) - [TalonOne.NewManagementKey](docs/NewManagementKey.md) - [TalonOne.NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md) + - [TalonOne.NewNotificationTest](docs/NewNotificationTest.md) - [TalonOne.NewNotificationWebhook](docs/NewNotificationWebhook.md) - [TalonOne.NewOutgoingIntegrationWebhook](docs/NewOutgoingIntegrationWebhook.md) - [TalonOne.NewPassword](docs/NewPassword.md) @@ -695,13 +717,19 @@ Class | Method | HTTP request | Description - [TalonOne.NewRoleV2](docs/NewRoleV2.md) - [TalonOne.NewRuleset](docs/NewRuleset.md) - [TalonOne.NewSamlConnection](docs/NewSamlConnection.md) + - [TalonOne.NewStore](docs/NewStore.md) - [TalonOne.NewTemplateDef](docs/NewTemplateDef.md) - [TalonOne.NewUser](docs/NewUser.md) - [TalonOne.NewWebhook](docs/NewWebhook.md) - [TalonOne.Notification](docs/Notification.md) - - [TalonOne.NotificationWebhook](docs/NotificationWebhook.md) + - [TalonOne.NotificationActivation](docs/NotificationActivation.md) + - [TalonOne.NotificationTest](docs/NotificationTest.md) + - [TalonOne.OneTimeCode](docs/OneTimeCode.md) - [TalonOne.OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md) + - [TalonOne.OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md) - [TalonOne.OutgoingIntegrationConfiguration](docs/OutgoingIntegrationConfiguration.md) + - [TalonOne.OutgoingIntegrationIterablePolicy](docs/OutgoingIntegrationIterablePolicy.md) + - [TalonOne.OutgoingIntegrationMoEngagePolicy](docs/OutgoingIntegrationMoEngagePolicy.md) - [TalonOne.OutgoingIntegrationTemplate](docs/OutgoingIntegrationTemplate.md) - [TalonOne.OutgoingIntegrationTemplateWithConfigurationDetails](docs/OutgoingIntegrationTemplateWithConfigurationDetails.md) - [TalonOne.OutgoingIntegrationTemplates](docs/OutgoingIntegrationTemplates.md) @@ -719,6 +747,7 @@ Class | Method | HTTP request | Description - [TalonOne.ReferralRejectionReason](docs/ReferralRejectionReason.md) - [TalonOne.RejectCouponEffectProps](docs/RejectCouponEffectProps.md) - [TalonOne.RejectReferralEffectProps](docs/RejectReferralEffectProps.md) + - [TalonOne.RemoveFromAudienceEffectProps](docs/RemoveFromAudienceEffectProps.md) - [TalonOne.RemoveItemCatalogAction](docs/RemoveItemCatalogAction.md) - [TalonOne.RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md) - [TalonOne.ReopenSessionResponse](docs/ReopenSessionResponse.md) @@ -742,6 +771,7 @@ Class | Method | HTTP request | Description - [TalonOne.Rule](docs/Rule.md) - [TalonOne.RuleFailureReason](docs/RuleFailureReason.md) - [TalonOne.Ruleset](docs/Ruleset.md) + - [TalonOne.SSOConfig](docs/SSOConfig.md) - [TalonOne.SamlConnection](docs/SamlConnection.md) - [TalonOne.SamlConnectionMetadata](docs/SamlConnectionMetadata.md) - [TalonOne.SamlLoginEndpoint](docs/SamlLoginEndpoint.md) @@ -753,6 +783,7 @@ Class | Method | HTTP request | Description - [TalonOne.ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md) - [TalonOne.ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md) - [TalonOne.SlotDef](docs/SlotDef.md) + - [TalonOne.Store](docs/Store.md) - [TalonOne.StrikethroughChangedItem](docs/StrikethroughChangedItem.md) - [TalonOne.StrikethroughCustomEffectPerItemProps](docs/StrikethroughCustomEffectPerItemProps.md) - [TalonOne.StrikethroughEffect](docs/StrikethroughEffect.md) @@ -765,9 +796,17 @@ Class | Method | HTTP request | Description - [TalonOne.TemplateDef](docs/TemplateDef.md) - [TalonOne.TemplateLimitConfig](docs/TemplateLimitConfig.md) - [TalonOne.Tier](docs/Tier.md) + - [TalonOne.TierDowngradeNotificationPolicy](docs/TierDowngradeNotificationPolicy.md) + - [TalonOne.TierUpgradeNotificationPolicy](docs/TierUpgradeNotificationPolicy.md) + - [TalonOne.TierWillDowngradeNotificationPolicy](docs/TierWillDowngradeNotificationPolicy.md) + - [TalonOne.TierWillDowngradeNotificationTrigger](docs/TierWillDowngradeNotificationTrigger.md) + - [TalonOne.TimePoint](docs/TimePoint.md) + - [TalonOne.TrackEventV2Response](docs/TrackEventV2Response.md) - [TalonOne.TransferLoyaltyCard](docs/TransferLoyaltyCard.md) - [TalonOne.TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md) + - [TalonOne.TwoFAConfig](docs/TwoFAConfig.md) - [TalonOne.UpdateAccount](docs/UpdateAccount.md) + - [TalonOne.UpdateAchievement](docs/UpdateAchievement.md) - [TalonOne.UpdateApplication](docs/UpdateApplication.md) - [TalonOne.UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) - [TalonOne.UpdateAudience](docs/UpdateAudience.md) @@ -787,6 +826,7 @@ Class | Method | HTTP request | Description - [TalonOne.UpdateReferral](docs/UpdateReferral.md) - [TalonOne.UpdateReferralBatch](docs/UpdateReferralBatch.md) - [TalonOne.UpdateRole](docs/UpdateRole.md) + - [TalonOne.UpdateStore](docs/UpdateStore.md) - [TalonOne.UpdateUser](docs/UpdateUser.md) - [TalonOne.User](docs/User.md) - [TalonOne.UserEntity](docs/UserEntity.md) diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md index 9038f35d..6268a8a8 100644 --- a/docs/AccountAnalytics.md +++ b/docs/AccountAnalytics.md @@ -23,5 +23,6 @@ Name | Type | Description | Notes **webhooks** | **Number** | Total number of webhooks in the account. | **loyaltyPrograms** | **Number** | Total number of all loyalty programs in the account. | **liveLoyaltyPrograms** | **Number** | Total number of live loyalty programs in the account. | +**lastUpdatedAt** | **Date** | The point in time when the analytics numbers were updated last. | diff --git a/docs/AccountDashboardStatisticCampaigns.md b/docs/AccountDashboardStatisticCampaigns.md index 06c12ec0..5a647004 100644 --- a/docs/AccountDashboardStatisticCampaigns.md +++ b/docs/AccountDashboardStatisticCampaigns.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **live** | **Number** | Number of campaigns that are active and live (across all Applications). | -**endingSoon** | **Number** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. | +**endingSoon** | **Number** | Campaigns scheduled to expire sometime in the next 7 days. | +**lowOnBudget** | **Number** | Campaigns with less than 10% of budget left. | diff --git a/docs/Achievement.md b/docs/Achievement.md new file mode 100644 index 00000000..a3028770 --- /dev/null +++ b/docs/Achievement.md @@ -0,0 +1,18 @@ +# TalonOne.Achievement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | Internal ID of this entity. | +**created** | **Date** | The time this entity was created. | +**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | +**title** | **String** | The display name for the achievement in the Campaign Manager. | +**description** | **String** | A description of the achievement. | +**target** | **Number** | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. | +**period** | **String** | The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | +**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] +**userId** | **Number** | ID of the user that created this achievement. | +**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | + + diff --git a/docs/AchievementAdditionalProperties.md b/docs/AchievementAdditionalProperties.md new file mode 100644 index 00000000..4574949d --- /dev/null +++ b/docs/AchievementAdditionalProperties.md @@ -0,0 +1,10 @@ +# TalonOne.AchievementAdditionalProperties + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **Number** | ID of the user that created this achievement. | +**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | + + diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md index 844f492f..a1d2060b 100644 --- a/docs/AddLoyaltyPointsEffectProps.md +++ b/docs/AddLoyaltyPointsEffectProps.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **expiryDate** | **Date** | Date after which points will expire. | [optional] **transactionUUID** | **String** | The identifier of this addition in the loyalty ledger. | **cartItemPosition** | **Number** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] -**cartItemSubPosition** | **Number** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. | [optional] +**cartItemSubPosition** | **Number** | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional] **cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional] **bundleIndex** | **Number** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] **bundleName** | **String** | The name of the bundle definition. | [optional] diff --git a/docs/AddToAudienceEffectProps.md b/docs/AddToAudienceEffectProps.md new file mode 100644 index 00000000..dbf60587 --- /dev/null +++ b/docs/AddToAudienceEffectProps.md @@ -0,0 +1,12 @@ +# TalonOne.AddToAudienceEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audienceId** | **Number** | The internal ID of the audience. | [optional] +**audienceName** | **String** | The name of the audience. | [optional] +**profileIntegrationId** | **String** | The ID of the customer profile in the third-party integration platform. | [optional] +**profileId** | **Number** | The internal ID of the customer profile. | [optional] + + diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md new file mode 100644 index 00000000..22930ec9 --- /dev/null +++ b/docs/AdditionalCampaignProperties.md @@ -0,0 +1,29 @@ +# TalonOne.AdditionalCampaignProperties + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budgets** | [**[CampaignBudget]**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | +**couponRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] +**referralRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] +**discountCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] +**discountEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] +**couponCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] +**customEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional] +**referralCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] +**addFreeItemEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional] +**awardedGiveawaysCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] +**createdLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional] +**createdLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] +**redeemedLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional] +**redeemedLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] +**callApiEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] +**reservecouponEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional] +**lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional] +**updated** | **Date** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] +**createdBy** | **String** | Name of the user who created this campaign if available. | [optional] +**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional] +**templateId** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional] + + diff --git a/docs/Application.md b/docs/Application.md index d592c2a7..6184e1bc 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] **defaultDiscountScope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] **enableCascadingDiscounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional] -**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). | [optional] +**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. | [optional] **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional] **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md index 229d43ea..9fcc4b96 100644 --- a/docs/ApplicationAPIKey.md +++ b/docs/ApplicationAPIKey.md @@ -36,6 +36,8 @@ Name | Type | Description | Notes * `salesforce` (value: `"salesforce"`) +* `emarsys` (value: `"emarsys"`) + diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index 432e2c1a..c507e789 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **totalSales** | **Number** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] **audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] -**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | +**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | **sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] **advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index 3bc286aa..5970919d 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -8,6 +8,8 @@ Name | Type | Description | Notes **created** | **Date** | The time this entity was created. | **applicationId** | **Number** | The ID of the application that owns this entity. | **profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional] +**storeId** | **Number** | The ID of the store. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **sessionId** | **Number** | The globally unique Talon.One ID of the session that contains this event. | [optional] **type** | **String** | A string representing the event. Must not be a reserved event name. | **attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. | diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index f342deb3..e7428e91 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -6,13 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | Internal ID of this entity. | **created** | **Date** | The time this entity was created. The time this entity was created. | +**integrationId** | **String** | The integration ID set by your integration layer. | +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **applicationId** | **Number** | The ID of the application that owns this entity. | **profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional] -**integrationId** | **String** | The integration ID set by your integration layer. | **profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional] **coupon** | **String** | Any coupon code entered. | **referral** | **String** | Any referral code entered. | -**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | +**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | **cartItems** | [**[CartItem]**](CartItem.md) | Serialized JSON representation. | **discounts** | **{String: Number}** | **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. | **totalDiscounts** | **Number** | The total sum of the discounts applied to this session. | diff --git a/docs/ApplicationStoreEntity.md b/docs/ApplicationStoreEntity.md new file mode 100644 index 00000000..1494407f --- /dev/null +++ b/docs/ApplicationStoreEntity.md @@ -0,0 +1,9 @@ +# TalonOne.ApplicationStoreEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**storeId** | **Number** | The ID of the store. | [optional] + + diff --git a/docs/Attribute.md b/docs/Attribute.md index 5ace93ce..e2551fd8 100644 --- a/docs/Attribute.md +++ b/docs/Attribute.md @@ -47,6 +47,8 @@ Name | Type | Description | Notes * `Referral` (value: `"Referral"`) +* `Store` (value: `"Store"`) + diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md index cd2367e0..4652c449 100644 --- a/docs/AudienceCustomer.md +++ b/docs/AudienceCustomer.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **totalSales** | **Number** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] **audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] -**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | +**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | **sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] **connectedApplicationsIds** | **[Number]** | A list of the IDs of the Applications that are connected to this customer profile. | [optional] **connectedAudiences** | **[Number]** | A list of the IDs of the audiences that are connected to this customer profile. | [optional] diff --git a/docs/BaseCampaign.md b/docs/BaseCampaign.md index 20468a8e..02b2ab4b 100644 --- a/docs/BaseCampaign.md +++ b/docs/BaseCampaign.md @@ -17,6 +17,9 @@ Name | Type | Description | Notes **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] @@ -49,3 +52,14 @@ Name | Type | Description | Notes + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/BaseCampaignForNotification.md b/docs/BaseCampaignForNotification.md new file mode 100644 index 00000000..c9991862 --- /dev/null +++ b/docs/BaseCampaignForNotification.md @@ -0,0 +1,73 @@ +# TalonOne.BaseCampaignForNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | A user-facing name for this campaign. | +**description** | **String** | A detailed description of the campaign. | [optional] +**startTime** | **Date** | Timestamp when the campaign will become active. | [optional] +**endTime** | **Date** | Timestamp when the campaign will become inactive. | [optional] +**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] +**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled'] +**activeRulesetId** | **Number** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] +**tags** | **[String]** | A list of tags for the campaign. | +**features** | **[String]** | The features enabled in this campaign. | +**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | +**campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] + + + +## Enum: StateEnum + + +* `enabled` (value: `"enabled"`) + +* `disabled` (value: `"disabled"`) + +* `archived` (value: `"archived"`) + +* `draft` (value: `"draft"`) + +* `scheduled` (value: `"scheduled"`) + +* `running` (value: `"running"`) + +* `expired` (value: `"expired"`) + + + + + +## Enum: [FeaturesEnum] + + +* `coupons` (value: `"coupons"`) + +* `referrals` (value: `"referrals"`) + +* `loyalty` (value: `"loyalty"`) + +* `giveaways` (value: `"giveaways"`) + +* `strikethrough` (value: `"strikethrough"`) + + + + + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md index 5678d7b5..5051068e 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional] **usersPerCardLimit** | **Number** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional] -**tiersExpireIn** | **String** | The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] +**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] **tiersDowngradePolicy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional] diff --git a/docs/BaseNotification.md b/docs/BaseNotification.md index b759a4d4..9d8184fc 100644 --- a/docs/BaseNotification.md +++ b/docs/BaseNotification.md @@ -5,7 +5,34 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **policy** | [**Object**](.md) | | +**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true] **webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | | **id** | **Number** | Unique ID for this entity. | +**type** | **String** | The notification type. | + + + +## Enum: TypeEnum + + +* `campaign` (value: `"campaign"`) + +* `loyalty_added_deducted_points` (value: `"loyalty_added_deducted_points"`) + +* `coupon` (value: `"coupon"`) + +* `expiring_points` (value: `"expiring_points"`) + +* `pending_to_active_points` (value: `"pending_to_active_points"`) + +* `strikethrough_pricing` (value: `"strikethrough_pricing"`) + +* `tier_downgrade` (value: `"tier_downgrade"`) + +* `tier_upgrade` (value: `"tier_upgrade"`) + +* `tier_will_downgrade` (value: `"tier_will_downgrade"`) + + diff --git a/docs/BaseNotificationEntity.md b/docs/BaseNotificationEntity.md index 7e0a5116..efb9c234 100644 --- a/docs/BaseNotificationEntity.md +++ b/docs/BaseNotificationEntity.md @@ -5,5 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **policy** | [**Object**](.md) | | +**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true] diff --git a/docs/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md index a0487d0a..d614c91f 100644 --- a/docs/BaseNotificationWebhook.md +++ b/docs/BaseNotificationWebhook.md @@ -9,5 +9,6 @@ Name | Type | Description | Notes **modified** | **Date** | The time this entity was last modified. | **url** | **String** | API URL for the given webhook-based notification. | **headers** | **[String]** | List of API HTTP headers for the given webhook-based notification. | +**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true] diff --git a/docs/BulkOperationOnCampaigns.md b/docs/BulkOperationOnCampaigns.md new file mode 100644 index 00000000..b901780a --- /dev/null +++ b/docs/BulkOperationOnCampaigns.md @@ -0,0 +1,21 @@ +# TalonOne.BulkOperationOnCampaigns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **String** | The operation to perform on the specified campaign IDs. | +**campaignIds** | **[Number]** | The list of campaign IDs on which the operation will be performed. | + + + +## Enum: OperationEnum + + +* `disable` (value: `"disable"`) + +* `delete` (value: `"delete"`) + + + + diff --git a/docs/Campaign.md b/docs/Campaign.md index 7b88b0cf..3aa3dc2c 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -21,21 +21,25 @@ Name | Type | Description | Notes **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] -**couponRedemptionCount** | **Number** | Number of coupons redeemed in the campaign. | [optional] -**referralRedemptionCount** | **Number** | Number of referral codes redeemed in the campaign. | [optional] -**discountCount** | **Number** | Total amount of discounts redeemed in the campaign. | [optional] -**discountEffectCount** | **Number** | Total number of times discounts were redeemed in this campaign. | [optional] -**couponCreationCount** | **Number** | Total number of coupons created by rules in this campaign. | [optional] -**customEffectCount** | **Number** | Total number of custom effects triggered by rules in this campaign. | [optional] -**referralCreationCount** | **Number** | Total number of referrals created by rules in this campaign. | [optional] -**addFreeItemEffectCount** | **Number** | Total number of times triggering add free item effext is allowed in this campaign. | [optional] -**awardedGiveawaysCount** | **Number** | Total number of giveaways awarded by rules in this campaign. | [optional] -**createdLoyaltyPointsCount** | **Number** | Total number of loyalty points created by rules in this campaign. | [optional] -**createdLoyaltyPointsEffectCount** | **Number** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] -**redeemedLoyaltyPointsCount** | **Number** | Total number of loyalty points redeemed by rules in this campaign. | [optional] -**redeemedLoyaltyPointsEffectCount** | **Number** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] -**callApiEffectCount** | **Number** | Total number of webhook triggered by rules in this campaign. | [optional] -**reservecouponEffectCount** | **Number** | Total number of reserve coupon effects triggered by rules in this campaign. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] +**budgets** | [**[CampaignBudget]**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | +**couponRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] +**referralRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] +**discountCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] +**discountEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] +**couponCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] +**customEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional] +**referralCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] +**addFreeItemEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional] +**awardedGiveawaysCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] +**createdLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional] +**createdLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] +**redeemedLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional] +**redeemedLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] +**callApiEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] +**reservecouponEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional] **lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional] **updated** | **Date** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] **createdBy** | **String** | Name of the user who created this campaign if available. | [optional] @@ -73,3 +77,14 @@ Name | Type | Description | Notes + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/CampaignBudget.md b/docs/CampaignBudget.md new file mode 100644 index 00000000..a421b8c1 --- /dev/null +++ b/docs/CampaignBudget.md @@ -0,0 +1,11 @@ +# TalonOne.CampaignBudget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **String** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` | +**limit** | **Number** | The value to set for the limit. | +**counter** | **Number** | The number of occurrences of the limited action in the context of the campaign. | + + diff --git a/docs/CampaignCreatedNotification.md b/docs/CampaignCreatedNotification.md index 766c29fb..a692ce55 100644 --- a/docs/CampaignCreatedNotification.md +++ b/docs/CampaignCreatedNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign** | [**Campaign**](Campaign.md) | | +**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | | **ruleset** | [**Ruleset**](Ruleset.md) | | [optional] **evaluationPosition** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | | diff --git a/docs/CampaignDeletedNotification.md b/docs/CampaignDeletedNotification.md index 8ec4811b..8c0367b6 100644 --- a/docs/CampaignDeletedNotification.md +++ b/docs/CampaignDeletedNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign** | [**Campaign**](Campaign.md) | | +**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | | **deletedAt** | **Date** | Time when the campaign was deleted. | diff --git a/docs/CampaignEditedNotification.md b/docs/CampaignEditedNotification.md index 45f1f003..e688ed7f 100644 --- a/docs/CampaignEditedNotification.md +++ b/docs/CampaignEditedNotification.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign** | [**Campaign**](Campaign.md) | | -**oldCampaign** | [**Campaign**](Campaign.md) | | +**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | | +**oldCampaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | | **ruleset** | [**Ruleset**](Ruleset.md) | | [optional] diff --git a/docs/CampaignEvaluationGroup.md b/docs/CampaignEvaluationGroup.md index f980a353..c842faf3 100644 --- a/docs/CampaignEvaluationGroup.md +++ b/docs/CampaignEvaluationGroup.md @@ -8,7 +8,8 @@ Name | Type | Description | Notes **name** | **String** | The name of the campaign evaluation group. | **parentId** | **Number** | The ID of the parent group that contains the campaign evaluation group. | **description** | **String** | A description of the campaign evaluation group. | [optional] -**evaluationMode** | **String** | | +**evaluationMode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. | +**evaluationScope** | **String** | The evaluation scope of the campaign evaluation group. | **locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. | **id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | @@ -28,3 +29,14 @@ Name | Type | Description | Notes + +## Enum: EvaluationScopeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `session` (value: `"session"`) + + + + diff --git a/docs/CampaignForNotification.md b/docs/CampaignForNotification.md new file mode 100644 index 00000000..8fbf7ae8 --- /dev/null +++ b/docs/CampaignForNotification.md @@ -0,0 +1,98 @@ +# TalonOne.CampaignForNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | Unique ID for this entity. | +**created** | **Date** | The exact moment this entity was created. | +**applicationId** | **Number** | The ID of the application that owns this entity. | +**userId** | **Number** | The ID of the user associated with this entity. | +**name** | **String** | A user-facing name for this campaign. | +**description** | **String** | A detailed description of the campaign. | +**startTime** | **Date** | Timestamp when the campaign will become active. | [optional] +**endTime** | **Date** | Timestamp when the campaign will become inactive. | [optional] +**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] +**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled'] +**activeRulesetId** | **Number** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] +**tags** | **[String]** | A list of tags for the campaign. | +**features** | **[String]** | The features enabled in this campaign. | +**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | +**campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] +**budgets** | [**[CampaignBudget]**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | +**couponRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] +**referralRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] +**discountCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] +**discountEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] +**couponCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] +**customEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional] +**referralCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] +**addFreeItemEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional] +**awardedGiveawaysCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] +**createdLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional] +**createdLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] +**redeemedLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional] +**redeemedLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] +**callApiEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] +**reservecouponEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional] +**lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional] +**updated** | **Date** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] +**createdBy** | **String** | Name of the user who created this campaign if available. | [optional] +**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional] +**templateId** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional] + + + +## Enum: StateEnum + + +* `enabled` (value: `"enabled"`) + +* `disabled` (value: `"disabled"`) + +* `archived` (value: `"archived"`) + +* `draft` (value: `"draft"`) + +* `scheduled` (value: `"scheduled"`) + +* `running` (value: `"running"`) + +* `expired` (value: `"expired"`) + + + + + +## Enum: [FeaturesEnum] + + +* `coupons` (value: `"coupons"`) + +* `referrals` (value: `"referrals"`) + +* `loyalty` (value: `"loyalty"`) + +* `giveaways` (value: `"giveaways"`) + +* `strikethrough` (value: `"strikethrough"`) + + + + + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md index bf174d13..7f2c53db 100644 --- a/docs/CampaignGroup.md +++ b/docs/CampaignGroup.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **created** | **Date** | The time this entity was created. | **modified** | **Date** | The time this entity was last modified. | **accountId** | **Number** | The ID of the account that owns this entity. | -**name** | **String** | The name of this campaign group. | -**description** | **String** | A longer description of the campaign group. | [optional] -**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] -**campaignIds** | **[Number]** | A list of the IDs of the campaigns that this campaign group owns. | [optional] +**name** | **String** | The name of this campaign access group. | +**description** | **String** | A longer description of the campaign access group. | [optional] +**subscribedApplicationsIds** | **[Number]** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional] +**campaignIds** | **[Number]** | A list of IDs of the campaigns that are part of the campaign access group. | [optional] diff --git a/docs/CampaignNotificationPolicy.md b/docs/CampaignNotificationPolicy.md new file mode 100644 index 00000000..a415b05e --- /dev/null +++ b/docs/CampaignNotificationPolicy.md @@ -0,0 +1,9 @@ +# TalonOne.CampaignNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Notification name. | + + diff --git a/docs/CampaignRulesetChangedNotification.md b/docs/CampaignRulesetChangedNotification.md index c7456e34..b857a964 100644 --- a/docs/CampaignRulesetChangedNotification.md +++ b/docs/CampaignRulesetChangedNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign** | [**Campaign**](Campaign.md) | | +**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | | **oldRuleset** | [**Ruleset**](Ruleset.md) | | [optional] **ruleset** | [**Ruleset**](Ruleset.md) | | [optional] diff --git a/docs/CampaignSetBranchNode.md b/docs/CampaignSetBranchNode.md index 482812ce..71758ff2 100644 --- a/docs/CampaignSetBranchNode.md +++ b/docs/CampaignSetBranchNode.md @@ -11,7 +11,8 @@ Name | Type | Description | Notes **groupId** | **Number** | The ID of the campaign set. | **locked** | **Boolean** | An indicator of whether the campaign set is locked for modification. | **description** | **String** | A description of the campaign set. | [optional] -**evaluationMode** | **String** | | +**evaluationMode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. | +**evaluationScope** | **String** | The evaluation scope of the campaign evaluation group. | @@ -49,3 +50,14 @@ Name | Type | Description | Notes + +## Enum: EvaluationScopeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `session` (value: `"session"`) + + + + diff --git a/docs/CampaignStateChangedNotification.md b/docs/CampaignStateChangedNotification.md index 1d7de39b..71a9cbe6 100644 --- a/docs/CampaignStateChangedNotification.md +++ b/docs/CampaignStateChangedNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign** | [**Campaign**](Campaign.md) | | +**campaign** | [**CampaignForNotification**](CampaignForNotification.md) | | **oldState** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | **newState** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | **ruleset** | [**Ruleset**](Ruleset.md) | | [optional] diff --git a/docs/CampaignStateNotification.md b/docs/CampaignStateNotification.md new file mode 100644 index 00000000..bba66126 --- /dev/null +++ b/docs/CampaignStateNotification.md @@ -0,0 +1,108 @@ +# TalonOne.CampaignStateNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | Unique ID for this entity. | +**created** | **Date** | The exact moment this entity was created. | +**applicationId** | **Number** | The ID of the application that owns this entity. | +**userId** | **Number** | The ID of the user associated with this entity. | +**name** | **String** | A user-facing name for this campaign. | +**description** | **String** | A detailed description of the campaign. | +**startTime** | **Date** | Timestamp when the campaign will become active. | [optional] +**endTime** | **Date** | Timestamp when the campaign will become inactive. | [optional] +**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] +**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled'] +**activeRulesetId** | **Number** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] +**tags** | **[String]** | A list of tags for the campaign. | +**features** | **[String]** | The features enabled in this campaign. | +**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | +**campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] +**budgets** | [**[CampaignBudget]**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | +**couponRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] +**referralRedemptionCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] +**discountCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] +**discountEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] +**couponCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] +**customEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional] +**referralCreationCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] +**addFreeItemEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional] +**awardedGiveawaysCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] +**createdLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional] +**createdLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] +**redeemedLoyaltyPointsCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional] +**redeemedLoyaltyPointsEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] +**callApiEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] +**reservecouponEffectCount** | **Number** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional] +**lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional] +**updated** | **Date** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] +**createdBy** | **String** | Name of the user who created this campaign if available. | [optional] +**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional] +**templateId** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional] +**frontendState** | **String** | A campaign state described exactly as in the Campaign Manager. | + + + +## Enum: StateEnum + + +* `enabled` (value: `"enabled"`) + +* `disabled` (value: `"disabled"`) + +* `archived` (value: `"archived"`) + + + + + +## Enum: [FeaturesEnum] + + +* `coupons` (value: `"coupons"`) + +* `referrals` (value: `"referrals"`) + +* `loyalty` (value: `"loyalty"`) + +* `giveaways` (value: `"giveaways"`) + +* `strikethrough` (value: `"strikethrough"`) + + + + + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + + +## Enum: FrontendStateEnum + + +* `expired` (value: `"expired"`) + +* `scheduled` (value: `"scheduled"`) + +* `running` (value: `"running"`) + +* `draft` (value: `"draft"`) + +* `disabled` (value: `"disabled"`) + + + + diff --git a/docs/CampaignTemplate.md b/docs/CampaignTemplate.md index 52a08ced..e945166d 100644 --- a/docs/CampaignTemplate.md +++ b/docs/CampaignTemplate.md @@ -24,6 +24,7 @@ Name | Type | Description | Notes **applicationsIds** | **[Number]** | A list of IDs of the Applications that are subscribed to this campaign template. | **campaignCollections** | [**[CampaignTemplateCollection]**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] **defaultCampaignGroupId** | **Number** | The default campaign group ID. | [optional] +**campaignType** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced'] **updated** | **Date** | Timestamp of the most recent update to the campaign template or any of its elements. | [optional] **updatedBy** | **String** | Name of the user who last updated this campaign template, if available. | [optional] **validApplicationIds** | **[Number]** | The IDs of the Applications that are related to this entity. | @@ -59,3 +60,14 @@ Name | Type | Description | Notes + +## Enum: CampaignTypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/CardLedgerPointsEntryIntegrationAPI.md b/docs/CardLedgerPointsEntryIntegrationAPI.md new file mode 100644 index 00000000..0b934e39 --- /dev/null +++ b/docs/CardLedgerPointsEntryIntegrationAPI.md @@ -0,0 +1,18 @@ +# TalonOne.CardLedgerPointsEntryIntegrationAPI + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | ID of the transaction that adds loyalty points. | +**created** | **Date** | Date and time the loyalty card points were added. | +**programId** | **Number** | ID of the loyalty program. | +**customerProfileID** | **String** | Integration ID of the customer profile linked to the card. | [optional] +**customerSessionId** | **String** | ID of the customer session where points were added. | [optional] +**name** | **String** | Name or reason of the transaction that adds loyalty points. | +**startDate** | **String** | When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. | +**expiryDate** | **String** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. | +**subledgerId** | **String** | ID of the subledger. | +**amount** | **Number** | Amount of loyalty points added in the transaction. | + + diff --git a/docs/CartItem.md b/docs/CartItem.md index 51c0b06d..37beeb30 100644 --- a/docs/CartItem.md +++ b/docs/CartItem.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of item. | [optional] **sku** | **String** | Stock keeping unit of item. | -**quantity** | **Number** | Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. | +**quantity** | **Number** | Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. | **returnedQuantity** | **Number** | Number of returned items, calculated internally based on returns of this item. | [optional] **remainingQuantity** | **Number** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional] **price** | **Number** | Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). If it is part of a catalog, setting a price here overrides the price from the catalog. | [optional] @@ -18,6 +18,6 @@ Name | Type | Description | Notes **position** | **Number** | Position of the Cart Item in the Cart (calculated internally). | [optional] **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. | [optional] **additionalCosts** | [**{String: AdditionalCost}**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] -**catalogItemID** | **Number** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs). | [optional] +**catalogItemID** | **Number** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional] diff --git a/docs/ChangeLoyaltyTierLevelEffectProps.md b/docs/ChangeLoyaltyTierLevelEffectProps.md new file mode 100644 index 00000000..d4169d98 --- /dev/null +++ b/docs/ChangeLoyaltyTierLevelEffectProps.md @@ -0,0 +1,14 @@ +# TalonOne.ChangeLoyaltyTierLevelEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ruleTitle** | **String** | The title of the rule that triggered the tier upgrade or downgrade. | +**programId** | **Number** | The ID of the loyalty program where these points were added. | +**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. | +**previousTierName** | **String** | The name of the tier from which the user was upgraded or downgraded. | [optional] +**newTierName** | **String** | The name of the tier to which the user has been upgraded or downgraded. | +**expiryDate** | **Date** | The expiration date of the new tier. | [optional] + + diff --git a/docs/Coupon.md b/docs/Coupon.md index 43409b14..40bd13b2 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -25,5 +25,6 @@ Name | Type | Description | Notes **reservation** | **Boolean** | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] **batchId** | **String** | The id of the batch the coupon belongs to. | [optional] **isReservationMandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] diff --git a/docs/CreateAchievement.md b/docs/CreateAchievement.md new file mode 100644 index 00000000..1742fbca --- /dev/null +++ b/docs/CreateAchievement.md @@ -0,0 +1,14 @@ +# TalonOne.CreateAchievement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | +**title** | **String** | The display name for the achievement in the Campaign Manager. | +**description** | **String** | A description of the achievement. | +**target** | **Number** | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. | +**period** | **String** | The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | +**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] + + diff --git a/docs/CreateApplicationAPIKey.md b/docs/CreateApplicationAPIKey.md index a46ec582..6b6b7dd5 100644 --- a/docs/CreateApplicationAPIKey.md +++ b/docs/CreateApplicationAPIKey.md @@ -31,6 +31,8 @@ Name | Type | Description | Notes * `salesforce` (value: `"salesforce"`) +* `emarsys` (value: `"emarsys"`) + diff --git a/docs/CreateTemplateCampaign.md b/docs/CreateTemplateCampaign.md index af3f6886..87410fc3 100644 --- a/docs/CreateTemplateCampaign.md +++ b/docs/CreateTemplateCampaign.md @@ -13,5 +13,6 @@ Name | Type | Description | Notes **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional] **tags** | **[String]** | A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. | [optional] **evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**linkedStoreIds** | **[Number]** | A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md index c419a54a..58f8415c 100644 --- a/docs/CustomEffectProps.md +++ b/docs/CustomEffectProps.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **effectId** | **Number** | The ID of the custom effect that was triggered. | **name** | **String** | The type of the custom effect. | **cartItemPosition** | **Number** | The index of the item in the cart item list to which the custom effect is applied. | [optional] -**cartItemSubPosition** | **Number** | When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. | [optional] +**cartItemSubPosition** | **Number** | For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. | [optional] **bundleIndex** | **Number** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] **bundleName** | **String** | The name of the bundle definition. | [optional] **payload** | [**Object**](.md) | The JSON payload of the custom effect. | diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index 8768b959..217468c9 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **totalSales** | **Number** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] **audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] -**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | +**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | **sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] diff --git a/docs/CustomerProfileIntegrationResponseV2.md b/docs/CustomerProfileIntegrationResponseV2.md new file mode 100644 index 00000000..71199909 --- /dev/null +++ b/docs/CustomerProfileIntegrationResponseV2.md @@ -0,0 +1,17 @@ +# TalonOne.CustomerProfileIntegrationResponseV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customerProfile** | [**CustomerProfile**](CustomerProfile.md) | | [optional] +**event** | [**Event**](Event.md) | | [optional] +**loyalty** | [**Loyalty**](Loyalty.md) | | [optional] +**triggeredCampaigns** | [**[Campaign]**](Campaign.md) | | [optional] +**ruleFailureReasons** | [**[RuleFailureReason]**](RuleFailureReason.md) | | [optional] +**awardedGiveaways** | [**[Giveaway]**](Giveaway.md) | | [optional] +**effects** | [**[Effect]**](Effect.md) | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | +**createdCoupons** | [**[Coupon]**](Coupon.md) | | +**createdReferrals** | [**[Referral]**](Referral.md) | | + + diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index 3cfe79c8..b326fe74 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | **coupon** | **String** | Any coupon code entered. | **referral** | **String** | Any referral code entered. | -**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [default to 'open'] +**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [default to 'open'] **cartItems** | [**[CartItem]**](CartItem.md) | Serialized JSON representation. | **identifiers** | **[String]** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). | [optional] **total** | **Number** | The total sum of the cart in one session. | diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index c5589611..3fed93a8 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -9,19 +9,20 @@ Name | Type | Description | Notes **integrationId** | **String** | The integration ID set by your integration layer. | **applicationId** | **Number** | The ID of the application that owns this entity. | **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluableCampaignIds** | **[Number]** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] **couponCodes** | **[String]** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] **referralCode** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] **loyaltyCards** | **[String]** | Any loyalty cards used. | [optional] -**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [default to 'open'] -**cartItems** | [**[CartItem]**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | +**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [default to 'open'] +**cartItems** | [**[CartItem]**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | **additionalCosts** | [**{String: AdditionalCost}**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] **identifiers** | **[String]** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [optional] **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | **firstSession** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | -**total** | **Number** | The total sum of cart-items, as well as additional costs, before any discounts applied. | -**cartItemTotal** | **Number** | The total sum of cart-items before any discounts applied. | -**additionalCostTotal** | **Number** | The total sum of additional costs before any discounts applied. | +**total** | **Number** | The total value of cart items and additional costs in the session, before any discounts are applied. | +**cartItemTotal** | **Number** | The total value of cart items, before any discounts are applied. | +**additionalCostTotal** | **Number** | The total value of additional costs, before any discounts are applied. | **updated** | **Date** | Timestamp of the most recent event received on this session. | diff --git a/docs/Effect.md b/docs/Effect.md index 8d8e57c1..375f439d 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **effectType** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | **triggeredByCoupon** | **Number** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] **triggeredForCatalogItem** | **Number** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] +**conditionIndex** | **Number** | The index of the condition that was triggered. | [optional] **props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md index 607be4fd..bcba8e65 100644 --- a/docs/EffectEntity.md +++ b/docs/EffectEntity.md @@ -11,5 +11,6 @@ Name | Type | Description | Notes **effectType** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | **triggeredByCoupon** | **Number** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] **triggeredForCatalogItem** | **Number** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] +**conditionIndex** | **Number** | The index of the condition that was triggered. | [optional] diff --git a/docs/Event.md b/docs/Event.md index aa111441..d0f41f9a 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **created** | **Date** | The time this entity was created. | **applicationId** | **Number** | The ID of the application that owns this entity. | **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **type** | **String** | A string representing the event. Must not be a reserved event name. | **attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. | **sessionId** | **String** | The ID of the session that this event occurred in. | [optional] diff --git a/docs/EventV2.md b/docs/EventV2.md index 32c26702..7a5d0e0c 100644 --- a/docs/EventV2.md +++ b/docs/EventV2.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluableCampaignIds** | **[Number]** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] -**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. | -**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). | [optional] +**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. | +**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] diff --git a/docs/ExpiringPointsNotificationPolicy.md b/docs/ExpiringPointsNotificationPolicy.md index 86429b66..164ca44d 100644 --- a/docs/ExpiringPointsNotificationPolicy.md +++ b/docs/ExpiringPointsNotificationPolicy.md @@ -6,5 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Notification name. | **triggers** | [**[ExpiringPointsNotificationTrigger]**](ExpiringPointsNotificationTrigger.md) | | +**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true] diff --git a/docs/InlineResponse20010.md b/docs/InlineResponse20010.md index c402709c..05d0ebe7 100644 --- a/docs/InlineResponse20010.md +++ b/docs/InlineResponse20010.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | -**data** | [**[CampaignTemplate]**](CampaignTemplate.md) | | +**data** | [**[Referral]**](Referral.md) | | diff --git a/docs/InlineResponse20011.md b/docs/InlineResponse20011.md index c27c5318..e46e12f6 100644 --- a/docs/InlineResponse20011.md +++ b/docs/InlineResponse20011.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | | +**hasMore** | **Boolean** | | +**data** | [**[CampaignTemplate]**](CampaignTemplate.md) | | diff --git a/docs/InlineResponse20012.md b/docs/InlineResponse20012.md index 62db9243..d5910ebc 100644 --- a/docs/InlineResponse20012.md +++ b/docs/InlineResponse20012.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | -**data** | [**[LoyaltyProgramTransaction]**](LoyaltyProgramTransaction.md) | | +**totalResultSize** | **Number** | | +**data** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | | diff --git a/docs/InlineResponse20013.md b/docs/InlineResponse20013.md index af209d43..43b00690 100644 --- a/docs/InlineResponse20013.md +++ b/docs/InlineResponse20013.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | -**data** | [**[LoyaltyCard]**](LoyaltyCard.md) | | +**data** | [**[LoyaltyProgramTransaction]**](LoyaltyProgramTransaction.md) | | diff --git a/docs/InlineResponse20014.md b/docs/InlineResponse20014.md index 2d1976e4..198e8e73 100644 --- a/docs/InlineResponse20014.md +++ b/docs/InlineResponse20014.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | true means there is more data in the source collection to request.. | -**data** | [**[CardLedgerTransactionLogEntry]**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. | +**hasMore** | **Boolean** | | +**data** | [**[LoyaltyCard]**](LoyaltyCard.md) | | diff --git a/docs/InlineResponse20015.md b/docs/InlineResponse20015.md index f08c777d..9c4ac892 100644 --- a/docs/InlineResponse20015.md +++ b/docs/InlineResponse20015.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] -**totalResultSize** | **Number** | | [optional] -**data** | [**[CollectionWithoutPayload]**](CollectionWithoutPayload.md) | | +**hasMore** | **Boolean** | true means there is more data in the source collection to request.. | +**data** | [**[CardLedgerTransactionLogEntry]**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. | diff --git a/docs/InlineResponse20016.md b/docs/InlineResponse20016.md index 8da3b611..504e0ee9 100644 --- a/docs/InlineResponse20016.md +++ b/docs/InlineResponse20016.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | -**data** | [**[CollectionItem]**](CollectionItem.md) | | +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] +**data** | [**[CollectionWithoutPayload]**](CollectionWithoutPayload.md) | | diff --git a/docs/InlineResponse20017.md b/docs/InlineResponse20017.md index 2e3c4a28..fec4a1ca 100644 --- a/docs/InlineResponse20017.md +++ b/docs/InlineResponse20017.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] -**totalResultSize** | **Number** | | [optional] -**data** | [**[Collection]**](Collection.md) | | +**hasMore** | **Boolean** | | +**data** | [**[CollectionItem]**](CollectionItem.md) | | diff --git a/docs/InlineResponse20018.md b/docs/InlineResponse20018.md index 4b4b4d94..443f6e6b 100644 --- a/docs/InlineResponse20018.md +++ b/docs/InlineResponse20018.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | -**data** | [**[AccessLogEntry]**](AccessLogEntry.md) | | +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] +**data** | [**[Collection]**](Collection.md) | | diff --git a/docs/InlineResponse20019.md b/docs/InlineResponse20019.md index 4455733b..cfc45267 100644 --- a/docs/InlineResponse20019.md +++ b/docs/InlineResponse20019.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | +**hasMore** | **Boolean** | | **data** | [**[AccessLogEntry]**](AccessLogEntry.md) | | diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md index b1bb9ab7..2d3f862a 100644 --- a/docs/InlineResponse20020.md +++ b/docs/InlineResponse20020.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[CampaignAnalytics]**](CampaignAnalytics.md) | | +**data** | [**[AccessLogEntry]**](AccessLogEntry.md) | | diff --git a/docs/InlineResponse20021.md b/docs/InlineResponse20021.md index e767518d..ada841cd 100644 --- a/docs/InlineResponse20021.md +++ b/docs/InlineResponse20021.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | [optional] -**hasMore** | **Boolean** | | [optional] -**data** | [**[ApplicationCustomer]**](ApplicationCustomer.md) | | +**totalResultSize** | **Number** | | +**data** | [**[CampaignAnalytics]**](CampaignAnalytics.md) | | diff --git a/docs/InlineResponse20022.md b/docs/InlineResponse20022.md index 6128d9f9..0ab1ccf0 100644 --- a/docs/InlineResponse20022.md +++ b/docs/InlineResponse20022.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] **totalResultSize** | **Number** | | [optional] +**hasMore** | **Boolean** | | [optional] **data** | [**[ApplicationCustomer]**](ApplicationCustomer.md) | | diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md index fba201ee..7e2443bb 100644 --- a/docs/InlineResponse20023.md +++ b/docs/InlineResponse20023.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | [optional] **totalResultSize** | **Number** | | [optional] -**data** | [**[CustomerProfile]**](CustomerProfile.md) | | +**data** | [**[ApplicationCustomer]**](ApplicationCustomer.md) | | diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md index cf4df3f0..4502bb88 100644 --- a/docs/InlineResponse20024.md +++ b/docs/InlineResponse20024.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] **data** | [**[CustomerProfile]**](CustomerProfile.md) | | diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md index 8f52a0cc..1c901d32 100644 --- a/docs/InlineResponse20025.md +++ b/docs/InlineResponse20025.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | -**data** | [**[CustomerActivityReport]**](CustomerActivityReport.md) | | +**data** | [**[CustomerProfile]**](CustomerProfile.md) | | diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md index a0299b36..5d89a380 100644 --- a/docs/InlineResponse20026.md +++ b/docs/InlineResponse20026.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] -**data** | [**[ApplicationSession]**](ApplicationSession.md) | | +**hasMore** | **Boolean** | | +**data** | [**[CustomerActivityReport]**](CustomerActivityReport.md) | | diff --git a/docs/InlineResponse20027.md b/docs/InlineResponse20027.md index a0564d25..51674e9d 100644 --- a/docs/InlineResponse20027.md +++ b/docs/InlineResponse20027.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | -**data** | [**[ApplicationEvent]**](ApplicationEvent.md) | | +**hasMore** | **Boolean** | | [optional] +**data** | [**[ApplicationSession]**](ApplicationSession.md) | | diff --git a/docs/InlineResponse20028.md b/docs/InlineResponse20028.md index 0590629a..a243282d 100644 --- a/docs/InlineResponse20028.md +++ b/docs/InlineResponse20028.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | **[String]** | | +**hasMore** | **Boolean** | | +**data** | [**[ApplicationEvent]**](ApplicationEvent.md) | | diff --git a/docs/InlineResponse20029.md b/docs/InlineResponse20029.md index c15c6dd0..087c2a24 100644 --- a/docs/InlineResponse20029.md +++ b/docs/InlineResponse20029.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] -**totalResultSize** | **Number** | | [optional] -**data** | [**[Audience]**](Audience.md) | | +**totalResultSize** | **Number** | | +**data** | **[String]** | | diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md index d7bc17f8..106209da 100644 --- a/docs/InlineResponse2003.md +++ b/docs/InlineResponse2003.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[Application]**](Application.md) | | +**hasMore** | **Boolean** | | +**data** | [**[CardLedgerPointsEntryIntegrationAPI]**](CardLedgerPointsEntryIntegrationAPI.md) | | diff --git a/docs/InlineResponse20030.md b/docs/InlineResponse20030.md index 9e4f4c9a..23f9c85e 100644 --- a/docs/InlineResponse20030.md +++ b/docs/InlineResponse20030.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | [optional] **totalResultSize** | **Number** | | [optional] -**data** | [**[ApplicationReferee]**](ApplicationReferee.md) | | +**data** | [**[Audience]**](Audience.md) | | diff --git a/docs/InlineResponse20031.md b/docs/InlineResponse20031.md index 992ea1a8..7ed8d90b 100644 --- a/docs/InlineResponse20031.md +++ b/docs/InlineResponse20031.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[Attribute]**](Attribute.md) | | +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] +**data** | [**[ApplicationReferee]**](ApplicationReferee.md) | | diff --git a/docs/InlineResponse20032.md b/docs/InlineResponse20032.md index 0f647d1a..c512982b 100644 --- a/docs/InlineResponse20032.md +++ b/docs/InlineResponse20032.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | [optional] -**totalResultSize** | **Number** | | [optional] -**data** | [**[CatalogItem]**](CatalogItem.md) | | +**totalResultSize** | **Number** | | +**data** | [**[Attribute]**](Attribute.md) | | diff --git a/docs/InlineResponse20033.md b/docs/InlineResponse20033.md index 8ca8e927..2a1f8f70 100644 --- a/docs/InlineResponse20033.md +++ b/docs/InlineResponse20033.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[AccountAdditionalCost]**](AccountAdditionalCost.md) | | +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] +**data** | [**[CatalogItem]**](CatalogItem.md) | | diff --git a/docs/InlineResponse20034.md b/docs/InlineResponse20034.md index 77800052..bb57e8de 100644 --- a/docs/InlineResponse20034.md +++ b/docs/InlineResponse20034.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[WebhookWithOutgoingIntegrationDetails]**](WebhookWithOutgoingIntegrationDetails.md) | | +**data** | [**[AccountAdditionalCost]**](AccountAdditionalCost.md) | | diff --git a/docs/InlineResponse20035.md b/docs/InlineResponse20035.md index 5b068a85..94ae341a 100644 --- a/docs/InlineResponse20035.md +++ b/docs/InlineResponse20035.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | | +**data** | [**[WebhookWithOutgoingIntegrationDetails]**](WebhookWithOutgoingIntegrationDetails.md) | | diff --git a/docs/InlineResponse20036.md b/docs/InlineResponse20036.md index f35a6aa0..f3e6fe37 100644 --- a/docs/InlineResponse20036.md +++ b/docs/InlineResponse20036.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[WebhookLogEntry]**](WebhookLogEntry.md) | | +**data** | [**[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | | diff --git a/docs/InlineResponse20037.md b/docs/InlineResponse20037.md index ca38a981..65aad06b 100644 --- a/docs/InlineResponse20037.md +++ b/docs/InlineResponse20037.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[EventType]**](EventType.md) | | +**data** | [**[WebhookLogEntry]**](WebhookLogEntry.md) | | diff --git a/docs/InlineResponse20038.md b/docs/InlineResponse20038.md index 227e7641..30144581 100644 --- a/docs/InlineResponse20038.md +++ b/docs/InlineResponse20038.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[User]**](User.md) | | +**data** | [**[EventType]**](EventType.md) | | diff --git a/docs/InlineResponse20039.md b/docs/InlineResponse20039.md index a56fe3bb..8551365b 100644 --- a/docs/InlineResponse20039.md +++ b/docs/InlineResponse20039.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | [optional] -**hasMore** | **Boolean** | | [optional] -**data** | [**[Change]**](Change.md) | | +**totalResultSize** | **Number** | | +**data** | [**[User]**](User.md) | | diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md index cba75910..ca8a9031 100644 --- a/docs/InlineResponse2004.md +++ b/docs/InlineResponse2004.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[Campaign]**](Campaign.md) | | +**hasMore** | **Boolean** | | +**data** | [**[LedgerPointsEntryIntegrationAPI]**](LedgerPointsEntryIntegrationAPI.md) | | diff --git a/docs/InlineResponse20040.md b/docs/InlineResponse20040.md index e48af045..b6f905d2 100644 --- a/docs/InlineResponse20040.md +++ b/docs/InlineResponse20040.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalResultSize** | **Number** | | -**data** | [**[ModelExport]**](ModelExport.md) | | +**totalResultSize** | **Number** | | [optional] +**hasMore** | **Boolean** | | [optional] +**data** | [**[Change]**](Change.md) | | diff --git a/docs/InlineResponse20041.md b/docs/InlineResponse20041.md index 9b7ed69e..aafb56f9 100644 --- a/docs/InlineResponse20041.md +++ b/docs/InlineResponse20041.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[Role]**](Role.md) | | +**data** | [**[ModelExport]**](ModelExport.md) | | diff --git a/docs/InlineResponse20042.md b/docs/InlineResponse20042.md new file mode 100644 index 00000000..92f06f0b --- /dev/null +++ b/docs/InlineResponse20042.md @@ -0,0 +1,10 @@ +# TalonOne.InlineResponse20042 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**totalResultSize** | **Number** | | +**data** | [**[Role]**](Role.md) | | + + diff --git a/docs/InlineResponse20043.md b/docs/InlineResponse20043.md new file mode 100644 index 00000000..f5d9a099 --- /dev/null +++ b/docs/InlineResponse20043.md @@ -0,0 +1,11 @@ +# TalonOne.InlineResponse20043 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasMore** | **Boolean** | | [optional] +**totalResultSize** | **Number** | | [optional] +**data** | [**[Store]**](Store.md) | | + + diff --git a/docs/InlineResponse2005.md b/docs/InlineResponse2005.md index b4a71248..ac19f5f0 100644 --- a/docs/InlineResponse2005.md +++ b/docs/InlineResponse2005.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[NotificationWebhook]**](NotificationWebhook.md) | | +**data** | [**[Application]**](Application.md) | | diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md index 0c56097c..cc8c8ca8 100644 --- a/docs/InlineResponse2006.md +++ b/docs/InlineResponse2006.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[Ruleset]**](Ruleset.md) | | +**data** | [**[Campaign]**](Campaign.md) | | diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md index 91484c82..ae8aaba4 100644 --- a/docs/InlineResponse2007.md +++ b/docs/InlineResponse2007.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalResultSize** | **Number** | | -**data** | [**[Coupon]**](Coupon.md) | | +**data** | [**[Ruleset]**](Ruleset.md) | | diff --git a/docs/InlineResponse2008.md b/docs/InlineResponse2008.md index 8c51b197..f979e5a7 100644 --- a/docs/InlineResponse2008.md +++ b/docs/InlineResponse2008.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hasMore** | **Boolean** | | +**totalResultSize** | **Number** | | **data** | [**[Coupon]**](Coupon.md) | | diff --git a/docs/InlineResponse2009.md b/docs/InlineResponse2009.md index fafdf077..9a664100 100644 --- a/docs/InlineResponse2009.md +++ b/docs/InlineResponse2009.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hasMore** | **Boolean** | | -**data** | [**[Referral]**](Referral.md) | | +**data** | [**[Coupon]**](Coupon.md) | | diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index 207828be..3e7ca2bf 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -16,7 +16,9 @@ Method | HTTP request | Description [**getCustomerSession**](IntegrationApi.md#getCustomerSession) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session [**getLoyaltyBalances**](IntegrationApi.md#getLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points [**getLoyaltyCardBalances**](IntegrationApi.md#getLoyaltyCardBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances +[**getLoyaltyCardPoints**](IntegrationApi.md#getLoyaltyCardPoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points [**getLoyaltyCardTransactions**](IntegrationApi.md#getLoyaltyCardTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions +[**getLoyaltyProgramProfilePoints**](IntegrationApi.md#getLoyaltyProgramProfilePoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points [**getLoyaltyProgramProfileTransactions**](IntegrationApi.md#getLoyaltyProgramProfileTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions [**getReservedCustomers**](IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved [**linkLoyaltyCardToProfile**](IntegrationApi.md#linkLoyaltyCardToProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card @@ -89,7 +91,7 @@ Name | Type | Description | Notes Create coupon reservation -Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. <div class=\"redoc-section\"> <p class=\"title\">Important</p> This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). </div> To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. +Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. If the **Coupon visibility** checkbox was selected when [creating a universal code](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons#generating-a-universal-code), the coupon code is implicitly reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. <div class=\"redoc-section\"> <p class=\"title\">Important</p> This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). This endpoint overrides the reservation limit set for the coupon code during coupon creation. </div> To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. ### Example @@ -559,7 +561,7 @@ Name | Type | Description | Notes Get customer's loyalty points -Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer). +Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) ### Example @@ -573,10 +575,10 @@ api_key_v1.apiKey = 'YOUR API KEY'; //api_key_v1.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.IntegrationApi(); -let loyaltyProgramId = 56; // Number | 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. +let loyaltyProgramId = 56; // Number | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. let integrationId = "integrationId_example"; // String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. let opts = { - 'endDate': new Date("2013-10-20T19:20:30+01:00") // 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. + 'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. }; apiInstance.getLoyaltyBalances(loyaltyProgramId, integrationId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -591,9 +593,9 @@ apiInstance.getLoyaltyBalances(loyaltyProgramId, integrationId, opts).then((data Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **loyaltyProgramId** | **Number**| 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. | + **loyaltyProgramId** | **Number**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | **integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | - **endDate** | **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. | [optional] + **endDate** | **Date**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. | [optional] ### Return type @@ -632,7 +634,7 @@ let apiInstance = new TalonOne.IntegrationApi(); let loyaltyProgramId = 56; // Number | 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. let loyaltyCardId = "loyaltyCardId_example"; // String | 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. let opts = { - 'endDate': new Date("2013-10-20T19:20:30+01:00") // 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. + 'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. }; apiInstance.getLoyaltyCardBalances(loyaltyProgramId, loyaltyCardId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -649,7 +651,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltyProgramId** | **Number**| 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. | **loyaltyCardId** | **String**| 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. | - **endDate** | **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. | [optional] + **endDate** | **Date**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. | [optional] ### Return type @@ -665,6 +667,68 @@ Name | Type | Description | Notes - **Accept**: application/json +## getLoyaltyCardPoints + +> InlineResponse2003 getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, opts) + +List card's unused loyalty points + +Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: api_key_v1 +let api_key_v1 = defaultClient.authentications['api_key_v1']; +api_key_v1.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//api_key_v1.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.IntegrationApi(); +let loyaltyProgramId = 56; // Number | 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. +let loyaltyCardId = "loyaltyCardId_example"; // String | 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. +let opts = { + 'status': "'active'", // String | Filter points based on their status. + 'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data. + 'pageSize': 50, // Number | The number of items in this response. + 'skip': 56 // Number | The number of items to skip when paging through large result sets. +}; +apiInstance.getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loyaltyProgramId** | **Number**| 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. | + **loyaltyCardId** | **String**| 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. | + **status** | **String**| Filter points based on their status. | [optional] [default to 'active'] + **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] + **pageSize** | **Number**| The number of items in this response. | [optional] [default to 50] + **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] + +### Return type + +[**InlineResponse2003**](InlineResponse2003.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## getLoyaltyCardTransactions > InlineResponse2001 getLoyaltyCardTransactions(loyaltyProgramId, loyaltyCardId, opts) @@ -689,6 +753,7 @@ let loyaltyProgramId = 56; // Number | Identifier of the card-based loyalty prog let loyaltyCardId = "loyaltyCardId_example"; // String | 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. let opts = { 'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data. + 'loyaltyTransactionType': "loyaltyTransactionType_example", // String | 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. 'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. 'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. 'pageSize': 1000, // Number | The number of items in this response. @@ -710,6 +775,7 @@ Name | Type | Description | Notes **loyaltyProgramId** | **Number**| 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. | **loyaltyCardId** | **String**| 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. | **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] + **loyaltyTransactionType** | **String**| 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. | [optional] **startDate** | **Date**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional] **endDate** | **Date**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional] **pageSize** | **Number**| The number of items in this response. | [optional] [default to 1000] @@ -729,6 +795,68 @@ Name | Type | Description | Notes - **Accept**: application/json +## getLoyaltyProgramProfilePoints + +> InlineResponse2004 getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, opts) + +List customer's unused loyalty points + +Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: api_key_v1 +let api_key_v1 = defaultClient.authentications['api_key_v1']; +api_key_v1.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//api_key_v1.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.IntegrationApi(); +let loyaltyProgramId = 56; // Number | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. +let integrationId = "integrationId_example"; // String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. +let opts = { + 'status': "'active'", // String | Filter points based on their status. + 'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data. + 'pageSize': 50, // Number | The number of items in this response. + 'skip': 56 // Number | The number of items to skip when paging through large result sets. +}; +apiInstance.getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loyaltyProgramId** | **Number**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + **integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | + **status** | **String**| Filter points based on their status. | [optional] [default to 'active'] + **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] + **pageSize** | **Number**| The number of items in this response. | [optional] [default to 50] + **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] + +### Return type + +[**InlineResponse2004**](InlineResponse2004.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## getLoyaltyProgramProfileTransactions > InlineResponse2002 getLoyaltyProgramProfileTransactions(loyaltyProgramId, integrationId, opts) @@ -749,10 +877,11 @@ api_key_v1.apiKey = 'YOUR API KEY'; //api_key_v1.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.IntegrationApi(); -let loyaltyProgramId = 56; // Number | 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. +let loyaltyProgramId = 56; // Number | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. let integrationId = "integrationId_example"; // String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. let opts = { 'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data. + 'loyaltyTransactionType': "loyaltyTransactionType_example", // String | 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. 'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. 'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. 'pageSize': 50, // Number | The number of items in this response. @@ -771,9 +900,10 @@ apiInstance.getLoyaltyProgramProfileTransactions(loyaltyProgramId, integrationId Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **loyaltyProgramId** | **Number**| 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. | + **loyaltyProgramId** | **Number**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | **integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] + **loyaltyTransactionType** | **String**| 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. | [optional] **startDate** | **Date**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional] **endDate** | **Date**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional] **pageSize** | **Number**| The number of items in this response. | [optional] [default to 50] @@ -849,7 +979,7 @@ Name | Type | Description | Notes Link customer profile to card -[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows. +[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows. ### Example @@ -903,7 +1033,7 @@ Name | Type | Description | Notes Reopen customer session -Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>not pending</strong> pending loyalty points.</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial</a>.</p> </details> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. +Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>non-pending</strong> loyalty points</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial</a>.</p> </details> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. ### Example @@ -953,7 +1083,7 @@ Name | Type | Description | Notes Return cart items -Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled for the Application. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). +Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). ### Example @@ -1057,11 +1187,11 @@ Name | Type | Description | Notes ## trackEventV2 -> IntegrationStateV2 trackEventV2(body, opts) +> TrackEventV2Response trackEventV2(body, opts) Track event -Triggers a custom event. You can build a condition around this event in your rules. Talon.One offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). **Important:** - `profileId` is required. An event is associated with a customer profile. - Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). When you successfully sent an event to Talon.One, you can list received events in the **Events** view in the Campaign Manager. +Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> ### Example @@ -1099,7 +1229,7 @@ Name | Type | Description | Notes ### Return type -[**IntegrationStateV2**](IntegrationStateV2.md) +[**TrackEventV2Response**](TrackEventV2Response.md) ### Authorization @@ -1169,7 +1299,7 @@ null (empty response body) Update audience name -Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. +Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. ### Example @@ -1221,7 +1351,7 @@ Name | Type | Description | Notes Update multiple customer profiles' audiences -Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. +Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect. ### Example @@ -1267,11 +1397,11 @@ null (empty response body) ## updateCustomerProfileV2 -> IntegrationStateV2 updateCustomerProfileV2(integrationId, body, opts) +> CustomerProfileIntegrationResponseV2 updateCustomerProfileV2(integrationId, body, opts) Update customer profile -Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> +Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> ### Example @@ -1311,7 +1441,7 @@ Name | Type | Description | Notes ### Return type -[**IntegrationStateV2**](IntegrationStateV2.md) +[**CustomerProfileIntegrationResponseV2**](CustomerProfileIntegrationResponseV2.md) ### Authorization @@ -1329,7 +1459,7 @@ Name | Type | Description | Notes Update multiple customer profiles -Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). +Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. ### Example @@ -1383,7 +1513,7 @@ Name | Type | Description | Notes Update customer session -Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). +Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). ### Example @@ -1400,7 +1530,7 @@ let apiInstance = new TalonOne.IntegrationApi(); let customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. let body = new TalonOne.IntegrationRequest(); // IntegrationRequest | body let opts = { - 'dry': true // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. + 'dry': true // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). }; apiInstance.updateCustomerSessionV2(customerSessionId, body, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -1417,7 +1547,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | **body** | [**IntegrationRequest**](IntegrationRequest.md)| body | - **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. | [optional] + **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional] ### Return type diff --git a/docs/IntegrationCoupon.md b/docs/IntegrationCoupon.md index 00f2bc39..55552fdd 100644 --- a/docs/IntegrationCoupon.md +++ b/docs/IntegrationCoupon.md @@ -25,6 +25,7 @@ Name | Type | Description | Notes **reservation** | **Boolean** | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] **batchId** | **String** | The id of the batch the coupon belongs to. | [optional] **isReservationMandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] **profileRedemptionCount** | **Number** | The number of times the coupon was redeemed by the profile. | diff --git a/docs/IntegrationEvent.md b/docs/IntegrationEvent.md index 78d3aeb4..d2e77918 100644 --- a/docs/IntegrationEvent.md +++ b/docs/IntegrationEvent.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **type** | **String** | A string representing the event. Must not be a reserved event name. | **attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. | diff --git a/docs/IntegrationEventV2Request.md b/docs/IntegrationEventV2Request.md index c4f3fca9..1be979de 100644 --- a/docs/IntegrationEventV2Request.md +++ b/docs/IntegrationEventV2Request.md @@ -5,9 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluableCampaignIds** | **[Number]** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] -**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. | -**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). | [optional] +**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. | +**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] **responseContent** | **[String]** | Optional list of requested information to be present on the response related to the tracking custom event. | [optional] diff --git a/docs/IntegrationStoreEntity.md b/docs/IntegrationStoreEntity.md new file mode 100644 index 00000000..019e9bf7 --- /dev/null +++ b/docs/IntegrationStoreEntity.md @@ -0,0 +1,9 @@ +# TalonOne.IntegrationStoreEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] + + diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index c27b7839..259e8510 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -25,6 +25,7 @@ Name | Type | Description | Notes **reservation** | **Boolean** | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] **batchId** | **String** | The id of the batch the coupon belongs to. | [optional] **isReservationMandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] **profileRedemptionCount** | **Number** | The number of times the coupon was redeemed by the profile. | **state** | **String** | Can be: - `active`: The coupon can be used. It is a reserved coupon that is neither pending, used nor expired, and has a non-exhausted limit counter. - `used`: The coupon has been redeemed and cannot be used again. It is not pending and has reached its redemption limit or was redeemed by the profile before expiration. - `expired`: The coupon was never redeemed and it is now expired. It is non-pending, non-active and non-used by the profile. - `pending`: The coupon will be usable in the future. - `disabled`: The coupon is part of a non-active campaign. | diff --git a/docs/LedgerPointsEntryIntegrationAPI.md b/docs/LedgerPointsEntryIntegrationAPI.md new file mode 100644 index 00000000..a447ada1 --- /dev/null +++ b/docs/LedgerPointsEntryIntegrationAPI.md @@ -0,0 +1,17 @@ +# TalonOne.LedgerPointsEntryIntegrationAPI + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | ID of the transaction that adds loyalty points. | +**created** | **Date** | Date and time the loyalty points were added. | +**programId** | **Number** | ID of the loyalty program. | +**customerSessionId** | **String** | ID of the customer session where points were added. | [optional] +**name** | **String** | Name or reason of the transaction that adds loyalty points. | +**startDate** | **String** | When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. | +**expiryDate** | **String** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. | +**subledgerId** | **String** | ID of the subledger. | +**amount** | **Number** | Amount of loyalty points added in the transaction. | + + diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md index 0273f5af..fbe6c1a5 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -14,15 +14,15 @@ Name | Type | Description | Notes **allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | **usersPerCardLimit** | **Number** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | -**tiersExpireIn** | **String** | The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] +**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] **tiersDowngradePolicy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional] **accountID** | **Number** | The ID of the Talon.One account that owns this program. | **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | **tiers** | [**[LoyaltyTier]**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] **timezone** | **String** | A string containing an IANA timezone descriptor. | **cardBased** | **Boolean** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false] -**canUpdateTiers** | **Boolean** | True if it is possible to change tiers definition. | [optional] [default to false] -**canUpgradeToAdvancedTiers** | **Boolean** | True if it is possible to introduce tiersExpireIn and tiersDowngradePolicy. | [optional] [default to false] +**canUpdateTiers** | **Boolean** | `True` if the tier definitions can be updated. | [optional] [default to false] +**canUpgradeToAdvancedTiers** | **Boolean** | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. | [optional] [default to false] diff --git a/docs/LoyaltyProgramTransaction.md b/docs/LoyaltyProgramTransaction.md index 1ff1a80b..66f45cbd 100644 --- a/docs/LoyaltyProgramTransaction.md +++ b/docs/LoyaltyProgramTransaction.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **subledgerId** | **String** | ID of the subledger. | **customerSessionId** | **String** | ID of the customer session where the transaction occurred. | [optional] **importId** | **Number** | ID of the import where the transaction occurred. | [optional] -**userId** | **Number** | ID of the user who manually added or deducted points. Applies only for manual transactions. | [optional] -**userEmail** | **String** | The email of the user who manually added or deducted points. Applies only for manual transactions. | [optional] +**userId** | **Number** | ID of the user who manually added or deducted points. Applies only to manual transactions. | [optional] +**userEmail** | **String** | The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions. | [optional] **rulesetId** | **Number** | ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] **ruleName** | **String** | Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index fe7bb9ad..8abb4543 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -11,27 +11,28 @@ Method | HTTP request | Description [**createAdditionalCost**](ManagementApi.md#createAdditionalCost) | **POST** /v1/additional_costs | Create additional cost [**createAttribute**](ManagementApi.md#createAttribute) | **POST** /v1/attributes | Create custom attribute [**createCampaignFromTemplate**](ManagementApi.md#createCampaignFromTemplate) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template -[**createCollection**](ManagementApi.md#createCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create collection +[**createCollection**](ManagementApi.md#createCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection [**createCoupons**](ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons [**createCouponsAsync**](ManagementApi.md#createCouponsAsync) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously [**createCouponsForMultipleRecipients**](ManagementApi.md#createCouponsForMultipleRecipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients -[**createNotificationWebhook**](ManagementApi.md#createNotificationWebhook) | **POST** /v1/applications/{applicationId}/notification_webhooks | Create notification about campaign-related changes [**createPasswordRecoveryEmail**](ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset [**createSession**](ManagementApi.md#createSession) | **POST** /v1/sessions | Create session +[**createStore**](ManagementApi.md#createStore) | **POST** /v1/applications/{applicationId}/stores | Create store [**deductLoyaltyCardPoints**](ManagementApi.md#deductLoyaltyCardPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card [**deleteAccountCollection**](ManagementApi.md#deleteAccountCollection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection [**deleteCampaign**](ManagementApi.md#deleteCampaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign -[**deleteCollection**](ManagementApi.md#deleteCollection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete collection +[**deleteCollection**](ManagementApi.md#deleteCollection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection [**deleteCoupon**](ManagementApi.md#deleteCoupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon [**deleteCoupons**](ManagementApi.md#deleteCoupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons [**deleteLoyaltyCard**](ManagementApi.md#deleteLoyaltyCard) | **DELETE** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card -[**deleteNotificationWebhook**](ManagementApi.md#deleteNotificationWebhook) | **DELETE** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification about campaign-related changes [**deleteReferral**](ManagementApi.md#deleteReferral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral +[**deleteStore**](ManagementApi.md#deleteStore) | **DELETE** /v1/applications/{applicationId}/stores/{storeId} | Delete store [**destroySession**](ManagementApi.md#destroySession) | **DELETE** /v1/sessions | Destroy session [**exportAccountCollectionItems**](ManagementApi.md#exportAccountCollectionItems) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items -[**exportCollectionItems**](ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export a collection's items +[**exportCollectionItems**](ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items [**exportCoupons**](ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons [**exportCustomerSessions**](ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions +[**exportCustomersTiers**](ManagementApi.md#exportCustomersTiers) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers | Export customers' tier data [**exportEffects**](ManagementApi.md#exportEffects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered effects [**exportLoyaltyBalance**](ManagementApi.md#exportLoyaltyBalance) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV [**exportLoyaltyBalances**](ManagementApi.md#exportLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances @@ -68,7 +69,7 @@ Method | HTTP request | Description [**getCampaignTemplates**](ManagementApi.md#getCampaignTemplates) | **GET** /v1/campaign_templates | List campaign templates [**getCampaigns**](ManagementApi.md#getCampaigns) | **GET** /v1/applications/{applicationId}/campaigns | List campaigns [**getChanges**](ManagementApi.md#getChanges) | **GET** /v1/changes | Get audit logs for an account -[**getCollection**](ManagementApi.md#getCollection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get collection +[**getCollection**](ManagementApi.md#getCollection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection [**getCollectionItems**](ManagementApi.md#getCollectionItems) | **GET** /v1/collections/{collectionId}/items | Get collection items [**getCouponsWithoutTotalCount**](ManagementApi.md#getCouponsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons [**getCustomerActivityReport**](ManagementApi.md#getCustomerActivityReport) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report @@ -87,21 +88,20 @@ Method | HTTP request | Description [**getLoyaltyProgramTransactions**](ManagementApi.md#getLoyaltyProgramTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions [**getLoyaltyPrograms**](ManagementApi.md#getLoyaltyPrograms) | **GET** /v1/loyalty_programs | List loyalty programs [**getLoyaltyStatistics**](ManagementApi.md#getLoyaltyStatistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics -[**getNotificationWebhook**](ManagementApi.md#getNotificationWebhook) | **GET** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification about campaign-related changes -[**getNotificationWebhooks**](ManagementApi.md#getNotificationWebhooks) | **GET** /v1/applications/{applicationId}/notification_webhooks | List notifications about campaign-related changes [**getReferralsWithoutTotalCount**](ManagementApi.md#getReferralsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals [**getRole**](ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get role [**getRuleset**](ManagementApi.md#getRuleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset [**getRulesets**](ManagementApi.md#getRulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets +[**getStore**](ManagementApi.md#getStore) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store [**getUser**](ManagementApi.md#getUser) | **GET** /v1/users/{userId} | Get user [**getUsers**](ManagementApi.md#getUsers) | **GET** /v1/users | List users in account [**getWebhook**](ManagementApi.md#getWebhook) | **GET** /v1/webhooks/{webhookId} | Get webhook [**getWebhookActivationLogs**](ManagementApi.md#getWebhookActivationLogs) | **GET** /v1/webhook_activation_logs | List webhook activation log entries [**getWebhookLogs**](ManagementApi.md#getWebhookLogs) | **GET** /v1/webhook_logs | List webhook log entries [**getWebhooks**](ManagementApi.md#getWebhooks) | **GET** /v1/webhooks | List webhooks -[**importAccountCollection**](ManagementApi.md#importAccountCollection) | **POST** /v1/collections/{collectionId}/import | Import data in existing account-level collection +[**importAccountCollection**](ManagementApi.md#importAccountCollection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection [**importAllowedList**](ManagementApi.md#importAllowedList) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute -[**importCollection**](ManagementApi.md#importCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data in existing collection +[**importCollection**](ManagementApi.md#importCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection [**importCoupons**](ManagementApi.md#importCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons [**importLoyaltyCards**](ManagementApi.md#importLoyaltyCards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards [**importLoyaltyCustomersTiers**](ManagementApi.md#importLoyaltyCustomersTiers) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers @@ -110,10 +110,12 @@ Method | HTTP request | Description [**importReferrals**](ManagementApi.md#importReferrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals [**listAccountCollections**](ManagementApi.md#listAccountCollections) | **GET** /v1/collections | List collections in account [**listCatalogItems**](ManagementApi.md#listCatalogItems) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog -[**listCollections**](ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections -[**listCollectionsInApplication**](ManagementApi.md#listCollectionsInApplication) | **GET** /v1/applications/{applicationId}/collections | List collections in application +[**listCollections**](ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign +[**listCollectionsInApplication**](ManagementApi.md#listCollectionsInApplication) | **GET** /v1/applications/{applicationId}/collections | List collections in Application +[**listStores**](ManagementApi.md#listStores) | **GET** /v1/applications/{applicationId}/stores | List stores +[**notificationActivation**](ManagementApi.md#notificationActivation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification [**postAddedDeductedPointsNotification**](ManagementApi.md#postAddedDeductedPointsNotification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points -[**postCatalogsStrikethroughNotification**](ManagementApi.md#postCatalogsStrikethroughNotification) | **POST** /v1/catalogs/{applicationId}/notifications/strikethrough | Create strikethrough notification +[**postCatalogsStrikethroughNotification**](ManagementApi.md#postCatalogsStrikethroughNotification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification [**postPendingPointsNotification**](ManagementApi.md#postPendingPointsNotification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points [**removeLoyaltyPoints**](ManagementApi.md#removeLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile [**resetPassword**](ManagementApi.md#resetPassword) | **POST** /v1/reset_password | Reset password @@ -124,12 +126,12 @@ Method | HTTP request | Description [**updateAdditionalCost**](ManagementApi.md#updateAdditionalCost) | **PUT** /v1/additional_costs/{additionalCostId} | Update additional cost [**updateAttribute**](ManagementApi.md#updateAttribute) | **PUT** /v1/attributes/{attributeId} | Update custom attribute [**updateCampaign**](ManagementApi.md#updateCampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign -[**updateCollection**](ManagementApi.md#updateCollection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update collection description +[**updateCollection**](ManagementApi.md#updateCollection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update campaign-level collection's description [**updateCoupon**](ManagementApi.md#updateCoupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon [**updateCouponBatch**](ManagementApi.md#updateCouponBatch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons [**updateLoyaltyCard**](ManagementApi.md#updateLoyaltyCard) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status -[**updateNotificationWebhook**](ManagementApi.md#updateNotificationWebhook) | **PUT** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification about campaign-related changes [**updateReferral**](ManagementApi.md#updateReferral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral +[**updateStore**](ManagementApi.md#updateStore) | **PUT** /v1/applications/{applicationId}/stores/{storeId} | Update store @@ -253,7 +255,7 @@ null (empty response body) ## copyCampaignToApplications -> InlineResponse2004 copyCampaignToApplications(applicationId, campaignId, body) +> InlineResponse2006 copyCampaignToApplications(applicationId, campaignId, body) Copy the campaign into the specified Application @@ -298,7 +300,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2004**](InlineResponse2004.md) +[**InlineResponse2006**](InlineResponse2006.md) ### Authorization @@ -316,7 +318,7 @@ Name | Type | Description | Notes Create account-level collection -Create account-level collection. +Create an account-level collection. ### Example @@ -536,9 +538,9 @@ Name | Type | Description | Notes > Collection createCollection(applicationId, campaignId, body) -Create collection +Create campaign-level collection -Create a collection. +Create a campaign-level collection in a given campaign. ### Example @@ -593,7 +595,7 @@ Name | Type | Description | Notes ## createCoupons -> InlineResponse2007 createCoupons(applicationId, campaignId, body, opts) +> InlineResponse2008 createCoupons(applicationId, campaignId, body, opts) Create coupons @@ -642,7 +644,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2007**](InlineResponse2007.md) +[**InlineResponse2008**](InlineResponse2008.md) ### Authorization @@ -715,7 +717,7 @@ Name | Type | Description | Notes ## createCouponsForMultipleRecipients -> InlineResponse2007 createCouponsForMultipleRecipients(applicationId, campaignId, body, opts) +> InlineResponse2008 createCouponsForMultipleRecipients(applicationId, campaignId, body, opts) Create coupons for multiple recipients @@ -764,7 +766,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2007**](InlineResponse2007.md) +[**InlineResponse2008**](InlineResponse2008.md) ### Authorization @@ -776,13 +778,13 @@ Name | Type | Description | Notes - **Accept**: application/json -## createNotificationWebhook +## createPasswordRecoveryEmail -> NotificationWebhook createNotificationWebhook(applicationId, body) +> NewPasswordEmail createPasswordRecoveryEmail(body) -Create notification about campaign-related changes +Request a password reset -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). +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. ### Example @@ -801,9 +803,8 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let body = new TalonOne.NewNotificationWebhook(); // NewNotificationWebhook | body -apiInstance.createNotificationWebhook(applicationId, body).then((data) => { +let body = new TalonOne.NewPasswordEmail(); // NewPasswordEmail | body +apiInstance.createPasswordRecoveryEmail(body).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -816,12 +817,11 @@ apiInstance.createNotificationWebhook(applicationId, body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md)| body | + **body** | [**NewPasswordEmail**](NewPasswordEmail.md)| body | ### Return type -[**NotificationWebhook**](NotificationWebhook.md) +[**NewPasswordEmail**](NewPasswordEmail.md) ### Authorization @@ -833,13 +833,13 @@ Name | Type | Description | Notes - **Accept**: application/json -## createPasswordRecoveryEmail +## createSession -> NewPasswordEmail createPasswordRecoveryEmail(body) +> Session createSession(body) -Request a password reset +Create session -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. +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> ### Example @@ -858,8 +858,8 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let body = new TalonOne.NewPasswordEmail(); // NewPasswordEmail | body -apiInstance.createPasswordRecoveryEmail(body).then((data) => { +let body = new TalonOne.LoginParams(); // LoginParams | body +apiInstance.createSession(body).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -872,11 +872,11 @@ apiInstance.createPasswordRecoveryEmail(body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewPasswordEmail**](NewPasswordEmail.md)| body | + **body** | [**LoginParams**](LoginParams.md)| body | ### Return type -[**NewPasswordEmail**](NewPasswordEmail.md) +[**Session**](Session.md) ### Authorization @@ -888,13 +888,13 @@ Name | Type | Description | Notes - **Accept**: application/json -## createSession +## createStore -> Session createSession(body) +> Store createStore(applicationId, body) -Create session +Create store -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> +Create a new store in a specific Application. ### Example @@ -913,8 +913,9 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let body = new TalonOne.LoginParams(); // LoginParams | body -apiInstance.createSession(body).then((data) => { +let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. +let body = new TalonOne.NewStore(); // NewStore | body +apiInstance.createStore(applicationId, body).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -927,11 +928,12 @@ apiInstance.createSession(body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LoginParams**](LoginParams.md)| body | + **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | + **body** | [**NewStore**](NewStore.md)| body | ### Return type -[**Session**](Session.md) +[**Store**](Store.md) ### Authorization @@ -1008,7 +1010,7 @@ null (empty response body) Delete account-level collection -Delete the given account-level collection. +Delete a given account-level collection. ### Example @@ -1027,7 +1029,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. apiInstance.deleteAccountCollection(collectionId).then(() => { console.log('API called successfully.'); }, (error) => { @@ -1041,7 +1043,7 @@ apiInstance.deleteAccountCollection(collectionId).then(() => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | ### Return type @@ -1118,9 +1120,9 @@ null (empty response body) > deleteCollection(applicationId, campaignId, collectionId) -Delete collection +Delete campaign-level collection -Delete the given collection. +Delete a given campaign-level collection. ### Example @@ -1141,7 +1143,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. apiInstance.deleteCollection(applicationId, campaignId, collectionId).then(() => { console.log('API called successfully.'); }, (error) => { @@ -1157,7 +1159,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | ### Return type @@ -1374,13 +1376,13 @@ null (empty response body) - **Accept**: application/json -## deleteNotificationWebhook +## deleteReferral -> deleteNotificationWebhook(applicationId, notificationWebhookId) +> deleteReferral(applicationId, campaignId, referralId) -Delete notification about campaign-related changes +Delete referral -Remove the given existing [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). +Delete the specified referral. ### Example @@ -1400,8 +1402,9 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let notificationWebhookId = 56; // Number | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. -apiInstance.deleteNotificationWebhook(applicationId, notificationWebhookId).then(() => { +let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. +let referralId = "referralId_example"; // String | The ID of the referral code. +apiInstance.deleteReferral(applicationId, campaignId, referralId).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); @@ -1415,7 +1418,8 @@ apiInstance.deleteNotificationWebhook(applicationId, notificationWebhookId).then Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **notificationWebhookId** | **Number**| The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | + **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | + **referralId** | **String**| The ID of the referral code. | ### Return type @@ -1431,13 +1435,13 @@ null (empty response body) - **Accept**: Not defined -## deleteReferral +## deleteStore -> deleteReferral(applicationId, campaignId, referralId) +> deleteStore(applicationId, storeId) -Delete referral +Delete store -Delete the specified referral. +Delete the specified store. ### Example @@ -1457,9 +1461,8 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let referralId = "referralId_example"; // String | The ID of the referral code. -apiInstance.deleteReferral(applicationId, campaignId, referralId).then(() => { +let storeId = "storeId_example"; // String | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. +apiInstance.deleteStore(applicationId, storeId).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); @@ -1473,8 +1476,7 @@ apiInstance.deleteReferral(applicationId, campaignId, referralId).then(() => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **referralId** | **String**| The ID of the referral code. | + **storeId** | **String**| The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. | ### Return type @@ -1487,7 +1489,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: Not defined +- **Accept**: application/json ## destroySession @@ -1547,7 +1549,7 @@ null (empty response body) Export account-level collection's items -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/). +Download a CSV file containing items from a given 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/). ### Example @@ -1566,7 +1568,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. apiInstance.exportAccountCollectionItems(collectionId).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -1580,7 +1582,7 @@ apiInstance.exportAccountCollectionItems(collectionId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | ### Return type @@ -1600,9 +1602,9 @@ Name | Type | Description | Notes > String exportCollectionItems(applicationId, campaignId, collectionId) -Export a collection's items +Export campaign-level collection's items -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/). +Download a CSV file containing items from a given campaign-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/). ### Example @@ -1623,7 +1625,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. apiInstance.exportCollectionItems(applicationId, campaignId, collectionId).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -1639,7 +1641,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | ### Return type @@ -1661,7 +1663,7 @@ Name | Type | Description | Notes Export coupons -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. +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 can contain 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. ### Example @@ -1690,11 +1692,12 @@ let opts = { 'valid': "valid_example", // String | 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. 'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. 'referralId': 56, // Number | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - 'recipientIntegrationId': "recipientIntegrationId_example", // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + 'recipientIntegrationId': "recipientIntegrationId_example", // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. 'batchId': "batchId_example", // String | Filter results by batches of coupons - 'exactMatch': false, // Boolean | Filter results to an exact case-insensitive matching against the coupon code + 'exactMatch': false, // Boolean | Filter results to an exact case-insensitive matching against the coupon code. 'dateFormat': "dateFormat_example", // String | Determines the format of dates in the export document. - 'campaignState': "campaignState_example" // String | 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. + 'campaignState': "campaignState_example", // String | 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. + 'valuesOnly': false // Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data. }; apiInstance.exportCoupons(applicationId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -1718,11 +1721,12 @@ Name | Type | Description | Notes **valid** | **String**| 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. | [optional] **usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] **referralId** | **Number**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] - **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional] + **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. | [optional] **batchId** | **String**| Filter results by batches of coupons | [optional] - **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false] + **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false] **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] **campaignState** | **String**| 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. | [optional] + **valuesOnly** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false] ### Return type @@ -1744,7 +1748,7 @@ Name | Type | Description | Notes Export customer sessions -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. +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-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `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. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session. ### Example @@ -1805,13 +1809,74 @@ Name | Type | Description | Notes - **Accept**: application/csv +## exportCustomersTiers + +> String exportCustomersTiers(loyaltyProgramId, opts) + +Export customers' tier data + +Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: management_key +let management_key = defaultClient.authentications['management_key']; +management_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//management_key.apiKeyPrefix = 'Token'; +// Configure API key authorization: manager_auth +let manager_auth = defaultClient.authentications['manager_auth']; +manager_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//manager_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.ManagementApi(); +let loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program. +let opts = { + 'subledgerIds': ["null"], // [String] | An array of subledgers IDs to filter the export by. + 'tierNames': ["null"] // [String] | An array of tier names to filter the export by. +}; +apiInstance.exportCustomersTiers(loyaltyProgramId, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loyaltyProgramId** | **String**| The identifier for the loyalty program. | + **subledgerIds** | [**[String]**](String.md)| An array of subledgers IDs to filter the export by. | [optional] + **tierNames** | [**[String]**](String.md)| An array of tier names to filter the export by. | [optional] + +### Return type + +**String** + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + + ## exportEffects > String exportEffects(applicationId, opts) Export triggered effects -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. +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/entities/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. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store. ### Example @@ -1897,7 +1962,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program. let opts = { - 'endDate': new Date("2013-10-20T19:20:30+01:00") // 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. + 'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. }; apiInstance.exportLoyaltyBalance(loyaltyProgramId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -1913,7 +1978,7 @@ apiInstance.exportLoyaltyBalance(loyaltyProgramId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltyProgramId** | **String**| The identifier for the loyalty program. | - **endDate** | **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. | [optional] + **endDate** | **Date**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. | [optional] ### Return type @@ -1956,7 +2021,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program. let opts = { - 'endDate': new Date("2013-10-20T19:20:30+01:00") // 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. + 'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. }; apiInstance.exportLoyaltyBalances(loyaltyProgramId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -1972,7 +2037,7 @@ apiInstance.exportLoyaltyBalances(loyaltyProgramId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltyProgramId** | **String**| The identifier for the loyalty program. | - **endDate** | **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. | [optional] + **endDate** | **Date**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. | [optional] ### Return type @@ -2015,7 +2080,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let loyaltyProgramId = 56; // Number | 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. let opts = { - 'endDate': new Date("2013-10-20T19:20:30+01:00") // 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. + 'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. }; apiInstance.exportLoyaltyCardBalances(loyaltyProgramId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -2031,7 +2096,7 @@ apiInstance.exportLoyaltyCardBalances(loyaltyProgramId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltyProgramId** | **Number**| 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. | - **endDate** | **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. | [optional] + **endDate** | **Date**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. | [optional] ### Return type @@ -2311,7 +2376,7 @@ Name | Type | Description | Notes ## getAccessLogsWithoutTotalCount -> InlineResponse20018 getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, opts) +> InlineResponse20019 getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, opts) Get access logs for Application @@ -2370,7 +2435,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20018**](InlineResponse20018.md) +[**InlineResponse20019**](InlineResponse20019.md) ### Authorization @@ -2517,7 +2582,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. apiInstance.getAccountCollection(collectionId).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -2531,7 +2596,7 @@ apiInstance.getAccountCollection(collectionId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | ### Return type @@ -2604,7 +2669,7 @@ Name | Type | Description | Notes ## getAdditionalCosts -> InlineResponse20033 getAdditionalCosts(opts) +> InlineResponse20034 getAdditionalCosts(opts) List additional costs @@ -2651,7 +2716,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization @@ -2665,7 +2730,7 @@ Name | Type | Description | Notes ## getAllAccessLogs -> InlineResponse20019 getAllAccessLogs(rangeStart, rangeEnd, opts) +> InlineResponse20020 getAllAccessLogs(rangeStart, rangeEnd, opts) List access logs @@ -2722,7 +2787,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20019**](InlineResponse20019.md) +[**InlineResponse20020**](InlineResponse20020.md) ### Authorization @@ -2736,7 +2801,7 @@ Name | Type | Description | Notes ## getAllRoles -> InlineResponse20041 getAllRoles() +> InlineResponse20042 getAllRoles() List roles @@ -2773,7 +2838,7 @@ This endpoint does not need any parameter. ### Return type -[**InlineResponse20041**](InlineResponse20041.md) +[**InlineResponse20042**](InlineResponse20042.md) ### Authorization @@ -2954,7 +3019,7 @@ Name | Type | Description | Notes ## getApplicationCustomerFriends -> InlineResponse20030 getApplicationCustomerFriends(applicationId, integrationId, opts) +> InlineResponse20031 getApplicationCustomerFriends(applicationId, integrationId, opts) List friends referred by customer profile @@ -3007,7 +3072,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization @@ -3021,7 +3086,7 @@ Name | Type | Description | Notes ## getApplicationCustomers -> InlineResponse20021 getApplicationCustomers(applicationId, opts) +> InlineResponse20022 getApplicationCustomers(applicationId, opts) List application's customers @@ -3072,7 +3137,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20021**](InlineResponse20021.md) +[**InlineResponse20022**](InlineResponse20022.md) ### Authorization @@ -3086,7 +3151,7 @@ Name | Type | Description | Notes ## getApplicationCustomersByAttributes -> InlineResponse20022 getApplicationCustomersByAttributes(applicationId, body, opts) +> InlineResponse20023 getApplicationCustomersByAttributes(applicationId, body, opts) List application customers matching the given attributes @@ -3137,7 +3202,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20022**](InlineResponse20022.md) +[**InlineResponse20023**](InlineResponse20023.md) ### Authorization @@ -3151,7 +3216,7 @@ Name | Type | Description | Notes ## getApplicationEventTypes -> InlineResponse20028 getApplicationEventTypes(applicationId, opts) +> InlineResponse20029 getApplicationEventTypes(applicationId, opts) List Applications event types @@ -3200,7 +3265,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20028**](InlineResponse20028.md) +[**InlineResponse20029**](InlineResponse20029.md) ### Authorization @@ -3214,7 +3279,7 @@ Name | Type | Description | Notes ## getApplicationEventsWithoutTotalCount -> InlineResponse20027 getApplicationEventsWithoutTotalCount(applicationId, opts) +> InlineResponse20028 getApplicationEventsWithoutTotalCount(applicationId, opts) List Applications events @@ -3285,7 +3350,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization @@ -3356,7 +3421,7 @@ Name | Type | Description | Notes ## getApplicationSessions -> InlineResponse20026 getApplicationSessions(applicationId, opts) +> InlineResponse20027 getApplicationSessions(applicationId, opts) List Application sessions @@ -3419,7 +3484,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20026**](InlineResponse20026.md) +[**InlineResponse20027**](InlineResponse20027.md) ### Authorization @@ -3433,7 +3498,7 @@ Name | Type | Description | Notes ## getApplications -> InlineResponse2003 getApplications(opts) +> InlineResponse2005 getApplications(opts) List Applications @@ -3480,7 +3545,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2003**](InlineResponse2003.md) +[**InlineResponse2005**](InlineResponse2005.md) ### Authorization @@ -3549,7 +3614,7 @@ Name | Type | Description | Notes ## getAttributes -> InlineResponse20031 getAttributes(opts) +> InlineResponse20032 getAttributes(opts) List custom attributes @@ -3598,7 +3663,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20031**](InlineResponse20031.md) +[**InlineResponse20032**](InlineResponse20032.md) ### Authorization @@ -3612,7 +3677,7 @@ Name | Type | Description | Notes ## getAudiences -> InlineResponse20029 getAudiences(opts) +> InlineResponse20030 getAudiences(opts) List audiences @@ -3661,7 +3726,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization @@ -3732,7 +3797,7 @@ Name | Type | Description | Notes ## getCampaignAnalytics -> InlineResponse20020 getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, opts) +> InlineResponse20021 getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, opts) Get analytics of campaigns @@ -3783,7 +3848,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20020**](InlineResponse20020.md) +[**InlineResponse20021**](InlineResponse20021.md) ### Authorization @@ -3797,7 +3862,7 @@ Name | Type | Description | Notes ## getCampaignByAttributes -> InlineResponse2004 getCampaignByAttributes(applicationId, body, opts) +> InlineResponse2006 getCampaignByAttributes(applicationId, body, opts) List campaigns that match the given attributes @@ -3850,7 +3915,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2004**](InlineResponse2004.md) +[**InlineResponse2006**](InlineResponse2006.md) ### Authorization @@ -3864,7 +3929,7 @@ Name | Type | Description | Notes ## getCampaignTemplates -> InlineResponse20010 getCampaignTemplates(opts) +> InlineResponse20011 getCampaignTemplates(opts) List campaign templates @@ -3919,7 +3984,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20010**](InlineResponse20010.md) +[**InlineResponse20011**](InlineResponse20011.md) ### Authorization @@ -3933,7 +3998,7 @@ Name | Type | Description | Notes ## getCampaigns -> InlineResponse2004 getCampaigns(applicationId, opts) +> InlineResponse2006 getCampaigns(applicationId, opts) List campaigns @@ -3966,8 +4031,9 @@ let opts = { 'tags': "tags_example", // String | 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 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. - 'campaignGroupId': 56, // Number | Filter results to campaigns owned by the specified campaign group ID. - 'templateId': 56 // Number | The ID of the Campaign Template this Campaign was created from. + 'campaignGroupId': 56, // Number | Filter results to campaigns owned by the specified campaign access group ID. + 'templateId': 56, // Number | The ID of the Campaign Template this Campaign was created from. + 'storeId': 56 // Number | Filter results to campaigns linked to the specified store ID. }; apiInstance.getCampaigns(applicationId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -3991,12 +4057,13 @@ Name | Type | Description | Notes **tags** | **String**| 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 | [optional] **createdBefore** | **Date**| 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. | [optional] **createdAfter** | **Date**| 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. | [optional] - **campaignGroupId** | **Number**| Filter results to campaigns owned by the specified campaign group ID. | [optional] + **campaignGroupId** | **Number**| Filter results to campaigns owned by the specified campaign access group ID. | [optional] **templateId** | **Number**| The ID of the Campaign Template this Campaign was created from. | [optional] + **storeId** | **Number**| Filter results to campaigns linked to the specified store ID. | [optional] ### Return type -[**InlineResponse2004**](InlineResponse2004.md) +[**InlineResponse2006**](InlineResponse2006.md) ### Authorization @@ -4010,7 +4077,7 @@ Name | Type | Description | Notes ## getChanges -> InlineResponse20039 getChanges(opts) +> InlineResponse20040 getChanges(opts) Get audit logs for an account @@ -4073,7 +4140,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20039**](InlineResponse20039.md) +[**InlineResponse20040**](InlineResponse20040.md) ### Authorization @@ -4089,9 +4156,9 @@ Name | Type | Description | Notes > Collection getCollection(applicationId, campaignId, collectionId) -Get collection +Get campaign-level collection -Retrieve a given collection. +Retrieve a given campaign-level collection. ### Example @@ -4112,7 +4179,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. apiInstance.getCollection(applicationId, campaignId, collectionId).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -4128,7 +4195,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | ### Return type @@ -4146,11 +4213,11 @@ Name | Type | Description | Notes ## getCollectionItems -> InlineResponse20016 getCollectionItems(collectionId, opts) +> InlineResponse20017 getCollectionItems(collectionId, opts) Get collection items -Retrieve the items from the given collection. +Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint. ### Example @@ -4169,7 +4236,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. let opts = { 'pageSize': 1000, // Number | The number of items in this response. 'skip': 56 // Number | The number of items to skip when paging through large result sets. @@ -4187,13 +4254,13 @@ apiInstance.getCollectionItems(collectionId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | **pageSize** | **Number**| The number of items in this response. | [optional] [default to 1000] **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] ### Return type -[**InlineResponse20016**](InlineResponse20016.md) +[**InlineResponse20017**](InlineResponse20017.md) ### Authorization @@ -4207,7 +4274,7 @@ Name | Type | Description | Notes ## getCouponsWithoutTotalCount -> InlineResponse2008 getCouponsWithoutTotalCount(applicationId, campaignId, opts) +> InlineResponse2009 getCouponsWithoutTotalCount(applicationId, campaignId, opts) List coupons @@ -4276,7 +4343,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2008**](InlineResponse2008.md) +[**InlineResponse2009**](InlineResponse2009.md) ### Authorization @@ -4357,7 +4424,7 @@ Name | Type | Description | Notes ## getCustomerActivityReportsWithoutTotalCount -> InlineResponse20025 getCustomerActivityReportsWithoutTotalCount(rangeStart, rangeEnd, applicationId, opts) +> InlineResponse20026 getCustomerActivityReportsWithoutTotalCount(rangeStart, rangeEnd, applicationId, opts) Get Activity Reports for Application Customers @@ -4418,7 +4485,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20025**](InlineResponse20025.md) +[**InlineResponse20026**](InlineResponse20026.md) ### Authorization @@ -4552,7 +4619,7 @@ Name | Type | Description | Notes ## getCustomerProfiles -> InlineResponse20024 getCustomerProfiles(opts) +> InlineResponse20025 getCustomerProfiles(opts) List customer profiles @@ -4599,7 +4666,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20024**](InlineResponse20024.md) +[**InlineResponse20025**](InlineResponse20025.md) ### Authorization @@ -4613,7 +4680,7 @@ Name | Type | Description | Notes ## getCustomersByAttributes -> InlineResponse20023 getCustomersByAttributes(body, opts) +> InlineResponse20024 getCustomersByAttributes(body, opts) List customer profiles matching the given attributes @@ -4662,7 +4729,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20023**](InlineResponse20023.md) +[**InlineResponse20024**](InlineResponse20024.md) ### Authorization @@ -4676,7 +4743,7 @@ Name | Type | Description | Notes ## getEventTypes -> InlineResponse20037 getEventTypes(opts) +> InlineResponse20038 getEventTypes(opts) List event types @@ -4727,7 +4794,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20037**](InlineResponse20037.md) +[**InlineResponse20038**](InlineResponse20038.md) ### Authorization @@ -4741,7 +4808,7 @@ Name | Type | Description | Notes ## getExports -> InlineResponse20040 getExports(opts) +> InlineResponse20041 getExports(opts) Get exports @@ -4792,7 +4859,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20040**](InlineResponse20040.md) +[**InlineResponse20041**](InlineResponse20041.md) ### Authorization @@ -4863,11 +4930,11 @@ Name | Type | Description | Notes ## getLoyaltyCardTransactionLogs -> InlineResponse20014 getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, opts) +> InlineResponse20015 getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, opts) List card's transactions -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. +Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-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. ### Example @@ -4918,7 +4985,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20014**](InlineResponse20014.md) +[**InlineResponse20015**](InlineResponse20015.md) ### Authorization @@ -4932,7 +4999,7 @@ Name | Type | Description | Notes ## getLoyaltyCards -> InlineResponse20013 getLoyaltyCards(loyaltyProgramId, opts) +> InlineResponse20014 getLoyaltyCards(loyaltyProgramId, opts) List loyalty cards @@ -4985,7 +5052,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20013**](InlineResponse20013.md) +[**InlineResponse20014**](InlineResponse20014.md) ### Authorization @@ -5111,7 +5178,7 @@ Name | Type | Description | Notes ## getLoyaltyProgramTransactions -> InlineResponse20012 getLoyaltyProgramTransactions(loyaltyProgramId, opts) +> InlineResponse20013 getLoyaltyProgramTransactions(loyaltyProgramId, opts) List loyalty program transactions @@ -5166,7 +5233,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20012**](InlineResponse20012.md) +[**InlineResponse20013**](InlineResponse20013.md) ### Authorization @@ -5180,7 +5247,7 @@ Name | Type | Description | Notes ## getLoyaltyPrograms -> InlineResponse20011 getLoyaltyPrograms() +> InlineResponse20012 getLoyaltyPrograms() List loyalty programs @@ -5217,7 +5284,7 @@ This endpoint does not need any parameter. ### Return type -[**InlineResponse20011**](InlineResponse20011.md) +[**InlineResponse20012**](InlineResponse20012.md) ### Authorization @@ -5231,7 +5298,7 @@ This endpoint does not need any parameter. ## getLoyaltyStatistics -> LoyaltyStatistics getLoyaltyStatistics(loyaltyProgramId) +> LoyaltyDashboardData getLoyaltyStatistics(loyaltyProgramId) Get loyalty program statistics @@ -5272,119 +5339,7 @@ Name | Type | Description | Notes ### Return type -[**LoyaltyStatistics**](LoyaltyStatistics.md) - -### Authorization - -[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## getNotificationWebhook - -> NotificationWebhook getNotificationWebhook(applicationId, notificationWebhookId) - -Get notification about campaign-related changes - -Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). - -### Example - -```javascript -import TalonOne from 'talon_one'; -let defaultClient = TalonOne.ApiClient.instance; -// Configure API key authorization: management_key -let management_key = defaultClient.authentications['management_key']; -management_key.apiKey = 'YOUR API KEY'; -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) -//management_key.apiKeyPrefix = 'Token'; -// Configure API key authorization: manager_auth -let manager_auth = defaultClient.authentications['manager_auth']; -manager_auth.apiKey = 'YOUR API KEY'; -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) -//manager_auth.apiKeyPrefix = 'Token'; - -let apiInstance = new TalonOne.ManagementApi(); -let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let notificationWebhookId = 56; // Number | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. -apiInstance.getNotificationWebhook(applicationId, notificationWebhookId).then((data) => { - console.log('API called successfully. Returned data: ' + data); -}, (error) => { - console.error(error); -}); - -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **notificationWebhookId** | **Number**| The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | - -### Return type - -[**NotificationWebhook**](NotificationWebhook.md) - -### Authorization - -[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## getNotificationWebhooks - -> InlineResponse2005 getNotificationWebhooks(applicationId) - -List notifications about campaign-related changes - -List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application. - -### Example - -```javascript -import TalonOne from 'talon_one'; -let defaultClient = TalonOne.ApiClient.instance; -// Configure API key authorization: management_key -let management_key = defaultClient.authentications['management_key']; -management_key.apiKey = 'YOUR API KEY'; -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) -//management_key.apiKeyPrefix = 'Token'; -// Configure API key authorization: manager_auth -let manager_auth = defaultClient.authentications['manager_auth']; -manager_auth.apiKey = 'YOUR API KEY'; -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) -//manager_auth.apiKeyPrefix = 'Token'; - -let apiInstance = new TalonOne.ManagementApi(); -let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -apiInstance.getNotificationWebhooks(applicationId).then((data) => { - console.log('API called successfully. Returned data: ' + data); -}, (error) => { - console.error(error); -}); - -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - -### Return type - -[**InlineResponse2005**](InlineResponse2005.md) +[**LoyaltyDashboardData**](LoyaltyDashboardData.md) ### Authorization @@ -5398,7 +5353,7 @@ Name | Type | Description | Notes ## getReferralsWithoutTotalCount -> InlineResponse2009 getReferralsWithoutTotalCount(applicationId, campaignId, opts) +> InlineResponse20010 getReferralsWithoutTotalCount(applicationId, campaignId, opts) List referrals @@ -5461,7 +5416,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2009**](InlineResponse2009.md) +[**InlineResponse20010**](InlineResponse20010.md) ### Authorization @@ -5589,7 +5544,7 @@ Name | Type | Description | Notes ## getRulesets -> InlineResponse2006 getRulesets(applicationId, campaignId, opts) +> InlineResponse2007 getRulesets(applicationId, campaignId, opts) List campaign rulesets @@ -5640,7 +5595,64 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2006**](InlineResponse2006.md) +[**InlineResponse2007**](InlineResponse2007.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getStore + +> Store getStore(applicationId, storeId) + +Get store + +Get store details for a specific store ID. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: management_key +let management_key = defaultClient.authentications['management_key']; +management_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//management_key.apiKeyPrefix = 'Token'; +// Configure API key authorization: manager_auth +let manager_auth = defaultClient.authentications['manager_auth']; +manager_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//manager_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.ManagementApi(); +let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. +let storeId = "storeId_example"; // String | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. +apiInstance.getStore(applicationId, storeId).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | + **storeId** | **String**| The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. | + +### Return type + +[**Store**](Store.md) ### Authorization @@ -5709,7 +5721,7 @@ Name | Type | Description | Notes ## getUsers -> InlineResponse20038 getUsers(opts) +> InlineResponse20039 getUsers(opts) List users in account @@ -5756,7 +5768,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20038**](InlineResponse20038.md) +[**InlineResponse20039**](InlineResponse20039.md) ### Authorization @@ -5825,7 +5837,7 @@ Name | Type | Description | Notes ## getWebhookActivationLogs -> InlineResponse20035 getWebhookActivationLogs(opts) +> InlineResponse20036 getWebhookActivationLogs(opts) List webhook activation log entries @@ -5884,7 +5896,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20035**](InlineResponse20035.md) +[**InlineResponse20036**](InlineResponse20036.md) ### Authorization @@ -5898,7 +5910,7 @@ Name | Type | Description | Notes ## getWebhookLogs -> InlineResponse20036 getWebhookLogs(opts) +> InlineResponse20037 getWebhookLogs(opts) List webhook log entries @@ -5959,7 +5971,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20036**](InlineResponse20036.md) +[**InlineResponse20037**](InlineResponse20037.md) ### Authorization @@ -5973,7 +5985,7 @@ Name | Type | Description | Notes ## getWebhooks -> InlineResponse20034 getWebhooks(opts) +> InlineResponse20035 getWebhooks(opts) List webhooks @@ -6030,7 +6042,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20034**](InlineResponse20034.md) +[**InlineResponse20035**](InlineResponse20035.md) ### Authorization @@ -6046,7 +6058,7 @@ Name | Type | Description | Notes > ModelImport importAccountCollection(collectionId, opts) -Import data in existing account-level collection +Import data into existing account-level collection 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. @@ -6067,7 +6079,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. let opts = { 'upFile': "upFile_example" // String | The file with the information about the data that should be imported. }; @@ -6084,7 +6096,7 @@ apiInstance.importAccountCollection(collectionId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | **upFile** | **String**| The file with the information about the data that should be imported. | [optional] ### Return type @@ -6164,7 +6176,7 @@ Name | Type | Description | Notes > ModelImport importCollection(applicationId, campaignId, collectionId, opts) -Import data in existing collection +Import data into existing campaign-level collection 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. @@ -6187,7 +6199,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. let opts = { 'upFile': "upFile_example" // String | The file with the information about the data that should be imported. }; @@ -6206,7 +6218,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | **upFile** | **String**| The file with the information about the data that should be imported. | [optional] ### Return type @@ -6229,7 +6241,7 @@ Name | Type | Description | Notes Import coupons -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). +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_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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). ### Example @@ -6467,7 +6479,7 @@ Name | Type | Description | Notes Import giveaway codes into a giveaway pool -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\"\"}\" ``` +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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **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\"\"}\" ``` ### Example @@ -6526,7 +6538,7 @@ Name | Type | Description | Notes Import referrals -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\"\"}\" ``` +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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **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\"\"}\" ``` ### Example @@ -6583,11 +6595,11 @@ Name | Type | Description | Notes ## listAccountCollections -> InlineResponse20015 listAccountCollections(opts) +> InlineResponse20016 listAccountCollections(opts) List collections in account -List collections in account. +List account-level collections in the account. ### Example @@ -6611,7 +6623,7 @@ let opts = { 'skip': 56, // Number | The number of items to skip when paging through large result sets. 'sort': "sort_example", // String | 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. 'withTotalResultSize': true, // Boolean | 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. - 'name': "name_example" // String | Filter by the name of the Collection. + 'name': "name_example" // String | Filter by collection name. }; apiInstance.listAccountCollections(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -6630,11 +6642,11 @@ Name | Type | Description | Notes **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] **sort** | **String**| 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. | [optional] **withTotalResultSize** | **Boolean**| 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. | [optional] - **name** | **String**| Filter by the name of the Collection. | [optional] + **name** | **String**| Filter by collection name. | [optional] ### Return type -[**InlineResponse20015**](InlineResponse20015.md) +[**InlineResponse20016**](InlineResponse20016.md) ### Authorization @@ -6648,7 +6660,7 @@ Name | Type | Description | Notes ## listCatalogItems -> InlineResponse20032 listCatalogItems(catalogId, opts) +> InlineResponse20033 listCatalogItems(catalogId, opts) List items in a catalog @@ -6699,7 +6711,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization @@ -6713,11 +6725,11 @@ Name | Type | Description | Notes ## listCollections -> InlineResponse20017 listCollections(applicationId, campaignId, opts) +> InlineResponse20018 listCollections(applicationId, campaignId, opts) -List collections +List collections in campaign -List collections in the campaign. +List collections in a given campaign. ### Example @@ -6743,7 +6755,7 @@ let opts = { 'skip': 56, // Number | The number of items to skip when paging through large result sets. 'sort': "sort_example", // String | 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. 'withTotalResultSize': true, // Boolean | 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. - 'name': "name_example" // String | Filter by the name of the Collection. + 'name': "name_example" // String | Filter by collection name. }; apiInstance.listCollections(applicationId, campaignId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -6764,11 +6776,11 @@ Name | Type | Description | Notes **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] **sort** | **String**| 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. | [optional] **withTotalResultSize** | **Boolean**| 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. | [optional] - **name** | **String**| Filter by the name of the Collection. | [optional] + **name** | **String**| Filter by collection name. | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20018**](InlineResponse20018.md) ### Authorization @@ -6782,11 +6794,11 @@ Name | Type | Description | Notes ## listCollectionsInApplication -> InlineResponse20017 listCollectionsInApplication(applicationId, opts) +> InlineResponse20018 listCollectionsInApplication(applicationId, opts) -List collections in application +List collections in Application -List collections from all campaigns in the Application. +List campaign-level collections from all campaigns in a given Application. ### Example @@ -6811,7 +6823,7 @@ let opts = { 'skip': 56, // Number | The number of items to skip when paging through large result sets. 'sort': "sort_example", // String | 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. 'withTotalResultSize': true, // Boolean | 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. - 'name': "name_example" // String | Filter by the name of the Collection. + 'name': "name_example" // String | Filter by collection name. }; apiInstance.listCollectionsInApplication(applicationId, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -6831,11 +6843,11 @@ Name | Type | Description | Notes **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] **sort** | **String**| 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. | [optional] **withTotalResultSize** | **Boolean**| 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. | [optional] - **name** | **String**| Filter by the name of the Collection. | [optional] + **name** | **String**| Filter by collection name. | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20018**](InlineResponse20018.md) ### Authorization @@ -6847,13 +6859,141 @@ Name | Type | Description | Notes - **Accept**: application/json +## listStores + +> InlineResponse20043 listStores(applicationId, opts) + +List stores + +List all stores for a specific Application. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: management_key +let management_key = defaultClient.authentications['management_key']; +management_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//management_key.apiKeyPrefix = 'Token'; +// Configure API key authorization: manager_auth +let manager_auth = defaultClient.authentications['manager_auth']; +manager_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//manager_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.ManagementApi(); +let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. +let opts = { + 'pageSize': 1000, // Number | The number of items in this response. + 'skip': 56, // Number | The number of items to skip when paging through large result sets. + 'sort': "sort_example", // String | 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. + 'withTotalResultSize': true, // Boolean | 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. + 'campaignId': 3.4, // Number | Filter results by campaign. + 'name': "name_example", // String | The name of the store. + 'integrationId': "integrationId_example" // String | The integration ID of the store. +}; +apiInstance.listStores(applicationId, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | + **pageSize** | **Number**| The number of items in this response. | [optional] [default to 1000] + **skip** | **Number**| The number of items to skip when paging through large result sets. | [optional] + **sort** | **String**| 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. | [optional] + **withTotalResultSize** | **Boolean**| 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. | [optional] + **campaignId** | **Number**| Filter results by campaign. | [optional] + **name** | **String**| The name of the store. | [optional] + **integrationId** | **String**| The integration ID of the store. | [optional] + +### Return type + +[**InlineResponse20043**](InlineResponse20043.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## notificationActivation + +> notificationActivation(notificationId, body) + +Activate or deactivate notification + +Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification. + +### Example + +```javascript +import TalonOne from 'talon_one'; +let defaultClient = TalonOne.ApiClient.instance; +// Configure API key authorization: management_key +let management_key = defaultClient.authentications['management_key']; +management_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//management_key.apiKeyPrefix = 'Token'; +// Configure API key authorization: manager_auth +let manager_auth = defaultClient.authentications['manager_auth']; +manager_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//manager_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new TalonOne.ManagementApi(); +let notificationId = 56; // Number | The ID of the notification. Get it with the appropriate _List notifications_ endpoint. +let body = new TalonOne.NotificationActivation(); // NotificationActivation | body +apiInstance.notificationActivation(notificationId, body).then(() => { + console.log('API called successfully.'); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notificationId** | **Number**| The ID of the notification. Get it with the appropriate _List notifications_ endpoint. | + **body** | [**NotificationActivation**](NotificationActivation.md)| body | + +### Return type + +null (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + ## postAddedDeductedPointsNotification > BaseNotification postAddedDeductedPointsNotification(loyaltyProgramId, body) Create notification about added or deducted loyalty points -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). +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 loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). ### Example @@ -6967,7 +7107,7 @@ Name | Type | Description | Notes Create notification about pending loyalty points -Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications). +Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). ### Example @@ -7134,11 +7274,11 @@ Name | Type | Description | Notes ## searchCouponsAdvancedApplicationWideWithoutTotalCount -> InlineResponse2008 searchCouponsAdvancedApplicationWideWithoutTotalCount(applicationId, body, opts) +> InlineResponse2009 searchCouponsAdvancedApplicationWideWithoutTotalCount(applicationId, body, opts) List coupons that match the given attributes (without total count) -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. +List the coupons whose attributes match the query criteria in all the 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. ### Example @@ -7205,7 +7345,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2008**](InlineResponse2008.md) +[**InlineResponse2009**](InlineResponse2009.md) ### Authorization @@ -7219,7 +7359,7 @@ Name | Type | Description | Notes ## searchCouponsAdvancedWithoutTotalCount -> InlineResponse2008 searchCouponsAdvancedWithoutTotalCount(applicationId, campaignId, body, opts) +> InlineResponse2009 searchCouponsAdvancedWithoutTotalCount(applicationId, campaignId, body, opts) List coupons that match the given attributes in campaign (without total count) @@ -7290,7 +7430,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2008**](InlineResponse2008.md) +[**InlineResponse2009**](InlineResponse2009.md) ### Authorization @@ -7367,7 +7507,7 @@ null (empty response body) Update account-level collection -Edit the description of the account-level collection and enable or disable the collection in the specified Applications. +Edit the description of a given account-level collection and enable or disable the collection in the specified Applications. ### Example @@ -7386,7 +7526,7 @@ manager_auth.apiKey = 'YOUR API KEY'; //manager_auth.apiKeyPrefix = 'Token'; let apiInstance = new TalonOne.ManagementApi(); -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. let body = new TalonOne.UpdateCollection(); // UpdateCollection | body apiInstance.updateAccountCollection(collectionId, body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -7401,7 +7541,7 @@ apiInstance.updateAccountCollection(collectionId, body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | **body** | [**UpdateCollection**](UpdateCollection.md)| body | ### Return type @@ -7424,7 +7564,7 @@ Name | Type | Description | Notes Update additional cost -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. +Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the `name` property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations. ### Example @@ -7595,9 +7735,9 @@ Name | Type | Description | Notes > Collection updateCollection(applicationId, campaignId, collectionId, body) -Update collection description +Update campaign-level collection's description -Edit the description of the collection. +Edit the description of a given campaign-level collection. ### Example @@ -7618,7 +7758,7 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. +let collectionId = 56; // Number | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. let body = new TalonOne.UpdateCampaignCollection(); // UpdateCampaignCollection | body apiInstance.updateCollection(applicationId, campaignId, collectionId, body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -7635,7 +7775,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **collectionId** | **Number**| The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | + **collectionId** | **Number**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | **body** | [**UpdateCampaignCollection**](UpdateCampaignCollection.md)| body | ### Return type @@ -7719,7 +7859,7 @@ Name | Type | Description | Notes Update coupons -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). +Update all coupons, or a specific batch of coupons in the given 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). ### Example @@ -7831,13 +7971,13 @@ Name | Type | Description | Notes - **Accept**: application/json -## updateNotificationWebhook +## updateReferral -> NotificationWebhook updateNotificationWebhook(applicationId, notificationWebhookId, body) +> Referral updateReferral(applicationId, campaignId, referralId, body) -Update notification about campaign-related changes +Update referral -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). +Update the specified referral. ### Example @@ -7857,9 +7997,10 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let notificationWebhookId = 56; // Number | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. -let body = new TalonOne.NewNotificationWebhook(); // NewNotificationWebhook | body -apiInstance.updateNotificationWebhook(applicationId, notificationWebhookId, body).then((data) => { +let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. +let referralId = "referralId_example"; // String | The ID of the referral code. +let body = new TalonOne.UpdateReferral(); // UpdateReferral | body +apiInstance.updateReferral(applicationId, campaignId, referralId, body).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -7873,12 +8014,13 @@ apiInstance.updateNotificationWebhook(applicationId, notificationWebhookId, body Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **notificationWebhookId** | **Number**| The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | - **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md)| body | + **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | + **referralId** | **String**| The ID of the referral code. | + **body** | [**UpdateReferral**](UpdateReferral.md)| body | ### Return type -[**NotificationWebhook**](NotificationWebhook.md) +[**Referral**](Referral.md) ### Authorization @@ -7890,13 +8032,13 @@ Name | Type | Description | Notes - **Accept**: application/json -## updateReferral +## updateStore -> Referral updateReferral(applicationId, campaignId, referralId, body) +> Store updateStore(applicationId, storeId, body) -Update referral +Update store -Update the specified referral. +Update store details for a specific store ID. ### Example @@ -7916,10 +8058,9 @@ manager_auth.apiKey = 'YOUR API KEY'; let apiInstance = new TalonOne.ManagementApi(); let applicationId = 56; // Number | The ID of the Application. It is displayed in your Talon.One deployment URL. -let campaignId = 56; // Number | The ID of the campaign. It is displayed in your Talon.One deployment URL. -let referralId = "referralId_example"; // String | The ID of the referral code. -let body = new TalonOne.UpdateReferral(); // UpdateReferral | body -apiInstance.updateReferral(applicationId, campaignId, referralId, body).then((data) => { +let storeId = "storeId_example"; // String | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. +let body = new TalonOne.NewStore(); // NewStore | body +apiInstance.updateStore(applicationId, storeId, body).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -7933,13 +8074,12 @@ apiInstance.updateReferral(applicationId, campaignId, referralId, body).then((da Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Number**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaignId** | **Number**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | - **referralId** | **String**| The ID of the referral code. | - **body** | [**UpdateReferral**](UpdateReferral.md)| body | + **storeId** | **String**| The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. | + **body** | [**NewStore**](NewStore.md)| body | ### Return type -[**Referral**](Referral.md) +[**Store**](Store.md) ### Authorization diff --git a/docs/NewApplication.md b/docs/NewApplication.md index f431197b..ec03a883 100644 --- a/docs/NewApplication.md +++ b/docs/NewApplication.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] **defaultDiscountScope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] **enableCascadingDiscounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional] -**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). | [optional] +**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. | [optional] **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional] **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] diff --git a/docs/NewApplicationAPIKey.md b/docs/NewApplicationAPIKey.md index 16d7b5ba..58d9cd60 100644 --- a/docs/NewApplicationAPIKey.md +++ b/docs/NewApplicationAPIKey.md @@ -37,6 +37,8 @@ Name | Type | Description | Notes * `salesforce` (value: `"salesforce"`) +* `emarsys` (value: `"emarsys"`) + diff --git a/docs/NewAttribute.md b/docs/NewAttribute.md index f8c00a7b..9ebb0b97 100644 --- a/docs/NewAttribute.md +++ b/docs/NewAttribute.md @@ -43,6 +43,8 @@ Name | Type | Description | Notes * `Referral` (value: `"Referral"`) +* `Store` (value: `"Store"`) + diff --git a/docs/NewBaseNotification.md b/docs/NewBaseNotification.md index 3aaea0b6..4435c7f2 100644 --- a/docs/NewBaseNotification.md +++ b/docs/NewBaseNotification.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **policy** | [**Object**](.md) | | +**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true] **webhook** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | | diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md index f37c9284..daea0195 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -18,6 +18,8 @@ Name | Type | Description | Notes **limits** | [**[LimitConfig]**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] **evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] @@ -50,3 +52,14 @@ Name | Type | Description | Notes + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/NewCampaignEvaluationGroup.md b/docs/NewCampaignEvaluationGroup.md index 3b1a1698..fa34fd6a 100644 --- a/docs/NewCampaignEvaluationGroup.md +++ b/docs/NewCampaignEvaluationGroup.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **name** | **String** | The name of the campaign evaluation group. | **parentId** | **Number** | The ID of the parent group that contains the campaign evaluation group. | **description** | **String** | A description of the campaign evaluation group. | [optional] -**evaluationMode** | **String** | | +**evaluationMode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. | +**evaluationScope** | **String** | The evaluation scope of the campaign evaluation group. | **locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. | @@ -26,3 +27,14 @@ Name | Type | Description | Notes + +## Enum: EvaluationScopeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `session` (value: `"session"`) + + + + diff --git a/docs/NewCampaignGroup.md b/docs/NewCampaignGroup.md index e2b2d19e..1ffd6864 100644 --- a/docs/NewCampaignGroup.md +++ b/docs/NewCampaignGroup.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The name of this campaign group. | -**description** | **String** | A longer description of the campaign group. | [optional] -**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] -**campaignIds** | **[Number]** | A list of the IDs of the campaigns that this campaign group owns. | [optional] +**name** | **String** | The name of this campaign access group. | +**description** | **String** | A longer description of the campaign access group. | [optional] +**subscribedApplicationsIds** | **[Number]** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional] +**campaignIds** | **[Number]** | A list of IDs of the campaigns that are part of the campaign access group. | [optional] diff --git a/docs/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md index af8d403e..cfa1dbdc 100644 --- a/docs/NewCampaignTemplate.md +++ b/docs/NewCampaignTemplate.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **templateParams** | [**[CampaignTemplateParams]**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] **campaignCollections** | [**[CampaignTemplateCollection]**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] **defaultCampaignGroupId** | **Number** | The default campaign group ID. | [optional] +**campaignType** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced'] @@ -50,3 +51,14 @@ Name | Type | Description | Notes + +## Enum: CampaignTypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index 612854d2..10a896ff 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -17,5 +17,6 @@ Name | Type | Description | Notes **validCharacters** | **[String]** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] **couponPattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] **isReservationMandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index 89aaddff..6e4cc69f 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **coupon** | **String** | Any coupon code entered. | [optional] **referral** | **String** | Any referral code entered. | [optional] -**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open'] +**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [optional] [default to 'open'] **cartItems** | [**[CartItem]**](CartItem.md) | Serialized JSON representation. | [optional] **identifiers** | **[String]** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). | [optional] **total** | **Number** | The total sum of the cart in one session. | [optional] diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md index 4214f2c1..c1f5b8e5 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -5,12 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluableCampaignIds** | **[Number]** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] **couponCodes** | **[String]** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] **referralCode** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] **loyaltyCards** | **[String]** | Any loyalty cards used. | [optional] -**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open'] -**cartItems** | [**[CartItem]**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional] +**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [optional] [default to 'open'] +**cartItems** | [**[CartItem]**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional] **additionalCosts** | [**{String: AdditionalCost}**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] **identifiers** | **[String]** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [optional] **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] diff --git a/docs/NewEvent.md b/docs/NewEvent.md index 8f921ba1..ad2179cb 100644 --- a/docs/NewEvent.md +++ b/docs/NewEvent.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] **type** | **String** | A string representing the event. Must not be a reserved event name. | **attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. | **sessionId** | **String** | The ID of the session that this event occurred in. | diff --git a/docs/NewInvitation.md b/docs/NewInvitation.md index ebe4916b..23efff27 100644 --- a/docs/NewInvitation.md +++ b/docs/NewInvitation.md @@ -6,7 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of the user being invited. | [optional] **email** | **String** | | -**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` | -**roles** | **[Number]** | An array of roleIDs to assign the new user to. | [optional] +**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` | [optional] +**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. We recommend using this flag over using the `acl` with value `{\"Role\": 127}`. | [optional] +**roles** | **[Number]** | An array of role IDs to assign to the new user. | [optional] diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index 602b11f6..006b5a0a 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | **usersPerCardLimit** | **Number** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | -**tiersExpireIn** | **String** | The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] +**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] **tiersDowngradePolicy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional] **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | **tiers** | [**[NewLoyaltyTier]**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] diff --git a/docs/NewNotificationTest.md b/docs/NewNotificationTest.md new file mode 100644 index 00000000..20e0d0c6 --- /dev/null +++ b/docs/NewNotificationTest.md @@ -0,0 +1,56 @@ +# TalonOne.NewNotificationTest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | The notification type. | +**queryParams** | **[String]** | Array of query parameters. | [optional] +**headers** | **[String]** | List of API HTTP headers for the given webhook-based notification. | [optional] +**verb** | **String** | API method for this notification. | +**url** | **String** | API URL for the given notification. | +**payload** | **String** | API payload of this notification. | + + + +## Enum: TypeEnum + + +* `campaign` (value: `"campaign"`) + +* `loyalty_added_deducted_points` (value: `"loyalty_added_deducted_points"`) + +* `coupon` (value: `"coupon"`) + +* `expiring_points` (value: `"expiring_points"`) + +* `pending_to_active_points` (value: `"pending_to_active_points"`) + +* `strikethrough_pricing` (value: `"strikethrough_pricing"`) + +* `tier_downgrade` (value: `"tier_downgrade"`) + +* `tier_upgrade` (value: `"tier_upgrade"`) + +* `tier_will_downgrade` (value: `"tier_will_downgrade"`) + + + + + +## Enum: VerbEnum + + +* `POST` (value: `"POST"`) + +* `PUT` (value: `"PUT"`) + +* `GET` (value: `"GET"`) + +* `DELETE` (value: `"DELETE"`) + +* `PATCH` (value: `"PATCH"`) + + + + diff --git a/docs/NewNotificationWebhook.md b/docs/NewNotificationWebhook.md index 11367247..0befb976 100644 --- a/docs/NewNotificationWebhook.md +++ b/docs/NewNotificationWebhook.md @@ -6,5 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **String** | API URL for the given webhook-based notification. | **headers** | **[String]** | List of API HTTP headers for the given webhook-based notification. | +**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true] diff --git a/docs/NewRoleV2.md b/docs/NewRoleV2.md index 969e9fa3..94ab6f23 100644 --- a/docs/NewRoleV2.md +++ b/docs/NewRoleV2.md @@ -6,7 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of the role. | **description** | **String** | Description of the role. | -**isAdmin** | **Boolean** | Indicates whether the role grants admin permissions. | [optional] **permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional] **members** | **[Number]** | A list of user identifiers the role is assigned to. | [optional] diff --git a/docs/NewStore.md b/docs/NewStore.md new file mode 100644 index 00000000..0b88193a --- /dev/null +++ b/docs/NewStore.md @@ -0,0 +1,12 @@ +# TalonOne.NewStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The name of the store. | +**description** | **String** | The description of the store. | +**attributes** | [**Object**](.md) | The attributes of the store. | [optional] +**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | + + diff --git a/docs/NotificationActivation.md b/docs/NotificationActivation.md new file mode 100644 index 00000000..9969c038 --- /dev/null +++ b/docs/NotificationActivation.md @@ -0,0 +1,9 @@ +# TalonOne.NotificationActivation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Boolean** | Indicates whether the notification is activated. | + + diff --git a/docs/NotificationTest.md b/docs/NotificationTest.md new file mode 100644 index 00000000..ff3c8e34 --- /dev/null +++ b/docs/NotificationTest.md @@ -0,0 +1,10 @@ +# TalonOne.NotificationTest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**httpResponse** | **String** | The returned http response. | +**httpStatus** | **String** | The returned http status code and status message. | + + diff --git a/docs/OneTimeCode.md b/docs/OneTimeCode.md new file mode 100644 index 00000000..d3ffdd9d --- /dev/null +++ b/docs/OneTimeCode.md @@ -0,0 +1,12 @@ +# TalonOne.OneTimeCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **Number** | The ID of the user. | +**accountId** | **Number** | The ID of the account. | +**token** | **String** | The two-factor authentication token created during sign-in. This token is used to ensure that the correct user is trying to sign in with a given one-time security code. | +**code** | **String** | The one-time security code used for signing in. | [optional] + + diff --git a/docs/OutgoingIntegrationCleverTapPolicy.md b/docs/OutgoingIntegrationCleverTapPolicy.md new file mode 100644 index 00000000..90d44abb --- /dev/null +++ b/docs/OutgoingIntegrationCleverTapPolicy.md @@ -0,0 +1,11 @@ +# TalonOne.OutgoingIntegrationCleverTapPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**baseUrl** | **String** | The base URL that is based on the region key of your CleverTap account. | +**accountId** | **String** | The CleverTap Project ID. | +**passcode** | **String** | The CleverTap Project passcode. | + + diff --git a/docs/OutgoingIntegrationIterablePolicy.md b/docs/OutgoingIntegrationIterablePolicy.md new file mode 100644 index 00000000..e56f868c --- /dev/null +++ b/docs/OutgoingIntegrationIterablePolicy.md @@ -0,0 +1,10 @@ +# TalonOne.OutgoingIntegrationIterablePolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**baseUrl** | **String** | The base URL that is based on the region key of your Iterable account. | +**apiKey** | **String** | The API key generated from your Iterable account. See [Iterable API Key Guide](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) | + + diff --git a/docs/OutgoingIntegrationMoEngagePolicy.md b/docs/OutgoingIntegrationMoEngagePolicy.md new file mode 100644 index 00000000..fafffeac --- /dev/null +++ b/docs/OutgoingIntegrationMoEngagePolicy.md @@ -0,0 +1,12 @@ +# TalonOne.OutgoingIntegrationMoEngagePolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**baseUrl** | **String** | The base URL of your MoEngage deployment, containing the MoEngage data center number (represented by `0X`). | +**appId** | **String** | MoEngage APP ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | +**dataApiId** | **String** | MoEngage DATA API ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | +**dataApiKey** | **String** | MoEngage DATA API Key. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | + + diff --git a/docs/RemoveFromAudienceEffectProps.md b/docs/RemoveFromAudienceEffectProps.md new file mode 100644 index 00000000..cb10e07b --- /dev/null +++ b/docs/RemoveFromAudienceEffectProps.md @@ -0,0 +1,12 @@ +# TalonOne.RemoveFromAudienceEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audienceId** | **Number** | The internal ID of the audience. | [optional] +**audienceName** | **String** | The name of the audience. | [optional] +**profileIntegrationId** | **String** | The ID of the customer profile in the third-party integration platform. | [optional] +**profileId** | **Number** | The internal ID of the customer profile. | [optional] + + diff --git a/docs/ReturnedCartItem.md b/docs/ReturnedCartItem.md index 167500db..89fbddbc 100644 --- a/docs/ReturnedCartItem.md +++ b/docs/ReturnedCartItem.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **position** | **Number** | The index of the cart item in the provided customer session's `cartItems` property. | -**quantity** | **Number** | Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. | [optional] +**quantity** | **Number** | Number of cart items to return. | [optional] diff --git a/docs/RoleAssign.md b/docs/RoleAssign.md index 455b34e7..0aa6e61b 100644 --- a/docs/RoleAssign.md +++ b/docs/RoleAssign.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**users** | **[Number]** | An array of userIDs. | -**roles** | **[Number]** | An array of roleIDs. | +**users** | **[Number]** | An array of user IDs. | +**roles** | **[Number]** | An array of role IDs. | diff --git a/docs/RoleV2.md b/docs/RoleV2.md index 1a464686..1a2b0ab9 100644 --- a/docs/RoleV2.md +++ b/docs/RoleV2.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes **accountId** | **Number** | The ID of the account that owns this entity. | **name** | **String** | Name of the role. | [optional] **description** | **String** | Description of the role. | [optional] -**isAdmin** | **Boolean** | Indicates whether the role grants admin permissions. | [optional] **permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional] **members** | **[Number]** | A list of user identifiers the role is assigned to. | [optional] diff --git a/docs/RoleV2ApplicationDetails.md b/docs/RoleV2ApplicationDetails.md index 9aad16c4..fa92077d 100644 --- a/docs/RoleV2ApplicationDetails.md +++ b/docs/RoleV2ApplicationDetails.md @@ -7,5 +7,6 @@ Name | Type | Description | Notes **application** | **String** | Name of the Application-related permission set for the given Application. | [optional] **campaign** | **String** | Name of the campaign-related permission set for the given Application. | [optional] **draftCampaign** | **String** | Name of the draft campaign-related permission set for the given Application. | [optional] +**tools** | **String** | Name of the tools-related permission set. | [optional] diff --git a/docs/RoleV2Base.md b/docs/RoleV2Base.md index 131e32db..ea9282af 100644 --- a/docs/RoleV2Base.md +++ b/docs/RoleV2Base.md @@ -6,7 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of the role. | [optional] **description** | **String** | Description of the role. | [optional] -**isAdmin** | **Boolean** | Indicates whether the role grants admin permissions. | [optional] **permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional] **members** | **[Number]** | A list of user identifiers the role is assigned to. | [optional] diff --git a/docs/RoleV2PermissionSet.md b/docs/RoleV2PermissionSet.md index ef883fc7..78d877d2 100644 --- a/docs/RoleV2PermissionSet.md +++ b/docs/RoleV2PermissionSet.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of the permission set. | -**logicalOperations** | **[String]** | List of logical operations in the permission set. Each logical operation must be shown under the `x-logicalPermissionOperation` tag on an endpoint level. | +**logicalOperations** | **[String]** | List of logical operations in the permission set. Each logical operation must be shown under the `x-permission` tag on an endpoint level. | diff --git a/docs/RollbackAddedLoyaltyPointsEffectProps.md b/docs/RollbackAddedLoyaltyPointsEffectProps.md index 4f786892..1a49f113 100644 --- a/docs/RollbackAddedLoyaltyPointsEffectProps.md +++ b/docs/RollbackAddedLoyaltyPointsEffectProps.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **recipientIntegrationId** | **String** | The user for whom these points were originally added. | **transactionUUID** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. | **cartItemPosition** | **Number** | The index of the item in the cart items for which the loyalty points were rolled back. | [optional] -**cartItemSubPosition** | **Number** | The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. | [optional] +**cartItemSubPosition** | **Number** | For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back. | [optional] **cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional] diff --git a/docs/RollbackDiscountEffectProps.md b/docs/RollbackDiscountEffectProps.md index d2724ac4..fa382e2b 100644 --- a/docs/RollbackDiscountEffectProps.md +++ b/docs/RollbackDiscountEffectProps.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **name** | **String** | The name of the \"setDiscount\" effect that was rolled back. | **value** | **Number** | The value of the discount that was rolled back. | **cartItemPosition** | **Number** | The index of the item in the cart items for which the discount was rolled back. | [optional] -**cartItemSubPosition** | **Number** | The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled. | [optional] +**cartItemSubPosition** | **Number** | For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item. | [optional] **additionalCostId** | **Number** | The ID of the additional cost that was rolled back. | [optional] **additionalCost** | **String** | The name of the additional cost that was rolled back. | [optional] **scope** | **String** | The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` | [optional] diff --git a/docs/SSOConfig.md b/docs/SSOConfig.md new file mode 100644 index 00000000..f9f37bfd --- /dev/null +++ b/docs/SSOConfig.md @@ -0,0 +1,9 @@ +# TalonOne.SSOConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enforced** | **Boolean** | An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. | + + diff --git a/docs/SamlLoginEndpoint.md b/docs/SamlLoginEndpoint.md index fe574f9c..85a8905e 100644 --- a/docs/SamlLoginEndpoint.md +++ b/docs/SamlLoginEndpoint.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**id** | **Number** | ID of the SAML login endpoint. | **name** | **String** | ID of the SAML service. | **loginURL** | **String** | Single Sign-On URL. | diff --git a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md index dd1b5f6c..80ef6879 100644 --- a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **additionalCostId** | **Number** | The ID of the additional cost. | **value** | **Number** | The total monetary value of the discount. | **position** | **Number** | The index of the item in the cart item list containing the additional cost to be discounted. | -**subPosition** | **Number** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. | [optional] +**subPosition** | **Number** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional] **additionalCost** | **String** | The name of the additional cost. | **desiredValue** | **Number** | Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. | [optional] diff --git a/docs/SetDiscountPerItemEffectProps.md b/docs/SetDiscountPerItemEffectProps.md index 931d76b2..e9272f70 100644 --- a/docs/SetDiscountPerItemEffectProps.md +++ b/docs/SetDiscountPerItemEffectProps.md @@ -7,12 +7,14 @@ Name | Type | Description | Notes **name** | **String** | The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. | **value** | **Number** | The total monetary value of the discount. | **position** | **Number** | The index of the item in the cart items list on which this discount should be applied. | -**subPosition** | **Number** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. | [optional] +**subPosition** | **Number** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional] **desiredValue** | **Number** | The original value of the discount. | [optional] **scope** | **String** | The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. | [optional] **totalDiscount** | **Number** | The total discount given if this effect is a result of a prorated discount. | [optional] **desiredTotalDiscount** | **Number** | The original total discount to give if this effect is a result of a prorated discount. | [optional] **bundleIndex** | **Number** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] **bundleName** | **String** | The name of the bundle definition. | [optional] +**targetedItemPosition** | **Number** | The index of the targeted bundle item on which the applied discount is based. | [optional] +**targetedItemSubPosition** | **Number** | The sub-position of the targeted bundle item on which the applied discount is based. | [optional] diff --git a/docs/Store.md b/docs/Store.md new file mode 100644 index 00000000..8b0fe388 --- /dev/null +++ b/docs/Store.md @@ -0,0 +1,17 @@ +# TalonOne.Store + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Number** | Internal ID of this entity. | +**created** | **Date** | The time this entity was created. The time this entity was created. | +**name** | **String** | The name of the store. | +**description** | **String** | The description of the store. | +**attributes** | [**Object**](.md) | The attributes of the store. | [optional] +**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | +**applicationId** | **Number** | The ID of the application that owns this entity. | +**updated** | **Date** | Timestamp of the most recent update on this entity. | +**linkedCampaignIds** | **[Number]** | A list of IDs of the campaigns that are linked with current store. | [optional] + + diff --git a/docs/TalangAttribute.md b/docs/TalangAttribute.md index 0f29c879..070cec17 100644 --- a/docs/TalangAttribute.md +++ b/docs/TalangAttribute.md @@ -53,6 +53,8 @@ Name | Type | Description | Notes * `Session` (value: `"Session"`) +* `Store` (value: `"Store"`) + diff --git a/docs/TierDowngradeNotificationPolicy.md b/docs/TierDowngradeNotificationPolicy.md new file mode 100644 index 00000000..220b87cd --- /dev/null +++ b/docs/TierDowngradeNotificationPolicy.md @@ -0,0 +1,9 @@ +# TalonOne.TierDowngradeNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The name of the notification. | + + diff --git a/docs/TierUpgradeNotificationPolicy.md b/docs/TierUpgradeNotificationPolicy.md new file mode 100644 index 00000000..1c709b01 --- /dev/null +++ b/docs/TierUpgradeNotificationPolicy.md @@ -0,0 +1,9 @@ +# TalonOne.TierUpgradeNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Notification name. | + + diff --git a/docs/TierWillDowngradeNotificationPolicy.md b/docs/TierWillDowngradeNotificationPolicy.md new file mode 100644 index 00000000..097dd9bf --- /dev/null +++ b/docs/TierWillDowngradeNotificationPolicy.md @@ -0,0 +1,10 @@ +# TalonOne.TierWillDowngradeNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The name of the notification. | +**triggers** | [**[TierWillDowngradeNotificationTrigger]**](TierWillDowngradeNotificationTrigger.md) | | + + diff --git a/docs/TierWillDowngradeNotificationTrigger.md b/docs/TierWillDowngradeNotificationTrigger.md new file mode 100644 index 00000000..d2deda86 --- /dev/null +++ b/docs/TierWillDowngradeNotificationTrigger.md @@ -0,0 +1,21 @@ +# TalonOne.TierWillDowngradeNotificationTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **Number** | The amount of period. | +**period** | **String** | Notification period indicated by a letter; \"w\" means week, \"d\" means day. | + + + +## Enum: PeriodEnum + + +* `w` (value: `"w"`) + +* `d` (value: `"d"`) + + + + diff --git a/docs/TimePoint.md b/docs/TimePoint.md new file mode 100644 index 00000000..6d7e2d35 --- /dev/null +++ b/docs/TimePoint.md @@ -0,0 +1,14 @@ +# TalonOne.TimePoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month** | **Number** | The achievement is reset in this month. **Note**: Only applicable if the period is set to `Y`. | [optional] +**dayOfMonth** | **Number** | The achievement is reset on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. | [optional] +**dayOfWeek** | **Number** | The achievement is reset on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. | [optional] +**hour** | **Number** | The achievement is reset at this hour. | +**minute** | **Number** | The achievement is reset at this minute. | +**second** | **Number** | The achievement is reset at this second. | + + diff --git a/docs/TrackEventV2Response.md b/docs/TrackEventV2Response.md new file mode 100644 index 00000000..76a62c6d --- /dev/null +++ b/docs/TrackEventV2Response.md @@ -0,0 +1,17 @@ +# TalonOne.TrackEventV2Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customerProfile** | [**CustomerProfile**](CustomerProfile.md) | | [optional] +**event** | [**Event**](Event.md) | | [optional] +**loyalty** | [**Loyalty**](Loyalty.md) | | [optional] +**triggeredCampaigns** | [**[Campaign]**](Campaign.md) | | [optional] +**ruleFailureReasons** | [**[RuleFailureReason]**](RuleFailureReason.md) | | [optional] +**awardedGiveaways** | [**[Giveaway]**](Giveaway.md) | | [optional] +**effects** | [**[Effect]**](Effect.md) | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | +**createdCoupons** | [**[Coupon]**](Coupon.md) | | +**createdReferrals** | [**[Referral]**](Referral.md) | | + + diff --git a/docs/TwoFAConfig.md b/docs/TwoFAConfig.md new file mode 100644 index 00000000..8bf57a6f --- /dev/null +++ b/docs/TwoFAConfig.md @@ -0,0 +1,10 @@ +# TalonOne.TwoFAConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Boolean** | An indication of whether two-factor authentication is enabled for the account. | +**requireEverySignIn** | **Boolean** | Can be `true` or `false`. - `true`: Two-factor authentication is required each time a user signs in to their Talon.One account. - `false`: Two-factor authentication is only required when a user signs in to their Talon.One account on a new device, and every 30 days after that. | [optional] + + diff --git a/docs/UpdateAchievement.md b/docs/UpdateAchievement.md new file mode 100644 index 00000000..2e4a0065 --- /dev/null +++ b/docs/UpdateAchievement.md @@ -0,0 +1,10 @@ +# TalonOne.UpdateAchievement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional] +**description** | **String** | A description of the achievement. | [optional] + + diff --git a/docs/UpdateApplication.md b/docs/UpdateApplication.md index 2ce67366..ed8362a7 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] **defaultDiscountScope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] **enableCascadingDiscounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional] -**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). | [optional] +**enableFlattenedCartItems** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. | [optional] **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional] **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md index 7b8207f8..c007a102 100644 --- a/docs/UpdateCampaign.md +++ b/docs/UpdateCampaign.md @@ -17,6 +17,9 @@ Name | Type | Description | Notes **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**[LimitConfig]**](LimitConfig.md) | The set of limits that will operate for this campaign. | **campaignGroups** | **[Number]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional] +**evaluationGroupId** | **Number** | The ID of the campaign evaluation group the campaign belongs to. | [optional] +**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] +**linkedStoreIds** | **[Number]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] @@ -49,3 +52,14 @@ Name | Type | Description | Notes + +## Enum: TypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/UpdateCampaignEvaluationGroup.md b/docs/UpdateCampaignEvaluationGroup.md index 610135e4..d3ce018c 100644 --- a/docs/UpdateCampaignEvaluationGroup.md +++ b/docs/UpdateCampaignEvaluationGroup.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **name** | **String** | The name of the campaign evaluation group. | **parentId** | **Number** | The ID of the parent group that contains the campaign evaluation group. | **description** | **String** | A description of the campaign evaluation group. | [optional] -**evaluationMode** | **String** | | +**evaluationMode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. | +**evaluationScope** | **String** | The evaluation scope of the campaign evaluation group. | **locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. | @@ -26,3 +27,14 @@ Name | Type | Description | Notes + +## Enum: EvaluationScopeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `session` (value: `"session"`) + + + + diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md index f938ee86..d6107e90 100644 --- a/docs/UpdateCampaignGroup.md +++ b/docs/UpdateCampaignGroup.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The name of this campaign group. | -**description** | **String** | A longer description of the campaign group. | [optional] -**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] -**campaignIds** | **[Number]** | A list of the IDs of the campaigns that this campaign group owns. | [optional] +**name** | **String** | The name of this campaign access group. | +**description** | **String** | A longer description of the campaign access group. | [optional] +**subscribedApplicationsIds** | **[Number]** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional] +**campaignIds** | **[Number]** | A list of IDs of the campaigns that are part of the campaign access group. | [optional] diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md index 970009fe..102723a8 100644 --- a/docs/UpdateCampaignTemplate.md +++ b/docs/UpdateCampaignTemplate.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **applicationsIds** | **[Number]** | A list of IDs of the Applications that are subscribed to this campaign template. | **campaignCollections** | [**[CampaignTemplateCollection]**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] **defaultCampaignGroupId** | **Number** | The default campaign group ID. | [optional] +**campaignType** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] @@ -52,3 +53,14 @@ Name | Type | Description | Notes + +## Enum: CampaignTypeEnum + + +* `cartItem` (value: `"cartItem"`) + +* `advanced` (value: `"advanced"`) + + + + diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index 634751b7..4128b955 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -13,5 +13,6 @@ Name | Type | Description | Notes **recipientIntegrationId** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional] **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] **isReservationMandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 2efb23cd..cbd6426e 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **reservationLimit** | **Number** | The number of reservations that can be made with this coupon code. | [optional] **startDate** | **Date** | Timestamp at which point the coupon becomes valid. | [optional] **expiryDate** | **Date** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] -**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] -**batchID** | **String** | The id of the batch the coupon belongs to. | [optional] +**attributes** | [**Object**](.md) | Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. | [optional] +**batchID** | **String** | The ID of the batch the coupon(s) belong to. | [optional] diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index b89e68e0..fdec8d53 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional] **usersPerCardLimit** | **Number** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional] -**tiersExpireIn** | **String** | The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] +**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] **tiersDowngradePolicy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional] **tiers** | [**[NewLoyaltyTier]**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] diff --git a/docs/UpdateStore.md b/docs/UpdateStore.md new file mode 100644 index 00000000..43354610 --- /dev/null +++ b/docs/UpdateStore.md @@ -0,0 +1,11 @@ +# TalonOne.UpdateStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The name of the store. | +**description** | **String** | The description of the store. | +**attributes** | [**Object**](.md) | The attributes of the store. | [optional] + + diff --git a/docs/UpdateUser.md b/docs/UpdateUser.md index 99dceabd..a5ebfa0d 100644 --- a/docs/UpdateUser.md +++ b/docs/UpdateUser.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **state** | **String** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional] **roles** | **[Number]** | List of roles to assign to the user. | [optional] **applicationNotificationSubscriptions** | [**Object**](.md) | | [optional] +**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. | [optional] diff --git a/docs/User.md b/docs/User.md index cb40ba8f..7eac0222 100644 --- a/docs/User.md +++ b/docs/User.md @@ -17,6 +17,9 @@ Name | Type | Description | Notes **roles** | **[Number]** | Contains a list of all roles the user is a member of. | [optional] **applicationNotificationSubscriptions** | [**Object**](.md) | | [optional] **authMethod** | **String** | The Authentication method for this user. | [optional] +**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. | [optional] +**lastSignedIn** | **Date** | Date and time when the user last signed in to Talon.One. | [optional] +**lastAccessed** | **Date** | Date and time of the user's last activity after signing in to Talon.One. | [optional] diff --git a/package.json b/package.json index ec499dc5..2b973d23 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "talon_one", - "version": "5.0.1-rc", + "version": "6.0.0", "description": "Talon.One API SDK for Javascript", "homepage": "https://developers.talon.one/SDKs/JavaScript", "author": { diff --git a/src/ApiClient.js b/src/ApiClient.js index 1c69b360..2f5d6dee 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -17,7 +17,7 @@ import querystring from "querystring"; /** * @module ApiClient -* @version 5.0.1 +* @version 6.0.0 */ /** diff --git a/src/api/IntegrationApi.js b/src/api/IntegrationApi.js index 13e8367a..f3aa85c1 100644 --- a/src/api/IntegrationApi.js +++ b/src/api/IntegrationApi.js @@ -21,11 +21,14 @@ import CouponReservations from '../model/CouponReservations'; import CustomerInventory from '../model/CustomerInventory'; import CustomerProfileAudienceRequest from '../model/CustomerProfileAudienceRequest'; import CustomerProfileIntegrationRequestV2 from '../model/CustomerProfileIntegrationRequestV2'; +import CustomerProfileIntegrationResponseV2 from '../model/CustomerProfileIntegrationResponseV2'; import ErrorResponse from '../model/ErrorResponse'; import ErrorResponseWithStatus from '../model/ErrorResponseWithStatus'; import InlineResponse200 from '../model/InlineResponse200'; import InlineResponse2001 from '../model/InlineResponse2001'; import InlineResponse2002 from '../model/InlineResponse2002'; +import InlineResponse2003 from '../model/InlineResponse2003'; +import InlineResponse2004 from '../model/InlineResponse2004'; import InlineResponse201 from '../model/InlineResponse201'; import IntegrationCustomerSessionResponse from '../model/IntegrationCustomerSessionResponse'; import IntegrationEventV2Request from '../model/IntegrationEventV2Request'; @@ -42,12 +45,13 @@ import NewReferralsForMultipleAdvocates from '../model/NewReferralsForMultipleAd import Referral from '../model/Referral'; import ReopenSessionResponse from '../model/ReopenSessionResponse'; import ReturnIntegrationRequest from '../model/ReturnIntegrationRequest'; +import TrackEventV2Response from '../model/TrackEventV2Response'; import UpdateAudience from '../model/UpdateAudience'; /** * Integration service. * @module api/IntegrationApi -* @version 5.0.1 +* @version 6.0.0 */ export default class IntegrationApi { @@ -113,7 +117,7 @@ export default class IntegrationApi { /** * Create coupon reservation - * Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store.

Important

This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code).
To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. + * Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. If the **Coupon visibility** checkbox was selected when [creating a universal code](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons#generating-a-universal-code), the coupon code is implicitly reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint.

Important

This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). This endpoint overrides the reservation limit set for the coupon code during coupon creation.
To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. * @param {String} couponValue The code of the coupon. * @param {module:model/CouponReservations} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Coupon} and HTTP response @@ -152,7 +156,7 @@ export default class IntegrationApi { /** * Create coupon reservation - * Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store.

Important

This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code).
To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. + * Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. If the **Coupon visibility** checkbox was selected when [creating a universal code](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons#generating-a-universal-code), the coupon code is implicitly reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint.

Important

This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). This endpoint overrides the reservation limit set for the coupon code during coupon creation.
To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. * @param {String} couponValue The code of the coupon. * @param {module:model/CouponReservations} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Coupon} @@ -579,11 +583,11 @@ export default class IntegrationApi { /** * Get customer's loyalty points - * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer). - * @param {Number} loyaltyProgramId 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. + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LoyaltyBalances} and HTTP response */ getLoyaltyBalancesWithHttpInfo(loyaltyProgramId, integrationId, opts) { @@ -623,11 +627,11 @@ export default class IntegrationApi { /** * Get customer's loyalty points - * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer). - * @param {Number} loyaltyProgramId 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. + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LoyaltyBalances} */ getLoyaltyBalances(loyaltyProgramId, integrationId, opts) { @@ -644,7 +648,7 @@ export default class IntegrationApi { * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LoyaltyBalances} and HTTP response */ getLoyaltyCardBalancesWithHttpInfo(loyaltyProgramId, loyaltyCardId, opts) { @@ -688,7 +692,7 @@ export default class IntegrationApi { * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LoyaltyBalances} */ getLoyaltyCardBalances(loyaltyProgramId, loyaltyCardId, opts) { @@ -699,6 +703,76 @@ export default class IntegrationApi { } + /** + * List card's unused loyalty points + * Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + * @param {Number} loyaltyProgramId 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. + * @param {String} loyaltyCardId 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. + * @param {Object} [opts] Optional parameters + * @param {module:model/String=} [opts.status] Filter points based on their status. (default to 'active') + * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2003} and HTTP response + */ + getLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, opts) { + opts = opts || {}; + let postBody = null; + // verify the required parameter 'loyaltyProgramId' is set + if (loyaltyProgramId === undefined || loyaltyProgramId === null) { + throw new Error("Missing the required parameter 'loyaltyProgramId' when calling getLoyaltyCardPoints"); + } + // verify the required parameter 'loyaltyCardId' is set + if (loyaltyCardId === undefined || loyaltyCardId === null) { + throw new Error("Missing the required parameter 'loyaltyCardId' when calling getLoyaltyCardPoints"); + } + + let pathParams = { + 'loyaltyProgramId': loyaltyProgramId, + 'loyaltyCardId': loyaltyCardId + }; + let queryParams = { + 'status': opts['status'], + 'subledgerId': opts['subledgerId'], + 'pageSize': opts['pageSize'], + 'skip': opts['skip'] + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['api_key_v1']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = InlineResponse2003; + return this.apiClient.callApi( + '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List card's unused loyalty points + * Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + * @param {Number} loyaltyProgramId 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. + * @param {String} loyaltyCardId 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. + * @param {Object} [opts] Optional parameters + * @param {module:model/String=} [opts.status] Filter points based on their status. (default to 'active') + * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2003} + */ + getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, opts) { + return this.getLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * List card's transactions * Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned. @@ -706,6 +780,7 @@ export default class IntegrationApi { * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {module:model/String=} [opts.loyaltyTransactionType] 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. * @param {Date=} [opts.startDate] Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) @@ -730,6 +805,7 @@ export default class IntegrationApi { }; let queryParams = { 'subledgerId': opts['subledgerId'], + 'loyaltyTransactionType': opts['loyaltyTransactionType'], 'startDate': opts['startDate'], 'endDate': opts['endDate'], 'pageSize': opts['pageSize'], @@ -758,6 +834,7 @@ export default class IntegrationApi { * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {module:model/String=} [opts.loyaltyTransactionType] 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. * @param {Date=} [opts.startDate] Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) @@ -772,13 +849,84 @@ export default class IntegrationApi { } + /** + * List customer's unused loyalty points + * Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. + * @param {Object} [opts] Optional parameters + * @param {module:model/String=} [opts.status] Filter points based on their status. (default to 'active') + * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response + */ + getLoyaltyProgramProfilePointsWithHttpInfo(loyaltyProgramId, integrationId, opts) { + opts = opts || {}; + let postBody = null; + // verify the required parameter 'loyaltyProgramId' is set + if (loyaltyProgramId === undefined || loyaltyProgramId === null) { + throw new Error("Missing the required parameter 'loyaltyProgramId' when calling getLoyaltyProgramProfilePoints"); + } + // verify the required parameter 'integrationId' is set + if (integrationId === undefined || integrationId === null) { + throw new Error("Missing the required parameter 'integrationId' when calling getLoyaltyProgramProfilePoints"); + } + + let pathParams = { + 'loyaltyProgramId': loyaltyProgramId, + 'integrationId': integrationId + }; + let queryParams = { + 'status': opts['status'], + 'subledgerId': opts['subledgerId'], + 'pageSize': opts['pageSize'], + 'skip': opts['skip'] + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['api_key_v1']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = InlineResponse2004; + return this.apiClient.callApi( + '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List customer's unused loyalty points + * Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past. + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. + * @param {Object} [opts] Optional parameters + * @param {module:model/String=} [opts.status] Filter points based on their status. (default to 'active') + * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004} + */ + getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, opts) { + return this.getLoyaltyProgramProfilePointsWithHttpInfo(loyaltyProgramId, integrationId, opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * List customer's loyalty transactions * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint. - * @param {Number} loyaltyProgramId 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. + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {Object} [opts] Optional parameters * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {module:model/String=} [opts.loyaltyTransactionType] 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. * @param {Date=} [opts.startDate] Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) @@ -803,6 +951,7 @@ export default class IntegrationApi { }; let queryParams = { 'subledgerId': opts['subledgerId'], + 'loyaltyTransactionType': opts['loyaltyTransactionType'], 'startDate': opts['startDate'], 'endDate': opts['endDate'], 'pageSize': opts['pageSize'], @@ -827,10 +976,11 @@ export default class IntegrationApi { /** * List customer's loyalty transactions * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint. - * @param {Number} loyaltyProgramId 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. + * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {Object} [opts] Optional parameters * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. + * @param {module:model/String=} [opts.loyaltyTransactionType] 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. * @param {Date=} [opts.startDate] Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) @@ -895,7 +1045,7 @@ export default class IntegrationApi { /** * Link customer profile to card - * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows. + * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows. * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {module:model/LoyaltyCardRegistration} body body @@ -940,7 +1090,7 @@ export default class IntegrationApi { /** * Link customer profile to card - * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows. + * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows. * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {module:model/LoyaltyCardRegistration} body body @@ -956,7 +1106,7 @@ export default class IntegrationApi { /** * Reopen customer session - * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below.
Effects and budgets unimpacted by a session reopening

The following effects and budgets are left the way they were once the session was originally closed:

  • Add free item effect
  • Any not pending pending loyalty points.
  • Award giveaway
  • Coupon and referral creation
  • Coupon reservation
  • Custom effect
  • Update attribute value
  • Update cart item attribute value

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

**Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. + * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below.
Effects and budgets unimpacted by a session reopening

The following effects and budgets are left the way they were once the session was originally closed:

  • Add free item effect
  • Any non-pending loyalty points
  • Award giveaway
  • Coupon and referral creation
  • Coupon reservation
  • Custom effect
  • Update attribute value
  • Update cart item attribute value

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

**Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ReopenSessionResponse} and HTTP response */ @@ -990,7 +1140,7 @@ export default class IntegrationApi { /** * Reopen customer session - * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below.
Effects and budgets unimpacted by a session reopening

The following effects and budgets are left the way they were once the session was originally closed:

  • Add free item effect
  • Any not pending pending loyalty points.
  • Award giveaway
  • Coupon and referral creation
  • Coupon reservation
  • Custom effect
  • Update attribute value
  • Update cart item attribute value

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

**Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. + * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below.
Effects and budgets unimpacted by a session reopening

The following effects and budgets are left the way they were once the session was originally closed:

  • Add free item effect
  • Any non-pending loyalty points
  • Award giveaway
  • Coupon and referral creation
  • Coupon reservation
  • Custom effect
  • Update attribute value
  • Update cart item attribute value

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

**Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one. * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ReopenSessionResponse} */ @@ -1004,7 +1154,7 @@ export default class IntegrationApi { /** * Return cart items - * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled for the Application. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). + * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @param {module:model/ReturnIntegrationRequest} body body * @param {Object} [opts] Optional parameters @@ -1047,7 +1197,7 @@ export default class IntegrationApi { /** * Return cart items - * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled for the Application. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). + * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @param {module:model/ReturnIntegrationRequest} body body * @param {Object} [opts] Optional parameters @@ -1118,12 +1268,12 @@ export default class IntegrationApi { /** * Track event - * Triggers a custom event. You can build a condition around this event in your rules. Talon.One offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). **Important:** - `profileId` is required. An event is associated with a customer profile. - Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). When you successfully sent an event to Talon.One, you can list received events in the **Events** view in the Campaign Manager. + * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).

Important

1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
* @param {module:model/IntegrationEventV2Request} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationStateV2} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TrackEventV2Response} and HTTP response */ trackEventV2WithHttpInfo(body, opts) { opts = opts || {}; @@ -1147,7 +1297,7 @@ export default class IntegrationApi { let authNames = ['api_key_v1']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = IntegrationStateV2; + let returnType = TrackEventV2Response; return this.apiClient.callApi( '/v2/events', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -1157,12 +1307,12 @@ export default class IntegrationApi { /** * Track event - * Triggers a custom event. You can build a condition around this event in your rules. Talon.One offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). **Important:** - `profileId` is required. An event is associated with a customer profile. - Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). When you successfully sent an event to Talon.One, you can list received events in the **Events** view in the Campaign Manager. + * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).

Important

1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
* @param {module:model/IntegrationEventV2Request} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationStateV2} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TrackEventV2Response} */ trackEventV2(body, opts) { return this.trackEventV2WithHttpInfo(body, opts) @@ -1228,7 +1378,7 @@ export default class IntegrationApi { /** * Update audience name - * Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. + * Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. * @param {Number} audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). * @param {module:model/UpdateAudience} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Audience} and HTTP response @@ -1267,7 +1417,7 @@ export default class IntegrationApi { /** * Update audience name - * Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. + * Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. * @param {Number} audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). * @param {module:model/UpdateAudience} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Audience} @@ -1282,7 +1432,7 @@ export default class IntegrationApi { /** * Update multiple customer profiles' audiences - * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. + * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect. * @param {module:model/CustomerProfileAudienceRequest} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -1315,7 +1465,7 @@ export default class IntegrationApi { /** * Update multiple customer profiles' audiences - * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. + * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect. * @param {module:model/CustomerProfileAudienceRequest} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -1329,13 +1479,13 @@ export default class IntegrationApi { /** * Update customer profile - * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.

Performance tips

- Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
+ * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.

Performance tips

- Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
* @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {module:model/CustomerProfileIntegrationRequestV2} body body * @param {Object} [opts] Optional parameters * @param {Boolean=} [opts.runRuleEngine] Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. (default to false) * @param {Boolean=} [opts.dry] (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationStateV2} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CustomerProfileIntegrationResponseV2} and HTTP response */ updateCustomerProfileV2WithHttpInfo(integrationId, body, opts) { opts = opts || {}; @@ -1364,7 +1514,7 @@ export default class IntegrationApi { let authNames = ['api_key_v1']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = IntegrationStateV2; + let returnType = CustomerProfileIntegrationResponseV2; return this.apiClient.callApi( '/v2/customer_profiles/{integrationId}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, @@ -1374,13 +1524,13 @@ export default class IntegrationApi { /** * Update customer profile - * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.

Performance tips

- Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
+ * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.

Performance tips

- Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
* @param {String} integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. * @param {module:model/CustomerProfileIntegrationRequestV2} body body * @param {Object} [opts] Optional parameters * @param {Boolean=} [opts.runRuleEngine] Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. (default to false) * @param {Boolean=} [opts.dry] (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationStateV2} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomerProfileIntegrationResponseV2} */ updateCustomerProfileV2(integrationId, body, opts) { return this.updateCustomerProfileV2WithHttpInfo(integrationId, body, opts) @@ -1392,7 +1542,7 @@ export default class IntegrationApi { /** * Update multiple customer profiles - * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). + * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. * @param {module:model/MultipleCustomerProfileIntegrationRequest} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') @@ -1429,7 +1579,7 @@ export default class IntegrationApi { /** * Update multiple customer profiles - * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). + * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. * @param {module:model/MultipleCustomerProfileIntegrationRequest} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') @@ -1445,11 +1595,11 @@ export default class IntegrationApi { /** * Update customer session - * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). + * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @param {module:model/IntegrationRequest} body body * @param {Object} [opts] Optional parameters - * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. + * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationStateV2} and HTTP response */ updateCustomerSessionV2WithHttpInfo(customerSessionId, body, opts) { @@ -1488,11 +1638,11 @@ export default class IntegrationApi { /** * Update customer session - * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). + * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). * @param {String} customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. * @param {module:model/IntegrationRequest} body body * @param {Object} [opts] Optional parameters - * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. + * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationStateV2} */ updateCustomerSessionV2(customerSessionId, body, opts) { diff --git a/src/api/ManagementApi.js b/src/api/ManagementApi.js index 46d82fc8..cf212371 100644 --- a/src/api/ManagementApi.js +++ b/src/api/ManagementApi.js @@ -58,7 +58,6 @@ import InlineResponse20026 from '../model/InlineResponse20026'; import InlineResponse20027 from '../model/InlineResponse20027'; import InlineResponse20028 from '../model/InlineResponse20028'; import InlineResponse20029 from '../model/InlineResponse20029'; -import InlineResponse2003 from '../model/InlineResponse2003'; import InlineResponse20030 from '../model/InlineResponse20030'; import InlineResponse20031 from '../model/InlineResponse20031'; import InlineResponse20032 from '../model/InlineResponse20032'; @@ -69,9 +68,10 @@ import InlineResponse20036 from '../model/InlineResponse20036'; import InlineResponse20037 from '../model/InlineResponse20037'; import InlineResponse20038 from '../model/InlineResponse20038'; import InlineResponse20039 from '../model/InlineResponse20039'; -import InlineResponse2004 from '../model/InlineResponse2004'; import InlineResponse20040 from '../model/InlineResponse20040'; import InlineResponse20041 from '../model/InlineResponse20041'; +import InlineResponse20042 from '../model/InlineResponse20042'; +import InlineResponse20043 from '../model/InlineResponse20043'; import InlineResponse2005 from '../model/InlineResponse2005'; import InlineResponse2006 from '../model/InlineResponse2006'; import InlineResponse2007 from '../model/InlineResponse2007'; @@ -79,9 +79,9 @@ import InlineResponse2008 from '../model/InlineResponse2008'; import InlineResponse2009 from '../model/InlineResponse2009'; import LoginParams from '../model/LoginParams'; import LoyaltyCard from '../model/LoyaltyCard'; +import LoyaltyDashboardData from '../model/LoyaltyDashboardData'; import LoyaltyLedger from '../model/LoyaltyLedger'; import LoyaltyProgram from '../model/LoyaltyProgram'; -import LoyaltyStatistics from '../model/LoyaltyStatistics'; import ModelImport from '../model/ModelImport'; import NewAdditionalCost from '../model/NewAdditionalCost'; import NewAttribute from '../model/NewAttribute'; @@ -91,14 +91,15 @@ import NewCollection from '../model/NewCollection'; import NewCouponCreationJob from '../model/NewCouponCreationJob'; import NewCoupons from '../model/NewCoupons'; import NewCouponsForMultipleRecipients from '../model/NewCouponsForMultipleRecipients'; -import NewNotificationWebhook from '../model/NewNotificationWebhook'; import NewPassword from '../model/NewPassword'; import NewPasswordEmail from '../model/NewPasswordEmail'; -import NotificationWebhook from '../model/NotificationWebhook'; +import NewStore from '../model/NewStore'; +import NotificationActivation from '../model/NotificationActivation'; import Referral from '../model/Referral'; import Role from '../model/Role'; import Ruleset from '../model/Ruleset'; import Session from '../model/Session'; +import Store from '../model/Store'; import TransferLoyaltyCard from '../model/TransferLoyaltyCard'; import UpdateCampaign from '../model/UpdateCampaign'; import UpdateCampaignCollection from '../model/UpdateCampaignCollection'; @@ -113,7 +114,7 @@ import Webhook from '../model/Webhook'; /** * Management service. * @module api/ManagementApi -* @version 5.0.1 +* @version 6.0.0 */ export default class ManagementApi { @@ -258,7 +259,7 @@ export default class ManagementApi { * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/CampaignCopy} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2006} and HTTP response */ copyCampaignToApplicationsWithHttpInfo(applicationId, campaignId, body) { let postBody = body; @@ -289,7 +290,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2004; + let returnType = InlineResponse2006; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/copy', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -303,7 +304,7 @@ export default class ManagementApi { * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/CampaignCopy} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2006} */ copyCampaignToApplications(applicationId, campaignId, body) { return this.copyCampaignToApplicationsWithHttpInfo(applicationId, campaignId, body) @@ -315,7 +316,7 @@ export default class ManagementApi { /** * Create account-level collection - * Create account-level collection. + * Create an account-level collection. * @param {module:model/NewCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Collection} and HTTP response */ @@ -348,7 +349,7 @@ export default class ManagementApi { /** * Create account-level collection - * Create account-level collection. + * Create an account-level collection. * @param {module:model/NewCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Collection} */ @@ -509,8 +510,8 @@ export default class ManagementApi { /** - * Create collection - * Create a collection. + * Create campaign-level collection + * Create a campaign-level collection in a given campaign. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/NewCampaignCollection} body body @@ -554,8 +555,8 @@ export default class ManagementApi { } /** - * Create collection - * Create a collection. + * Create campaign-level collection + * Create a campaign-level collection in a given campaign. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/NewCampaignCollection} body body @@ -577,7 +578,7 @@ export default class ManagementApi { * @param {module:model/NewCoupons} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2007} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2008} and HTTP response */ createCouponsWithHttpInfo(applicationId, campaignId, body, opts) { opts = opts || {}; @@ -610,7 +611,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2007; + let returnType = InlineResponse2008; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -626,7 +627,7 @@ export default class ManagementApi { * @param {module:model/NewCoupons} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2007} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2008} */ createCoupons(applicationId, campaignId, body, opts) { return this.createCouponsWithHttpInfo(applicationId, campaignId, body, opts) @@ -705,7 +706,7 @@ export default class ManagementApi { * @param {module:model/NewCouponsForMultipleRecipients} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2007} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2008} and HTTP response */ createCouponsForMultipleRecipientsWithHttpInfo(applicationId, campaignId, body, opts) { opts = opts || {}; @@ -738,7 +739,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2007; + let returnType = InlineResponse2008; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -754,7 +755,7 @@ export default class ManagementApi { * @param {module:model/NewCouponsForMultipleRecipients} body body * @param {Object} [opts] Optional parameters * @param {String=} [opts.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. (default to 'yes') - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2007} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2008} */ createCouponsForMultipleRecipients(applicationId, campaignId, body, opts) { return this.createCouponsForMultipleRecipientsWithHttpInfo(applicationId, campaignId, body, opts) @@ -765,25 +766,19 @@ export default class ManagementApi { /** - * Create notification about campaign-related changes - * 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). - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {module:model/NewNotificationWebhook} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotificationWebhook} and HTTP response + * Request a password reset + * 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. + * @param {module:model/NewPasswordEmail} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NewPasswordEmail} and HTTP response */ - createNotificationWebhookWithHttpInfo(applicationId, body) { + createPasswordRecoveryEmailWithHttpInfo(body) { let postBody = body; - // verify the required parameter 'applicationId' is set - if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling createNotificationWebhook"); - } // verify the required parameter 'body' is set if (body === undefined || body === null) { - throw new Error("Missing the required parameter 'body' when calling createNotificationWebhook"); + throw new Error("Missing the required parameter 'body' when calling createPasswordRecoveryEmail"); } let pathParams = { - 'applicationId': applicationId }; let queryParams = { }; @@ -795,23 +790,22 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = NotificationWebhook; + let returnType = NewPasswordEmail; return this.apiClient.callApi( - '/v1/applications/{applicationId}/notification_webhooks', 'POST', + '/v1/password_recovery_emails', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Create notification about campaign-related changes - * 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). - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {module:model/NewNotificationWebhook} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotificationWebhook} + * Request a password reset + * 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. + * @param {module:model/NewPasswordEmail} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NewPasswordEmail} */ - createNotificationWebhook(applicationId, body) { - return this.createNotificationWebhookWithHttpInfo(applicationId, body) + createPasswordRecoveryEmail(body) { + return this.createPasswordRecoveryEmailWithHttpInfo(body) .then(function(response_and_data) { return response_and_data.data; }); @@ -819,16 +813,16 @@ export default class ManagementApi { /** - * Request a password reset - * 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. - * @param {module:model/NewPasswordEmail} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NewPasswordEmail} and HTTP response + * Create session + * 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.

Granular API key

Instead of using a session, you can also use the Management API key feature in the Campaign Manager to decide which endpoints can be used with a given key.
+ * @param {module:model/LoginParams} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Session} and HTTP response */ - createPasswordRecoveryEmailWithHttpInfo(body) { + createSessionWithHttpInfo(body) { let postBody = body; // verify the required parameter 'body' is set if (body === undefined || body === null) { - throw new Error("Missing the required parameter 'body' when calling createPasswordRecoveryEmail"); + throw new Error("Missing the required parameter 'body' when calling createSession"); } let pathParams = { @@ -843,22 +837,22 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = NewPasswordEmail; + let returnType = Session; return this.apiClient.callApi( - '/v1/password_recovery_emails', 'POST', + '/v1/sessions', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Request a password reset - * 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. - * @param {module:model/NewPasswordEmail} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NewPasswordEmail} + * Create session + * 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.

Granular API key

Instead of using a session, you can also use the Management API key feature in the Campaign Manager to decide which endpoints can be used with a given key.
+ * @param {module:model/LoginParams} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Session} */ - createPasswordRecoveryEmail(body) { - return this.createPasswordRecoveryEmailWithHttpInfo(body) + createSession(body) { + return this.createSessionWithHttpInfo(body) .then(function(response_and_data) { return response_and_data.data; }); @@ -866,19 +860,25 @@ export default class ManagementApi { /** - * Create session - * 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.

Granular API key

Instead of using a session, you can also use the Management API key feature in the Campaign Manager to decide which endpoints can be used with a given key.
- * @param {module:model/LoginParams} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Session} and HTTP response + * Create store + * Create a new store in a specific Application. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {module:model/NewStore} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Store} and HTTP response */ - createSessionWithHttpInfo(body) { + createStoreWithHttpInfo(applicationId, body) { let postBody = body; + // verify the required parameter 'applicationId' is set + if (applicationId === undefined || applicationId === null) { + throw new Error("Missing the required parameter 'applicationId' when calling createStore"); + } // verify the required parameter 'body' is set if (body === undefined || body === null) { - throw new Error("Missing the required parameter 'body' when calling createSession"); + throw new Error("Missing the required parameter 'body' when calling createStore"); } let pathParams = { + 'applicationId': applicationId }; let queryParams = { }; @@ -890,22 +890,23 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = Session; + let returnType = Store; return this.apiClient.callApi( - '/v1/sessions', 'POST', + '/v1/applications/{applicationId}/stores', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Create session - * 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.

Granular API key

Instead of using a session, you can also use the Management API key feature in the Campaign Manager to decide which endpoints can be used with a given key.
- * @param {module:model/LoginParams} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Session} + * Create store + * Create a new store in a specific Application. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {module:model/NewStore} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Store} */ - createSession(body) { - return this.createSessionWithHttpInfo(body) + createStore(applicationId, body) { + return this.createStoreWithHttpInfo(applicationId, body) .then(function(response_and_data) { return response_and_data.data; }); @@ -975,8 +976,8 @@ export default class ManagementApi { /** * Delete account-level collection - * Delete the given account-level collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Delete a given account-level collection. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ deleteAccountCollectionWithHttpInfo(collectionId) { @@ -1009,8 +1010,8 @@ export default class ManagementApi { /** * Delete account-level collection - * Delete the given account-level collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Delete a given account-level collection. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ deleteAccountCollection(collectionId) { @@ -1077,11 +1078,11 @@ export default class ManagementApi { /** - * Delete collection - * Delete the given collection. + * Delete campaign-level collection + * Delete a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ deleteCollectionWithHttpInfo(applicationId, campaignId, collectionId) { @@ -1123,11 +1124,11 @@ export default class ManagementApi { } /** - * Delete collection - * Delete the given collection. + * Delete campaign-level collection + * Delete a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ deleteCollection(applicationId, campaignId, collectionId) { @@ -1353,26 +1354,32 @@ export default class ManagementApi { /** - * Delete notification about campaign-related changes - * Remove the given existing [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + * Delete referral + * Delete the specified referral. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. + * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param {String} referralId The ID of the referral code. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ - deleteNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId) { + deleteReferralWithHttpInfo(applicationId, campaignId, referralId) { let postBody = null; // verify the required parameter 'applicationId' is set if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling deleteNotificationWebhook"); + throw new Error("Missing the required parameter 'applicationId' when calling deleteReferral"); + } + // verify the required parameter 'campaignId' is set + if (campaignId === undefined || campaignId === null) { + throw new Error("Missing the required parameter 'campaignId' when calling deleteReferral"); } - // verify the required parameter 'notificationWebhookId' is set - if (notificationWebhookId === undefined || notificationWebhookId === null) { - throw new Error("Missing the required parameter 'notificationWebhookId' when calling deleteNotificationWebhook"); + // verify the required parameter 'referralId' is set + if (referralId === undefined || referralId === null) { + throw new Error("Missing the required parameter 'referralId' when calling deleteReferral"); } let pathParams = { 'applicationId': applicationId, - 'notificationWebhookId': notificationWebhookId + 'campaignId': campaignId, + 'referralId': referralId }; let queryParams = { }; @@ -1386,21 +1393,22 @@ export default class ManagementApi { let accepts = []; let returnType = null; return this.apiClient.callApi( - '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}', 'DELETE', + '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Delete notification about campaign-related changes - * Remove the given existing [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + * Delete referral + * Delete the specified referral. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. + * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param {String} referralId The ID of the referral code. * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ - deleteNotificationWebhook(applicationId, notificationWebhookId) { - return this.deleteNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId) + deleteReferral(applicationId, campaignId, referralId) { + return this.deleteReferralWithHttpInfo(applicationId, campaignId, referralId) .then(function(response_and_data) { return response_and_data.data; }); @@ -1408,32 +1416,26 @@ export default class ManagementApi { /** - * Delete referral - * Delete the specified referral. + * Delete store + * Delete the specified store. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {String} referralId The ID of the referral code. + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ - deleteReferralWithHttpInfo(applicationId, campaignId, referralId) { + deleteStoreWithHttpInfo(applicationId, storeId) { let postBody = null; // verify the required parameter 'applicationId' is set if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling deleteReferral"); - } - // verify the required parameter 'campaignId' is set - if (campaignId === undefined || campaignId === null) { - throw new Error("Missing the required parameter 'campaignId' when calling deleteReferral"); + throw new Error("Missing the required parameter 'applicationId' when calling deleteStore"); } - // verify the required parameter 'referralId' is set - if (referralId === undefined || referralId === null) { - throw new Error("Missing the required parameter 'referralId' when calling deleteReferral"); + // verify the required parameter 'storeId' is set + if (storeId === undefined || storeId === null) { + throw new Error("Missing the required parameter 'storeId' when calling deleteStore"); } let pathParams = { 'applicationId': applicationId, - 'campaignId': campaignId, - 'referralId': referralId + 'storeId': storeId }; let queryParams = { }; @@ -1444,25 +1446,24 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; - let accepts = []; + let accepts = ['application/json']; let returnType = null; return this.apiClient.callApi( - '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}', 'DELETE', + '/v1/applications/{applicationId}/stores/{storeId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Delete referral - * Delete the specified referral. + * Delete store + * Delete the specified store. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {String} referralId The ID of the referral code. + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ - deleteReferral(applicationId, campaignId, referralId) { - return this.deleteReferralWithHttpInfo(applicationId, campaignId, referralId) + deleteStore(applicationId, storeId) { + return this.deleteStoreWithHttpInfo(applicationId, storeId) .then(function(response_and_data) { return response_and_data.data; }); @@ -1512,8 +1513,8 @@ export default class ManagementApi { /** * Export account-level collection's items - * 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/). - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Download a CSV file containing items from a given 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/). + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportAccountCollectionItemsWithHttpInfo(collectionId) { @@ -1546,8 +1547,8 @@ export default class ManagementApi { /** * Export account-level collection's items - * 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/). - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Download a CSV file containing items from a given 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/). + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportAccountCollectionItems(collectionId) { @@ -1559,11 +1560,11 @@ export default class ManagementApi { /** - * Export a collection's items - * 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/). + * Export campaign-level collection's items + * Download a CSV file containing items from a given campaign-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/). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportCollectionItemsWithHttpInfo(applicationId, campaignId, collectionId) { @@ -1605,11 +1606,11 @@ export default class ManagementApi { } /** - * Export a collection's items - * 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/). + * Export campaign-level collection's items + * Download a CSV file containing items from a given campaign-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/). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportCollectionItems(applicationId, campaignId, collectionId) { @@ -1622,7 +1623,7 @@ export default class ManagementApi { /** * Export coupons - * 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. + * 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 can contain 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.campaignId] Filter results by campaign. @@ -1633,11 +1634,12 @@ export default class ManagementApi { * @param {module:model/String=} [opts.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. * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. * @param {Number=} [opts.referralId] Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. * @param {String=} [opts.batchId] Filter results by batches of coupons - * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) + * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code. (default to false) * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document. * @param {module:model/String=} [opts.campaignState] 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. + * @param {Boolean=} [opts.valuesOnly] Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false) * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportCouponsWithHttpInfo(applicationId, opts) { @@ -1664,7 +1666,8 @@ export default class ManagementApi { 'batchId': opts['batchId'], 'exactMatch': opts['exactMatch'], 'dateFormat': opts['dateFormat'], - 'campaignState': opts['campaignState'] + 'campaignState': opts['campaignState'], + 'valuesOnly': opts['valuesOnly'] }; let headerParams = { }; @@ -1684,7 +1687,7 @@ export default class ManagementApi { /** * Export coupons - * 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. + * 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 can contain 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.campaignId] Filter results by campaign. @@ -1695,11 +1698,12 @@ export default class ManagementApi { * @param {module:model/String=} [opts.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. * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. * @param {Number=} [opts.referralId] Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. * @param {String=} [opts.batchId] Filter results by batches of coupons - * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) + * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code. (default to false) * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document. * @param {module:model/String=} [opts.campaignState] 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. + * @param {Boolean=} [opts.valuesOnly] Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false) * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportCoupons(applicationId, opts) { @@ -1712,7 +1716,7 @@ export default class ManagementApi { /** * Export customer sessions - * 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. + * 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-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `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. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. @@ -1758,7 +1762,7 @@ export default class ManagementApi { /** * Export customer sessions - * 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. + * 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-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `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. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. @@ -1776,9 +1780,66 @@ export default class ManagementApi { } + /** + * Export customers' tier data + * Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported. + * @param {String} loyaltyProgramId The identifier for the loyalty program. + * @param {Object} [opts] Optional parameters + * @param {Array.=} [opts.subledgerIds] An array of subledgers IDs to filter the export by. + * @param {Array.=} [opts.tierNames] An array of tier names to filter the export by. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response + */ + exportCustomersTiersWithHttpInfo(loyaltyProgramId, opts) { + opts = opts || {}; + let postBody = null; + // verify the required parameter 'loyaltyProgramId' is set + if (loyaltyProgramId === undefined || loyaltyProgramId === null) { + throw new Error("Missing the required parameter 'loyaltyProgramId' when calling exportCustomersTiers"); + } + + let pathParams = { + 'loyaltyProgramId': loyaltyProgramId + }; + let queryParams = { + 'subledgerIds': this.apiClient.buildCollectionParam(opts['subledgerIds'], 'csv'), + 'tierNames': this.apiClient.buildCollectionParam(opts['tierNames'], 'csv') + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['management_key', 'manager_auth']; + let contentTypes = []; + let accepts = ['application/csv']; + let returnType = 'String'; + return this.apiClient.callApi( + '/v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Export customers' tier data + * Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported. + * @param {String} loyaltyProgramId The identifier for the loyalty program. + * @param {Object} [opts] Optional parameters + * @param {Array.=} [opts.subledgerIds] An array of subledgers IDs to filter the export by. + * @param {Array.=} [opts.tierNames] An array of tier names to filter the export by. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} + */ + exportCustomersTiers(loyaltyProgramId, opts) { + return this.exportCustomersTiersWithHttpInfo(loyaltyProgramId, opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Export triggered effects - * 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. + * 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/entities/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. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.campaignId] Filter results by campaign. @@ -1822,7 +1883,7 @@ export default class ManagementApi { /** * Export triggered effects - * 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. + * 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/entities/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. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.campaignId] Filter results by campaign. @@ -1844,7 +1905,7 @@ export default class ManagementApi { * ⚠️ 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/). * @param {String} loyaltyProgramId The identifier for the loyalty program. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportLoyaltyBalanceWithHttpInfo(loyaltyProgramId, opts) { @@ -1882,7 +1943,7 @@ export default class ManagementApi { * ⚠️ 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/). * @param {String} loyaltyProgramId The identifier for the loyalty program. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportLoyaltyBalance(loyaltyProgramId, opts) { @@ -1898,7 +1959,7 @@ export default class ManagementApi { * 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. * @param {String} loyaltyProgramId The identifier for the loyalty program. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportLoyaltyBalancesWithHttpInfo(loyaltyProgramId, opts) { @@ -1936,7 +1997,7 @@ export default class ManagementApi { * 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. * @param {String} loyaltyProgramId The identifier for the loyalty program. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportLoyaltyBalances(loyaltyProgramId, opts) { @@ -1952,7 +2013,7 @@ export default class ManagementApi { * 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. * @param {Number} loyaltyProgramId 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. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response */ exportLoyaltyCardBalancesWithHttpInfo(loyaltyProgramId, opts) { @@ -1990,7 +2051,7 @@ export default class ManagementApi { * 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. * @param {Number} loyaltyProgramId 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. * @param {Object} [opts] Optional parameters - * @param {Date=} [opts.endDate] 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. + * @param {Date=} [opts.endDate] Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** It must be an RFC3339 timestamp string. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} */ exportLoyaltyCardBalances(loyaltyProgramId, opts) { @@ -2293,7 +2354,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20018} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20019} and HTTP response */ getAccessLogsWithoutTotalCountWithHttpInfo(applicationId, rangeStart, rangeEnd, opts) { opts = opts || {}; @@ -2332,7 +2393,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20018; + let returnType = InlineResponse20019; return this.apiClient.callApi( '/v1/applications/{applicationId}/access_logs/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2353,7 +2414,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20018} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20019} */ getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, opts) { return this.getAccessLogsWithoutTotalCountWithHttpInfo(applicationId, rangeStart, rangeEnd, opts) @@ -2462,7 +2523,7 @@ export default class ManagementApi { /** * Get account-level collection * Retrieve a given account-level collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Collection} and HTTP response */ getAccountCollectionWithHttpInfo(collectionId) { @@ -2496,7 +2557,7 @@ export default class ManagementApi { /** * Get account-level collection * Retrieve a given account-level collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Collection} */ getAccountCollection(collectionId) { @@ -2562,7 +2623,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20033} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20034} and HTTP response */ getAdditionalCostsWithHttpInfo(opts) { opts = opts || {}; @@ -2583,7 +2644,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20033; + let returnType = InlineResponse20034; return this.apiClient.callApi( '/v1/additional_costs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2598,7 +2659,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20033} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20034} */ getAdditionalCosts(opts) { return this.getAdditionalCostsWithHttpInfo(opts) @@ -2620,7 +2681,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20019} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20020} and HTTP response */ getAllAccessLogsWithHttpInfo(rangeStart, rangeEnd, opts) { opts = opts || {}; @@ -2654,7 +2715,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20019; + let returnType = InlineResponse20020; return this.apiClient.callApi( '/v1/access_logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2674,7 +2735,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20019} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20020} */ getAllAccessLogs(rangeStart, rangeEnd, opts) { return this.getAllAccessLogsWithHttpInfo(rangeStart, rangeEnd, opts) @@ -2687,7 +2748,7 @@ export default class ManagementApi { /** * List roles * List all roles. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20041} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20042} and HTTP response */ getAllRolesWithHttpInfo() { let postBody = null; @@ -2704,7 +2765,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20041; + let returnType = InlineResponse20042; return this.apiClient.callApi( '/v1/roles', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2715,7 +2776,7 @@ export default class ManagementApi { /** * List roles * List all roles. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20041} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20042} */ getAllRoles() { return this.getAllRolesWithHttpInfo() @@ -2886,7 +2947,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20030} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20031} and HTTP response */ getApplicationCustomerFriendsWithHttpInfo(applicationId, integrationId, opts) { opts = opts || {}; @@ -2918,7 +2979,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20030; + let returnType = InlineResponse20031; return this.apiClient.callApi( '/v1/applications/{applicationId}/profile/{integrationId}/friends', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2936,7 +2997,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20030} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20031} */ getApplicationCustomerFriends(applicationId, integrationId, opts) { return this.getApplicationCustomerFriendsWithHttpInfo(applicationId, integrationId, opts) @@ -2955,7 +3016,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20021} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20022} and HTTP response */ getApplicationCustomersWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -2982,7 +3043,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20021; + let returnType = InlineResponse20022; return this.apiClient.callApi( '/v1/applications/{applicationId}/customers', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -2999,7 +3060,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20021} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20022} */ getApplicationCustomers(applicationId, opts) { return this.getApplicationCustomersWithHttpInfo(applicationId, opts) @@ -3018,7 +3079,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20022} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20023} and HTTP response */ getApplicationCustomersByAttributesWithHttpInfo(applicationId, body, opts) { opts = opts || {}; @@ -3048,7 +3109,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse20022; + let returnType = InlineResponse20023; return this.apiClient.callApi( '/v1/applications/{applicationId}/customer_search', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -3065,7 +3126,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20022} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20023} */ getApplicationCustomersByAttributes(applicationId, body, opts) { return this.getApplicationCustomersByAttributesWithHttpInfo(applicationId, body, opts) @@ -3083,7 +3144,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20028} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20029} and HTTP response */ getApplicationEventTypesWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -3109,7 +3170,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20028; + let returnType = InlineResponse20029; return this.apiClient.callApi( '/v1/applications/{applicationId}/event_types', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3125,7 +3186,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20028} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20029} */ getApplicationEventTypes(applicationId, opts) { return this.getApplicationEventTypesWithHttpInfo(applicationId, opts) @@ -3154,7 +3215,7 @@ export default class ManagementApi { * @param {String=} [opts.referralCode] Referral code * @param {String=} [opts.ruleQuery] Rule name filter for events * @param {String=} [opts.campaignQuery] Campaign name filter for events - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20027} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20028} and HTTP response */ getApplicationEventsWithoutTotalCountWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -3191,7 +3252,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20027; + let returnType = InlineResponse20028; return this.apiClient.callApi( '/v1/applications/{applicationId}/events/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3218,7 +3279,7 @@ export default class ManagementApi { * @param {String=} [opts.referralCode] Referral code * @param {String=} [opts.ruleQuery] Rule name filter for events * @param {String=} [opts.campaignQuery] Campaign name filter for events - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20027} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20028} */ getApplicationEventsWithoutTotalCount(applicationId, opts) { return this.getApplicationEventsWithoutTotalCountWithHttpInfo(applicationId, opts) @@ -3298,7 +3359,7 @@ export default class ManagementApi { * @param {String=} [opts.coupon] Filter by sessions with this coupon. Must be exact match. * @param {String=} [opts.referral] Filter by sessions with this referral. Must be exact match. * @param {String=} [opts.integrationId] Filter by sessions with this integrationId. Must be exact match. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20026} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20027} and HTTP response */ getApplicationSessionsWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -3331,7 +3392,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20026; + let returnType = InlineResponse20027; return this.apiClient.callApi( '/v1/applications/{applicationId}/sessions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3354,7 +3415,7 @@ export default class ManagementApi { * @param {String=} [opts.coupon] Filter by sessions with this coupon. Must be exact match. * @param {String=} [opts.referral] Filter by sessions with this referral. Must be exact match. * @param {String=} [opts.integrationId] Filter by sessions with this integrationId. Must be exact match. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20026} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20027} */ getApplicationSessions(applicationId, opts) { return this.getApplicationSessionsWithHttpInfo(applicationId, opts) @@ -3371,7 +3432,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2003} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2005} and HTTP response */ getApplicationsWithHttpInfo(opts) { opts = opts || {}; @@ -3392,7 +3453,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse2003; + let returnType = InlineResponse2005; return this.apiClient.callApi( '/v1/applications', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3407,7 +3468,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2003} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2005} */ getApplications(opts) { return this.getApplicationsWithHttpInfo(opts) @@ -3473,7 +3534,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {String=} [opts.entity] Returned attributes will be filtered by supplied entity. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20031} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20032} and HTTP response */ getAttributesWithHttpInfo(opts) { opts = opts || {}; @@ -3495,7 +3556,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20031; + let returnType = InlineResponse20032; return this.apiClient.callApi( '/v1/attributes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3511,7 +3572,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {String=} [opts.entity] Returned attributes will be filtered by supplied entity. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20031} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20032} */ getAttributes(opts) { return this.getAttributesWithHttpInfo(opts) @@ -3529,7 +3590,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20029} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20030} and HTTP response */ getAudiencesWithHttpInfo(opts) { opts = opts || {}; @@ -3551,7 +3612,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20029; + let returnType = InlineResponse20030; return this.apiClient.callApi( '/v1/audiences', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3567,7 +3628,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20029} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20030} */ getAudiences(opts) { return this.getAudiencesWithHttpInfo(opts) @@ -3641,7 +3702,7 @@ export default class ManagementApi { * @param {Date} rangeEnd Only return results from before this timestamp. This must be an RFC3339 timestamp string. * @param {Object} [opts] Optional parameters * @param {module:model/String=} [opts.granularity] The time interval between the results in the returned time-series. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20020} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20021} and HTTP response */ getCampaignAnalyticsWithHttpInfo(applicationId, campaignId, rangeStart, rangeEnd, opts) { opts = opts || {}; @@ -3680,7 +3741,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20020; + let returnType = InlineResponse20021; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/analytics', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3697,7 +3758,7 @@ export default class ManagementApi { * @param {Date} rangeEnd Only return results from before this timestamp. This must be an RFC3339 timestamp string. * @param {Object} [opts] Optional parameters * @param {module:model/String=} [opts.granularity] The time interval between the results in the returned time-series. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20020} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20021} */ getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, opts) { return this.getCampaignAnalyticsWithHttpInfo(applicationId, campaignId, rangeStart, rangeEnd, opts) @@ -3717,7 +3778,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {module:model/String=} [opts.campaignState] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2006} and HTTP response */ getCampaignByAttributesWithHttpInfo(applicationId, body, opts) { opts = opts || {}; @@ -3748,7 +3809,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2004; + let returnType = InlineResponse2006; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns_search', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -3766,7 +3827,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {module:model/String=} [opts.campaignState] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2006} */ getCampaignByAttributes(applicationId, body, opts) { return this.getCampaignByAttributesWithHttpInfo(applicationId, body, opts) @@ -3787,7 +3848,7 @@ export default class ManagementApi { * @param {String=} [opts.name] Filter results performing case-insensitive matching against the name of the campaign template. * @param {String=} [opts.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. * @param {Number=} [opts.userId] Filter results by user ID. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20010} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20011} and HTTP response */ getCampaignTemplatesWithHttpInfo(opts) { opts = opts || {}; @@ -3812,7 +3873,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20010; + let returnType = InlineResponse20011; return this.apiClient.callApi( '/v1/campaign_templates', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3831,7 +3892,7 @@ export default class ManagementApi { * @param {String=} [opts.name] Filter results performing case-insensitive matching against the name of the campaign template. * @param {String=} [opts.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. * @param {Number=} [opts.userId] Filter results by user ID. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20010} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20011} */ getCampaignTemplates(opts) { return this.getCampaignTemplatesWithHttpInfo(opts) @@ -3854,9 +3915,10 @@ export default class ManagementApi { * @param {String=} [opts.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 * @param {Date=} [opts.createdBefore] 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. * @param {Date=} [opts.createdAfter] 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. - * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign group ID. + * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign access group ID. * @param {Number=} [opts.templateId] The ID of the Campaign Template this Campaign was created from. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response + * @param {Number=} [opts.storeId] Filter results to campaigns linked to the specified store ID. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2006} and HTTP response */ getCampaignsWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -3879,7 +3941,8 @@ export default class ManagementApi { 'createdBefore': opts['createdBefore'], 'createdAfter': opts['createdAfter'], 'campaignGroupId': opts['campaignGroupId'], - 'templateId': opts['templateId'] + 'templateId': opts['templateId'], + 'storeId': opts['storeId'] }; let headerParams = { }; @@ -3889,7 +3952,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse2004; + let returnType = InlineResponse2006; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3910,9 +3973,10 @@ export default class ManagementApi { * @param {String=} [opts.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 * @param {Date=} [opts.createdBefore] 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. * @param {Date=} [opts.createdAfter] 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. - * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign group ID. + * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign access group ID. * @param {Number=} [opts.templateId] The ID of the Campaign Template this Campaign was created from. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004} + * @param {Number=} [opts.storeId] Filter results to campaigns linked to the specified store ID. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2006} */ getCampaigns(applicationId, opts) { return this.getCampaignsWithHttpInfo(applicationId, opts) @@ -3937,7 +4001,7 @@ export default class ManagementApi { * @param {Boolean=} [opts.withTotalResultSize] 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. * @param {Number=} [opts.managementKeyId] Filter results that match the given management key ID. * @param {Boolean=} [opts.includeOld] When this flag is set to false, the state without the change will not be returned. The default value is true. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20039} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20040} and HTTP response */ getChangesWithHttpInfo(opts) { opts = opts || {}; @@ -3966,7 +4030,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20039; + let returnType = InlineResponse20040; return this.apiClient.callApi( '/v1/changes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -3989,7 +4053,7 @@ export default class ManagementApi { * @param {Boolean=} [opts.withTotalResultSize] 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. * @param {Number=} [opts.managementKeyId] Filter results that match the given management key ID. * @param {Boolean=} [opts.includeOld] When this flag is set to false, the state without the change will not be returned. The default value is true. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20039} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20040} */ getChanges(opts) { return this.getChangesWithHttpInfo(opts) @@ -4000,11 +4064,11 @@ export default class ManagementApi { /** - * Get collection - * Retrieve a given collection. + * Get campaign-level collection + * Retrieve a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Collection} and HTTP response */ getCollectionWithHttpInfo(applicationId, campaignId, collectionId) { @@ -4046,11 +4110,11 @@ export default class ManagementApi { } /** - * Get collection - * Retrieve a given collection. + * Get campaign-level collection + * Retrieve a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Collection} */ getCollection(applicationId, campaignId, collectionId) { @@ -4063,12 +4127,12 @@ export default class ManagementApi { /** * Get collection items - * Retrieve the items from the given collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20016} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20017} and HTTP response */ getCollectionItemsWithHttpInfo(collectionId, opts) { opts = opts || {}; @@ -4093,7 +4157,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20016; + let returnType = InlineResponse20017; return this.apiClient.callApi( '/v1/collections/{collectionId}/items', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4103,12 +4167,12 @@ export default class ManagementApi { /** * Get collection items - * Retrieve the items from the given collection. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20016} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20017} */ getCollectionItems(collectionId, opts) { return this.getCollectionItemsWithHttpInfo(collectionId, opts) @@ -4136,7 +4200,7 @@ export default class ManagementApi { * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field * @param {String=} [opts.batchId] Filter results by batches of coupons * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2008} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response */ getCouponsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) { opts = opts || {}; @@ -4176,7 +4240,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse2008; + let returnType = InlineResponse2009; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4202,7 +4266,7 @@ export default class ManagementApi { * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field * @param {String=} [opts.batchId] Filter results by batches of coupons * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2008} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009} */ getCouponsWithoutTotalCount(applicationId, campaignId, opts) { return this.getCouponsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) @@ -4304,7 +4368,7 @@ export default class ManagementApi { * @param {String=} [opts.integrationId] Filter results performing an exact matching against the profile integration identifier. * @param {String=} [opts.campaignName] Only return reports matching the campaignName * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20025} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20026} and HTTP response */ getCustomerActivityReportsWithoutTotalCountWithHttpInfo(rangeStart, rangeEnd, applicationId, opts) { opts = opts || {}; @@ -4344,7 +4408,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20025; + let returnType = InlineResponse20026; return this.apiClient.callApi( '/v1/applications/{applicationId}/customer_activity_reports/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4366,7 +4430,7 @@ export default class ManagementApi { * @param {String=} [opts.integrationId] Filter results performing an exact matching against the profile integration identifier. * @param {String=} [opts.campaignName] Only return reports matching the campaignName * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20025} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20026} */ getCustomerActivityReportsWithoutTotalCount(rangeStart, rangeEnd, applicationId, opts) { return this.getCustomerActivityReportsWithoutTotalCountWithHttpInfo(rangeStart, rangeEnd, applicationId, opts) @@ -4498,7 +4562,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.sandbox] Indicates whether you are pointing to a sandbox or Live customer. (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20024} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20025} and HTTP response */ getCustomerProfilesWithHttpInfo(opts) { opts = opts || {}; @@ -4519,7 +4583,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20024; + let returnType = InlineResponse20025; return this.apiClient.callApi( '/v1/customers/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4534,7 +4598,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.sandbox] Indicates whether you are pointing to a sandbox or Live customer. (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20024} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20025} */ getCustomerProfiles(opts) { return this.getCustomerProfilesWithHttpInfo(opts) @@ -4552,7 +4616,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.sandbox] Indicates whether you are pointing to a sandbox or Live customer. (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20023} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20024} and HTTP response */ getCustomersByAttributesWithHttpInfo(body, opts) { opts = opts || {}; @@ -4577,7 +4641,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse20023; + let returnType = InlineResponse20024; return this.apiClient.callApi( '/v1/customer_search/no_total', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -4593,7 +4657,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.sandbox] Indicates whether you are pointing to a sandbox or Live customer. (default to false) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20023} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20024} */ getCustomersByAttributes(body, opts) { return this.getCustomersByAttributesWithHttpInfo(body, opts) @@ -4612,7 +4676,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20037} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20038} and HTTP response */ getEventTypesWithHttpInfo(opts) { opts = opts || {}; @@ -4635,7 +4699,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20037; + let returnType = InlineResponse20038; return this.apiClient.callApi( '/v1/event_types', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4652,7 +4716,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20037} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20038} */ getEventTypes(opts) { return this.getEventTypesWithHttpInfo(opts) @@ -4671,7 +4735,7 @@ export default class ManagementApi { * @param {Number=} [opts.applicationId] Filter results by Application ID. * @param {Number=} [opts.campaignId] Filter by the campaign ID on which the limit counters are used. * @param {module:model/String=} [opts.entity] The name of the entity type that was exported. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20040} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20041} and HTTP response */ getExportsWithHttpInfo(opts) { opts = opts || {}; @@ -4694,7 +4758,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20040; + let returnType = InlineResponse20041; return this.apiClient.callApi( '/v1/exports', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4711,7 +4775,7 @@ export default class ManagementApi { * @param {Number=} [opts.applicationId] Filter results by Application ID. * @param {Number=} [opts.campaignId] Filter by the campaign ID on which the limit counters are used. * @param {module:model/String=} [opts.entity] The name of the entity type that was exported. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20040} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20041} */ getExports(opts) { return this.getExportsWithHttpInfo(opts) @@ -4778,7 +4842,7 @@ export default class ManagementApi { /** * List card's transactions - * 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. + * Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-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. * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters @@ -4787,7 +4851,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20014} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20015} and HTTP response */ getLoyaltyCardTransactionLogsWithHttpInfo(loyaltyProgramId, loyaltyCardId, opts) { opts = opts || {}; @@ -4820,7 +4884,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20014; + let returnType = InlineResponse20015; return this.apiClient.callApi( '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4830,7 +4894,7 @@ export default class ManagementApi { /** * List card's transactions - * 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. + * Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-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. * @param {Number} loyaltyProgramId 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. * @param {String} loyaltyCardId 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. * @param {Object} [opts] Optional parameters @@ -4839,7 +4903,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.subledgerId] The ID of the subledger by which we filter the data. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20014} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20015} */ getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, opts) { return this.getLoyaltyCardTransactionLogsWithHttpInfo(loyaltyProgramId, loyaltyCardId, opts) @@ -4859,7 +4923,7 @@ export default class ManagementApi { * @param {String=} [opts.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. * @param {String=} [opts.identifier] Optional query parameter to search cards by identifier. * @param {Number=} [opts.profileId] Filter by the profile ID. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20013} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20014} and HTTP response */ getLoyaltyCardsWithHttpInfo(loyaltyProgramId, opts) { opts = opts || {}; @@ -4887,7 +4951,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20013; + let returnType = InlineResponse20014; return this.apiClient.callApi( '/v1/loyalty_programs/{loyaltyProgramId}/cards', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4905,7 +4969,7 @@ export default class ManagementApi { * @param {String=} [opts.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. * @param {String=} [opts.identifier] Optional query parameter to search cards by identifier. * @param {Number=} [opts.profileId] Filter by the profile ID. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20013} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20014} */ getLoyaltyCards(loyaltyProgramId, opts) { return this.getLoyaltyCardsWithHttpInfo(loyaltyProgramId, opts) @@ -5029,7 +5093,7 @@ export default class ManagementApi { * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20012} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20013} and HTTP response */ getLoyaltyProgramTransactionsWithHttpInfo(loyaltyProgramId, opts) { opts = opts || {}; @@ -5058,7 +5122,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20012; + let returnType = InlineResponse20013; return this.apiClient.callApi( '/v1/loyalty_programs/{loyaltyProgramId}/transactions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5077,7 +5141,7 @@ export default class ManagementApi { * @param {Date=} [opts.endDate] Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. * @param {Number=} [opts.pageSize] The number of items in this response. (default to 50) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20012} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20013} */ getLoyaltyProgramTransactions(loyaltyProgramId, opts) { return this.getLoyaltyProgramTransactionsWithHttpInfo(loyaltyProgramId, opts) @@ -5090,7 +5154,7 @@ export default class ManagementApi { /** * List loyalty programs * List the loyalty programs of the account. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20011} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20012} and HTTP response */ getLoyaltyProgramsWithHttpInfo() { let postBody = null; @@ -5107,7 +5171,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20011; + let returnType = InlineResponse20012; return this.apiClient.callApi( '/v1/loyalty_programs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5118,7 +5182,7 @@ export default class ManagementApi { /** * List loyalty programs * List the loyalty programs of the account. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20011} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20012} */ getLoyaltyPrograms() { return this.getLoyaltyProgramsWithHttpInfo() @@ -5132,7 +5196,7 @@ export default class ManagementApi { * Get loyalty program statistics * 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. * @param {Number} loyaltyProgramId 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LoyaltyStatistics} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LoyaltyDashboardData} and HTTP response */ getLoyaltyStatisticsWithHttpInfo(loyaltyProgramId) { let postBody = null; @@ -5154,7 +5218,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = LoyaltyStatistics; + let returnType = LoyaltyDashboardData; return this.apiClient.callApi( '/v1/loyalty_programs/{loyaltyProgramId}/statistics', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5166,7 +5230,7 @@ export default class ManagementApi { * Get loyalty program statistics * 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. * @param {Number} loyaltyProgramId 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LoyaltyStatistics} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LoyaltyDashboardData} */ getLoyaltyStatistics(loyaltyProgramId) { return this.getLoyaltyStatisticsWithHttpInfo(loyaltyProgramId) @@ -5176,109 +5240,6 @@ export default class ManagementApi { } - /** - * Get notification about campaign-related changes - * Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotificationWebhook} and HTTP response - */ - getNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId) { - let postBody = null; - // verify the required parameter 'applicationId' is set - if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling getNotificationWebhook"); - } - // verify the required parameter 'notificationWebhookId' is set - if (notificationWebhookId === undefined || notificationWebhookId === null) { - throw new Error("Missing the required parameter 'notificationWebhookId' when calling getNotificationWebhook"); - } - - let pathParams = { - 'applicationId': applicationId, - 'notificationWebhookId': notificationWebhookId - }; - let queryParams = { - }; - let headerParams = { - }; - let formParams = { - }; - - let authNames = ['management_key', 'manager_auth']; - let contentTypes = []; - let accepts = ['application/json']; - let returnType = NotificationWebhook; - return this.apiClient.callApi( - '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}', 'GET', - pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType, null - ); - } - - /** - * Get notification about campaign-related changes - * Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotificationWebhook} - */ - getNotificationWebhook(applicationId, notificationWebhookId) { - return this.getNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId) - .then(function(response_and_data) { - return response_and_data.data; - }); - } - - - /** - * List notifications about campaign-related changes - * List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application. - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2005} and HTTP response - */ - getNotificationWebhooksWithHttpInfo(applicationId) { - let postBody = null; - // verify the required parameter 'applicationId' is set - if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling getNotificationWebhooks"); - } - - let pathParams = { - 'applicationId': applicationId - }; - let queryParams = { - }; - let headerParams = { - }; - let formParams = { - }; - - let authNames = ['management_key', 'manager_auth']; - let contentTypes = []; - let accepts = ['application/json']; - let returnType = InlineResponse2005; - return this.apiClient.callApi( - '/v1/applications/{applicationId}/notification_webhooks', 'GET', - pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType, null - ); - } - - /** - * List notifications about campaign-related changes - * List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application. - * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2005} - */ - getNotificationWebhooks(applicationId) { - return this.getNotificationWebhooksWithHttpInfo(applicationId) - .then(function(response_and_data) { - return response_and_data.data; - }); - } - - /** * List referrals * List all referrals of the specified campaign. @@ -5294,7 +5255,7 @@ export default class ManagementApi { * @param {module:model/String=} [opts.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. * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20010} and HTTP response */ getReferralsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) { opts = opts || {}; @@ -5331,7 +5292,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse2009; + let returnType = InlineResponse20010; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5354,7 +5315,7 @@ export default class ManagementApi { * @param {module:model/String=} [opts.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. * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20010} */ getReferralsWithoutTotalCount(applicationId, campaignId, opts) { return this.getReferralsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) @@ -5483,7 +5444,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2006} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2007} and HTTP response */ getRulesetsWithHttpInfo(applicationId, campaignId, opts) { opts = opts || {}; @@ -5514,7 +5475,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse2006; + let returnType = InlineResponse2007; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5531,7 +5492,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2006} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2007} */ getRulesets(applicationId, campaignId, opts) { return this.getRulesetsWithHttpInfo(applicationId, campaignId, opts) @@ -5541,6 +5502,61 @@ export default class ManagementApi { } + /** + * Get store + * Get store details for a specific store ID. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Store} and HTTP response + */ + getStoreWithHttpInfo(applicationId, storeId) { + let postBody = null; + // verify the required parameter 'applicationId' is set + if (applicationId === undefined || applicationId === null) { + throw new Error("Missing the required parameter 'applicationId' when calling getStore"); + } + // verify the required parameter 'storeId' is set + if (storeId === undefined || storeId === null) { + throw new Error("Missing the required parameter 'storeId' when calling getStore"); + } + + let pathParams = { + 'applicationId': applicationId, + 'storeId': storeId + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['management_key', 'manager_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = Store; + return this.apiClient.callApi( + '/v1/applications/{applicationId}/stores/{storeId}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Get store + * Get store details for a specific store ID. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Store} + */ + getStore(applicationId, storeId) { + return this.getStoreWithHttpInfo(applicationId, storeId) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Get user * Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile. @@ -5596,7 +5612,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20038} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20039} and HTTP response */ getUsersWithHttpInfo(opts) { opts = opts || {}; @@ -5617,7 +5633,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20038; + let returnType = InlineResponse20039; return this.apiClient.callApi( '/v1/users', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5632,7 +5648,7 @@ export default class ManagementApi { * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20038} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20039} */ getUsers(opts) { return this.getUsersWithHttpInfo(opts) @@ -5703,7 +5719,7 @@ export default class ManagementApi { * @param {Number=} [opts.campaignId] Filter results by campaign. * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20035} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20036} and HTTP response */ getWebhookActivationLogsWithHttpInfo(opts) { opts = opts || {}; @@ -5730,7 +5746,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20035; + let returnType = InlineResponse20036; return this.apiClient.callApi( '/v1/webhook_activation_logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5751,7 +5767,7 @@ export default class ManagementApi { * @param {Number=} [opts.campaignId] Filter results by campaign. * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20035} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20036} */ getWebhookActivationLogs(opts) { return this.getWebhookActivationLogsWithHttpInfo(opts) @@ -5775,7 +5791,7 @@ export default class ManagementApi { * @param {String=} [opts.requestUuid] Filter results by request UUID. * @param {Date=} [opts.createdBefore] 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. * @param {Date=} [opts.createdAfter] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20036} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20037} and HTTP response */ getWebhookLogsWithHttpInfo(opts) { opts = opts || {}; @@ -5803,7 +5819,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20036; + let returnType = InlineResponse20037; return this.apiClient.callApi( '/v1/webhook_logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5825,7 +5841,7 @@ export default class ManagementApi { * @param {String=} [opts.requestUuid] Filter results by request UUID. * @param {Date=} [opts.createdBefore] 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. * @param {Date=} [opts.createdAfter] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20036} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20037} */ getWebhookLogs(opts) { return this.getWebhookLogsWithHttpInfo(opts) @@ -5847,7 +5863,7 @@ export default class ManagementApi { * @param {module:model/String=} [opts.visibility] Filter results by visibility. * @param {Number=} [opts.outgoingIntegrationsTypeId] Filter results by outgoing integration type ID. * @param {String=} [opts.title] Filter results performing case-insensitive matching against the webhook title. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20034} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20035} and HTTP response */ getWebhooksWithHttpInfo(opts) { opts = opts || {}; @@ -5873,7 +5889,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20034; + let returnType = InlineResponse20035; return this.apiClient.callApi( '/v1/webhooks', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -5893,7 +5909,7 @@ export default class ManagementApi { * @param {module:model/String=} [opts.visibility] Filter results by visibility. * @param {Number=} [opts.outgoingIntegrationsTypeId] Filter results by outgoing integration type ID. * @param {String=} [opts.title] Filter results performing case-insensitive matching against the webhook title. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20034} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20035} */ getWebhooks(opts) { return this.getWebhooksWithHttpInfo(opts) @@ -5904,9 +5920,9 @@ export default class ManagementApi { /** - * Import data in existing account-level collection + * Import data into existing account-level collection * 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. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ModelImport} and HTTP response @@ -5942,9 +5958,9 @@ export default class ManagementApi { } /** - * Import data in existing account-level collection + * Import data into existing account-level collection * 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. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ModelImport} @@ -6012,11 +6028,11 @@ export default class ManagementApi { /** - * Import data in existing collection + * Import data into existing campaign-level collection * 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ModelImport} and HTTP response @@ -6062,11 +6078,11 @@ export default class ManagementApi { } /** - * Import data in existing collection + * Import data into existing campaign-level collection * 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ModelImport} @@ -6081,7 +6097,7 @@ export default class ManagementApi { /** * Import coupons - * 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). + * 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_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6125,7 +6141,7 @@ export default class ManagementApi { /** * Import coupons - * 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). + * 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_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6304,7 +6320,7 @@ export default class ManagementApi { /** * Import giveaway codes into a giveaway pool - * 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\"\"}\" ``` + * 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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **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\"\"}\" ``` * @param {Number} poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. @@ -6342,7 +6358,7 @@ export default class ManagementApi { /** * Import giveaway codes into a giveaway pool - * 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\"\"}\" ``` + * 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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"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. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **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\"\"}\" ``` * @param {Number} poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. * @param {Object} [opts] Optional parameters * @param {String=} [opts.upFile] The file with the information about the data that should be imported. @@ -6358,7 +6374,7 @@ export default class ManagementApi { /** * Import referrals - * 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\"\"}\" ``` + * 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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **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\"\"}\" ``` * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6402,7 +6418,7 @@ export default class ManagementApi { /** * Import referrals - * 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\"\"}\" ``` + * 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, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **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\"\"}\" ``` * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6419,14 +6435,14 @@ export default class ManagementApi { /** * List collections in account - * List collections in account. + * List account-level collections in the account. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20015} and HTTP response + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20016} and HTTP response */ listAccountCollectionsWithHttpInfo(opts) { opts = opts || {}; @@ -6449,7 +6465,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20015; + let returnType = InlineResponse20016; return this.apiClient.callApi( '/v1/collections', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -6459,14 +6475,14 @@ export default class ManagementApi { /** * List collections in account - * List collections in account. + * List account-level collections in the account. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20015} + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20016} */ listAccountCollections(opts) { return this.listAccountCollectionsWithHttpInfo(opts) @@ -6485,7 +6501,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. * @param {String=} [opts.sku] The SKU of the item. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20032} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20033} and HTTP response */ listCatalogItemsWithHttpInfo(catalogId, opts) { opts = opts || {}; @@ -6512,7 +6528,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20032; + let returnType = InlineResponse20033; return this.apiClient.callApi( '/v1/catalogs/{catalogId}/items', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -6529,7 +6545,7 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {Boolean=} [opts.withTotalResultSize] 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. * @param {String=} [opts.sku] The SKU of the item. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20032} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20033} */ listCatalogItems(catalogId, opts) { return this.listCatalogItemsWithHttpInfo(catalogId, opts) @@ -6540,8 +6556,8 @@ export default class ManagementApi { /** - * List collections - * List collections in the campaign. + * List collections in campaign + * List collections in a given campaign. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6549,8 +6565,8 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20017} and HTTP response + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20018} and HTTP response */ listCollectionsWithHttpInfo(applicationId, campaignId, opts) { opts = opts || {}; @@ -6583,7 +6599,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20017; + let returnType = InlineResponse20018; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/collections', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -6592,8 +6608,8 @@ export default class ManagementApi { } /** - * List collections - * List collections in the campaign. + * List collections in campaign + * List collections in a given campaign. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters @@ -6601,8 +6617,8 @@ export default class ManagementApi { * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20017} + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20018} */ listCollections(applicationId, campaignId, opts) { return this.listCollectionsWithHttpInfo(applicationId, campaignId, opts) @@ -6613,16 +6629,16 @@ export default class ManagementApi { /** - * List collections in application - * List collections from all campaigns in the Application. + * List collections in Application + * List campaign-level collections from all campaigns in a given Application. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20017} and HTTP response + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20018} and HTTP response */ listCollectionsInApplicationWithHttpInfo(applicationId, opts) { opts = opts || {}; @@ -6650,7 +6666,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = []; let accepts = ['application/json']; - let returnType = InlineResponse20017; + let returnType = InlineResponse20018; return this.apiClient.callApi( '/v1/applications/{applicationId}/collections', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -6659,16 +6675,16 @@ export default class ManagementApi { } /** - * List collections in application - * List collections from all campaigns in the Application. + * List collections in Application + * List campaign-level collections from all campaigns in a given Application. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} [opts] Optional parameters * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. * @param {String=} [opts.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. * @param {Boolean=} [opts.withTotalResultSize] 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. - * @param {String=} [opts.name] Filter by the name of the Collection. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20017} + * @param {String=} [opts.name] Filter by collection name. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20018} */ listCollectionsInApplication(applicationId, opts) { return this.listCollectionsInApplicationWithHttpInfo(applicationId, opts) @@ -6678,9 +6694,135 @@ export default class ManagementApi { } + /** + * List stores + * List all stores for a specific Application. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {Object} [opts] Optional parameters + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @param {String=} [opts.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. + * @param {Boolean=} [opts.withTotalResultSize] 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. + * @param {Number=} [opts.campaignId] Filter results by campaign. + * @param {String=} [opts.name] The name of the store. + * @param {String=} [opts.integrationId] The integration ID of the store. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20043} and HTTP response + */ + listStoresWithHttpInfo(applicationId, opts) { + opts = opts || {}; + let postBody = null; + // verify the required parameter 'applicationId' is set + if (applicationId === undefined || applicationId === null) { + throw new Error("Missing the required parameter 'applicationId' when calling listStores"); + } + + let pathParams = { + 'applicationId': applicationId + }; + let queryParams = { + 'pageSize': opts['pageSize'], + 'skip': opts['skip'], + 'sort': opts['sort'], + 'withTotalResultSize': opts['withTotalResultSize'], + 'campaignId': opts['campaignId'], + 'name': opts['name'], + 'integrationId': opts['integrationId'] + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['management_key', 'manager_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = InlineResponse20043; + return this.apiClient.callApi( + '/v1/applications/{applicationId}/stores', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List stores + * List all stores for a specific Application. + * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param {Object} [opts] Optional parameters + * @param {Number=} [opts.pageSize] The number of items in this response. (default to 1000) + * @param {Number=} [opts.skip] The number of items to skip when paging through large result sets. + * @param {String=} [opts.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. + * @param {Boolean=} [opts.withTotalResultSize] 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. + * @param {Number=} [opts.campaignId] Filter results by campaign. + * @param {String=} [opts.name] The name of the store. + * @param {String=} [opts.integrationId] The integration ID of the store. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20043} + */ + listStores(applicationId, opts) { + return this.listStoresWithHttpInfo(applicationId, opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * Activate or deactivate notification + * Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification. + * @param {Number} notificationId The ID of the notification. Get it with the appropriate _List notifications_ endpoint. + * @param {module:model/NotificationActivation} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response + */ + notificationActivationWithHttpInfo(notificationId, body) { + let postBody = body; + // verify the required parameter 'notificationId' is set + if (notificationId === undefined || notificationId === null) { + throw new Error("Missing the required parameter 'notificationId' when calling notificationActivation"); + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling notificationActivation"); + } + + let pathParams = { + 'notificationId': notificationId + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['management_key', 'manager_auth']; + let contentTypes = ['application/json']; + let accepts = []; + let returnType = null; + return this.apiClient.callApi( + '/v1/notifications/{notificationId}/activation', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Activate or deactivate notification + * Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification. + * @param {Number} notificationId The ID of the notification. Get it with the appropriate _List notifications_ endpoint. + * @param {module:model/NotificationActivation} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise} + */ + notificationActivation(notificationId, body) { + return this.notificationActivationWithHttpInfo(notificationId, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Create notification about added or deducted loyalty points - * 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). + * 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 loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {module:model/NewBaseNotification} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BaseNotification} and HTTP response @@ -6719,7 +6861,7 @@ export default class ManagementApi { /** * Create notification about added or deducted loyalty points - * 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). + * 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 loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {module:model/NewBaseNotification} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BaseNotification} @@ -6765,7 +6907,7 @@ export default class ManagementApi { let accepts = ['application/json']; let returnType = BaseNotification; return this.apiClient.callApi( - '/v1/catalogs/{applicationId}/notifications/strikethrough', 'POST', + '/v1/applications/{applicationId}/catalogs/notifications/strikethrough', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); @@ -6788,7 +6930,7 @@ export default class ManagementApi { /** * Create notification about pending loyalty points - * Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications). + * Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {module:model/NewBaseNotification} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BaseNotification} and HTTP response @@ -6827,7 +6969,7 @@ export default class ManagementApi { /** * Create notification about pending loyalty points - * Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications). + * Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications). * @param {Number} loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. * @param {module:model/NewBaseNotification} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BaseNotification} @@ -6950,7 +7092,7 @@ export default class ManagementApi { /** * List coupons that match the given attributes (without total count) - * 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. + * List the coupons whose attributes match the query criteria in all the 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} body body * @param {Object} [opts] Optional parameters @@ -6967,7 +7109,7 @@ export default class ManagementApi { * @param {String=} [opts.batchId] Filter results by batches of coupons * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) * @param {module:model/String=} [opts.campaignState] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2008} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response */ searchCouponsAdvancedApplicationWideWithoutTotalCountWithHttpInfo(applicationId, body, opts) { opts = opts || {}; @@ -7007,7 +7149,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2008; + let returnType = InlineResponse2009; return this.apiClient.callApi( '/v1/applications/{applicationId}/coupons_search_advanced/no_total', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -7017,7 +7159,7 @@ export default class ManagementApi { /** * List coupons that match the given attributes (without total count) - * 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. + * List the coupons whose attributes match the query criteria in all the 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. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Object} body body * @param {Object} [opts] Optional parameters @@ -7034,7 +7176,7 @@ export default class ManagementApi { * @param {String=} [opts.batchId] Filter results by batches of coupons * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) * @param {module:model/String=} [opts.campaignState] 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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2008} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009} */ searchCouponsAdvancedApplicationWideWithoutTotalCount(applicationId, body, opts) { return this.searchCouponsAdvancedApplicationWideWithoutTotalCountWithHttpInfo(applicationId, body, opts) @@ -7063,7 +7205,7 @@ export default class ManagementApi { * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) * @param {String=} [opts.batchId] Filter results by batches of coupons - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2008} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response */ searchCouponsAdvancedWithoutTotalCountWithHttpInfo(applicationId, campaignId, body, opts) { opts = opts || {}; @@ -7107,7 +7249,7 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = InlineResponse2008; + let returnType = InlineResponse2009; return this.apiClient.callApi( '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total', 'POST', pathParams, queryParams, headerParams, formParams, postBody, @@ -7134,7 +7276,7 @@ export default class ManagementApi { * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false) * @param {String=} [opts.batchId] Filter results by batches of coupons - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2008} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009} */ searchCouponsAdvancedWithoutTotalCount(applicationId, campaignId, body, opts) { return this.searchCouponsAdvancedWithoutTotalCountWithHttpInfo(applicationId, campaignId, body, opts) @@ -7207,8 +7349,8 @@ export default class ManagementApi { /** * Update account-level collection - * Edit the description of the account-level collection and enable or disable the collection in the specified Applications. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Edit the description of a given account-level collection and enable or disable the collection in the specified Applications. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {module:model/UpdateCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Collection} and HTTP response */ @@ -7246,8 +7388,8 @@ export default class ManagementApi { /** * Update account-level collection - * Edit the description of the account-level collection and enable or disable the collection in the specified Applications. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * Edit the description of a given account-level collection and enable or disable the collection in the specified Applications. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. * @param {module:model/UpdateCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Collection} */ @@ -7261,7 +7403,7 @@ export default class ManagementApi { /** * Update additional cost - * 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. + * Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the `name` property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations. * @param {Number} additionalCostId 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**. * @param {module:model/NewAdditionalCost} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AccountAdditionalCost} and HTTP response @@ -7300,7 +7442,7 @@ export default class ManagementApi { /** * Update additional cost - * 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. + * Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the `name` property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations. * @param {Number} additionalCostId 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**. * @param {module:model/NewAdditionalCost} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AccountAdditionalCost} @@ -7429,11 +7571,11 @@ export default class ManagementApi { /** - * Update collection description - * Edit the description of the collection. + * Update campaign-level collection's description + * Edit the description of a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @param {module:model/UpdateCampaignCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Collection} and HTTP response */ @@ -7480,11 +7622,11 @@ export default class ManagementApi { } /** - * Update collection description - * Edit the description of the collection. + * Update campaign-level collection's description + * Edit the description of a given campaign-level collection. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {Number} collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. + * @param {Number} collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. * @param {module:model/UpdateCampaignCollection} body body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Collection} */ @@ -7566,7 +7708,7 @@ export default class ManagementApi { /** * Update coupons - * 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).

Important

  • Only send sequential requests to this endpoint.
  • Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.
To update a specific coupon, use [Update coupon](#operation/updateCoupon). + * Update all coupons, or a specific batch of coupons in the given 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).

Important

  • Only send sequential requests to this endpoint.
  • Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.
To update a specific coupon, use [Update coupon](#operation/updateCoupon). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/UpdateCouponBatch} body body @@ -7611,7 +7753,7 @@ export default class ManagementApi { /** * Update coupons - * 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).

Important

  • Only send sequential requests to this endpoint.
  • Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.
To update a specific coupon, use [Update coupon](#operation/updateCoupon). + * Update all coupons, or a specific batch of coupons in the given 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).

Important

  • Only send sequential requests to this endpoint.
  • Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.
To update a specific coupon, use [Update coupon](#operation/updateCoupon). * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param {module:model/UpdateCouponBatch} body body @@ -7687,31 +7829,37 @@ export default class ManagementApi { /** - * Update notification about campaign-related changes - * 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). + * Update referral + * Update the specified referral. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. - * @param {module:model/NewNotificationWebhook} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotificationWebhook} and HTTP response + * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param {String} referralId The ID of the referral code. + * @param {module:model/UpdateReferral} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Referral} and HTTP response */ - updateNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId, body) { + updateReferralWithHttpInfo(applicationId, campaignId, referralId, body) { let postBody = body; // verify the required parameter 'applicationId' is set if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling updateNotificationWebhook"); + throw new Error("Missing the required parameter 'applicationId' when calling updateReferral"); } - // verify the required parameter 'notificationWebhookId' is set - if (notificationWebhookId === undefined || notificationWebhookId === null) { - throw new Error("Missing the required parameter 'notificationWebhookId' when calling updateNotificationWebhook"); + // verify the required parameter 'campaignId' is set + if (campaignId === undefined || campaignId === null) { + throw new Error("Missing the required parameter 'campaignId' when calling updateReferral"); + } + // verify the required parameter 'referralId' is set + if (referralId === undefined || referralId === null) { + throw new Error("Missing the required parameter 'referralId' when calling updateReferral"); } // verify the required parameter 'body' is set if (body === undefined || body === null) { - throw new Error("Missing the required parameter 'body' when calling updateNotificationWebhook"); + throw new Error("Missing the required parameter 'body' when calling updateReferral"); } let pathParams = { 'applicationId': applicationId, - 'notificationWebhookId': notificationWebhookId + 'campaignId': campaignId, + 'referralId': referralId }; let queryParams = { }; @@ -7723,24 +7871,25 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = NotificationWebhook; + let returnType = Referral; return this.apiClient.callApi( - '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}', 'PUT', + '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Update notification about campaign-related changes - * 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). + * Update referral + * Update the specified referral. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. - * @param {module:model/NewNotificationWebhook} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotificationWebhook} + * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param {String} referralId The ID of the referral code. + * @param {module:model/UpdateReferral} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Referral} */ - updateNotificationWebhook(applicationId, notificationWebhookId, body) { - return this.updateNotificationWebhookWithHttpInfo(applicationId, notificationWebhookId, body) + updateReferral(applicationId, campaignId, referralId, body) { + return this.updateReferralWithHttpInfo(applicationId, campaignId, referralId, body) .then(function(response_and_data) { return response_and_data.data; }); @@ -7748,37 +7897,31 @@ export default class ManagementApi { /** - * Update referral - * Update the specified referral. + * Update store + * Update store details for a specific store ID. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {String} referralId The ID of the referral code. - * @param {module:model/UpdateReferral} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Referral} and HTTP response + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + * @param {module:model/NewStore} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Store} and HTTP response */ - updateReferralWithHttpInfo(applicationId, campaignId, referralId, body) { + updateStoreWithHttpInfo(applicationId, storeId, body) { let postBody = body; // verify the required parameter 'applicationId' is set if (applicationId === undefined || applicationId === null) { - throw new Error("Missing the required parameter 'applicationId' when calling updateReferral"); + throw new Error("Missing the required parameter 'applicationId' when calling updateStore"); } - // verify the required parameter 'campaignId' is set - if (campaignId === undefined || campaignId === null) { - throw new Error("Missing the required parameter 'campaignId' when calling updateReferral"); - } - // verify the required parameter 'referralId' is set - if (referralId === undefined || referralId === null) { - throw new Error("Missing the required parameter 'referralId' when calling updateReferral"); + // verify the required parameter 'storeId' is set + if (storeId === undefined || storeId === null) { + throw new Error("Missing the required parameter 'storeId' when calling updateStore"); } // verify the required parameter 'body' is set if (body === undefined || body === null) { - throw new Error("Missing the required parameter 'body' when calling updateReferral"); + throw new Error("Missing the required parameter 'body' when calling updateStore"); } let pathParams = { 'applicationId': applicationId, - 'campaignId': campaignId, - 'referralId': referralId + 'storeId': storeId }; let queryParams = { }; @@ -7790,25 +7933,24 @@ export default class ManagementApi { let authNames = ['management_key', 'manager_auth']; let contentTypes = ['application/json']; let accepts = ['application/json']; - let returnType = Referral; + let returnType = Store; return this.apiClient.callApi( - '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}', 'PUT', + '/v1/applications/{applicationId}/stores/{storeId}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null ); } /** - * Update referral - * Update the specified referral. + * Update store + * Update store details for a specific store ID. * @param {Number} applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - * @param {Number} campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - * @param {String} referralId The ID of the referral code. - * @param {module:model/UpdateReferral} body body - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Referral} + * @param {String} storeId The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + * @param {module:model/NewStore} body body + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Store} */ - updateReferral(applicationId, campaignId, referralId, body) { - return this.updateReferralWithHttpInfo(applicationId, campaignId, referralId, body) + updateStore(applicationId, storeId, body) { + return this.updateStoreWithHttpInfo(applicationId, storeId, body) .then(function(response_and_data) { return response_and_data.data; }); diff --git a/src/index.js b/src/index.js index 19333458..eb6bfc9c 100644 --- a/src/index.js +++ b/src/index.js @@ -29,11 +29,15 @@ import AccountDashboardStatisticReferrals from './model/AccountDashboardStatisti import AccountDashboardStatisticRevenue from './model/AccountDashboardStatisticRevenue'; import AccountEntity from './model/AccountEntity'; import AccountLimits from './model/AccountLimits'; +import Achievement from './model/Achievement'; +import AchievementAdditionalProperties from './model/AchievementAdditionalProperties'; import AddFreeItemEffectProps from './model/AddFreeItemEffectProps'; import AddItemCatalogAction from './model/AddItemCatalogAction'; import AddLoyaltyPoints from './model/AddLoyaltyPoints'; import AddLoyaltyPointsEffectProps from './model/AddLoyaltyPointsEffectProps'; +import AddToAudienceEffectProps from './model/AddToAudienceEffectProps'; import AddedDeductedPointsNotificationPolicy from './model/AddedDeductedPointsNotificationPolicy'; +import AdditionalCampaignProperties from './model/AdditionalCampaignProperties'; import AdditionalCost from './model/AdditionalCost'; import Application from './model/Application'; import ApplicationAPIKey from './model/ApplicationAPIKey'; @@ -47,6 +51,7 @@ import ApplicationNotification from './model/ApplicationNotification'; import ApplicationReferee from './model/ApplicationReferee'; import ApplicationSession from './model/ApplicationSession'; import ApplicationSessionEntity from './model/ApplicationSessionEntity'; +import ApplicationStoreEntity from './model/ApplicationStoreEntity'; import AsyncCouponCreationResponse from './model/AsyncCouponCreationResponse'; import Attribute from './model/Attribute'; import AttributesMandatory from './model/AttributesMandatory'; @@ -58,6 +63,7 @@ import AudienceIntegrationID from './model/AudienceIntegrationID'; import AudienceMembership from './model/AudienceMembership'; import AwardGiveawayEffectProps from './model/AwardGiveawayEffectProps'; import BaseCampaign from './model/BaseCampaign'; +import BaseCampaignForNotification from './model/BaseCampaignForNotification'; import BaseLoyaltyProgram from './model/BaseLoyaltyProgram'; import BaseNotification from './model/BaseNotification'; import BaseNotificationEntity from './model/BaseNotificationEntity'; @@ -67,9 +73,11 @@ import BaseSamlConnection from './model/BaseSamlConnection'; import Binding from './model/Binding'; import BulkApplicationNotification from './model/BulkApplicationNotification'; import BulkCampaignNotification from './model/BulkCampaignNotification'; +import BulkOperationOnCampaigns from './model/BulkOperationOnCampaigns'; import Campaign from './model/Campaign'; import CampaignActivationRequest from './model/CampaignActivationRequest'; import CampaignAnalytics from './model/CampaignAnalytics'; +import CampaignBudget from './model/CampaignBudget'; import CampaignCollection from './model/CampaignCollection'; import CampaignCollectionWithoutPayload from './model/CampaignCollectionWithoutPayload'; import CampaignCopy from './model/CampaignCopy'; @@ -80,9 +88,11 @@ import CampaignEntity from './model/CampaignEntity'; import CampaignEvaluationGroup from './model/CampaignEvaluationGroup'; import CampaignEvaluationPosition from './model/CampaignEvaluationPosition'; import CampaignEvaluationTreeChangedNotification from './model/CampaignEvaluationTreeChangedNotification'; +import CampaignForNotification from './model/CampaignForNotification'; import CampaignGroup from './model/CampaignGroup'; import CampaignGroupEntity from './model/CampaignGroupEntity'; import CampaignNotification from './model/CampaignNotification'; +import CampaignNotificationPolicy from './model/CampaignNotificationPolicy'; import CampaignRulesetChangedNotification from './model/CampaignRulesetChangedNotification'; import CampaignSearch from './model/CampaignSearch'; import CampaignSet from './model/CampaignSet'; @@ -90,9 +100,11 @@ import CampaignSetBranchNode from './model/CampaignSetBranchNode'; import CampaignSetLeafNode from './model/CampaignSetLeafNode'; import CampaignSetNode from './model/CampaignSetNode'; import CampaignStateChangedNotification from './model/CampaignStateChangedNotification'; +import CampaignStateNotification from './model/CampaignStateNotification'; import CampaignTemplate from './model/CampaignTemplate'; import CampaignTemplateCollection from './model/CampaignTemplateCollection'; import CampaignTemplateParams from './model/CampaignTemplateParams'; +import CardLedgerPointsEntryIntegrationAPI from './model/CardLedgerPointsEntryIntegrationAPI'; import CardLedgerTransactionLogEntry from './model/CardLedgerTransactionLogEntry'; import CardLedgerTransactionLogEntryIntegrationAPI from './model/CardLedgerTransactionLogEntryIntegrationAPI'; import CartItem from './model/CartItem'; @@ -103,6 +115,7 @@ import CatalogItem from './model/CatalogItem'; import CatalogSyncRequest from './model/CatalogSyncRequest'; import CatalogsStrikethroughNotificationPolicy from './model/CatalogsStrikethroughNotificationPolicy'; import Change from './model/Change'; +import ChangeLoyaltyTierLevelEffectProps from './model/ChangeLoyaltyTierLevelEffectProps'; import ChangeProfilePassword from './model/ChangeProfilePassword'; import CodeGeneratorSettings from './model/CodeGeneratorSettings'; import Collection from './model/Collection'; @@ -118,6 +131,7 @@ import CouponReservations from './model/CouponReservations'; import CouponSearch from './model/CouponSearch'; import CouponValue from './model/CouponValue'; import CouponsNotificationPolicy from './model/CouponsNotificationPolicy'; +import CreateAchievement from './model/CreateAchievement'; import CreateApplicationAPIKey from './model/CreateApplicationAPIKey'; import CreateManagementKey from './model/CreateManagementKey'; import CreateTemplateCampaign from './model/CreateTemplateCampaign'; @@ -131,6 +145,7 @@ import CustomerProfile from './model/CustomerProfile'; import CustomerProfileAudienceRequest from './model/CustomerProfileAudienceRequest'; import CustomerProfileAudienceRequestItem from './model/CustomerProfileAudienceRequestItem'; import CustomerProfileIntegrationRequestV2 from './model/CustomerProfileIntegrationRequestV2'; +import CustomerProfileIntegrationResponseV2 from './model/CustomerProfileIntegrationResponseV2'; import CustomerProfileSearchQuery from './model/CustomerProfileSearchQuery'; import CustomerProfileUpdateV2Response from './model/CustomerProfileUpdateV2Response'; import CustomerSession from './model/CustomerSession'; @@ -156,7 +171,6 @@ import ExpiringPointsNotificationPolicy from './model/ExpiringPointsNotification import ExpiringPointsNotificationTrigger from './model/ExpiringPointsNotificationTrigger'; import FeatureFlag from './model/FeatureFlag'; import FeaturesFeed from './model/FeaturesFeed'; -import FrontendState from './model/FrontendState'; import FuncArgDef from './model/FuncArgDef'; import FunctionDef from './model/FunctionDef'; import Giveaway from './model/Giveaway'; @@ -200,6 +214,8 @@ import InlineResponse20039 from './model/InlineResponse20039'; import InlineResponse2004 from './model/InlineResponse2004'; import InlineResponse20040 from './model/InlineResponse20040'; import InlineResponse20041 from './model/InlineResponse20041'; +import InlineResponse20042 from './model/InlineResponse20042'; +import InlineResponse20043 from './model/InlineResponse20043'; import InlineResponse2005 from './model/InlineResponse2005'; import InlineResponse2006 from './model/InlineResponse2006'; import InlineResponse2007 from './model/InlineResponse2007'; @@ -215,11 +231,13 @@ import IntegrationProfileEntity from './model/IntegrationProfileEntity'; import IntegrationRequest from './model/IntegrationRequest'; import IntegrationState from './model/IntegrationState'; import IntegrationStateV2 from './model/IntegrationStateV2'; +import IntegrationStoreEntity from './model/IntegrationStoreEntity'; import InventoryCoupon from './model/InventoryCoupon'; import InventoryReferral from './model/InventoryReferral'; import ItemAttribute from './model/ItemAttribute'; import LedgerEntry from './model/LedgerEntry'; import LedgerInfo from './model/LedgerInfo'; +import LedgerPointsEntryIntegrationAPI from './model/LedgerPointsEntryIntegrationAPI'; import LedgerTransactionLogEntryIntegrationAPI from './model/LedgerTransactionLogEntryIntegrationAPI'; import LibraryAttribute from './model/LibraryAttribute'; import LimitConfig from './model/LimitConfig'; @@ -243,7 +261,6 @@ import LoyaltyProgramEntity from './model/LoyaltyProgramEntity'; import LoyaltyProgramLedgers from './model/LoyaltyProgramLedgers'; import LoyaltyProgramSubledgers from './model/LoyaltyProgramSubledgers'; import LoyaltyProgramTransaction from './model/LoyaltyProgramTransaction'; -import LoyaltyStatistics from './model/LoyaltyStatistics'; import LoyaltySubLedger from './model/LoyaltySubLedger'; import LoyaltyTier from './model/LoyaltyTier'; import ManagementKey from './model/ManagementKey'; @@ -295,6 +312,7 @@ import NewLoyaltyProgram from './model/NewLoyaltyProgram'; import NewLoyaltyTier from './model/NewLoyaltyTier'; import NewManagementKey from './model/NewManagementKey'; import NewMultipleAudiencesItem from './model/NewMultipleAudiencesItem'; +import NewNotificationTest from './model/NewNotificationTest'; import NewNotificationWebhook from './model/NewNotificationWebhook'; import NewOutgoingIntegrationWebhook from './model/NewOutgoingIntegrationWebhook'; import NewPassword from './model/NewPassword'; @@ -307,13 +325,19 @@ import NewRole from './model/NewRole'; import NewRoleV2 from './model/NewRoleV2'; import NewRuleset from './model/NewRuleset'; import NewSamlConnection from './model/NewSamlConnection'; +import NewStore from './model/NewStore'; import NewTemplateDef from './model/NewTemplateDef'; import NewUser from './model/NewUser'; import NewWebhook from './model/NewWebhook'; import Notification from './model/Notification'; -import NotificationWebhook from './model/NotificationWebhook'; +import NotificationActivation from './model/NotificationActivation'; +import NotificationTest from './model/NotificationTest'; +import OneTimeCode from './model/OneTimeCode'; import OutgoingIntegrationBrazePolicy from './model/OutgoingIntegrationBrazePolicy'; +import OutgoingIntegrationCleverTapPolicy from './model/OutgoingIntegrationCleverTapPolicy'; import OutgoingIntegrationConfiguration from './model/OutgoingIntegrationConfiguration'; +import OutgoingIntegrationIterablePolicy from './model/OutgoingIntegrationIterablePolicy'; +import OutgoingIntegrationMoEngagePolicy from './model/OutgoingIntegrationMoEngagePolicy'; import OutgoingIntegrationTemplate from './model/OutgoingIntegrationTemplate'; import OutgoingIntegrationTemplateWithConfigurationDetails from './model/OutgoingIntegrationTemplateWithConfigurationDetails'; import OutgoingIntegrationTemplates from './model/OutgoingIntegrationTemplates'; @@ -331,6 +355,7 @@ import ReferralCreatedEffectProps from './model/ReferralCreatedEffectProps'; import ReferralRejectionReason from './model/ReferralRejectionReason'; import RejectCouponEffectProps from './model/RejectCouponEffectProps'; import RejectReferralEffectProps from './model/RejectReferralEffectProps'; +import RemoveFromAudienceEffectProps from './model/RemoveFromAudienceEffectProps'; import RemoveItemCatalogAction from './model/RemoveItemCatalogAction'; import RemoveManyItemsCatalogAction from './model/RemoveManyItemsCatalogAction'; import ReopenSessionResponse from './model/ReopenSessionResponse'; @@ -354,6 +379,7 @@ import RollbackReferralEffectProps from './model/RollbackReferralEffectProps'; import Rule from './model/Rule'; import RuleFailureReason from './model/RuleFailureReason'; import Ruleset from './model/Ruleset'; +import SSOConfig from './model/SSOConfig'; import SamlConnection from './model/SamlConnection'; import SamlConnectionMetadata from './model/SamlConnectionMetadata'; import SamlLoginEndpoint from './model/SamlLoginEndpoint'; @@ -365,6 +391,7 @@ import SetDiscountPerItemEffectProps from './model/SetDiscountPerItemEffectProps import ShowBundleMetadataEffectProps from './model/ShowBundleMetadataEffectProps'; import ShowNotificationEffectProps from './model/ShowNotificationEffectProps'; import SlotDef from './model/SlotDef'; +import Store from './model/Store'; import StrikethroughChangedItem from './model/StrikethroughChangedItem'; import StrikethroughCustomEffectPerItemProps from './model/StrikethroughCustomEffectPerItemProps'; import StrikethroughEffect from './model/StrikethroughEffect'; @@ -377,9 +404,17 @@ import TemplateArgDef from './model/TemplateArgDef'; import TemplateDef from './model/TemplateDef'; import TemplateLimitConfig from './model/TemplateLimitConfig'; import Tier from './model/Tier'; +import TierDowngradeNotificationPolicy from './model/TierDowngradeNotificationPolicy'; +import TierUpgradeNotificationPolicy from './model/TierUpgradeNotificationPolicy'; +import TierWillDowngradeNotificationPolicy from './model/TierWillDowngradeNotificationPolicy'; +import TierWillDowngradeNotificationTrigger from './model/TierWillDowngradeNotificationTrigger'; +import TimePoint from './model/TimePoint'; +import TrackEventV2Response from './model/TrackEventV2Response'; import TransferLoyaltyCard from './model/TransferLoyaltyCard'; import TriggerWebhookEffectProps from './model/TriggerWebhookEffectProps'; +import TwoFAConfig from './model/TwoFAConfig'; import UpdateAccount from './model/UpdateAccount'; +import UpdateAchievement from './model/UpdateAchievement'; import UpdateApplication from './model/UpdateApplication'; import UpdateAttributeEffectProps from './model/UpdateAttributeEffectProps'; import UpdateAudience from './model/UpdateAudience'; @@ -399,6 +434,7 @@ import UpdatePicklist from './model/UpdatePicklist'; import UpdateReferral from './model/UpdateReferral'; import UpdateReferralBatch from './model/UpdateReferralBatch'; import UpdateRole from './model/UpdateRole'; +import UpdateStore from './model/UpdateStore'; import UpdateUser from './model/UpdateUser'; import User from './model/User'; import UserEntity from './model/UserEntity'; @@ -440,7 +476,7 @@ import ManagementApi from './api/ManagementApi'; * *

* @module index -* @version 5.0.1 +* @version 6.0.0 */ export { /** @@ -545,6 +581,18 @@ export { */ AccountLimits, + /** + * The Achievement model constructor. + * @property {module:model/Achievement} + */ + Achievement, + + /** + * The AchievementAdditionalProperties model constructor. + * @property {module:model/AchievementAdditionalProperties} + */ + AchievementAdditionalProperties, + /** * The AddFreeItemEffectProps model constructor. * @property {module:model/AddFreeItemEffectProps} @@ -569,12 +617,24 @@ export { */ AddLoyaltyPointsEffectProps, + /** + * The AddToAudienceEffectProps model constructor. + * @property {module:model/AddToAudienceEffectProps} + */ + AddToAudienceEffectProps, + /** * The AddedDeductedPointsNotificationPolicy model constructor. * @property {module:model/AddedDeductedPointsNotificationPolicy} */ AddedDeductedPointsNotificationPolicy, + /** + * The AdditionalCampaignProperties model constructor. + * @property {module:model/AdditionalCampaignProperties} + */ + AdditionalCampaignProperties, + /** * The AdditionalCost model constructor. * @property {module:model/AdditionalCost} @@ -653,6 +713,12 @@ export { */ ApplicationSessionEntity, + /** + * The ApplicationStoreEntity model constructor. + * @property {module:model/ApplicationStoreEntity} + */ + ApplicationStoreEntity, + /** * The AsyncCouponCreationResponse model constructor. * @property {module:model/AsyncCouponCreationResponse} @@ -719,6 +785,12 @@ export { */ BaseCampaign, + /** + * The BaseCampaignForNotification model constructor. + * @property {module:model/BaseCampaignForNotification} + */ + BaseCampaignForNotification, + /** * The BaseLoyaltyProgram model constructor. * @property {module:model/BaseLoyaltyProgram} @@ -773,6 +845,12 @@ export { */ BulkCampaignNotification, + /** + * The BulkOperationOnCampaigns model constructor. + * @property {module:model/BulkOperationOnCampaigns} + */ + BulkOperationOnCampaigns, + /** * The Campaign model constructor. * @property {module:model/Campaign} @@ -791,6 +869,12 @@ export { */ CampaignAnalytics, + /** + * The CampaignBudget model constructor. + * @property {module:model/CampaignBudget} + */ + CampaignBudget, + /** * The CampaignCollection model constructor. * @property {module:model/CampaignCollection} @@ -851,6 +935,12 @@ export { */ CampaignEvaluationTreeChangedNotification, + /** + * The CampaignForNotification model constructor. + * @property {module:model/CampaignForNotification} + */ + CampaignForNotification, + /** * The CampaignGroup model constructor. * @property {module:model/CampaignGroup} @@ -869,6 +959,12 @@ export { */ CampaignNotification, + /** + * The CampaignNotificationPolicy model constructor. + * @property {module:model/CampaignNotificationPolicy} + */ + CampaignNotificationPolicy, + /** * The CampaignRulesetChangedNotification model constructor. * @property {module:model/CampaignRulesetChangedNotification} @@ -911,6 +1007,12 @@ export { */ CampaignStateChangedNotification, + /** + * The CampaignStateNotification model constructor. + * @property {module:model/CampaignStateNotification} + */ + CampaignStateNotification, + /** * The CampaignTemplate model constructor. * @property {module:model/CampaignTemplate} @@ -929,6 +1031,12 @@ export { */ CampaignTemplateParams, + /** + * The CardLedgerPointsEntryIntegrationAPI model constructor. + * @property {module:model/CardLedgerPointsEntryIntegrationAPI} + */ + CardLedgerPointsEntryIntegrationAPI, + /** * The CardLedgerTransactionLogEntry model constructor. * @property {module:model/CardLedgerTransactionLogEntry} @@ -989,6 +1097,12 @@ export { */ Change, + /** + * The ChangeLoyaltyTierLevelEffectProps model constructor. + * @property {module:model/ChangeLoyaltyTierLevelEffectProps} + */ + ChangeLoyaltyTierLevelEffectProps, + /** * The ChangeProfilePassword model constructor. * @property {module:model/ChangeProfilePassword} @@ -1079,6 +1193,12 @@ export { */ CouponsNotificationPolicy, + /** + * The CreateAchievement model constructor. + * @property {module:model/CreateAchievement} + */ + CreateAchievement, + /** * The CreateApplicationAPIKey model constructor. * @property {module:model/CreateApplicationAPIKey} @@ -1157,6 +1277,12 @@ export { */ CustomerProfileIntegrationRequestV2, + /** + * The CustomerProfileIntegrationResponseV2 model constructor. + * @property {module:model/CustomerProfileIntegrationResponseV2} + */ + CustomerProfileIntegrationResponseV2, + /** * The CustomerProfileSearchQuery model constructor. * @property {module:model/CustomerProfileSearchQuery} @@ -1307,12 +1433,6 @@ export { */ FeaturesFeed, - /** - * The FrontendState model constructor. - * @property {module:model/FrontendState} - */ - FrontendState, - /** * The FuncArgDef model constructor. * @property {module:model/FuncArgDef} @@ -1571,6 +1691,18 @@ export { */ InlineResponse20041, + /** + * The InlineResponse20042 model constructor. + * @property {module:model/InlineResponse20042} + */ + InlineResponse20042, + + /** + * The InlineResponse20043 model constructor. + * @property {module:model/InlineResponse20043} + */ + InlineResponse20043, + /** * The InlineResponse2005 model constructor. * @property {module:model/InlineResponse2005} @@ -1661,6 +1793,12 @@ export { */ IntegrationStateV2, + /** + * The IntegrationStoreEntity model constructor. + * @property {module:model/IntegrationStoreEntity} + */ + IntegrationStoreEntity, + /** * The InventoryCoupon model constructor. * @property {module:model/InventoryCoupon} @@ -1691,6 +1829,12 @@ export { */ LedgerInfo, + /** + * The LedgerPointsEntryIntegrationAPI model constructor. + * @property {module:model/LedgerPointsEntryIntegrationAPI} + */ + LedgerPointsEntryIntegrationAPI, + /** * The LedgerTransactionLogEntryIntegrationAPI model constructor. * @property {module:model/LedgerTransactionLogEntryIntegrationAPI} @@ -1829,12 +1973,6 @@ export { */ LoyaltyProgramTransaction, - /** - * The LoyaltyStatistics model constructor. - * @property {module:model/LoyaltyStatistics} - */ - LoyaltyStatistics, - /** * The LoyaltySubLedger model constructor. * @property {module:model/LoyaltySubLedger} @@ -2141,6 +2279,12 @@ export { */ NewMultipleAudiencesItem, + /** + * The NewNotificationTest model constructor. + * @property {module:model/NewNotificationTest} + */ + NewNotificationTest, + /** * The NewNotificationWebhook model constructor. * @property {module:model/NewNotificationWebhook} @@ -2213,6 +2357,12 @@ export { */ NewSamlConnection, + /** + * The NewStore model constructor. + * @property {module:model/NewStore} + */ + NewStore, + /** * The NewTemplateDef model constructor. * @property {module:model/NewTemplateDef} @@ -2238,10 +2388,22 @@ export { Notification, /** - * The NotificationWebhook model constructor. - * @property {module:model/NotificationWebhook} + * The NotificationActivation model constructor. + * @property {module:model/NotificationActivation} + */ + NotificationActivation, + + /** + * The NotificationTest model constructor. + * @property {module:model/NotificationTest} + */ + NotificationTest, + + /** + * The OneTimeCode model constructor. + * @property {module:model/OneTimeCode} */ - NotificationWebhook, + OneTimeCode, /** * The OutgoingIntegrationBrazePolicy model constructor. @@ -2249,12 +2411,30 @@ export { */ OutgoingIntegrationBrazePolicy, + /** + * The OutgoingIntegrationCleverTapPolicy model constructor. + * @property {module:model/OutgoingIntegrationCleverTapPolicy} + */ + OutgoingIntegrationCleverTapPolicy, + /** * The OutgoingIntegrationConfiguration model constructor. * @property {module:model/OutgoingIntegrationConfiguration} */ OutgoingIntegrationConfiguration, + /** + * The OutgoingIntegrationIterablePolicy model constructor. + * @property {module:model/OutgoingIntegrationIterablePolicy} + */ + OutgoingIntegrationIterablePolicy, + + /** + * The OutgoingIntegrationMoEngagePolicy model constructor. + * @property {module:model/OutgoingIntegrationMoEngagePolicy} + */ + OutgoingIntegrationMoEngagePolicy, + /** * The OutgoingIntegrationTemplate model constructor. * @property {module:model/OutgoingIntegrationTemplate} @@ -2357,6 +2537,12 @@ export { */ RejectReferralEffectProps, + /** + * The RemoveFromAudienceEffectProps model constructor. + * @property {module:model/RemoveFromAudienceEffectProps} + */ + RemoveFromAudienceEffectProps, + /** * The RemoveItemCatalogAction model constructor. * @property {module:model/RemoveItemCatalogAction} @@ -2495,6 +2681,12 @@ export { */ Ruleset, + /** + * The SSOConfig model constructor. + * @property {module:model/SSOConfig} + */ + SSOConfig, + /** * The SamlConnection model constructor. * @property {module:model/SamlConnection} @@ -2561,6 +2753,12 @@ export { */ SlotDef, + /** + * The Store model constructor. + * @property {module:model/Store} + */ + Store, + /** * The StrikethroughChangedItem model constructor. * @property {module:model/StrikethroughChangedItem} @@ -2633,6 +2831,42 @@ export { */ Tier, + /** + * The TierDowngradeNotificationPolicy model constructor. + * @property {module:model/TierDowngradeNotificationPolicy} + */ + TierDowngradeNotificationPolicy, + + /** + * The TierUpgradeNotificationPolicy model constructor. + * @property {module:model/TierUpgradeNotificationPolicy} + */ + TierUpgradeNotificationPolicy, + + /** + * The TierWillDowngradeNotificationPolicy model constructor. + * @property {module:model/TierWillDowngradeNotificationPolicy} + */ + TierWillDowngradeNotificationPolicy, + + /** + * The TierWillDowngradeNotificationTrigger model constructor. + * @property {module:model/TierWillDowngradeNotificationTrigger} + */ + TierWillDowngradeNotificationTrigger, + + /** + * The TimePoint model constructor. + * @property {module:model/TimePoint} + */ + TimePoint, + + /** + * The TrackEventV2Response model constructor. + * @property {module:model/TrackEventV2Response} + */ + TrackEventV2Response, + /** * The TransferLoyaltyCard model constructor. * @property {module:model/TransferLoyaltyCard} @@ -2645,12 +2879,24 @@ export { */ TriggerWebhookEffectProps, + /** + * The TwoFAConfig model constructor. + * @property {module:model/TwoFAConfig} + */ + TwoFAConfig, + /** * The UpdateAccount model constructor. * @property {module:model/UpdateAccount} */ UpdateAccount, + /** + * The UpdateAchievement model constructor. + * @property {module:model/UpdateAchievement} + */ + UpdateAchievement, + /** * The UpdateApplication model constructor. * @property {module:model/UpdateApplication} @@ -2765,6 +3011,12 @@ export { */ UpdateRole, + /** + * The UpdateStore model constructor. + * @property {module:model/UpdateStore} + */ + UpdateStore, + /** * The UpdateUser model constructor. * @property {module:model/UpdateUser} diff --git a/src/model/APIError.js b/src/model/APIError.js index 42128f2b..b21e133b 100644 --- a/src/model/APIError.js +++ b/src/model/APIError.js @@ -17,7 +17,7 @@ import ErrorSource from './ErrorSource'; /** * The APIError model module. * @module model/APIError - * @version 5.0.1 + * @version 6.0.0 */ class APIError { /** diff --git a/src/model/AcceptCouponEffectProps.js b/src/model/AcceptCouponEffectProps.js index 726b3e31..504bcacf 100644 --- a/src/model/AcceptCouponEffectProps.js +++ b/src/model/AcceptCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AcceptCouponEffectProps model module. * @module model/AcceptCouponEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class AcceptCouponEffectProps { /** diff --git a/src/model/AcceptReferralEffectProps.js b/src/model/AcceptReferralEffectProps.js index 83fbe9ba..64f529c2 100644 --- a/src/model/AcceptReferralEffectProps.js +++ b/src/model/AcceptReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AcceptReferralEffectProps model module. * @module model/AcceptReferralEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class AcceptReferralEffectProps { /** diff --git a/src/model/AccessLogEntry.js b/src/model/AccessLogEntry.js index 46a7eb36..fb0d1a04 100644 --- a/src/model/AccessLogEntry.js +++ b/src/model/AccessLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccessLogEntry model module. * @module model/AccessLogEntry - * @version 5.0.1 + * @version 6.0.0 */ class AccessLogEntry { /** diff --git a/src/model/Account.js b/src/model/Account.js index 08518341..157c4b4f 100644 --- a/src/model/Account.js +++ b/src/model/Account.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Account model module. * @module model/Account - * @version 5.0.1 + * @version 6.0.0 */ class Account { /** diff --git a/src/model/AccountAdditionalCost.js b/src/model/AccountAdditionalCost.js index b3d4d752..5d1f75cd 100644 --- a/src/model/AccountAdditionalCost.js +++ b/src/model/AccountAdditionalCost.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountAdditionalCost model module. * @module model/AccountAdditionalCost - * @version 5.0.1 + * @version 6.0.0 */ class AccountAdditionalCost { /** diff --git a/src/model/AccountAnalytics.js b/src/model/AccountAnalytics.js index 5311c403..136999cd 100644 --- a/src/model/AccountAnalytics.js +++ b/src/model/AccountAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountAnalytics model module. * @module model/AccountAnalytics - * @version 5.0.1 + * @version 6.0.0 */ class AccountAnalytics { /** @@ -41,10 +41,11 @@ class AccountAnalytics { * @param webhooks {Number} Total number of webhooks in the account. * @param loyaltyPrograms {Number} Total number of all loyalty programs in the account. * @param liveLoyaltyPrograms {Number} Total number of live loyalty programs in the account. + * @param lastUpdatedAt {Date} The point in time when the analytics numbers were updated last. */ - constructor(applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms) { + constructor(applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms, lastUpdatedAt) { - AccountAnalytics.initialize(this, applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms); + AccountAnalytics.initialize(this, applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms, lastUpdatedAt); } /** @@ -52,7 +53,7 @@ class AccountAnalytics { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms) { + static initialize(obj, applications, liveApplications, sandboxApplications, campaigns, activeCampaigns, liveActiveCampaigns, coupons, activeCoupons, expiredCoupons, referralCodes, activeReferralCodes, expiredReferralCodes, activeRules, users, roles, customAttributes, webhooks, loyaltyPrograms, liveLoyaltyPrograms, lastUpdatedAt) { obj['applications'] = applications; obj['liveApplications'] = liveApplications; obj['sandboxApplications'] = sandboxApplications; @@ -72,6 +73,7 @@ class AccountAnalytics { obj['webhooks'] = webhooks; obj['loyaltyPrograms'] = loyaltyPrograms; obj['liveLoyaltyPrograms'] = liveLoyaltyPrograms; + obj['lastUpdatedAt'] = lastUpdatedAt; } /** @@ -142,6 +144,9 @@ class AccountAnalytics { if (data.hasOwnProperty('liveLoyaltyPrograms')) { obj['liveLoyaltyPrograms'] = ApiClient.convertToType(data['liveLoyaltyPrograms'], 'Number'); } + if (data.hasOwnProperty('lastUpdatedAt')) { + obj['lastUpdatedAt'] = ApiClient.convertToType(data['lastUpdatedAt'], 'Date'); + } } return obj; } @@ -263,6 +268,12 @@ AccountAnalytics.prototype['loyaltyPrograms'] = undefined; */ AccountAnalytics.prototype['liveLoyaltyPrograms'] = undefined; +/** + * The point in time when the analytics numbers were updated last. + * @member {Date} lastUpdatedAt + */ +AccountAnalytics.prototype['lastUpdatedAt'] = undefined; + diff --git a/src/model/AccountDashboardStatistic.js b/src/model/AccountDashboardStatistic.js index 17e99ae7..8a06b422 100644 --- a/src/model/AccountDashboardStatistic.js +++ b/src/model/AccountDashboardStatistic.js @@ -22,7 +22,7 @@ import AccountDashboardStatisticRevenue from './AccountDashboardStatisticRevenue /** * The AccountDashboardStatistic model module. * @module model/AccountDashboardStatistic - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatistic { /** diff --git a/src/model/AccountDashboardStatisticApiCalls.js b/src/model/AccountDashboardStatisticApiCalls.js index 149c55e5..9d7982b1 100644 --- a/src/model/AccountDashboardStatisticApiCalls.js +++ b/src/model/AccountDashboardStatisticApiCalls.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticApiCalls model module. * @module model/AccountDashboardStatisticApiCalls - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticApiCalls { /** diff --git a/src/model/AccountDashboardStatisticCampaigns.js b/src/model/AccountDashboardStatisticCampaigns.js index 0b270e5d..7c436b82 100644 --- a/src/model/AccountDashboardStatisticCampaigns.js +++ b/src/model/AccountDashboardStatisticCampaigns.js @@ -16,18 +16,19 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticCampaigns model module. * @module model/AccountDashboardStatisticCampaigns - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticCampaigns { /** * Constructs a new AccountDashboardStatisticCampaigns. * @alias module:model/AccountDashboardStatisticCampaigns * @param live {Number} Number of campaigns that are active and live (across all Applications). - * @param endingSoon {Number} Campaigns with a schedule ending in 7 days or with only 10% of budget left. + * @param endingSoon {Number} Campaigns scheduled to expire sometime in the next 7 days. + * @param lowOnBudget {Number} Campaigns with less than 10% of budget left. */ - constructor(live, endingSoon) { + constructor(live, endingSoon, lowOnBudget) { - AccountDashboardStatisticCampaigns.initialize(this, live, endingSoon); + AccountDashboardStatisticCampaigns.initialize(this, live, endingSoon, lowOnBudget); } /** @@ -35,9 +36,10 @@ class AccountDashboardStatisticCampaigns { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, live, endingSoon) { + static initialize(obj, live, endingSoon, lowOnBudget) { obj['live'] = live; obj['endingSoon'] = endingSoon; + obj['lowOnBudget'] = lowOnBudget; } /** @@ -57,6 +59,9 @@ class AccountDashboardStatisticCampaigns { if (data.hasOwnProperty('endingSoon')) { obj['endingSoon'] = ApiClient.convertToType(data['endingSoon'], 'Number'); } + if (data.hasOwnProperty('lowOnBudget')) { + obj['lowOnBudget'] = ApiClient.convertToType(data['lowOnBudget'], 'Number'); + } } return obj; } @@ -71,11 +76,17 @@ class AccountDashboardStatisticCampaigns { AccountDashboardStatisticCampaigns.prototype['live'] = undefined; /** - * Campaigns with a schedule ending in 7 days or with only 10% of budget left. + * Campaigns scheduled to expire sometime in the next 7 days. * @member {Number} endingSoon */ AccountDashboardStatisticCampaigns.prototype['endingSoon'] = undefined; +/** + * Campaigns with less than 10% of budget left. + * @member {Number} lowOnBudget + */ +AccountDashboardStatisticCampaigns.prototype['lowOnBudget'] = undefined; + diff --git a/src/model/AccountDashboardStatisticDiscount.js b/src/model/AccountDashboardStatisticDiscount.js index 48f94a18..b7a868bc 100644 --- a/src/model/AccountDashboardStatisticDiscount.js +++ b/src/model/AccountDashboardStatisticDiscount.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticDiscount model module. * @module model/AccountDashboardStatisticDiscount - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticDiscount { /** diff --git a/src/model/AccountDashboardStatisticLoyaltyPoints.js b/src/model/AccountDashboardStatisticLoyaltyPoints.js index 27c003bd..47c301cc 100644 --- a/src/model/AccountDashboardStatisticLoyaltyPoints.js +++ b/src/model/AccountDashboardStatisticLoyaltyPoints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticLoyaltyPoints model module. * @module model/AccountDashboardStatisticLoyaltyPoints - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticLoyaltyPoints { /** diff --git a/src/model/AccountDashboardStatisticReferrals.js b/src/model/AccountDashboardStatisticReferrals.js index cc42cdec..49274dce 100644 --- a/src/model/AccountDashboardStatisticReferrals.js +++ b/src/model/AccountDashboardStatisticReferrals.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticReferrals model module. * @module model/AccountDashboardStatisticReferrals - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticReferrals { /** diff --git a/src/model/AccountDashboardStatisticRevenue.js b/src/model/AccountDashboardStatisticRevenue.js index 7ff2575e..64e34697 100644 --- a/src/model/AccountDashboardStatisticRevenue.js +++ b/src/model/AccountDashboardStatisticRevenue.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountDashboardStatisticRevenue model module. * @module model/AccountDashboardStatisticRevenue - * @version 5.0.1 + * @version 6.0.0 */ class AccountDashboardStatisticRevenue { /** diff --git a/src/model/AccountEntity.js b/src/model/AccountEntity.js index 7e0f0906..004f970d 100644 --- a/src/model/AccountEntity.js +++ b/src/model/AccountEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountEntity model module. * @module model/AccountEntity - * @version 5.0.1 + * @version 6.0.0 */ class AccountEntity { /** diff --git a/src/model/AccountLimits.js b/src/model/AccountLimits.js index bd4a7e92..e3055bad 100644 --- a/src/model/AccountLimits.js +++ b/src/model/AccountLimits.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AccountLimits model module. * @module model/AccountLimits - * @version 5.0.1 + * @version 6.0.0 */ class AccountLimits { /** diff --git a/src/model/Achievement.js b/src/model/Achievement.js new file mode 100644 index 00000000..f380132c --- /dev/null +++ b/src/model/Achievement.js @@ -0,0 +1,172 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import TimePoint from './TimePoint'; + +/** + * The Achievement model module. + * @module model/Achievement + * @version 6.0.0 + */ +class Achievement { + /** + * Constructs a new Achievement. + * + * @alias module:model/Achievement + * @param id {Number} Internal ID of this entity. + * @param created {Date} The time this entity was created. + * @param name {String} The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. + * @param title {String} The display name for the achievement in the Campaign Manager. + * @param description {String} A description of the achievement. + * @param target {Number} The maximum number of times a specific action must be completed by a customer profile over a defined period of time. + * @param period {String} The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. + * @param userId {Number} ID of the user that created this achievement. + * @param createdBy {String} Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. + */ + constructor(id, created, name, title, description, target, period, userId, createdBy) { + + Achievement.initialize(this, id, created, name, title, description, target, period, userId, createdBy); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, name, title, description, target, period, userId, createdBy) { + obj['id'] = id; + obj['created'] = created; + obj['name'] = name; + obj['title'] = title; + obj['description'] = description; + obj['target'] = target; + obj['period'] = period; + obj['userId'] = userId; + obj['createdBy'] = createdBy; + } + + /** + * Constructs a Achievement from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Achievement} obj Optional instance to populate. + * @return {module:model/Achievement} The populated Achievement instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new Achievement(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('title')) { + obj['title'] = ApiClient.convertToType(data['title'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('target')) { + obj['target'] = ApiClient.convertToType(data['target'], 'Number'); + } + if (data.hasOwnProperty('period')) { + obj['period'] = ApiClient.convertToType(data['period'], 'String'); + } + if (data.hasOwnProperty('periodEndOverride')) { + obj['periodEndOverride'] = TimePoint.constructFromObject(data['periodEndOverride']); + } + if (data.hasOwnProperty('userId')) { + obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); + } + if (data.hasOwnProperty('createdBy')) { + obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String'); + } + } + return obj; + } + + +} + +/** + * Internal ID of this entity. + * @member {Number} id + */ +Achievement.prototype['id'] = undefined; + +/** + * The time this entity was created. + * @member {Date} created + */ +Achievement.prototype['created'] = undefined; + +/** + * The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. + * @member {String} name + */ +Achievement.prototype['name'] = undefined; + +/** + * The display name for the achievement in the Campaign Manager. + * @member {String} title + */ +Achievement.prototype['title'] = undefined; + +/** + * A description of the achievement. + * @member {String} description + */ +Achievement.prototype['description'] = undefined; + +/** + * The maximum number of times a specific action must be completed by a customer profile over a defined period of time. + * @member {Number} target + */ +Achievement.prototype['target'] = undefined; + +/** + * The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. + * @member {String} period + */ +Achievement.prototype['period'] = undefined; + +/** + * @member {module:model/TimePoint} periodEndOverride + */ +Achievement.prototype['periodEndOverride'] = undefined; + +/** + * ID of the user that created this achievement. + * @member {Number} userId + */ +Achievement.prototype['userId'] = undefined; + +/** + * Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. + * @member {String} createdBy + */ +Achievement.prototype['createdBy'] = undefined; + + + + + + +export default Achievement; + diff --git a/src/model/AchievementAdditionalProperties.js b/src/model/AchievementAdditionalProperties.js new file mode 100644 index 00000000..a633f604 --- /dev/null +++ b/src/model/AchievementAdditionalProperties.js @@ -0,0 +1,85 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The AchievementAdditionalProperties model module. + * @module model/AchievementAdditionalProperties + * @version 6.0.0 + */ +class AchievementAdditionalProperties { + /** + * Constructs a new AchievementAdditionalProperties. + * @alias module:model/AchievementAdditionalProperties + * @param userId {Number} ID of the user that created this achievement. + * @param createdBy {String} Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. + */ + constructor(userId, createdBy) { + + AchievementAdditionalProperties.initialize(this, userId, createdBy); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, userId, createdBy) { + obj['userId'] = userId; + obj['createdBy'] = createdBy; + } + + /** + * Constructs a AchievementAdditionalProperties from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/AchievementAdditionalProperties} obj Optional instance to populate. + * @return {module:model/AchievementAdditionalProperties} The populated AchievementAdditionalProperties instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new AchievementAdditionalProperties(); + + if (data.hasOwnProperty('userId')) { + obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); + } + if (data.hasOwnProperty('createdBy')) { + obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String'); + } + } + return obj; + } + + +} + +/** + * ID of the user that created this achievement. + * @member {Number} userId + */ +AchievementAdditionalProperties.prototype['userId'] = undefined; + +/** + * Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. + * @member {String} createdBy + */ +AchievementAdditionalProperties.prototype['createdBy'] = undefined; + + + + + + +export default AchievementAdditionalProperties; + diff --git a/src/model/AddFreeItemEffectProps.js b/src/model/AddFreeItemEffectProps.js index cfc65743..1597fee1 100644 --- a/src/model/AddFreeItemEffectProps.js +++ b/src/model/AddFreeItemEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AddFreeItemEffectProps model module. * @module model/AddFreeItemEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class AddFreeItemEffectProps { /** diff --git a/src/model/AddItemCatalogAction.js b/src/model/AddItemCatalogAction.js index 16b8a983..a57d0a83 100644 --- a/src/model/AddItemCatalogAction.js +++ b/src/model/AddItemCatalogAction.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AddItemCatalogAction model module. * @module model/AddItemCatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class AddItemCatalogAction { /** diff --git a/src/model/AddLoyaltyPoints.js b/src/model/AddLoyaltyPoints.js index d2aaa275..977fae35 100644 --- a/src/model/AddLoyaltyPoints.js +++ b/src/model/AddLoyaltyPoints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AddLoyaltyPoints model module. * @module model/AddLoyaltyPoints - * @version 5.0.1 + * @version 6.0.0 */ class AddLoyaltyPoints { /** diff --git a/src/model/AddLoyaltyPointsEffectProps.js b/src/model/AddLoyaltyPointsEffectProps.js index af598209..5c1f1a36 100644 --- a/src/model/AddLoyaltyPointsEffectProps.js +++ b/src/model/AddLoyaltyPointsEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AddLoyaltyPointsEffectProps model module. * @module model/AddLoyaltyPointsEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class AddLoyaltyPointsEffectProps { /** @@ -170,7 +170,7 @@ AddLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined; AddLoyaltyPointsEffectProps.prototype['cartItemPosition'] = undefined; /** - * The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. + * For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. * @member {Number} cartItemSubPosition */ AddLoyaltyPointsEffectProps.prototype['cartItemSubPosition'] = undefined; diff --git a/src/model/AddToAudienceEffectProps.js b/src/model/AddToAudienceEffectProps.js new file mode 100644 index 00000000..9933b47e --- /dev/null +++ b/src/model/AddToAudienceEffectProps.js @@ -0,0 +1,100 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The AddToAudienceEffectProps model module. + * @module model/AddToAudienceEffectProps + * @version 6.0.0 + */ +class AddToAudienceEffectProps { + /** + * Constructs a new AddToAudienceEffectProps. + * The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect. + * @alias module:model/AddToAudienceEffectProps + */ + constructor() { + + AddToAudienceEffectProps.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a AddToAudienceEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/AddToAudienceEffectProps} obj Optional instance to populate. + * @return {module:model/AddToAudienceEffectProps} The populated AddToAudienceEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new AddToAudienceEffectProps(); + + if (data.hasOwnProperty('audienceId')) { + obj['audienceId'] = ApiClient.convertToType(data['audienceId'], 'Number'); + } + if (data.hasOwnProperty('audienceName')) { + obj['audienceName'] = ApiClient.convertToType(data['audienceName'], 'String'); + } + if (data.hasOwnProperty('profileIntegrationId')) { + obj['profileIntegrationId'] = ApiClient.convertToType(data['profileIntegrationId'], 'String'); + } + if (data.hasOwnProperty('profileId')) { + obj['profileId'] = ApiClient.convertToType(data['profileId'], 'Number'); + } + } + return obj; + } + + +} + +/** + * The internal ID of the audience. + * @member {Number} audienceId + */ +AddToAudienceEffectProps.prototype['audienceId'] = undefined; + +/** + * The name of the audience. + * @member {String} audienceName + */ +AddToAudienceEffectProps.prototype['audienceName'] = undefined; + +/** + * The ID of the customer profile in the third-party integration platform. + * @member {String} profileIntegrationId + */ +AddToAudienceEffectProps.prototype['profileIntegrationId'] = undefined; + +/** + * The internal ID of the customer profile. + * @member {Number} profileId + */ +AddToAudienceEffectProps.prototype['profileId'] = undefined; + + + + + + +export default AddToAudienceEffectProps; + diff --git a/src/model/AddedDeductedPointsNotificationPolicy.js b/src/model/AddedDeductedPointsNotificationPolicy.js index a6ad1a8c..e57c12c3 100644 --- a/src/model/AddedDeductedPointsNotificationPolicy.js +++ b/src/model/AddedDeductedPointsNotificationPolicy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AddedDeductedPointsNotificationPolicy model module. * @module model/AddedDeductedPointsNotificationPolicy - * @version 5.0.1 + * @version 6.0.0 */ class AddedDeductedPointsNotificationPolicy { /** diff --git a/src/model/AdditionalCampaignProperties.js b/src/model/AdditionalCampaignProperties.js new file mode 100644 index 00000000..3eefbfd0 --- /dev/null +++ b/src/model/AdditionalCampaignProperties.js @@ -0,0 +1,255 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import CampaignBudget from './CampaignBudget'; + +/** + * The AdditionalCampaignProperties model module. + * @module model/AdditionalCampaignProperties + * @version 6.0.0 + */ +class AdditionalCampaignProperties { + /** + * Constructs a new AdditionalCampaignProperties. + * @alias module:model/AdditionalCampaignProperties + * @param budgets {Array.} A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + */ + constructor(budgets) { + + AdditionalCampaignProperties.initialize(this, budgets); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, budgets) { + obj['budgets'] = budgets; + } + + /** + * Constructs a AdditionalCampaignProperties from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/AdditionalCampaignProperties} obj Optional instance to populate. + * @return {module:model/AdditionalCampaignProperties} The populated AdditionalCampaignProperties instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new AdditionalCampaignProperties(); + + if (data.hasOwnProperty('budgets')) { + obj['budgets'] = ApiClient.convertToType(data['budgets'], [CampaignBudget]); + } + if (data.hasOwnProperty('couponRedemptionCount')) { + obj['couponRedemptionCount'] = ApiClient.convertToType(data['couponRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('referralRedemptionCount')) { + obj['referralRedemptionCount'] = ApiClient.convertToType(data['referralRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('discountCount')) { + obj['discountCount'] = ApiClient.convertToType(data['discountCount'], 'Number'); + } + if (data.hasOwnProperty('discountEffectCount')) { + obj['discountEffectCount'] = ApiClient.convertToType(data['discountEffectCount'], 'Number'); + } + if (data.hasOwnProperty('couponCreationCount')) { + obj['couponCreationCount'] = ApiClient.convertToType(data['couponCreationCount'], 'Number'); + } + if (data.hasOwnProperty('customEffectCount')) { + obj['customEffectCount'] = ApiClient.convertToType(data['customEffectCount'], 'Number'); + } + if (data.hasOwnProperty('referralCreationCount')) { + obj['referralCreationCount'] = ApiClient.convertToType(data['referralCreationCount'], 'Number'); + } + if (data.hasOwnProperty('addFreeItemEffectCount')) { + obj['addFreeItemEffectCount'] = ApiClient.convertToType(data['addFreeItemEffectCount'], 'Number'); + } + if (data.hasOwnProperty('awardedGiveawaysCount')) { + obj['awardedGiveawaysCount'] = ApiClient.convertToType(data['awardedGiveawaysCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsCount')) { + obj['createdLoyaltyPointsCount'] = ApiClient.convertToType(data['createdLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsEffectCount')) { + obj['createdLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['createdLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsCount')) { + obj['redeemedLoyaltyPointsCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsEffectCount')) { + obj['redeemedLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('callApiEffectCount')) { + obj['callApiEffectCount'] = ApiClient.convertToType(data['callApiEffectCount'], 'Number'); + } + if (data.hasOwnProperty('reservecouponEffectCount')) { + obj['reservecouponEffectCount'] = ApiClient.convertToType(data['reservecouponEffectCount'], 'Number'); + } + if (data.hasOwnProperty('lastActivity')) { + obj['lastActivity'] = ApiClient.convertToType(data['lastActivity'], 'Date'); + } + if (data.hasOwnProperty('updated')) { + obj['updated'] = ApiClient.convertToType(data['updated'], 'Date'); + } + if (data.hasOwnProperty('createdBy')) { + obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String'); + } + if (data.hasOwnProperty('updatedBy')) { + obj['updatedBy'] = ApiClient.convertToType(data['updatedBy'], 'String'); + } + if (data.hasOwnProperty('templateId')) { + obj['templateId'] = ApiClient.convertToType(data['templateId'], 'Number'); + } + } + return obj; + } + + +} + +/** + * A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + * @member {Array.} budgets + */ +AdditionalCampaignProperties.prototype['budgets'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. + * @member {Number} couponRedemptionCount + */ +AdditionalCampaignProperties.prototype['couponRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. + * @member {Number} referralRedemptionCount + */ +AdditionalCampaignProperties.prototype['referralRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. + * @member {Number} discountCount + */ +AdditionalCampaignProperties.prototype['discountCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. + * @member {Number} discountEffectCount + */ +AdditionalCampaignProperties.prototype['discountEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. + * @member {Number} couponCreationCount + */ +AdditionalCampaignProperties.prototype['couponCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. + * @member {Number} customEffectCount + */ +AdditionalCampaignProperties.prototype['customEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. + * @member {Number} referralCreationCount + */ +AdditionalCampaignProperties.prototype['referralCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. + * @member {Number} addFreeItemEffectCount + */ +AdditionalCampaignProperties.prototype['addFreeItemEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. + * @member {Number} awardedGiveawaysCount + */ +AdditionalCampaignProperties.prototype['awardedGiveawaysCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. + * @member {Number} createdLoyaltyPointsCount + */ +AdditionalCampaignProperties.prototype['createdLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. + * @member {Number} createdLoyaltyPointsEffectCount + */ +AdditionalCampaignProperties.prototype['createdLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsCount + */ +AdditionalCampaignProperties.prototype['redeemedLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsEffectCount + */ +AdditionalCampaignProperties.prototype['redeemedLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. + * @member {Number} callApiEffectCount + */ +AdditionalCampaignProperties.prototype['callApiEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. + * @member {Number} reservecouponEffectCount + */ +AdditionalCampaignProperties.prototype['reservecouponEffectCount'] = undefined; + +/** + * Timestamp of the most recent event received by this campaign. + * @member {Date} lastActivity + */ +AdditionalCampaignProperties.prototype['lastActivity'] = undefined; + +/** + * Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. + * @member {Date} updated + */ +AdditionalCampaignProperties.prototype['updated'] = undefined; + +/** + * Name of the user who created this campaign if available. + * @member {String} createdBy + */ +AdditionalCampaignProperties.prototype['createdBy'] = undefined; + +/** + * Name of the user who last updated this campaign if available. + * @member {String} updatedBy + */ +AdditionalCampaignProperties.prototype['updatedBy'] = undefined; + +/** + * The ID of the Campaign Template this Campaign was created from. + * @member {Number} templateId + */ +AdditionalCampaignProperties.prototype['templateId'] = undefined; + + + + + + +export default AdditionalCampaignProperties; + diff --git a/src/model/AdditionalCost.js b/src/model/AdditionalCost.js index cfead488..04705d2d 100644 --- a/src/model/AdditionalCost.js +++ b/src/model/AdditionalCost.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AdditionalCost model module. * @module model/AdditionalCost - * @version 5.0.1 + * @version 6.0.0 */ class AdditionalCost { /** diff --git a/src/model/Application.js b/src/model/Application.js index 7e860a66..f5301be5 100644 --- a/src/model/Application.js +++ b/src/model/Application.js @@ -19,7 +19,7 @@ import LoyaltyProgram from './LoyaltyProgram'; /** * The Application model module. * @module model/Application - * @version 5.0.1 + * @version 6.0.0 */ class Application { /** @@ -213,7 +213,7 @@ Application.prototype['defaultDiscountScope'] = undefined; Application.prototype['enableCascadingDiscounts'] = undefined; /** - * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). + * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. * @member {Boolean} enableFlattenedCartItems */ Application.prototype['enableFlattenedCartItems'] = undefined; diff --git a/src/model/ApplicationAPIKey.js b/src/model/ApplicationAPIKey.js index 1e47d8d1..75f4a173 100644 --- a/src/model/ApplicationAPIKey.js +++ b/src/model/ApplicationAPIKey.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationAPIKey model module. * @module model/ApplicationAPIKey - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationAPIKey { /** @@ -204,7 +204,13 @@ ApplicationAPIKey['PlatformEnum'] = { * value: "salesforce" * @const */ - "salesforce": "salesforce" + "salesforce": "salesforce", + + /** + * value: "emarsys" + * @const + */ + "emarsys": "emarsys" }; diff --git a/src/model/ApplicationApiHealth.js b/src/model/ApplicationApiHealth.js index e3507e59..fc87936a 100644 --- a/src/model/ApplicationApiHealth.js +++ b/src/model/ApplicationApiHealth.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationApiHealth model module. * @module model/ApplicationApiHealth - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationApiHealth { /** diff --git a/src/model/ApplicationCampaignStats.js b/src/model/ApplicationCampaignStats.js index 2980607c..1232180a 100644 --- a/src/model/ApplicationCampaignStats.js +++ b/src/model/ApplicationCampaignStats.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationCampaignStats model module. * @module model/ApplicationCampaignStats - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationCampaignStats { /** diff --git a/src/model/ApplicationCustomer.js b/src/model/ApplicationCustomer.js index 84241b17..85cf68ee 100644 --- a/src/model/ApplicationCustomer.js +++ b/src/model/ApplicationCustomer.js @@ -18,7 +18,7 @@ import LoyaltyMembership from './LoyaltyMembership'; /** * The ApplicationCustomer model module. * @module model/ApplicationCustomer - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationCustomer { /** @@ -32,7 +32,7 @@ class ApplicationCustomer { * @param accountId {Number} The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. * @param closedSessions {Number} The total amount of closed sessions by a customer. A closed session is a successful purchase. * @param totalSales {Number} The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. - * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. */ constructor(id, created, integrationId, attributes, accountId, closedSessions, totalSales, lastActivity) { @@ -164,7 +164,7 @@ ApplicationCustomer.prototype['loyaltyMemberships'] = undefined; ApplicationCustomer.prototype['audienceMemberships'] = undefined; /** - * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. * @member {Date} lastActivity */ ApplicationCustomer.prototype['lastActivity'] = undefined; diff --git a/src/model/ApplicationCustomerEntity.js b/src/model/ApplicationCustomerEntity.js index 664fdea0..0bb11318 100644 --- a/src/model/ApplicationCustomerEntity.js +++ b/src/model/ApplicationCustomerEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationCustomerEntity model module. * @module model/ApplicationCustomerEntity - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationCustomerEntity { /** diff --git a/src/model/ApplicationEntity.js b/src/model/ApplicationEntity.js index 925ece49..f5b92413 100644 --- a/src/model/ApplicationEntity.js +++ b/src/model/ApplicationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationEntity model module. * @module model/ApplicationEntity - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationEntity { /** diff --git a/src/model/ApplicationEvent.js b/src/model/ApplicationEvent.js index c8ad0198..d3cc7728 100644 --- a/src/model/ApplicationEvent.js +++ b/src/model/ApplicationEvent.js @@ -18,7 +18,7 @@ import RuleFailureReason from './RuleFailureReason'; /** * The ApplicationEvent model module. * @module model/ApplicationEvent - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationEvent { /** @@ -74,6 +74,12 @@ class ApplicationEvent { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'Number'); } + if (data.hasOwnProperty('storeId')) { + obj['storeId'] = ApiClient.convertToType(data['storeId'], 'Number'); + } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('sessionId')) { obj['sessionId'] = ApiClient.convertToType(data['sessionId'], 'Number'); } @@ -120,6 +126,18 @@ ApplicationEvent.prototype['applicationId'] = undefined; */ ApplicationEvent.prototype['profileId'] = undefined; +/** + * The ID of the store. + * @member {Number} storeId + */ +ApplicationEvent.prototype['storeId'] = undefined; + +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +ApplicationEvent.prototype['storeIntegrationId'] = undefined; + /** * The globally unique Talon.One ID of the session that contains this event. * @member {Number} sessionId diff --git a/src/model/ApplicationNotification.js b/src/model/ApplicationNotification.js index 55295de6..e0d22896 100644 --- a/src/model/ApplicationNotification.js +++ b/src/model/ApplicationNotification.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationNotification model module. * @module model/ApplicationNotification - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationNotification { /** diff --git a/src/model/ApplicationReferee.js b/src/model/ApplicationReferee.js index 4c5a6597..6ddf654c 100644 --- a/src/model/ApplicationReferee.js +++ b/src/model/ApplicationReferee.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationReferee model module. * @module model/ApplicationReferee - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationReferee { /** diff --git a/src/model/ApplicationSession.js b/src/model/ApplicationSession.js index 7837da66..69af7eb0 100644 --- a/src/model/ApplicationSession.js +++ b/src/model/ApplicationSession.js @@ -17,7 +17,7 @@ import CartItem from './CartItem'; /** * The ApplicationSession model module. * @module model/ApplicationSession - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationSession { /** @@ -26,19 +26,19 @@ class ApplicationSession { * @alias module:model/ApplicationSession * @param id {Number} Internal ID of this entity. * @param created {Date} The time this entity was created. The time this entity was created. - * @param applicationId {Number} The ID of the application that owns this entity. * @param integrationId {String} The integration ID set by your integration layer. + * @param applicationId {Number} The ID of the application that owns this entity. * @param coupon {String} Any coupon code entered. * @param referral {String} Any referral code entered. - * @param state {module:model/ApplicationSession.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * @param state {module:model/ApplicationSession.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @param cartItems {Array.} Serialized JSON representation. * @param discounts {Object.} **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. * @param totalDiscounts {Number} The total sum of the discounts applied to this session. * @param total {Number} The total sum of the session before any discounts applied. */ - constructor(id, created, applicationId, integrationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total) { + constructor(id, created, integrationId, applicationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total) { - ApplicationSession.initialize(this, id, created, applicationId, integrationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total); + ApplicationSession.initialize(this, id, created, integrationId, applicationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total); } /** @@ -46,11 +46,11 @@ class ApplicationSession { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, id, created, applicationId, integrationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total) { + static initialize(obj, id, created, integrationId, applicationId, coupon, referral, state, cartItems, discounts, totalDiscounts, total) { obj['id'] = id; obj['created'] = created; - obj['applicationId'] = applicationId; obj['integrationId'] = integrationId; + obj['applicationId'] = applicationId; obj['coupon'] = coupon; obj['referral'] = referral; obj['state'] = state; @@ -77,15 +77,18 @@ class ApplicationSession { if (data.hasOwnProperty('created')) { obj['created'] = ApiClient.convertToType(data['created'], 'Date'); } + if (data.hasOwnProperty('integrationId')) { + obj['integrationId'] = ApiClient.convertToType(data['integrationId'], 'String'); + } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('applicationId')) { obj['applicationId'] = ApiClient.convertToType(data['applicationId'], 'Number'); } if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'Number'); } - if (data.hasOwnProperty('integrationId')) { - obj['integrationId'] = ApiClient.convertToType(data['integrationId'], 'String'); - } if (data.hasOwnProperty('profileintegrationid')) { obj['profileintegrationid'] = ApiClient.convertToType(data['profileintegrationid'], 'String'); } @@ -132,6 +135,18 @@ ApplicationSession.prototype['id'] = undefined; */ ApplicationSession.prototype['created'] = undefined; +/** + * The integration ID set by your integration layer. + * @member {String} integrationId + */ +ApplicationSession.prototype['integrationId'] = undefined; + +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +ApplicationSession.prototype['storeIntegrationId'] = undefined; + /** * The ID of the application that owns this entity. * @member {Number} applicationId @@ -144,12 +159,6 @@ ApplicationSession.prototype['applicationId'] = undefined; */ ApplicationSession.prototype['profileId'] = undefined; -/** - * The integration ID set by your integration layer. - * @member {String} integrationId - */ -ApplicationSession.prototype['integrationId'] = undefined; - /** * Integration ID of the customer for the session. * @member {String} profileintegrationid @@ -169,7 +178,7 @@ ApplicationSession.prototype['coupon'] = undefined; ApplicationSession.prototype['referral'] = undefined; /** - * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @member {module:model/ApplicationSession.StateEnum} state */ ApplicationSession.prototype['state'] = undefined; diff --git a/src/model/ApplicationSessionEntity.js b/src/model/ApplicationSessionEntity.js index 565cf89d..e6468d10 100644 --- a/src/model/ApplicationSessionEntity.js +++ b/src/model/ApplicationSessionEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ApplicationSessionEntity model module. * @module model/ApplicationSessionEntity - * @version 5.0.1 + * @version 6.0.0 */ class ApplicationSessionEntity { /** diff --git a/src/model/ApplicationStoreEntity.js b/src/model/ApplicationStoreEntity.js new file mode 100644 index 00000000..1033e3eb --- /dev/null +++ b/src/model/ApplicationStoreEntity.js @@ -0,0 +1,72 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The ApplicationStoreEntity model module. + * @module model/ApplicationStoreEntity + * @version 6.0.0 + */ +class ApplicationStoreEntity { + /** + * Constructs a new ApplicationStoreEntity. + * @alias module:model/ApplicationStoreEntity + */ + constructor() { + + ApplicationStoreEntity.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a ApplicationStoreEntity from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ApplicationStoreEntity} obj Optional instance to populate. + * @return {module:model/ApplicationStoreEntity} The populated ApplicationStoreEntity instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ApplicationStoreEntity(); + + if (data.hasOwnProperty('storeId')) { + obj['storeId'] = ApiClient.convertToType(data['storeId'], 'Number'); + } + } + return obj; + } + + +} + +/** + * The ID of the store. + * @member {Number} storeId + */ +ApplicationStoreEntity.prototype['storeId'] = undefined; + + + + + + +export default ApplicationStoreEntity; + diff --git a/src/model/AsyncCouponCreationResponse.js b/src/model/AsyncCouponCreationResponse.js index 9bee64e7..939467c2 100644 --- a/src/model/AsyncCouponCreationResponse.js +++ b/src/model/AsyncCouponCreationResponse.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AsyncCouponCreationResponse model module. * @module model/AsyncCouponCreationResponse - * @version 5.0.1 + * @version 6.0.0 */ class AsyncCouponCreationResponse { /** diff --git a/src/model/Attribute.js b/src/model/Attribute.js index fb91f424..713966f5 100644 --- a/src/model/Attribute.js +++ b/src/model/Attribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Attribute model module. * @module model/Attribute - * @version 5.0.1 + * @version 6.0.0 */ class Attribute { /** @@ -297,7 +297,13 @@ Attribute['EntityEnum'] = { * value: "Referral" * @const */ - "Referral": "Referral" + "Referral": "Referral", + + /** + * value: "Store" + * @const + */ + "Store": "Store" }; diff --git a/src/model/AttributesMandatory.js b/src/model/AttributesMandatory.js index 387b99e0..1ac027d3 100644 --- a/src/model/AttributesMandatory.js +++ b/src/model/AttributesMandatory.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AttributesMandatory model module. * @module model/AttributesMandatory - * @version 5.0.1 + * @version 6.0.0 */ class AttributesMandatory { /** diff --git a/src/model/AttributesSettings.js b/src/model/AttributesSettings.js index c08db354..3452534f 100644 --- a/src/model/AttributesSettings.js +++ b/src/model/AttributesSettings.js @@ -17,7 +17,7 @@ import AttributesMandatory from './AttributesMandatory'; /** * The AttributesSettings model module. * @module model/AttributesSettings - * @version 5.0.1 + * @version 6.0.0 */ class AttributesSettings { /** diff --git a/src/model/Audience.js b/src/model/Audience.js index 2a8dfc23..edd82975 100644 --- a/src/model/Audience.js +++ b/src/model/Audience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Audience model module. * @module model/Audience - * @version 5.0.1 + * @version 6.0.0 */ class Audience { /** diff --git a/src/model/AudienceAnalytics.js b/src/model/AudienceAnalytics.js index f159383c..e3dd592b 100644 --- a/src/model/AudienceAnalytics.js +++ b/src/model/AudienceAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AudienceAnalytics model module. * @module model/AudienceAnalytics - * @version 5.0.1 + * @version 6.0.0 */ class AudienceAnalytics { /** diff --git a/src/model/AudienceCustomer.js b/src/model/AudienceCustomer.js index 32fbeca8..7ddd62b3 100644 --- a/src/model/AudienceCustomer.js +++ b/src/model/AudienceCustomer.js @@ -18,7 +18,7 @@ import LoyaltyMembership from './LoyaltyMembership'; /** * The AudienceCustomer model module. * @module model/AudienceCustomer - * @version 5.0.1 + * @version 6.0.0 */ class AudienceCustomer { /** @@ -32,7 +32,7 @@ class AudienceCustomer { * @param accountId {Number} The ID of the Talon.One account that owns this profile. * @param closedSessions {Number} The total amount of closed sessions by a customer. A closed session is a successful purchase. * @param totalSales {Number} The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. - * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. */ constructor(id, created, integrationId, attributes, accountId, closedSessions, totalSales, lastActivity) { @@ -167,7 +167,7 @@ AudienceCustomer.prototype['loyaltyMemberships'] = undefined; AudienceCustomer.prototype['audienceMemberships'] = undefined; /** - * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. * @member {Date} lastActivity */ AudienceCustomer.prototype['lastActivity'] = undefined; diff --git a/src/model/AudienceIntegrationID.js b/src/model/AudienceIntegrationID.js index cfa9cc23..9bfbbdc2 100644 --- a/src/model/AudienceIntegrationID.js +++ b/src/model/AudienceIntegrationID.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AudienceIntegrationID model module. * @module model/AudienceIntegrationID - * @version 5.0.1 + * @version 6.0.0 */ class AudienceIntegrationID { /** diff --git a/src/model/AudienceMembership.js b/src/model/AudienceMembership.js index 4e11d785..0a661b2c 100644 --- a/src/model/AudienceMembership.js +++ b/src/model/AudienceMembership.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AudienceMembership model module. * @module model/AudienceMembership - * @version 5.0.1 + * @version 6.0.0 */ class AudienceMembership { /** diff --git a/src/model/AwardGiveawayEffectProps.js b/src/model/AwardGiveawayEffectProps.js index dc56ef30..037d6d69 100644 --- a/src/model/AwardGiveawayEffectProps.js +++ b/src/model/AwardGiveawayEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The AwardGiveawayEffectProps model module. * @module model/AwardGiveawayEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class AwardGiveawayEffectProps { /** diff --git a/src/model/BaseCampaign.js b/src/model/BaseCampaign.js index 163faac2..f52b3d58 100644 --- a/src/model/BaseCampaign.js +++ b/src/model/BaseCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The BaseCampaign model module. * @module model/BaseCampaign - * @version 5.0.1 + * @version 6.0.0 */ class BaseCampaign { /** @@ -98,6 +98,15 @@ class BaseCampaign { if (data.hasOwnProperty('campaignGroups')) { obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } } return obj; } @@ -182,6 +191,25 @@ BaseCampaign.prototype['limits'] = undefined; */ BaseCampaign.prototype['campaignGroups'] = undefined; +/** + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +BaseCampaign.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/BaseCampaign.TypeEnum} type + * @default 'advanced' + */ +BaseCampaign.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +BaseCampaign.prototype['linkedStoreIds'] = undefined; + @@ -252,6 +280,27 @@ BaseCampaign['FeaturesEnum'] = { }; +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +BaseCampaign['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default BaseCampaign; diff --git a/src/model/BaseCampaignForNotification.js b/src/model/BaseCampaignForNotification.js new file mode 100644 index 00000000..dc04c823 --- /dev/null +++ b/src/model/BaseCampaignForNotification.js @@ -0,0 +1,330 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import CodeGeneratorSettings from './CodeGeneratorSettings'; +import LimitConfig from './LimitConfig'; + +/** + * The BaseCampaignForNotification model module. + * @module model/BaseCampaignForNotification + * @version 6.0.0 + */ +class BaseCampaignForNotification { + /** + * Constructs a new BaseCampaignForNotification. + * @alias module:model/BaseCampaignForNotification + * @param name {String} A user-facing name for this campaign. + * @param state {module:model/BaseCampaignForNotification.StateEnum} A disabled or archived campaign is not evaluated for rules or coupons. + * @param tags {Array.} A list of tags for the campaign. + * @param features {Array.} The features enabled in this campaign. + * @param limits {Array.} The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + */ + constructor(name, state, tags, features, limits) { + + BaseCampaignForNotification.initialize(this, name, state, tags, features, limits); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name, state, tags, features, limits) { + obj['name'] = name; + obj['state'] = state; + obj['tags'] = tags; + obj['features'] = features; + obj['limits'] = limits; + } + + /** + * Constructs a BaseCampaignForNotification from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/BaseCampaignForNotification} obj Optional instance to populate. + * @return {module:model/BaseCampaignForNotification} The populated BaseCampaignForNotification instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new BaseCampaignForNotification(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('startTime')) { + obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date'); + } + if (data.hasOwnProperty('endTime')) { + obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('state')) { + obj['state'] = ApiClient.convertToType(data['state'], 'String'); + } + if (data.hasOwnProperty('activeRulesetId')) { + obj['activeRulesetId'] = ApiClient.convertToType(data['activeRulesetId'], 'Number'); + } + if (data.hasOwnProperty('tags')) { + obj['tags'] = ApiClient.convertToType(data['tags'], ['String']); + } + if (data.hasOwnProperty('features')) { + obj['features'] = ApiClient.convertToType(data['features'], ['String']); + } + if (data.hasOwnProperty('couponSettings')) { + obj['couponSettings'] = CodeGeneratorSettings.constructFromObject(data['couponSettings']); + } + if (data.hasOwnProperty('referralSettings')) { + obj['referralSettings'] = CodeGeneratorSettings.constructFromObject(data['referralSettings']); + } + if (data.hasOwnProperty('limits')) { + obj['limits'] = ApiClient.convertToType(data['limits'], [LimitConfig]); + } + if (data.hasOwnProperty('campaignGroups')) { + obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); + } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } + } + return obj; + } + + +} + +/** + * A user-facing name for this campaign. + * @member {String} name + */ +BaseCampaignForNotification.prototype['name'] = undefined; + +/** + * A detailed description of the campaign. + * @member {String} description + */ +BaseCampaignForNotification.prototype['description'] = undefined; + +/** + * Timestamp when the campaign will become active. + * @member {Date} startTime + */ +BaseCampaignForNotification.prototype['startTime'] = undefined; + +/** + * Timestamp when the campaign will become inactive. + * @member {Date} endTime + */ +BaseCampaignForNotification.prototype['endTime'] = undefined; + +/** + * Arbitrary properties associated with this campaign. + * @member {Object} attributes + */ +BaseCampaignForNotification.prototype['attributes'] = undefined; + +/** + * A disabled or archived campaign is not evaluated for rules or coupons. + * @member {module:model/BaseCampaignForNotification.StateEnum} state + * @default 'enabled' + */ +BaseCampaignForNotification.prototype['state'] = 'enabled'; + +/** + * [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. + * @member {Number} activeRulesetId + */ +BaseCampaignForNotification.prototype['activeRulesetId'] = undefined; + +/** + * A list of tags for the campaign. + * @member {Array.} tags + */ +BaseCampaignForNotification.prototype['tags'] = undefined; + +/** + * The features enabled in this campaign. + * @member {Array.} features + */ +BaseCampaignForNotification.prototype['features'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} couponSettings + */ +BaseCampaignForNotification.prototype['couponSettings'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} referralSettings + */ +BaseCampaignForNotification.prototype['referralSettings'] = undefined; + +/** + * The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @member {Array.} limits + */ +BaseCampaignForNotification.prototype['limits'] = undefined; + +/** + * The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. + * @member {Array.} campaignGroups + */ +BaseCampaignForNotification.prototype['campaignGroups'] = undefined; + +/** + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +BaseCampaignForNotification.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/BaseCampaignForNotification.TypeEnum} type + * @default 'advanced' + */ +BaseCampaignForNotification.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +BaseCampaignForNotification.prototype['linkedStoreIds'] = undefined; + + + + + +/** + * Allowed values for the state property. + * @enum {String} + * @readonly + */ +BaseCampaignForNotification['StateEnum'] = { + + /** + * value: "enabled" + * @const + */ + "enabled": "enabled", + + /** + * value: "disabled" + * @const + */ + "disabled": "disabled", + + /** + * value: "archived" + * @const + */ + "archived": "archived", + + /** + * value: "draft" + * @const + */ + "draft": "draft", + + /** + * value: "scheduled" + * @const + */ + "scheduled": "scheduled", + + /** + * value: "running" + * @const + */ + "running": "running", + + /** + * value: "expired" + * @const + */ + "expired": "expired" +}; + + +/** + * Allowed values for the features property. + * @enum {String} + * @readonly + */ +BaseCampaignForNotification['FeaturesEnum'] = { + + /** + * value: "coupons" + * @const + */ + "coupons": "coupons", + + /** + * value: "referrals" + * @const + */ + "referrals": "referrals", + + /** + * value: "loyalty" + * @const + */ + "loyalty": "loyalty", + + /** + * value: "giveaways" + * @const + */ + "giveaways": "giveaways", + + /** + * value: "strikethrough" + * @const + */ + "strikethrough": "strikethrough" +}; + + +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +BaseCampaignForNotification['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + + +export default BaseCampaignForNotification; + diff --git a/src/model/BaseLoyaltyProgram.js b/src/model/BaseLoyaltyProgram.js index 263ad853..da5351a5 100644 --- a/src/model/BaseLoyaltyProgram.js +++ b/src/model/BaseLoyaltyProgram.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The BaseLoyaltyProgram model module. * @module model/BaseLoyaltyProgram - * @version 5.0.1 + * @version 6.0.0 */ class BaseLoyaltyProgram { /** @@ -133,7 +133,7 @@ BaseLoyaltyProgram.prototype['usersPerCardLimit'] = undefined; BaseLoyaltyProgram.prototype['sandbox'] = undefined; /** - * The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. + * The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. * @member {String} tiersExpireIn */ BaseLoyaltyProgram.prototype['tiersExpireIn'] = undefined; diff --git a/src/model/BaseNotification.js b/src/model/BaseNotification.js index ed01205f..b6de8412 100644 --- a/src/model/BaseNotification.js +++ b/src/model/BaseNotification.js @@ -17,7 +17,7 @@ import BaseNotificationWebhook from './BaseNotificationWebhook'; /** * The BaseNotification model module. * @module model/BaseNotification - * @version 5.0.1 + * @version 6.0.0 */ class BaseNotification { /** @@ -27,10 +27,11 @@ class BaseNotification { * @param policy {Object} * @param webhook {module:model/BaseNotificationWebhook} * @param id {Number} Unique ID for this entity. + * @param type {module:model/BaseNotification.TypeEnum} The notification type. */ - constructor(policy, webhook, id) { + constructor(policy, webhook, id, type) { - BaseNotification.initialize(this, policy, webhook, id); + BaseNotification.initialize(this, policy, webhook, id, type); } /** @@ -38,10 +39,11 @@ class BaseNotification { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, policy, webhook, id) { + static initialize(obj, policy, webhook, id, type) { obj['policy'] = policy; obj['webhook'] = webhook; obj['id'] = id; + obj['type'] = type; } /** @@ -58,12 +60,18 @@ class BaseNotification { if (data.hasOwnProperty('policy')) { obj['policy'] = ApiClient.convertToType(data['policy'], Object); } + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } if (data.hasOwnProperty('webhook')) { obj['webhook'] = BaseNotificationWebhook.constructFromObject(data['webhook']); } if (data.hasOwnProperty('id')) { obj['id'] = ApiClient.convertToType(data['id'], 'Number'); } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } } return obj; } @@ -76,6 +84,13 @@ class BaseNotification { */ BaseNotification.prototype['policy'] = undefined; +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + * @default true + */ +BaseNotification.prototype['enabled'] = true; + /** * @member {module:model/BaseNotificationWebhook} webhook */ @@ -87,8 +102,77 @@ BaseNotification.prototype['webhook'] = undefined; */ BaseNotification.prototype['id'] = undefined; +/** + * The notification type. + * @member {module:model/BaseNotification.TypeEnum} type + */ +BaseNotification.prototype['type'] = undefined; + + + +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +BaseNotification['TypeEnum'] = { + + /** + * value: "campaign" + * @const + */ + "campaign": "campaign", + + /** + * value: "loyalty_added_deducted_points" + * @const + */ + "loyalty_added_deducted_points": "loyalty_added_deducted_points", + + /** + * value: "coupon" + * @const + */ + "coupon": "coupon", + + /** + * value: "expiring_points" + * @const + */ + "expiring_points": "expiring_points", + + /** + * value: "pending_to_active_points" + * @const + */ + "pending_to_active_points": "pending_to_active_points", + + /** + * value: "strikethrough_pricing" + * @const + */ + "strikethrough_pricing": "strikethrough_pricing", + + /** + * value: "tier_downgrade" + * @const + */ + "tier_downgrade": "tier_downgrade", + + /** + * value: "tier_upgrade" + * @const + */ + "tier_upgrade": "tier_upgrade", + + /** + * value: "tier_will_downgrade" + * @const + */ + "tier_will_downgrade": "tier_will_downgrade" +}; diff --git a/src/model/BaseNotificationEntity.js b/src/model/BaseNotificationEntity.js index 930d2876..7e1db4da 100644 --- a/src/model/BaseNotificationEntity.js +++ b/src/model/BaseNotificationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The BaseNotificationEntity model module. * @module model/BaseNotificationEntity - * @version 5.0.1 + * @version 6.0.0 */ class BaseNotificationEntity { /** @@ -52,6 +52,9 @@ class BaseNotificationEntity { if (data.hasOwnProperty('policy')) { obj['policy'] = ApiClient.convertToType(data['policy'], Object); } + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } } return obj; } @@ -64,6 +67,13 @@ class BaseNotificationEntity { */ BaseNotificationEntity.prototype['policy'] = undefined; +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + * @default true + */ +BaseNotificationEntity.prototype['enabled'] = true; + diff --git a/src/model/BaseNotificationWebhook.js b/src/model/BaseNotificationWebhook.js index 749e4c3d..5fe56617 100644 --- a/src/model/BaseNotificationWebhook.js +++ b/src/model/BaseNotificationWebhook.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The BaseNotificationWebhook model module. * @module model/BaseNotificationWebhook - * @version 5.0.1 + * @version 6.0.0 */ class BaseNotificationWebhook { /** @@ -73,6 +73,9 @@ class BaseNotificationWebhook { if (data.hasOwnProperty('headers')) { obj['headers'] = ApiClient.convertToType(data['headers'], ['String']); } + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } } return obj; } @@ -110,6 +113,13 @@ BaseNotificationWebhook.prototype['url'] = undefined; */ BaseNotificationWebhook.prototype['headers'] = undefined; +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + * @default true + */ +BaseNotificationWebhook.prototype['enabled'] = true; + diff --git a/src/model/BaseNotifications.js b/src/model/BaseNotifications.js index 11c5b5c7..4783e967 100644 --- a/src/model/BaseNotifications.js +++ b/src/model/BaseNotifications.js @@ -17,7 +17,7 @@ import BaseNotification from './BaseNotification'; /** * The BaseNotifications model module. * @module model/BaseNotifications - * @version 5.0.1 + * @version 6.0.0 */ class BaseNotifications { /** diff --git a/src/model/BaseSamlConnection.js b/src/model/BaseSamlConnection.js index 8b4127a0..b2090b51 100644 --- a/src/model/BaseSamlConnection.js +++ b/src/model/BaseSamlConnection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The BaseSamlConnection model module. * @module model/BaseSamlConnection - * @version 5.0.1 + * @version 6.0.0 */ class BaseSamlConnection { /** diff --git a/src/model/Binding.js b/src/model/Binding.js index 675d7a3b..364d6a1d 100644 --- a/src/model/Binding.js +++ b/src/model/Binding.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Binding model module. * @module model/Binding - * @version 5.0.1 + * @version 6.0.0 */ class Binding { /** diff --git a/src/model/BulkApplicationNotification.js b/src/model/BulkApplicationNotification.js index 0eeef280..8791c049 100644 --- a/src/model/BulkApplicationNotification.js +++ b/src/model/BulkApplicationNotification.js @@ -17,7 +17,7 @@ import ApplicationNotification from './ApplicationNotification'; /** * The BulkApplicationNotification model module. * @module model/BulkApplicationNotification - * @version 5.0.1 + * @version 6.0.0 */ class BulkApplicationNotification { /** diff --git a/src/model/BulkCampaignNotification.js b/src/model/BulkCampaignNotification.js index 09624344..4b666127 100644 --- a/src/model/BulkCampaignNotification.js +++ b/src/model/BulkCampaignNotification.js @@ -17,7 +17,7 @@ import CampaignNotification from './CampaignNotification'; /** * The BulkCampaignNotification model module. * @module model/BulkCampaignNotification - * @version 5.0.1 + * @version 6.0.0 */ class BulkCampaignNotification { /** diff --git a/src/model/BulkOperationOnCampaigns.js b/src/model/BulkOperationOnCampaigns.js new file mode 100644 index 00000000..1df47e43 --- /dev/null +++ b/src/model/BulkOperationOnCampaigns.js @@ -0,0 +1,106 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The BulkOperationOnCampaigns model module. + * @module model/BulkOperationOnCampaigns + * @version 6.0.0 + */ +class BulkOperationOnCampaigns { + /** + * Constructs a new BulkOperationOnCampaigns. + * @alias module:model/BulkOperationOnCampaigns + * @param operation {module:model/BulkOperationOnCampaigns.OperationEnum} The operation to perform on the specified campaign IDs. + * @param campaignIds {Array.} The list of campaign IDs on which the operation will be performed. + */ + constructor(operation, campaignIds) { + + BulkOperationOnCampaigns.initialize(this, operation, campaignIds); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, operation, campaignIds) { + obj['operation'] = operation; + obj['campaignIds'] = campaignIds; + } + + /** + * Constructs a BulkOperationOnCampaigns from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/BulkOperationOnCampaigns} obj Optional instance to populate. + * @return {module:model/BulkOperationOnCampaigns} The populated BulkOperationOnCampaigns instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new BulkOperationOnCampaigns(); + + if (data.hasOwnProperty('operation')) { + obj['operation'] = ApiClient.convertToType(data['operation'], 'String'); + } + if (data.hasOwnProperty('campaignIds')) { + obj['campaignIds'] = ApiClient.convertToType(data['campaignIds'], ['Number']); + } + } + return obj; + } + + +} + +/** + * The operation to perform on the specified campaign IDs. + * @member {module:model/BulkOperationOnCampaigns.OperationEnum} operation + */ +BulkOperationOnCampaigns.prototype['operation'] = undefined; + +/** + * The list of campaign IDs on which the operation will be performed. + * @member {Array.} campaignIds + */ +BulkOperationOnCampaigns.prototype['campaignIds'] = undefined; + + + + + +/** + * Allowed values for the operation property. + * @enum {String} + * @readonly + */ +BulkOperationOnCampaigns['OperationEnum'] = { + + /** + * value: "disable" + * @const + */ + "disable": "disable", + + /** + * value: "delete" + * @const + */ + "delete": "delete" +}; + + + +export default BulkOperationOnCampaigns; + diff --git a/src/model/Campaign.js b/src/model/Campaign.js index c82e4095..8441290b 100644 --- a/src/model/Campaign.js +++ b/src/model/Campaign.js @@ -12,13 +12,14 @@ */ import ApiClient from '../ApiClient'; +import CampaignBudget from './CampaignBudget'; import CodeGeneratorSettings from './CodeGeneratorSettings'; import LimitConfig from './LimitConfig'; /** * The Campaign model module. * @module model/Campaign - * @version 5.0.1 + * @version 6.0.0 */ class Campaign { /** @@ -35,10 +36,12 @@ class Campaign { * @param tags {Array.} A list of tags for the campaign. * @param features {Array.} The features enabled in this campaign. * @param limits {Array.} The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @param type {module:model/Campaign.TypeEnum} The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @param budgets {Array.} A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. */ - constructor(id, created, applicationId, userId, name, description, state, tags, features, limits) { + constructor(id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets) { - Campaign.initialize(this, id, created, applicationId, userId, name, description, state, tags, features, limits); + Campaign.initialize(this, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets); } /** @@ -46,7 +49,7 @@ class Campaign { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, id, created, applicationId, userId, name, description, state, tags, features, limits) { + static initialize(obj, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets) { obj['id'] = id; obj['created'] = created; obj['applicationId'] = applicationId; @@ -57,6 +60,8 @@ class Campaign { obj['tags'] = tags; obj['features'] = features; obj['limits'] = limits; + obj['type'] = type; + obj['budgets'] = budgets; } /** @@ -121,6 +126,18 @@ class Campaign { if (data.hasOwnProperty('campaignGroups')) { obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } + if (data.hasOwnProperty('budgets')) { + obj['budgets'] = ApiClient.convertToType(data['budgets'], [CampaignBudget]); + } if (data.hasOwnProperty('couponRedemptionCount')) { obj['couponRedemptionCount'] = ApiClient.convertToType(data['couponRedemptionCount'], 'Number'); } @@ -290,91 +307,116 @@ Campaign.prototype['limits'] = undefined; Campaign.prototype['campaignGroups'] = undefined; /** - * Number of coupons redeemed in the campaign. + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +Campaign.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/Campaign.TypeEnum} type + * @default 'advanced' + */ +Campaign.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +Campaign.prototype['linkedStoreIds'] = undefined; + +/** + * A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + * @member {Array.} budgets + */ +Campaign.prototype['budgets'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. * @member {Number} couponRedemptionCount */ Campaign.prototype['couponRedemptionCount'] = undefined; /** - * Number of referral codes redeemed in the campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. * @member {Number} referralRedemptionCount */ Campaign.prototype['referralRedemptionCount'] = undefined; /** - * Total amount of discounts redeemed in the campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. * @member {Number} discountCount */ Campaign.prototype['discountCount'] = undefined; /** - * Total number of times discounts were redeemed in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. * @member {Number} discountEffectCount */ Campaign.prototype['discountEffectCount'] = undefined; /** - * Total number of coupons created by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. * @member {Number} couponCreationCount */ Campaign.prototype['couponCreationCount'] = undefined; /** - * Total number of custom effects triggered by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. * @member {Number} customEffectCount */ Campaign.prototype['customEffectCount'] = undefined; /** - * Total number of referrals created by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. * @member {Number} referralCreationCount */ Campaign.prototype['referralCreationCount'] = undefined; /** - * Total number of times triggering add free item effext is allowed in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. * @member {Number} addFreeItemEffectCount */ Campaign.prototype['addFreeItemEffectCount'] = undefined; /** - * Total number of giveaways awarded by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. * @member {Number} awardedGiveawaysCount */ Campaign.prototype['awardedGiveawaysCount'] = undefined; /** - * Total number of loyalty points created by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. * @member {Number} createdLoyaltyPointsCount */ Campaign.prototype['createdLoyaltyPointsCount'] = undefined; /** - * Total number of loyalty point creation effects triggered by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. * @member {Number} createdLoyaltyPointsEffectCount */ Campaign.prototype['createdLoyaltyPointsEffectCount'] = undefined; /** - * Total number of loyalty points redeemed by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. * @member {Number} redeemedLoyaltyPointsCount */ Campaign.prototype['redeemedLoyaltyPointsCount'] = undefined; /** - * Total number of loyalty point redemption effects triggered by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. * @member {Number} redeemedLoyaltyPointsEffectCount */ Campaign.prototype['redeemedLoyaltyPointsEffectCount'] = undefined; /** - * Total number of webhook triggered by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. * @member {Number} callApiEffectCount */ Campaign.prototype['callApiEffectCount'] = undefined; /** - * Total number of reserve coupon effects triggered by rules in this campaign. + * This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. * @member {Number} reservecouponEffectCount */ Campaign.prototype['reservecouponEffectCount'] = undefined; @@ -479,6 +521,27 @@ Campaign['FeaturesEnum'] = { }; +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +Campaign['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default Campaign; diff --git a/src/model/CampaignActivationRequest.js b/src/model/CampaignActivationRequest.js index 46060da7..52e20f7a 100644 --- a/src/model/CampaignActivationRequest.js +++ b/src/model/CampaignActivationRequest.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignActivationRequest model module. * @module model/CampaignActivationRequest - * @version 5.0.1 + * @version 6.0.0 */ class CampaignActivationRequest { /** diff --git a/src/model/CampaignAnalytics.js b/src/model/CampaignAnalytics.js index b612d13a..b0a94120 100644 --- a/src/model/CampaignAnalytics.js +++ b/src/model/CampaignAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignAnalytics model module. * @module model/CampaignAnalytics - * @version 5.0.1 + * @version 6.0.0 */ class CampaignAnalytics { /** diff --git a/src/model/CampaignBudget.js b/src/model/CampaignBudget.js new file mode 100644 index 00000000..7958303d --- /dev/null +++ b/src/model/CampaignBudget.js @@ -0,0 +1,96 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The CampaignBudget model module. + * @module model/CampaignBudget + * @version 6.0.0 + */ +class CampaignBudget { + /** + * Constructs a new CampaignBudget. + * @alias module:model/CampaignBudget + * @param action {String} The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` + * @param limit {Number} The value to set for the limit. + * @param counter {Number} The number of occurrences of the limited action in the context of the campaign. + */ + constructor(action, limit, counter) { + + CampaignBudget.initialize(this, action, limit, counter); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, action, limit, counter) { + obj['action'] = action; + obj['limit'] = limit; + obj['counter'] = counter; + } + + /** + * Constructs a CampaignBudget from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CampaignBudget} obj Optional instance to populate. + * @return {module:model/CampaignBudget} The populated CampaignBudget instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CampaignBudget(); + + if (data.hasOwnProperty('action')) { + obj['action'] = ApiClient.convertToType(data['action'], 'String'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('counter')) { + obj['counter'] = ApiClient.convertToType(data['counter'], 'Number'); + } + } + return obj; + } + + +} + +/** + * The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` + * @member {String} action + */ +CampaignBudget.prototype['action'] = undefined; + +/** + * The value to set for the limit. + * @member {Number} limit + */ +CampaignBudget.prototype['limit'] = undefined; + +/** + * The number of occurrences of the limited action in the context of the campaign. + * @member {Number} counter + */ +CampaignBudget.prototype['counter'] = undefined; + + + + + + +export default CampaignBudget; + diff --git a/src/model/CampaignCollection.js b/src/model/CampaignCollection.js index bfddfb72..3cee746b 100644 --- a/src/model/CampaignCollection.js +++ b/src/model/CampaignCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignCollection model module. * @module model/CampaignCollection - * @version 5.0.1 + * @version 6.0.0 */ class CampaignCollection { /** diff --git a/src/model/CampaignCollectionWithoutPayload.js b/src/model/CampaignCollectionWithoutPayload.js index 8a350880..e455f6bd 100644 --- a/src/model/CampaignCollectionWithoutPayload.js +++ b/src/model/CampaignCollectionWithoutPayload.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignCollectionWithoutPayload model module. * @module model/CampaignCollectionWithoutPayload - * @version 5.0.1 + * @version 6.0.0 */ class CampaignCollectionWithoutPayload { /** diff --git a/src/model/CampaignCopy.js b/src/model/CampaignCopy.js index 8cedd433..fa600748 100644 --- a/src/model/CampaignCopy.js +++ b/src/model/CampaignCopy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignCopy model module. * @module model/CampaignCopy - * @version 5.0.1 + * @version 6.0.0 */ class CampaignCopy { /** diff --git a/src/model/CampaignCreatedNotification.js b/src/model/CampaignCreatedNotification.js index 20b15285..c6f5872b 100644 --- a/src/model/CampaignCreatedNotification.js +++ b/src/model/CampaignCreatedNotification.js @@ -12,21 +12,21 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; import CampaignEvaluationPosition from './CampaignEvaluationPosition'; +import CampaignStateNotification from './CampaignStateNotification'; import Ruleset from './Ruleset'; /** * The CampaignCreatedNotification model module. * @module model/CampaignCreatedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignCreatedNotification { /** * Constructs a new CampaignCreatedNotification. * A notification regarding a campaign that was created. * @alias module:model/CampaignCreatedNotification - * @param campaign {module:model/Campaign} + * @param campaign {module:model/CampaignStateNotification} * @param evaluationPosition {module:model/CampaignEvaluationPosition} */ constructor(campaign, evaluationPosition) { @@ -56,7 +56,7 @@ class CampaignCreatedNotification { obj = obj || new CampaignCreatedNotification(); if (data.hasOwnProperty('campaign')) { - obj['campaign'] = ApiClient.convertToType(data['campaign'], Campaign); + obj['campaign'] = CampaignStateNotification.constructFromObject(data['campaign']); } if (data.hasOwnProperty('ruleset')) { obj['ruleset'] = Ruleset.constructFromObject(data['ruleset']); @@ -72,7 +72,7 @@ class CampaignCreatedNotification { } /** - * @member {module:model/Campaign} campaign + * @member {module:model/CampaignStateNotification} campaign */ CampaignCreatedNotification.prototype['campaign'] = undefined; diff --git a/src/model/CampaignDeletedNotification.js b/src/model/CampaignDeletedNotification.js index a71cdda0..bb823f1e 100644 --- a/src/model/CampaignDeletedNotification.js +++ b/src/model/CampaignDeletedNotification.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; +import CampaignStateNotification from './CampaignStateNotification'; /** * The CampaignDeletedNotification model module. * @module model/CampaignDeletedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignDeletedNotification { /** * Constructs a new CampaignDeletedNotification. * A notification regarding a campaign that was deleted. * @alias module:model/CampaignDeletedNotification - * @param campaign {module:model/Campaign} + * @param campaign {module:model/CampaignStateNotification} * @param deletedAt {Date} Time when the campaign was deleted. */ constructor(campaign, deletedAt) { @@ -54,7 +54,7 @@ class CampaignDeletedNotification { obj = obj || new CampaignDeletedNotification(); if (data.hasOwnProperty('campaign')) { - obj['campaign'] = ApiClient.convertToType(data['campaign'], Campaign); + obj['campaign'] = CampaignStateNotification.constructFromObject(data['campaign']); } if (data.hasOwnProperty('deletedAt')) { obj['deletedAt'] = ApiClient.convertToType(data['deletedAt'], 'Date'); @@ -67,7 +67,7 @@ class CampaignDeletedNotification { } /** - * @member {module:model/Campaign} campaign + * @member {module:model/CampaignStateNotification} campaign */ CampaignDeletedNotification.prototype['campaign'] = undefined; diff --git a/src/model/CampaignEditedNotification.js b/src/model/CampaignEditedNotification.js index 740ac65e..8e9441ac 100644 --- a/src/model/CampaignEditedNotification.js +++ b/src/model/CampaignEditedNotification.js @@ -12,21 +12,21 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; +import CampaignStateNotification from './CampaignStateNotification'; import Ruleset from './Ruleset'; /** * The CampaignEditedNotification model module. * @module model/CampaignEditedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignEditedNotification { /** * Constructs a new CampaignEditedNotification. * A notification regarding a campaign which was edited. * @alias module:model/CampaignEditedNotification - * @param campaign {module:model/Campaign} - * @param oldCampaign {module:model/Campaign} + * @param campaign {module:model/CampaignStateNotification} + * @param oldCampaign {module:model/CampaignStateNotification} */ constructor(campaign, oldCampaign) { @@ -55,10 +55,10 @@ class CampaignEditedNotification { obj = obj || new CampaignEditedNotification(); if (data.hasOwnProperty('campaign')) { - obj['campaign'] = ApiClient.convertToType(data['campaign'], Campaign); + obj['campaign'] = CampaignStateNotification.constructFromObject(data['campaign']); } if (data.hasOwnProperty('oldCampaign')) { - obj['oldCampaign'] = ApiClient.convertToType(data['oldCampaign'], Campaign); + obj['oldCampaign'] = CampaignStateNotification.constructFromObject(data['oldCampaign']); } if (data.hasOwnProperty('ruleset')) { obj['ruleset'] = Ruleset.constructFromObject(data['ruleset']); @@ -71,12 +71,12 @@ class CampaignEditedNotification { } /** - * @member {module:model/Campaign} campaign + * @member {module:model/CampaignStateNotification} campaign */ CampaignEditedNotification.prototype['campaign'] = undefined; /** - * @member {module:model/Campaign} oldCampaign + * @member {module:model/CampaignStateNotification} oldCampaign */ CampaignEditedNotification.prototype['oldCampaign'] = undefined; diff --git a/src/model/CampaignEntity.js b/src/model/CampaignEntity.js index 75c0b67b..91b199c9 100644 --- a/src/model/CampaignEntity.js +++ b/src/model/CampaignEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignEntity model module. * @module model/CampaignEntity - * @version 5.0.1 + * @version 6.0.0 */ class CampaignEntity { /** diff --git a/src/model/CampaignEvaluationGroup.js b/src/model/CampaignEvaluationGroup.js index ce3168a7..a3d67254 100644 --- a/src/model/CampaignEvaluationGroup.js +++ b/src/model/CampaignEvaluationGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignEvaluationGroup model module. * @module model/CampaignEvaluationGroup - * @version 5.0.1 + * @version 6.0.0 */ class CampaignEvaluationGroup { /** @@ -26,13 +26,14 @@ class CampaignEvaluationGroup { * @param applicationId {Number} The ID of the application that owns this entity. * @param name {String} The name of the campaign evaluation group. * @param parentId {Number} The ID of the parent group that contains the campaign evaluation group. - * @param evaluationMode {module:model/CampaignEvaluationGroup.EvaluationModeEnum} + * @param evaluationMode {module:model/CampaignEvaluationGroup.EvaluationModeEnum} The mode by which campaigns in the campaign evaluation group are evaluated. + * @param evaluationScope {module:model/CampaignEvaluationGroup.EvaluationScopeEnum} The evaluation scope of the campaign evaluation group. * @param locked {Boolean} An indicator of whether the campaign evaluation group is locked for modification. * @param id {Number} Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. */ - constructor(applicationId, name, parentId, evaluationMode, locked, id) { + constructor(applicationId, name, parentId, evaluationMode, evaluationScope, locked, id) { - CampaignEvaluationGroup.initialize(this, applicationId, name, parentId, evaluationMode, locked, id); + CampaignEvaluationGroup.initialize(this, applicationId, name, parentId, evaluationMode, evaluationScope, locked, id); } /** @@ -40,11 +41,12 @@ class CampaignEvaluationGroup { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, applicationId, name, parentId, evaluationMode, locked, id) { + static initialize(obj, applicationId, name, parentId, evaluationMode, evaluationScope, locked, id) { obj['applicationId'] = applicationId; obj['name'] = name; obj['parentId'] = parentId; obj['evaluationMode'] = evaluationMode; + obj['evaluationScope'] = evaluationScope; obj['locked'] = locked; obj['id'] = id; } @@ -75,6 +77,9 @@ class CampaignEvaluationGroup { if (data.hasOwnProperty('evaluationMode')) { obj['evaluationMode'] = ApiClient.convertToType(data['evaluationMode'], 'String'); } + if (data.hasOwnProperty('evaluationScope')) { + obj['evaluationScope'] = ApiClient.convertToType(data['evaluationScope'], 'String'); + } if (data.hasOwnProperty('locked')) { obj['locked'] = ApiClient.convertToType(data['locked'], 'Boolean'); } @@ -113,10 +118,17 @@ CampaignEvaluationGroup.prototype['parentId'] = undefined; CampaignEvaluationGroup.prototype['description'] = undefined; /** + * The mode by which campaigns in the campaign evaluation group are evaluated. * @member {module:model/CampaignEvaluationGroup.EvaluationModeEnum} evaluationMode */ CampaignEvaluationGroup.prototype['evaluationMode'] = undefined; +/** + * The evaluation scope of the campaign evaluation group. + * @member {module:model/CampaignEvaluationGroup.EvaluationScopeEnum} evaluationScope + */ +CampaignEvaluationGroup.prototype['evaluationScope'] = undefined; + /** * An indicator of whether the campaign evaluation group is locked for modification. * @member {Boolean} locked @@ -166,6 +178,27 @@ CampaignEvaluationGroup['EvaluationModeEnum'] = { }; +/** + * Allowed values for the evaluationScope property. + * @enum {String} + * @readonly + */ +CampaignEvaluationGroup['EvaluationScopeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "session" + * @const + */ + "session": "session" +}; + + export default CampaignEvaluationGroup; diff --git a/src/model/CampaignEvaluationPosition.js b/src/model/CampaignEvaluationPosition.js index 63888f10..11265b65 100644 --- a/src/model/CampaignEvaluationPosition.js +++ b/src/model/CampaignEvaluationPosition.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignEvaluationPosition model module. * @module model/CampaignEvaluationPosition - * @version 5.0.1 + * @version 6.0.0 */ class CampaignEvaluationPosition { /** diff --git a/src/model/CampaignEvaluationTreeChangedNotification.js b/src/model/CampaignEvaluationTreeChangedNotification.js index 7bee2584..0ebf2d10 100644 --- a/src/model/CampaignEvaluationTreeChangedNotification.js +++ b/src/model/CampaignEvaluationTreeChangedNotification.js @@ -17,7 +17,7 @@ import CampaignSet from './CampaignSet'; /** * The CampaignEvaluationTreeChangedNotification model module. * @module model/CampaignEvaluationTreeChangedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignEvaluationTreeChangedNotification { /** diff --git a/src/model/CampaignForNotification.js b/src/model/CampaignForNotification.js new file mode 100644 index 00000000..2f362b56 --- /dev/null +++ b/src/model/CampaignForNotification.js @@ -0,0 +1,571 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import CampaignBudget from './CampaignBudget'; +import CodeGeneratorSettings from './CodeGeneratorSettings'; +import LimitConfig from './LimitConfig'; + +/** + * The CampaignForNotification model module. + * @module model/CampaignForNotification + * @version 6.0.0 + */ +class CampaignForNotification { + /** + * Constructs a new CampaignForNotification. + * + * @alias module:model/CampaignForNotification + * @param id {Number} Unique ID for this entity. + * @param created {Date} The exact moment this entity was created. + * @param applicationId {Number} The ID of the application that owns this entity. + * @param userId {Number} The ID of the user associated with this entity. + * @param name {String} A user-facing name for this campaign. + * @param description {String} A detailed description of the campaign. + * @param state {module:model/CampaignForNotification.StateEnum} A disabled or archived campaign is not evaluated for rules or coupons. + * @param tags {Array.} A list of tags for the campaign. + * @param features {Array.} The features enabled in this campaign. + * @param limits {Array.} The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @param type {module:model/CampaignForNotification.TypeEnum} The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @param budgets {Array.} A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + */ + constructor(id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets) { + + CampaignForNotification.initialize(this, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets) { + obj['id'] = id; + obj['created'] = created; + obj['applicationId'] = applicationId; + obj['userId'] = userId; + obj['name'] = name; + obj['description'] = description; + obj['state'] = state; + obj['tags'] = tags; + obj['features'] = features; + obj['limits'] = limits; + obj['type'] = type; + obj['budgets'] = budgets; + } + + /** + * Constructs a CampaignForNotification from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CampaignForNotification} obj Optional instance to populate. + * @return {module:model/CampaignForNotification} The populated CampaignForNotification instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CampaignForNotification(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('applicationId')) { + obj['applicationId'] = ApiClient.convertToType(data['applicationId'], 'Number'); + } + if (data.hasOwnProperty('userId')) { + obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('startTime')) { + obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date'); + } + if (data.hasOwnProperty('endTime')) { + obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('state')) { + obj['state'] = ApiClient.convertToType(data['state'], 'String'); + } + if (data.hasOwnProperty('activeRulesetId')) { + obj['activeRulesetId'] = ApiClient.convertToType(data['activeRulesetId'], 'Number'); + } + if (data.hasOwnProperty('tags')) { + obj['tags'] = ApiClient.convertToType(data['tags'], ['String']); + } + if (data.hasOwnProperty('features')) { + obj['features'] = ApiClient.convertToType(data['features'], ['String']); + } + if (data.hasOwnProperty('couponSettings')) { + obj['couponSettings'] = CodeGeneratorSettings.constructFromObject(data['couponSettings']); + } + if (data.hasOwnProperty('referralSettings')) { + obj['referralSettings'] = CodeGeneratorSettings.constructFromObject(data['referralSettings']); + } + if (data.hasOwnProperty('limits')) { + obj['limits'] = ApiClient.convertToType(data['limits'], [LimitConfig]); + } + if (data.hasOwnProperty('campaignGroups')) { + obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); + } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } + if (data.hasOwnProperty('budgets')) { + obj['budgets'] = ApiClient.convertToType(data['budgets'], [CampaignBudget]); + } + if (data.hasOwnProperty('couponRedemptionCount')) { + obj['couponRedemptionCount'] = ApiClient.convertToType(data['couponRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('referralRedemptionCount')) { + obj['referralRedemptionCount'] = ApiClient.convertToType(data['referralRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('discountCount')) { + obj['discountCount'] = ApiClient.convertToType(data['discountCount'], 'Number'); + } + if (data.hasOwnProperty('discountEffectCount')) { + obj['discountEffectCount'] = ApiClient.convertToType(data['discountEffectCount'], 'Number'); + } + if (data.hasOwnProperty('couponCreationCount')) { + obj['couponCreationCount'] = ApiClient.convertToType(data['couponCreationCount'], 'Number'); + } + if (data.hasOwnProperty('customEffectCount')) { + obj['customEffectCount'] = ApiClient.convertToType(data['customEffectCount'], 'Number'); + } + if (data.hasOwnProperty('referralCreationCount')) { + obj['referralCreationCount'] = ApiClient.convertToType(data['referralCreationCount'], 'Number'); + } + if (data.hasOwnProperty('addFreeItemEffectCount')) { + obj['addFreeItemEffectCount'] = ApiClient.convertToType(data['addFreeItemEffectCount'], 'Number'); + } + if (data.hasOwnProperty('awardedGiveawaysCount')) { + obj['awardedGiveawaysCount'] = ApiClient.convertToType(data['awardedGiveawaysCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsCount')) { + obj['createdLoyaltyPointsCount'] = ApiClient.convertToType(data['createdLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsEffectCount')) { + obj['createdLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['createdLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsCount')) { + obj['redeemedLoyaltyPointsCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsEffectCount')) { + obj['redeemedLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('callApiEffectCount')) { + obj['callApiEffectCount'] = ApiClient.convertToType(data['callApiEffectCount'], 'Number'); + } + if (data.hasOwnProperty('reservecouponEffectCount')) { + obj['reservecouponEffectCount'] = ApiClient.convertToType(data['reservecouponEffectCount'], 'Number'); + } + if (data.hasOwnProperty('lastActivity')) { + obj['lastActivity'] = ApiClient.convertToType(data['lastActivity'], 'Date'); + } + if (data.hasOwnProperty('updated')) { + obj['updated'] = ApiClient.convertToType(data['updated'], 'Date'); + } + if (data.hasOwnProperty('createdBy')) { + obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String'); + } + if (data.hasOwnProperty('updatedBy')) { + obj['updatedBy'] = ApiClient.convertToType(data['updatedBy'], 'String'); + } + if (data.hasOwnProperty('templateId')) { + obj['templateId'] = ApiClient.convertToType(data['templateId'], 'Number'); + } + } + return obj; + } + + +} + +/** + * Unique ID for this entity. + * @member {Number} id + */ +CampaignForNotification.prototype['id'] = undefined; + +/** + * The exact moment this entity was created. + * @member {Date} created + */ +CampaignForNotification.prototype['created'] = undefined; + +/** + * The ID of the application that owns this entity. + * @member {Number} applicationId + */ +CampaignForNotification.prototype['applicationId'] = undefined; + +/** + * The ID of the user associated with this entity. + * @member {Number} userId + */ +CampaignForNotification.prototype['userId'] = undefined; + +/** + * A user-facing name for this campaign. + * @member {String} name + */ +CampaignForNotification.prototype['name'] = undefined; + +/** + * A detailed description of the campaign. + * @member {String} description + */ +CampaignForNotification.prototype['description'] = undefined; + +/** + * Timestamp when the campaign will become active. + * @member {Date} startTime + */ +CampaignForNotification.prototype['startTime'] = undefined; + +/** + * Timestamp when the campaign will become inactive. + * @member {Date} endTime + */ +CampaignForNotification.prototype['endTime'] = undefined; + +/** + * Arbitrary properties associated with this campaign. + * @member {Object} attributes + */ +CampaignForNotification.prototype['attributes'] = undefined; + +/** + * A disabled or archived campaign is not evaluated for rules or coupons. + * @member {module:model/CampaignForNotification.StateEnum} state + * @default 'enabled' + */ +CampaignForNotification.prototype['state'] = 'enabled'; + +/** + * [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. + * @member {Number} activeRulesetId + */ +CampaignForNotification.prototype['activeRulesetId'] = undefined; + +/** + * A list of tags for the campaign. + * @member {Array.} tags + */ +CampaignForNotification.prototype['tags'] = undefined; + +/** + * The features enabled in this campaign. + * @member {Array.} features + */ +CampaignForNotification.prototype['features'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} couponSettings + */ +CampaignForNotification.prototype['couponSettings'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} referralSettings + */ +CampaignForNotification.prototype['referralSettings'] = undefined; + +/** + * The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @member {Array.} limits + */ +CampaignForNotification.prototype['limits'] = undefined; + +/** + * The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. + * @member {Array.} campaignGroups + */ +CampaignForNotification.prototype['campaignGroups'] = undefined; + +/** + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +CampaignForNotification.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/CampaignForNotification.TypeEnum} type + * @default 'advanced' + */ +CampaignForNotification.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +CampaignForNotification.prototype['linkedStoreIds'] = undefined; + +/** + * A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + * @member {Array.} budgets + */ +CampaignForNotification.prototype['budgets'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. + * @member {Number} couponRedemptionCount + */ +CampaignForNotification.prototype['couponRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. + * @member {Number} referralRedemptionCount + */ +CampaignForNotification.prototype['referralRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. + * @member {Number} discountCount + */ +CampaignForNotification.prototype['discountCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. + * @member {Number} discountEffectCount + */ +CampaignForNotification.prototype['discountEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. + * @member {Number} couponCreationCount + */ +CampaignForNotification.prototype['couponCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. + * @member {Number} customEffectCount + */ +CampaignForNotification.prototype['customEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. + * @member {Number} referralCreationCount + */ +CampaignForNotification.prototype['referralCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. + * @member {Number} addFreeItemEffectCount + */ +CampaignForNotification.prototype['addFreeItemEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. + * @member {Number} awardedGiveawaysCount + */ +CampaignForNotification.prototype['awardedGiveawaysCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. + * @member {Number} createdLoyaltyPointsCount + */ +CampaignForNotification.prototype['createdLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. + * @member {Number} createdLoyaltyPointsEffectCount + */ +CampaignForNotification.prototype['createdLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsCount + */ +CampaignForNotification.prototype['redeemedLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsEffectCount + */ +CampaignForNotification.prototype['redeemedLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. + * @member {Number} callApiEffectCount + */ +CampaignForNotification.prototype['callApiEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. + * @member {Number} reservecouponEffectCount + */ +CampaignForNotification.prototype['reservecouponEffectCount'] = undefined; + +/** + * Timestamp of the most recent event received by this campaign. + * @member {Date} lastActivity + */ +CampaignForNotification.prototype['lastActivity'] = undefined; + +/** + * Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. + * @member {Date} updated + */ +CampaignForNotification.prototype['updated'] = undefined; + +/** + * Name of the user who created this campaign if available. + * @member {String} createdBy + */ +CampaignForNotification.prototype['createdBy'] = undefined; + +/** + * Name of the user who last updated this campaign if available. + * @member {String} updatedBy + */ +CampaignForNotification.prototype['updatedBy'] = undefined; + +/** + * The ID of the Campaign Template this Campaign was created from. + * @member {Number} templateId + */ +CampaignForNotification.prototype['templateId'] = undefined; + + + + + +/** + * Allowed values for the state property. + * @enum {String} + * @readonly + */ +CampaignForNotification['StateEnum'] = { + + /** + * value: "enabled" + * @const + */ + "enabled": "enabled", + + /** + * value: "disabled" + * @const + */ + "disabled": "disabled", + + /** + * value: "archived" + * @const + */ + "archived": "archived", + + /** + * value: "draft" + * @const + */ + "draft": "draft", + + /** + * value: "scheduled" + * @const + */ + "scheduled": "scheduled", + + /** + * value: "running" + * @const + */ + "running": "running", + + /** + * value: "expired" + * @const + */ + "expired": "expired" +}; + + +/** + * Allowed values for the features property. + * @enum {String} + * @readonly + */ +CampaignForNotification['FeaturesEnum'] = { + + /** + * value: "coupons" + * @const + */ + "coupons": "coupons", + + /** + * value: "referrals" + * @const + */ + "referrals": "referrals", + + /** + * value: "loyalty" + * @const + */ + "loyalty": "loyalty", + + /** + * value: "giveaways" + * @const + */ + "giveaways": "giveaways", + + /** + * value: "strikethrough" + * @const + */ + "strikethrough": "strikethrough" +}; + + +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +CampaignForNotification['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + + +export default CampaignForNotification; + diff --git a/src/model/CampaignGroup.js b/src/model/CampaignGroup.js index 17ef5f48..5d4f5033 100644 --- a/src/model/CampaignGroup.js +++ b/src/model/CampaignGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignGroup model module. * @module model/CampaignGroup - * @version 5.0.1 + * @version 6.0.0 */ class CampaignGroup { /** @@ -27,7 +27,7 @@ class CampaignGroup { * @param created {Date} The time this entity was created. * @param modified {Date} The time this entity was last modified. * @param accountId {Number} The ID of the account that owns this entity. - * @param name {String} The name of this campaign group. + * @param name {String} The name of this campaign access group. */ constructor(id, created, modified, accountId, name) { @@ -114,25 +114,25 @@ CampaignGroup.prototype['modified'] = undefined; CampaignGroup.prototype['accountId'] = undefined; /** - * The name of this campaign group. + * The name of this campaign access group. * @member {String} name */ CampaignGroup.prototype['name'] = undefined; /** - * A longer description of the campaign group. + * A longer description of the campaign access group. * @member {String} description */ CampaignGroup.prototype['description'] = undefined; /** - * A list of the IDs of the applications that this campaign group is enabled for. + * A list of IDs of the Applications that this campaign access group is enabled for. * @member {Array.} subscribedApplicationsIds */ CampaignGroup.prototype['subscribedApplicationsIds'] = undefined; /** - * A list of the IDs of the campaigns that this campaign group owns. + * A list of IDs of the campaigns that are part of the campaign access group. * @member {Array.} campaignIds */ CampaignGroup.prototype['campaignIds'] = undefined; diff --git a/src/model/CampaignGroupEntity.js b/src/model/CampaignGroupEntity.js index b8520f33..cccaa976 100644 --- a/src/model/CampaignGroupEntity.js +++ b/src/model/CampaignGroupEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignGroupEntity model module. * @module model/CampaignGroupEntity - * @version 5.0.1 + * @version 6.0.0 */ class CampaignGroupEntity { /** diff --git a/src/model/CampaignNotification.js b/src/model/CampaignNotification.js index 6a405c08..847232b9 100644 --- a/src/model/CampaignNotification.js +++ b/src/model/CampaignNotification.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignNotification model module. * @module model/CampaignNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignNotification { /** diff --git a/src/model/CampaignNotificationPolicy.js b/src/model/CampaignNotificationPolicy.js new file mode 100644 index 00000000..3859eb27 --- /dev/null +++ b/src/model/CampaignNotificationPolicy.js @@ -0,0 +1,74 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The CampaignNotificationPolicy model module. + * @module model/CampaignNotificationPolicy + * @version 6.0.0 + */ +class CampaignNotificationPolicy { + /** + * Constructs a new CampaignNotificationPolicy. + * @alias module:model/CampaignNotificationPolicy + * @param name {String} Notification name. + */ + constructor(name) { + + CampaignNotificationPolicy.initialize(this, name); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name) { + obj['name'] = name; + } + + /** + * Constructs a CampaignNotificationPolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CampaignNotificationPolicy} obj Optional instance to populate. + * @return {module:model/CampaignNotificationPolicy} The populated CampaignNotificationPolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CampaignNotificationPolicy(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + } + return obj; + } + + +} + +/** + * Notification name. + * @member {String} name + */ +CampaignNotificationPolicy.prototype['name'] = undefined; + + + + + + +export default CampaignNotificationPolicy; + diff --git a/src/model/CampaignRulesetChangedNotification.js b/src/model/CampaignRulesetChangedNotification.js index b918b14f..f3d38061 100644 --- a/src/model/CampaignRulesetChangedNotification.js +++ b/src/model/CampaignRulesetChangedNotification.js @@ -12,20 +12,20 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; +import CampaignStateNotification from './CampaignStateNotification'; import Ruleset from './Ruleset'; /** * The CampaignRulesetChangedNotification model module. * @module model/CampaignRulesetChangedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignRulesetChangedNotification { /** * Constructs a new CampaignRulesetChangedNotification. * A notification regarding a campaign whose ruleset was changed. * @alias module:model/CampaignRulesetChangedNotification - * @param campaign {module:model/Campaign} + * @param campaign {module:model/CampaignStateNotification} */ constructor(campaign) { @@ -53,7 +53,7 @@ class CampaignRulesetChangedNotification { obj = obj || new CampaignRulesetChangedNotification(); if (data.hasOwnProperty('campaign')) { - obj['campaign'] = ApiClient.convertToType(data['campaign'], Campaign); + obj['campaign'] = CampaignStateNotification.constructFromObject(data['campaign']); } if (data.hasOwnProperty('oldRuleset')) { obj['oldRuleset'] = Ruleset.constructFromObject(data['oldRuleset']); @@ -69,7 +69,7 @@ class CampaignRulesetChangedNotification { } /** - * @member {module:model/Campaign} campaign + * @member {module:model/CampaignStateNotification} campaign */ CampaignRulesetChangedNotification.prototype['campaign'] = undefined; diff --git a/src/model/CampaignSearch.js b/src/model/CampaignSearch.js index 958c4bdb..d3841c3c 100644 --- a/src/model/CampaignSearch.js +++ b/src/model/CampaignSearch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSearch model module. * @module model/CampaignSearch - * @version 5.0.1 + * @version 6.0.0 */ class CampaignSearch { /** diff --git a/src/model/CampaignSet.js b/src/model/CampaignSet.js index 1b38d630..b9824264 100644 --- a/src/model/CampaignSet.js +++ b/src/model/CampaignSet.js @@ -17,7 +17,7 @@ import CampaignSetBranchNode from './CampaignSetBranchNode'; /** * The CampaignSet model module. * @module model/CampaignSet - * @version 5.0.1 + * @version 6.0.0 */ class CampaignSet { /** diff --git a/src/model/CampaignSetBranchNode.js b/src/model/CampaignSetBranchNode.js index 3a9958d7..29aad3ef 100644 --- a/src/model/CampaignSetBranchNode.js +++ b/src/model/CampaignSetBranchNode.js @@ -17,7 +17,7 @@ import CampaignSetNode from './CampaignSetNode'; /** * The CampaignSetBranchNode model module. * @module model/CampaignSetBranchNode - * @version 5.0.1 + * @version 6.0.0 */ class CampaignSetBranchNode { /** @@ -29,11 +29,12 @@ class CampaignSetBranchNode { * @param elements {Array.} Child elements of this set. * @param groupId {Number} The ID of the campaign set. * @param locked {Boolean} An indicator of whether the campaign set is locked for modification. - * @param evaluationMode {module:model/CampaignSetBranchNode.EvaluationModeEnum} + * @param evaluationMode {module:model/CampaignSetBranchNode.EvaluationModeEnum} The mode by which campaigns in the campaign evaluation group are evaluated. + * @param evaluationScope {module:model/CampaignSetBranchNode.EvaluationScopeEnum} The evaluation scope of the campaign evaluation group. */ - constructor(type, name, operator, elements, groupId, locked, evaluationMode) { + constructor(type, name, operator, elements, groupId, locked, evaluationMode, evaluationScope) { - CampaignSetBranchNode.initialize(this, type, name, operator, elements, groupId, locked, evaluationMode); + CampaignSetBranchNode.initialize(this, type, name, operator, elements, groupId, locked, evaluationMode, evaluationScope); } /** @@ -41,7 +42,7 @@ class CampaignSetBranchNode { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, type, name, operator, elements, groupId, locked, evaluationMode) { + static initialize(obj, type, name, operator, elements, groupId, locked, evaluationMode, evaluationScope) { obj['type'] = type; obj['name'] = name; obj['operator'] = operator; @@ -49,6 +50,7 @@ class CampaignSetBranchNode { obj['groupId'] = groupId; obj['locked'] = locked; obj['evaluationMode'] = evaluationMode; + obj['evaluationScope'] = evaluationScope; } /** @@ -86,6 +88,9 @@ class CampaignSetBranchNode { if (data.hasOwnProperty('evaluationMode')) { obj['evaluationMode'] = ApiClient.convertToType(data['evaluationMode'], 'String'); } + if (data.hasOwnProperty('evaluationScope')) { + obj['evaluationScope'] = ApiClient.convertToType(data['evaluationScope'], 'String'); + } } return obj; } @@ -136,10 +141,17 @@ CampaignSetBranchNode.prototype['locked'] = undefined; CampaignSetBranchNode.prototype['description'] = undefined; /** + * The mode by which campaigns in the campaign evaluation group are evaluated. * @member {module:model/CampaignSetBranchNode.EvaluationModeEnum} evaluationMode */ CampaignSetBranchNode.prototype['evaluationMode'] = undefined; +/** + * The evaluation scope of the campaign evaluation group. + * @member {module:model/CampaignSetBranchNode.EvaluationScopeEnum} evaluationScope + */ +CampaignSetBranchNode.prototype['evaluationScope'] = undefined; + @@ -213,6 +225,27 @@ CampaignSetBranchNode['EvaluationModeEnum'] = { }; +/** + * Allowed values for the evaluationScope property. + * @enum {String} + * @readonly + */ +CampaignSetBranchNode['EvaluationScopeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "session" + * @const + */ + "session": "session" +}; + + export default CampaignSetBranchNode; diff --git a/src/model/CampaignSetLeafNode.js b/src/model/CampaignSetLeafNode.js index 0e5d4c51..ce74004d 100644 --- a/src/model/CampaignSetLeafNode.js +++ b/src/model/CampaignSetLeafNode.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSetLeafNode model module. * @module model/CampaignSetLeafNode - * @version 5.0.1 + * @version 6.0.0 */ class CampaignSetLeafNode { /** diff --git a/src/model/CampaignSetNode.js b/src/model/CampaignSetNode.js index 726a0eda..06676c2d 100644 --- a/src/model/CampaignSetNode.js +++ b/src/model/CampaignSetNode.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSetNode model module. * @module model/CampaignSetNode - * @version 5.0.1 + * @version 6.0.0 */ class CampaignSetNode { /** diff --git a/src/model/CampaignStateChangedNotification.js b/src/model/CampaignStateChangedNotification.js index 8724f23b..2ccb0c18 100644 --- a/src/model/CampaignStateChangedNotification.js +++ b/src/model/CampaignStateChangedNotification.js @@ -12,20 +12,20 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; +import CampaignForNotification from './CampaignForNotification'; import Ruleset from './Ruleset'; /** * The CampaignStateChangedNotification model module. * @module model/CampaignStateChangedNotification - * @version 5.0.1 + * @version 6.0.0 */ class CampaignStateChangedNotification { /** * Constructs a new CampaignStateChangedNotification. * A notification regarding a campaign whose state changed. * @alias module:model/CampaignStateChangedNotification - * @param campaign {module:model/Campaign} + * @param campaign {module:model/CampaignForNotification} * @param oldState {String} The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] * @param newState {String} The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] */ @@ -57,7 +57,7 @@ class CampaignStateChangedNotification { obj = obj || new CampaignStateChangedNotification(); if (data.hasOwnProperty('campaign')) { - obj['campaign'] = Campaign.constructFromObject(data['campaign']); + obj['campaign'] = CampaignForNotification.constructFromObject(data['campaign']); } if (data.hasOwnProperty('oldState')) { obj['oldState'] = ApiClient.convertToType(data['oldState'], 'String'); @@ -76,7 +76,7 @@ class CampaignStateChangedNotification { } /** - * @member {module:model/Campaign} campaign + * @member {module:model/CampaignForNotification} campaign */ CampaignStateChangedNotification.prototype['campaign'] = undefined; diff --git a/src/model/CampaignStateNotification.js b/src/model/CampaignStateNotification.js new file mode 100644 index 00000000..0cfe1e80 --- /dev/null +++ b/src/model/CampaignStateNotification.js @@ -0,0 +1,597 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import CampaignBudget from './CampaignBudget'; +import CodeGeneratorSettings from './CodeGeneratorSettings'; +import LimitConfig from './LimitConfig'; + +/** + * The CampaignStateNotification model module. + * @module model/CampaignStateNotification + * @version 6.0.0 + */ +class CampaignStateNotification { + /** + * Constructs a new CampaignStateNotification. + * Campaign data and its state changes. + * @alias module:model/CampaignStateNotification + * @param id {Number} Unique ID for this entity. + * @param created {Date} The exact moment this entity was created. + * @param applicationId {Number} The ID of the application that owns this entity. + * @param userId {Number} The ID of the user associated with this entity. + * @param name {String} A user-facing name for this campaign. + * @param description {String} A detailed description of the campaign. + * @param state {module:model/CampaignStateNotification.StateEnum} A disabled or archived campaign is not evaluated for rules or coupons. + * @param tags {Array.} A list of tags for the campaign. + * @param features {Array.} The features enabled in this campaign. + * @param limits {Array.} The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @param type {module:model/CampaignStateNotification.TypeEnum} The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @param budgets {Array.} A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + * @param frontendState {module:model/CampaignStateNotification.FrontendStateEnum} A campaign state described exactly as in the Campaign Manager. + */ + constructor(id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets, frontendState) { + + CampaignStateNotification.initialize(this, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets, frontendState); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, applicationId, userId, name, description, state, tags, features, limits, type, budgets, frontendState) { + obj['id'] = id; + obj['created'] = created; + obj['applicationId'] = applicationId; + obj['userId'] = userId; + obj['name'] = name; + obj['description'] = description; + obj['state'] = state; + obj['tags'] = tags; + obj['features'] = features; + obj['limits'] = limits; + obj['type'] = type; + obj['budgets'] = budgets; + obj['frontendState'] = frontendState; + } + + /** + * Constructs a CampaignStateNotification from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CampaignStateNotification} obj Optional instance to populate. + * @return {module:model/CampaignStateNotification} The populated CampaignStateNotification instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CampaignStateNotification(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('applicationId')) { + obj['applicationId'] = ApiClient.convertToType(data['applicationId'], 'Number'); + } + if (data.hasOwnProperty('userId')) { + obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('startTime')) { + obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date'); + } + if (data.hasOwnProperty('endTime')) { + obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('state')) { + obj['state'] = ApiClient.convertToType(data['state'], 'String'); + } + if (data.hasOwnProperty('activeRulesetId')) { + obj['activeRulesetId'] = ApiClient.convertToType(data['activeRulesetId'], 'Number'); + } + if (data.hasOwnProperty('tags')) { + obj['tags'] = ApiClient.convertToType(data['tags'], ['String']); + } + if (data.hasOwnProperty('features')) { + obj['features'] = ApiClient.convertToType(data['features'], ['String']); + } + if (data.hasOwnProperty('couponSettings')) { + obj['couponSettings'] = CodeGeneratorSettings.constructFromObject(data['couponSettings']); + } + if (data.hasOwnProperty('referralSettings')) { + obj['referralSettings'] = CodeGeneratorSettings.constructFromObject(data['referralSettings']); + } + if (data.hasOwnProperty('limits')) { + obj['limits'] = ApiClient.convertToType(data['limits'], [LimitConfig]); + } + if (data.hasOwnProperty('campaignGroups')) { + obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); + } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } + if (data.hasOwnProperty('budgets')) { + obj['budgets'] = ApiClient.convertToType(data['budgets'], [CampaignBudget]); + } + if (data.hasOwnProperty('couponRedemptionCount')) { + obj['couponRedemptionCount'] = ApiClient.convertToType(data['couponRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('referralRedemptionCount')) { + obj['referralRedemptionCount'] = ApiClient.convertToType(data['referralRedemptionCount'], 'Number'); + } + if (data.hasOwnProperty('discountCount')) { + obj['discountCount'] = ApiClient.convertToType(data['discountCount'], 'Number'); + } + if (data.hasOwnProperty('discountEffectCount')) { + obj['discountEffectCount'] = ApiClient.convertToType(data['discountEffectCount'], 'Number'); + } + if (data.hasOwnProperty('couponCreationCount')) { + obj['couponCreationCount'] = ApiClient.convertToType(data['couponCreationCount'], 'Number'); + } + if (data.hasOwnProperty('customEffectCount')) { + obj['customEffectCount'] = ApiClient.convertToType(data['customEffectCount'], 'Number'); + } + if (data.hasOwnProperty('referralCreationCount')) { + obj['referralCreationCount'] = ApiClient.convertToType(data['referralCreationCount'], 'Number'); + } + if (data.hasOwnProperty('addFreeItemEffectCount')) { + obj['addFreeItemEffectCount'] = ApiClient.convertToType(data['addFreeItemEffectCount'], 'Number'); + } + if (data.hasOwnProperty('awardedGiveawaysCount')) { + obj['awardedGiveawaysCount'] = ApiClient.convertToType(data['awardedGiveawaysCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsCount')) { + obj['createdLoyaltyPointsCount'] = ApiClient.convertToType(data['createdLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsEffectCount')) { + obj['createdLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['createdLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsCount')) { + obj['redeemedLoyaltyPointsCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsEffectCount')) { + obj['redeemedLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('callApiEffectCount')) { + obj['callApiEffectCount'] = ApiClient.convertToType(data['callApiEffectCount'], 'Number'); + } + if (data.hasOwnProperty('reservecouponEffectCount')) { + obj['reservecouponEffectCount'] = ApiClient.convertToType(data['reservecouponEffectCount'], 'Number'); + } + if (data.hasOwnProperty('lastActivity')) { + obj['lastActivity'] = ApiClient.convertToType(data['lastActivity'], 'Date'); + } + if (data.hasOwnProperty('updated')) { + obj['updated'] = ApiClient.convertToType(data['updated'], 'Date'); + } + if (data.hasOwnProperty('createdBy')) { + obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String'); + } + if (data.hasOwnProperty('updatedBy')) { + obj['updatedBy'] = ApiClient.convertToType(data['updatedBy'], 'String'); + } + if (data.hasOwnProperty('templateId')) { + obj['templateId'] = ApiClient.convertToType(data['templateId'], 'Number'); + } + if (data.hasOwnProperty('frontendState')) { + obj['frontendState'] = ApiClient.convertToType(data['frontendState'], 'String'); + } + } + return obj; + } + + +} + +/** + * Unique ID for this entity. + * @member {Number} id + */ +CampaignStateNotification.prototype['id'] = undefined; + +/** + * The exact moment this entity was created. + * @member {Date} created + */ +CampaignStateNotification.prototype['created'] = undefined; + +/** + * The ID of the application that owns this entity. + * @member {Number} applicationId + */ +CampaignStateNotification.prototype['applicationId'] = undefined; + +/** + * The ID of the user associated with this entity. + * @member {Number} userId + */ +CampaignStateNotification.prototype['userId'] = undefined; + +/** + * A user-facing name for this campaign. + * @member {String} name + */ +CampaignStateNotification.prototype['name'] = undefined; + +/** + * A detailed description of the campaign. + * @member {String} description + */ +CampaignStateNotification.prototype['description'] = undefined; + +/** + * Timestamp when the campaign will become active. + * @member {Date} startTime + */ +CampaignStateNotification.prototype['startTime'] = undefined; + +/** + * Timestamp when the campaign will become inactive. + * @member {Date} endTime + */ +CampaignStateNotification.prototype['endTime'] = undefined; + +/** + * Arbitrary properties associated with this campaign. + * @member {Object} attributes + */ +CampaignStateNotification.prototype['attributes'] = undefined; + +/** + * A disabled or archived campaign is not evaluated for rules or coupons. + * @member {module:model/CampaignStateNotification.StateEnum} state + * @default 'enabled' + */ +CampaignStateNotification.prototype['state'] = 'enabled'; + +/** + * [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. + * @member {Number} activeRulesetId + */ +CampaignStateNotification.prototype['activeRulesetId'] = undefined; + +/** + * A list of tags for the campaign. + * @member {Array.} tags + */ +CampaignStateNotification.prototype['tags'] = undefined; + +/** + * The features enabled in this campaign. + * @member {Array.} features + */ +CampaignStateNotification.prototype['features'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} couponSettings + */ +CampaignStateNotification.prototype['couponSettings'] = undefined; + +/** + * @member {module:model/CodeGeneratorSettings} referralSettings + */ +CampaignStateNotification.prototype['referralSettings'] = undefined; + +/** + * The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + * @member {Array.} limits + */ +CampaignStateNotification.prototype['limits'] = undefined; + +/** + * The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. + * @member {Array.} campaignGroups + */ +CampaignStateNotification.prototype['campaignGroups'] = undefined; + +/** + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +CampaignStateNotification.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/CampaignStateNotification.TypeEnum} type + * @default 'advanced' + */ +CampaignStateNotification.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +CampaignStateNotification.prototype['linkedStoreIds'] = undefined; + +/** + * A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. + * @member {Array.} budgets + */ +CampaignStateNotification.prototype['budgets'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. + * @member {Number} couponRedemptionCount + */ +CampaignStateNotification.prototype['couponRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. + * @member {Number} referralRedemptionCount + */ +CampaignStateNotification.prototype['referralRedemptionCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. + * @member {Number} discountCount + */ +CampaignStateNotification.prototype['discountCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. + * @member {Number} discountEffectCount + */ +CampaignStateNotification.prototype['discountEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. + * @member {Number} couponCreationCount + */ +CampaignStateNotification.prototype['couponCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. + * @member {Number} customEffectCount + */ +CampaignStateNotification.prototype['customEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. + * @member {Number} referralCreationCount + */ +CampaignStateNotification.prototype['referralCreationCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. + * @member {Number} addFreeItemEffectCount + */ +CampaignStateNotification.prototype['addFreeItemEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. + * @member {Number} awardedGiveawaysCount + */ +CampaignStateNotification.prototype['awardedGiveawaysCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. + * @member {Number} createdLoyaltyPointsCount + */ +CampaignStateNotification.prototype['createdLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. + * @member {Number} createdLoyaltyPointsEffectCount + */ +CampaignStateNotification.prototype['createdLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsCount + */ +CampaignStateNotification.prototype['redeemedLoyaltyPointsCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsEffectCount + */ +CampaignStateNotification.prototype['redeemedLoyaltyPointsEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. + * @member {Number} callApiEffectCount + */ +CampaignStateNotification.prototype['callApiEffectCount'] = undefined; + +/** + * This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. + * @member {Number} reservecouponEffectCount + */ +CampaignStateNotification.prototype['reservecouponEffectCount'] = undefined; + +/** + * Timestamp of the most recent event received by this campaign. + * @member {Date} lastActivity + */ +CampaignStateNotification.prototype['lastActivity'] = undefined; + +/** + * Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. + * @member {Date} updated + */ +CampaignStateNotification.prototype['updated'] = undefined; + +/** + * Name of the user who created this campaign if available. + * @member {String} createdBy + */ +CampaignStateNotification.prototype['createdBy'] = undefined; + +/** + * Name of the user who last updated this campaign if available. + * @member {String} updatedBy + */ +CampaignStateNotification.prototype['updatedBy'] = undefined; + +/** + * The ID of the Campaign Template this Campaign was created from. + * @member {Number} templateId + */ +CampaignStateNotification.prototype['templateId'] = undefined; + +/** + * A campaign state described exactly as in the Campaign Manager. + * @member {module:model/CampaignStateNotification.FrontendStateEnum} frontendState + */ +CampaignStateNotification.prototype['frontendState'] = undefined; + + + + + +/** + * Allowed values for the state property. + * @enum {String} + * @readonly + */ +CampaignStateNotification['StateEnum'] = { + + /** + * value: "enabled" + * @const + */ + "enabled": "enabled", + + /** + * value: "disabled" + * @const + */ + "disabled": "disabled", + + /** + * value: "archived" + * @const + */ + "archived": "archived" +}; + + +/** + * Allowed values for the features property. + * @enum {String} + * @readonly + */ +CampaignStateNotification['FeaturesEnum'] = { + + /** + * value: "coupons" + * @const + */ + "coupons": "coupons", + + /** + * value: "referrals" + * @const + */ + "referrals": "referrals", + + /** + * value: "loyalty" + * @const + */ + "loyalty": "loyalty", + + /** + * value: "giveaways" + * @const + */ + "giveaways": "giveaways", + + /** + * value: "strikethrough" + * @const + */ + "strikethrough": "strikethrough" +}; + + +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +CampaignStateNotification['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + +/** + * Allowed values for the frontendState property. + * @enum {String} + * @readonly + */ +CampaignStateNotification['FrontendStateEnum'] = { + + /** + * value: "expired" + * @const + */ + "expired": "expired", + + /** + * value: "scheduled" + * @const + */ + "scheduled": "scheduled", + + /** + * value: "running" + * @const + */ + "running": "running", + + /** + * value: "draft" + * @const + */ + "draft": "draft", + + /** + * value: "disabled" + * @const + */ + "disabled": "disabled" +}; + + + +export default CampaignStateNotification; + diff --git a/src/model/CampaignTemplate.js b/src/model/CampaignTemplate.js index 3a1896dc..c2e56b0c 100644 --- a/src/model/CampaignTemplate.js +++ b/src/model/CampaignTemplate.js @@ -20,7 +20,7 @@ import TemplateLimitConfig from './TemplateLimitConfig'; /** * The CampaignTemplate model module. * @module model/CampaignTemplate - * @version 5.0.1 + * @version 6.0.0 */ class CampaignTemplate { /** @@ -36,11 +36,12 @@ class CampaignTemplate { * @param instructions {String} Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. * @param state {module:model/CampaignTemplate.StateEnum} Only campaign templates in 'available' state may be used to create campaigns. * @param applicationsIds {Array.} A list of IDs of the Applications that are subscribed to this campaign template. + * @param campaignType {module:model/CampaignTemplate.CampaignTypeEnum} The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. * @param validApplicationIds {Array.} The IDs of the Applications that are related to this entity. */ - constructor(id, created, accountId, userId, name, description, instructions, state, applicationsIds, validApplicationIds) { + constructor(id, created, accountId, userId, name, description, instructions, state, applicationsIds, campaignType, validApplicationIds) { - CampaignTemplate.initialize(this, id, created, accountId, userId, name, description, instructions, state, applicationsIds, validApplicationIds); + CampaignTemplate.initialize(this, id, created, accountId, userId, name, description, instructions, state, applicationsIds, campaignType, validApplicationIds); } /** @@ -48,7 +49,7 @@ class CampaignTemplate { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, id, created, accountId, userId, name, description, instructions, state, applicationsIds, validApplicationIds) { + static initialize(obj, id, created, accountId, userId, name, description, instructions, state, applicationsIds, campaignType, validApplicationIds) { obj['id'] = id; obj['created'] = created; obj['accountId'] = accountId; @@ -58,6 +59,7 @@ class CampaignTemplate { obj['instructions'] = instructions; obj['state'] = state; obj['applicationsIds'] = applicationsIds; + obj['campaignType'] = campaignType; obj['validApplicationIds'] = validApplicationIds; } @@ -132,6 +134,9 @@ class CampaignTemplate { if (data.hasOwnProperty('defaultCampaignGroupId')) { obj['defaultCampaignGroupId'] = ApiClient.convertToType(data['defaultCampaignGroupId'], 'Number'); } + if (data.hasOwnProperty('campaignType')) { + obj['campaignType'] = ApiClient.convertToType(data['campaignType'], 'String'); + } if (data.hasOwnProperty('updated')) { obj['updated'] = ApiClient.convertToType(data['updated'], 'Date'); } @@ -266,6 +271,13 @@ CampaignTemplate.prototype['campaignCollections'] = undefined; */ CampaignTemplate.prototype['defaultCampaignGroupId'] = undefined; +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/CampaignTemplate.CampaignTypeEnum} campaignType + * @default 'advanced' + */ +CampaignTemplate.prototype['campaignType'] = 'advanced'; + /** * Timestamp of the most recent update to the campaign template or any of its elements. * @member {Date} updated @@ -354,6 +366,27 @@ CampaignTemplate['FeaturesEnum'] = { }; +/** + * Allowed values for the campaignType property. + * @enum {String} + * @readonly + */ +CampaignTemplate['CampaignTypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default CampaignTemplate; diff --git a/src/model/CampaignTemplateCollection.js b/src/model/CampaignTemplateCollection.js index dced436e..15b26d97 100644 --- a/src/model/CampaignTemplateCollection.js +++ b/src/model/CampaignTemplateCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignTemplateCollection model module. * @module model/CampaignTemplateCollection - * @version 5.0.1 + * @version 6.0.0 */ class CampaignTemplateCollection { /** diff --git a/src/model/CampaignTemplateParams.js b/src/model/CampaignTemplateParams.js index 8781bb31..4c2a04c4 100644 --- a/src/model/CampaignTemplateParams.js +++ b/src/model/CampaignTemplateParams.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignTemplateParams model module. * @module model/CampaignTemplateParams - * @version 5.0.1 + * @version 6.0.0 */ class CampaignTemplateParams { /** diff --git a/src/model/CardLedgerPointsEntryIntegrationAPI.js b/src/model/CardLedgerPointsEntryIntegrationAPI.js new file mode 100644 index 00000000..0c0789cc --- /dev/null +++ b/src/model/CardLedgerPointsEntryIntegrationAPI.js @@ -0,0 +1,170 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The CardLedgerPointsEntryIntegrationAPI model module. + * @module model/CardLedgerPointsEntryIntegrationAPI + * @version 6.0.0 + */ +class CardLedgerPointsEntryIntegrationAPI { + /** + * Constructs a new CardLedgerPointsEntryIntegrationAPI. + * Loyalty card points with start and expiry dates. + * @alias module:model/CardLedgerPointsEntryIntegrationAPI + * @param id {Number} ID of the transaction that adds loyalty points. + * @param created {Date} Date and time the loyalty card points were added. + * @param programId {Number} ID of the loyalty program. + * @param name {String} Name or reason of the transaction that adds loyalty points. + * @param startDate {String} When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. + * @param expiryDate {String} Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. + * @param subledgerId {String} ID of the subledger. + * @param amount {Number} Amount of loyalty points added in the transaction. + */ + constructor(id, created, programId, name, startDate, expiryDate, subledgerId, amount) { + + CardLedgerPointsEntryIntegrationAPI.initialize(this, id, created, programId, name, startDate, expiryDate, subledgerId, amount); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, programId, name, startDate, expiryDate, subledgerId, amount) { + obj['id'] = id; + obj['created'] = created; + obj['programId'] = programId; + obj['name'] = name; + obj['startDate'] = startDate; + obj['expiryDate'] = expiryDate; + obj['subledgerId'] = subledgerId; + obj['amount'] = amount; + } + + /** + * Constructs a CardLedgerPointsEntryIntegrationAPI from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CardLedgerPointsEntryIntegrationAPI} obj Optional instance to populate. + * @return {module:model/CardLedgerPointsEntryIntegrationAPI} The populated CardLedgerPointsEntryIntegrationAPI instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CardLedgerPointsEntryIntegrationAPI(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('programId')) { + obj['programId'] = ApiClient.convertToType(data['programId'], 'Number'); + } + if (data.hasOwnProperty('customerProfileID')) { + obj['customerProfileID'] = ApiClient.convertToType(data['customerProfileID'], 'String'); + } + if (data.hasOwnProperty('customerSessionId')) { + obj['customerSessionId'] = ApiClient.convertToType(data['customerSessionId'], 'String'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('startDate')) { + obj['startDate'] = ApiClient.convertToType(data['startDate'], 'String'); + } + if (data.hasOwnProperty('expiryDate')) { + obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'String'); + } + if (data.hasOwnProperty('subledgerId')) { + obj['subledgerId'] = ApiClient.convertToType(data['subledgerId'], 'String'); + } + if (data.hasOwnProperty('amount')) { + obj['amount'] = ApiClient.convertToType(data['amount'], 'Number'); + } + } + return obj; + } + + +} + +/** + * ID of the transaction that adds loyalty points. + * @member {Number} id + */ +CardLedgerPointsEntryIntegrationAPI.prototype['id'] = undefined; + +/** + * Date and time the loyalty card points were added. + * @member {Date} created + */ +CardLedgerPointsEntryIntegrationAPI.prototype['created'] = undefined; + +/** + * ID of the loyalty program. + * @member {Number} programId + */ +CardLedgerPointsEntryIntegrationAPI.prototype['programId'] = undefined; + +/** + * Integration ID of the customer profile linked to the card. + * @member {String} customerProfileID + */ +CardLedgerPointsEntryIntegrationAPI.prototype['customerProfileID'] = undefined; + +/** + * ID of the customer session where points were added. + * @member {String} customerSessionId + */ +CardLedgerPointsEntryIntegrationAPI.prototype['customerSessionId'] = undefined; + +/** + * Name or reason of the transaction that adds loyalty points. + * @member {String} name + */ +CardLedgerPointsEntryIntegrationAPI.prototype['name'] = undefined; + +/** + * When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. + * @member {String} startDate + */ +CardLedgerPointsEntryIntegrationAPI.prototype['startDate'] = undefined; + +/** + * Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. + * @member {String} expiryDate + */ +CardLedgerPointsEntryIntegrationAPI.prototype['expiryDate'] = undefined; + +/** + * ID of the subledger. + * @member {String} subledgerId + */ +CardLedgerPointsEntryIntegrationAPI.prototype['subledgerId'] = undefined; + +/** + * Amount of loyalty points added in the transaction. + * @member {Number} amount + */ +CardLedgerPointsEntryIntegrationAPI.prototype['amount'] = undefined; + + + + + + +export default CardLedgerPointsEntryIntegrationAPI; + diff --git a/src/model/CardLedgerTransactionLogEntry.js b/src/model/CardLedgerTransactionLogEntry.js index 6aa98b72..05c698dd 100644 --- a/src/model/CardLedgerTransactionLogEntry.js +++ b/src/model/CardLedgerTransactionLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CardLedgerTransactionLogEntry model module. * @module model/CardLedgerTransactionLogEntry - * @version 5.0.1 + * @version 6.0.0 */ class CardLedgerTransactionLogEntry { /** diff --git a/src/model/CardLedgerTransactionLogEntryIntegrationAPI.js b/src/model/CardLedgerTransactionLogEntryIntegrationAPI.js index 61816c83..eaa372a5 100644 --- a/src/model/CardLedgerTransactionLogEntryIntegrationAPI.js +++ b/src/model/CardLedgerTransactionLogEntryIntegrationAPI.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CardLedgerTransactionLogEntryIntegrationAPI model module. * @module model/CardLedgerTransactionLogEntryIntegrationAPI - * @version 5.0.1 + * @version 6.0.0 */ class CardLedgerTransactionLogEntryIntegrationAPI { /** diff --git a/src/model/CartItem.js b/src/model/CartItem.js index 46e11744..c6dd501b 100644 --- a/src/model/CartItem.js +++ b/src/model/CartItem.js @@ -17,14 +17,14 @@ import AdditionalCost from './AdditionalCost'; /** * The CartItem model module. * @module model/CartItem - * @version 5.0.1 + * @version 6.0.0 */ class CartItem { /** * Constructs a new CartItem. * @alias module:model/CartItem * @param sku {String} Stock keeping unit of item. - * @param quantity {Number} Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. + * @param quantity {Number} Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. */ constructor(sku, quantity) { @@ -117,7 +117,7 @@ CartItem.prototype['name'] = undefined; CartItem.prototype['sku'] = undefined; /** - * Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. + * Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. * @member {Number} quantity */ CartItem.prototype['quantity'] = undefined; @@ -189,7 +189,7 @@ CartItem.prototype['attributes'] = undefined; CartItem.prototype['additionalCosts'] = undefined; /** - * The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs). + * The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). * @member {Number} catalogItemID */ CartItem.prototype['catalogItemID'] = undefined; diff --git a/src/model/Catalog.js b/src/model/Catalog.js index aa3135ef..e9006732 100644 --- a/src/model/Catalog.js +++ b/src/model/Catalog.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Catalog model module. * @module model/Catalog - * @version 5.0.1 + * @version 6.0.0 */ class Catalog { /** diff --git a/src/model/CatalogAction.js b/src/model/CatalogAction.js index c966e3b6..e8eedb5e 100644 --- a/src/model/CatalogAction.js +++ b/src/model/CatalogAction.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CatalogAction model module. * @module model/CatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class CatalogAction { /** diff --git a/src/model/CatalogActionFilter.js b/src/model/CatalogActionFilter.js index 95c655f6..dbecbc8a 100644 --- a/src/model/CatalogActionFilter.js +++ b/src/model/CatalogActionFilter.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CatalogActionFilter model module. * @module model/CatalogActionFilter - * @version 5.0.1 + * @version 6.0.0 */ class CatalogActionFilter { /** diff --git a/src/model/CatalogItem.js b/src/model/CatalogItem.js index 40f3d54c..bf992db4 100644 --- a/src/model/CatalogItem.js +++ b/src/model/CatalogItem.js @@ -17,7 +17,7 @@ import ItemAttribute from './ItemAttribute'; /** * The CatalogItem model module. * @module model/CatalogItem - * @version 5.0.1 + * @version 6.0.0 */ class CatalogItem { /** diff --git a/src/model/CatalogSyncRequest.js b/src/model/CatalogSyncRequest.js index b4898ed6..a84ad091 100644 --- a/src/model/CatalogSyncRequest.js +++ b/src/model/CatalogSyncRequest.js @@ -17,7 +17,7 @@ import CatalogAction from './CatalogAction'; /** * The CatalogSyncRequest model module. * @module model/CatalogSyncRequest - * @version 5.0.1 + * @version 6.0.0 */ class CatalogSyncRequest { /** diff --git a/src/model/CatalogsStrikethroughNotificationPolicy.js b/src/model/CatalogsStrikethroughNotificationPolicy.js index 92291382..3f8805ce 100644 --- a/src/model/CatalogsStrikethroughNotificationPolicy.js +++ b/src/model/CatalogsStrikethroughNotificationPolicy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CatalogsStrikethroughNotificationPolicy model module. * @module model/CatalogsStrikethroughNotificationPolicy - * @version 5.0.1 + * @version 6.0.0 */ class CatalogsStrikethroughNotificationPolicy { /** diff --git a/src/model/Change.js b/src/model/Change.js index 96cd1bc8..4879758c 100644 --- a/src/model/Change.js +++ b/src/model/Change.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Change model module. * @module model/Change - * @version 5.0.1 + * @version 6.0.0 */ class Change { /** diff --git a/src/model/ChangeLoyaltyTierLevelEffectProps.js b/src/model/ChangeLoyaltyTierLevelEffectProps.js new file mode 100644 index 00000000..42fee363 --- /dev/null +++ b/src/model/ChangeLoyaltyTierLevelEffectProps.js @@ -0,0 +1,126 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The ChangeLoyaltyTierLevelEffectProps model module. + * @module model/ChangeLoyaltyTierLevelEffectProps + * @version 6.0.0 + */ +class ChangeLoyaltyTierLevelEffectProps { + /** + * Constructs a new ChangeLoyaltyTierLevelEffectProps. + * The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded or downgraded due to a validated rule that contained an \"add loyalty points\" effect. + * @alias module:model/ChangeLoyaltyTierLevelEffectProps + * @param ruleTitle {String} The title of the rule that triggered the tier upgrade or downgrade. + * @param programId {Number} The ID of the loyalty program where these points were added. + * @param subLedgerId {String} The ID of the subledger within the loyalty program where these points were added. + * @param newTierName {String} The name of the tier to which the user has been upgraded or downgraded. + */ + constructor(ruleTitle, programId, subLedgerId, newTierName) { + + ChangeLoyaltyTierLevelEffectProps.initialize(this, ruleTitle, programId, subLedgerId, newTierName); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, ruleTitle, programId, subLedgerId, newTierName) { + obj['ruleTitle'] = ruleTitle; + obj['programId'] = programId; + obj['subLedgerId'] = subLedgerId; + obj['newTierName'] = newTierName; + } + + /** + * Constructs a ChangeLoyaltyTierLevelEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ChangeLoyaltyTierLevelEffectProps} obj Optional instance to populate. + * @return {module:model/ChangeLoyaltyTierLevelEffectProps} The populated ChangeLoyaltyTierLevelEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ChangeLoyaltyTierLevelEffectProps(); + + if (data.hasOwnProperty('ruleTitle')) { + obj['ruleTitle'] = ApiClient.convertToType(data['ruleTitle'], 'String'); + } + if (data.hasOwnProperty('programId')) { + obj['programId'] = ApiClient.convertToType(data['programId'], 'Number'); + } + if (data.hasOwnProperty('subLedgerId')) { + obj['subLedgerId'] = ApiClient.convertToType(data['subLedgerId'], 'String'); + } + if (data.hasOwnProperty('previousTierName')) { + obj['previousTierName'] = ApiClient.convertToType(data['previousTierName'], 'String'); + } + if (data.hasOwnProperty('newTierName')) { + obj['newTierName'] = ApiClient.convertToType(data['newTierName'], 'String'); + } + if (data.hasOwnProperty('expiryDate')) { + obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'Date'); + } + } + return obj; + } + + +} + +/** + * The title of the rule that triggered the tier upgrade or downgrade. + * @member {String} ruleTitle + */ +ChangeLoyaltyTierLevelEffectProps.prototype['ruleTitle'] = undefined; + +/** + * The ID of the loyalty program where these points were added. + * @member {Number} programId + */ +ChangeLoyaltyTierLevelEffectProps.prototype['programId'] = undefined; + +/** + * The ID of the subledger within the loyalty program where these points were added. + * @member {String} subLedgerId + */ +ChangeLoyaltyTierLevelEffectProps.prototype['subLedgerId'] = undefined; + +/** + * The name of the tier from which the user was upgraded or downgraded. + * @member {String} previousTierName + */ +ChangeLoyaltyTierLevelEffectProps.prototype['previousTierName'] = undefined; + +/** + * The name of the tier to which the user has been upgraded or downgraded. + * @member {String} newTierName + */ +ChangeLoyaltyTierLevelEffectProps.prototype['newTierName'] = undefined; + +/** + * The expiration date of the new tier. + * @member {Date} expiryDate + */ +ChangeLoyaltyTierLevelEffectProps.prototype['expiryDate'] = undefined; + + + + + + +export default ChangeLoyaltyTierLevelEffectProps; + diff --git a/src/model/ChangeProfilePassword.js b/src/model/ChangeProfilePassword.js index 2d6bc81c..5c8763c6 100644 --- a/src/model/ChangeProfilePassword.js +++ b/src/model/ChangeProfilePassword.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ChangeProfilePassword model module. * @module model/ChangeProfilePassword - * @version 5.0.1 + * @version 6.0.0 */ class ChangeProfilePassword { /** diff --git a/src/model/CodeGeneratorSettings.js b/src/model/CodeGeneratorSettings.js index bc816fff..0e727401 100644 --- a/src/model/CodeGeneratorSettings.js +++ b/src/model/CodeGeneratorSettings.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CodeGeneratorSettings model module. * @module model/CodeGeneratorSettings - * @version 5.0.1 + * @version 6.0.0 */ class CodeGeneratorSettings { /** diff --git a/src/model/Collection.js b/src/model/Collection.js index 01922691..a6d3418e 100644 --- a/src/model/Collection.js +++ b/src/model/Collection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Collection model module. * @module model/Collection - * @version 5.0.1 + * @version 6.0.0 */ class Collection { /** diff --git a/src/model/CollectionItem.js b/src/model/CollectionItem.js index 548baf6e..880f9b9e 100644 --- a/src/model/CollectionItem.js +++ b/src/model/CollectionItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CollectionItem model module. * @module model/CollectionItem - * @version 5.0.1 + * @version 6.0.0 */ class CollectionItem { /** diff --git a/src/model/CollectionWithoutPayload.js b/src/model/CollectionWithoutPayload.js index bf5d15cd..40e02c76 100644 --- a/src/model/CollectionWithoutPayload.js +++ b/src/model/CollectionWithoutPayload.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CollectionWithoutPayload model module. * @module model/CollectionWithoutPayload - * @version 5.0.1 + * @version 6.0.0 */ class CollectionWithoutPayload { /** diff --git a/src/model/Coupon.js b/src/model/Coupon.js index e14ff32c..4accef01 100644 --- a/src/model/Coupon.js +++ b/src/model/Coupon.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The Coupon model module. * @module model/Coupon - * @version 5.0.1 + * @version 6.0.0 */ class Coupon { /** @@ -124,6 +124,9 @@ class Coupon { if (data.hasOwnProperty('isReservationMandatory')) { obj['isReservationMandatory'] = ApiClient.convertToType(data['isReservationMandatory'], 'Boolean'); } + if (data.hasOwnProperty('implicitlyReserved')) { + obj['implicitlyReserved'] = ApiClient.convertToType(data['implicitlyReserved'], 'Boolean'); + } } return obj; } @@ -259,6 +262,12 @@ Coupon.prototype['batchId'] = undefined; */ Coupon.prototype['isReservationMandatory'] = true; +/** + * An indication of whether the coupon is implicitly reserved for all customers. + * @member {Boolean} implicitlyReserved + */ +Coupon.prototype['implicitlyReserved'] = undefined; + diff --git a/src/model/CouponConstraints.js b/src/model/CouponConstraints.js index c89c64f0..842c354a 100644 --- a/src/model/CouponConstraints.js +++ b/src/model/CouponConstraints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponConstraints model module. * @module model/CouponConstraints - * @version 5.0.1 + * @version 6.0.0 */ class CouponConstraints { /** diff --git a/src/model/CouponCreatedEffectProps.js b/src/model/CouponCreatedEffectProps.js index d403020a..a0b0825d 100644 --- a/src/model/CouponCreatedEffectProps.js +++ b/src/model/CouponCreatedEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponCreatedEffectProps model module. * @module model/CouponCreatedEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class CouponCreatedEffectProps { /** diff --git a/src/model/CouponCreationJob.js b/src/model/CouponCreationJob.js index 8484f970..ba40c129 100644 --- a/src/model/CouponCreationJob.js +++ b/src/model/CouponCreationJob.js @@ -17,7 +17,7 @@ import CodeGeneratorSettings from './CodeGeneratorSettings'; /** * The CouponCreationJob model module. * @module model/CouponCreationJob - * @version 5.0.1 + * @version 6.0.0 */ class CouponCreationJob { /** diff --git a/src/model/CouponLimitConfigs.js b/src/model/CouponLimitConfigs.js index dd365a58..ceb5d9db 100644 --- a/src/model/CouponLimitConfigs.js +++ b/src/model/CouponLimitConfigs.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The CouponLimitConfigs model module. * @module model/CouponLimitConfigs - * @version 5.0.1 + * @version 6.0.0 */ class CouponLimitConfigs { /** diff --git a/src/model/CouponRejectionReason.js b/src/model/CouponRejectionReason.js index 1e8fe401..da25f13c 100644 --- a/src/model/CouponRejectionReason.js +++ b/src/model/CouponRejectionReason.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponRejectionReason model module. * @module model/CouponRejectionReason - * @version 5.0.1 + * @version 6.0.0 */ class CouponRejectionReason { /** diff --git a/src/model/CouponReservations.js b/src/model/CouponReservations.js index 06b5b097..8ead905f 100644 --- a/src/model/CouponReservations.js +++ b/src/model/CouponReservations.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponReservations model module. * @module model/CouponReservations - * @version 5.0.1 + * @version 6.0.0 */ class CouponReservations { /** diff --git a/src/model/CouponSearch.js b/src/model/CouponSearch.js index 9e199647..212aefe2 100644 --- a/src/model/CouponSearch.js +++ b/src/model/CouponSearch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponSearch model module. * @module model/CouponSearch - * @version 5.0.1 + * @version 6.0.0 */ class CouponSearch { /** diff --git a/src/model/CouponValue.js b/src/model/CouponValue.js index aa272dd5..3537a893 100644 --- a/src/model/CouponValue.js +++ b/src/model/CouponValue.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponValue model module. * @module model/CouponValue - * @version 5.0.1 + * @version 6.0.0 */ class CouponValue { /** diff --git a/src/model/CouponsNotificationPolicy.js b/src/model/CouponsNotificationPolicy.js index 99e496c9..e0e3cde8 100644 --- a/src/model/CouponsNotificationPolicy.js +++ b/src/model/CouponsNotificationPolicy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponsNotificationPolicy model module. * @module model/CouponsNotificationPolicy - * @version 5.0.1 + * @version 6.0.0 */ class CouponsNotificationPolicy { /** diff --git a/src/model/CreateAchievement.js b/src/model/CreateAchievement.js new file mode 100644 index 00000000..6067f9b4 --- /dev/null +++ b/src/model/CreateAchievement.js @@ -0,0 +1,127 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import TimePoint from './TimePoint'; + +/** + * The CreateAchievement model module. + * @module model/CreateAchievement + * @version 6.0.0 + */ +class CreateAchievement { + /** + * Constructs a new CreateAchievement. + * @alias module:model/CreateAchievement + * @param name {String} The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. + * @param title {String} The display name for the achievement in the Campaign Manager. + * @param description {String} A description of the achievement. + * @param target {Number} The maximum number of times a specific action must be completed by a customer profile over a defined period of time. + * @param period {String} The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. + */ + constructor(name, title, description, target, period) { + + CreateAchievement.initialize(this, name, title, description, target, period); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name, title, description, target, period) { + obj['name'] = name; + obj['title'] = title; + obj['description'] = description; + obj['target'] = target; + obj['period'] = period; + } + + /** + * Constructs a CreateAchievement from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CreateAchievement} obj Optional instance to populate. + * @return {module:model/CreateAchievement} The populated CreateAchievement instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CreateAchievement(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('title')) { + obj['title'] = ApiClient.convertToType(data['title'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('target')) { + obj['target'] = ApiClient.convertToType(data['target'], 'Number'); + } + if (data.hasOwnProperty('period')) { + obj['period'] = ApiClient.convertToType(data['period'], 'String'); + } + if (data.hasOwnProperty('periodEndOverride')) { + obj['periodEndOverride'] = TimePoint.constructFromObject(data['periodEndOverride']); + } + } + return obj; + } + + +} + +/** + * The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. + * @member {String} name + */ +CreateAchievement.prototype['name'] = undefined; + +/** + * The display name for the achievement in the Campaign Manager. + * @member {String} title + */ +CreateAchievement.prototype['title'] = undefined; + +/** + * A description of the achievement. + * @member {String} description + */ +CreateAchievement.prototype['description'] = undefined; + +/** + * The maximum number of times a specific action must be completed by a customer profile over a defined period of time. + * @member {Number} target + */ +CreateAchievement.prototype['target'] = undefined; + +/** + * The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. + * @member {String} period + */ +CreateAchievement.prototype['period'] = undefined; + +/** + * @member {module:model/TimePoint} periodEndOverride + */ +CreateAchievement.prototype['periodEndOverride'] = undefined; + + + + + + +export default CreateAchievement; + diff --git a/src/model/CreateApplicationAPIKey.js b/src/model/CreateApplicationAPIKey.js index 94e2c0ae..0f846c00 100644 --- a/src/model/CreateApplicationAPIKey.js +++ b/src/model/CreateApplicationAPIKey.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CreateApplicationAPIKey model module. * @module model/CreateApplicationAPIKey - * @version 5.0.1 + * @version 6.0.0 */ class CreateApplicationAPIKey { /** @@ -148,7 +148,13 @@ CreateApplicationAPIKey['PlatformEnum'] = { * value: "salesforce" * @const */ - "salesforce": "salesforce" + "salesforce": "salesforce", + + /** + * value: "emarsys" + * @const + */ + "emarsys": "emarsys" }; diff --git a/src/model/CreateManagementKey.js b/src/model/CreateManagementKey.js index 13e90d96..13dd1d4f 100644 --- a/src/model/CreateManagementKey.js +++ b/src/model/CreateManagementKey.js @@ -17,7 +17,7 @@ import Endpoint from './Endpoint'; /** * The CreateManagementKey model module. * @module model/CreateManagementKey - * @version 5.0.1 + * @version 6.0.0 */ class CreateManagementKey { /** diff --git a/src/model/CreateTemplateCampaign.js b/src/model/CreateTemplateCampaign.js index ec4629db..40522b38 100644 --- a/src/model/CreateTemplateCampaign.js +++ b/src/model/CreateTemplateCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The CreateTemplateCampaign model module. * @module model/CreateTemplateCampaign - * @version 5.0.1 + * @version 6.0.0 */ class CreateTemplateCampaign { /** @@ -80,6 +80,9 @@ class CreateTemplateCampaign { if (data.hasOwnProperty('evaluationGroupId')) { obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } } return obj; } @@ -141,6 +144,12 @@ CreateTemplateCampaign.prototype['tags'] = undefined; */ CreateTemplateCampaign.prototype['evaluationGroupId'] = undefined; +/** + * A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +CreateTemplateCampaign.prototype['linkedStoreIds'] = undefined; + diff --git a/src/model/CreateTemplateCampaignResponse.js b/src/model/CreateTemplateCampaignResponse.js index 99b7e71f..b5e9261a 100644 --- a/src/model/CreateTemplateCampaignResponse.js +++ b/src/model/CreateTemplateCampaignResponse.js @@ -19,7 +19,7 @@ import Ruleset from './Ruleset'; /** * The CreateTemplateCampaignResponse model module. * @module model/CreateTemplateCampaignResponse - * @version 5.0.1 + * @version 6.0.0 */ class CreateTemplateCampaignResponse { /** diff --git a/src/model/CustomEffect.js b/src/model/CustomEffect.js index 378536bb..3c334f4a 100644 --- a/src/model/CustomEffect.js +++ b/src/model/CustomEffect.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The CustomEffect model module. * @module model/CustomEffect - * @version 5.0.1 + * @version 6.0.0 */ class CustomEffect { /** diff --git a/src/model/CustomEffectProps.js b/src/model/CustomEffectProps.js index cfa50734..e7fe2620 100644 --- a/src/model/CustomEffectProps.js +++ b/src/model/CustomEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomEffectProps model module. * @module model/CustomEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class CustomEffectProps { /** @@ -101,7 +101,7 @@ CustomEffectProps.prototype['name'] = undefined; CustomEffectProps.prototype['cartItemPosition'] = undefined; /** - * When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. + * For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. * @member {Number} cartItemSubPosition */ CustomEffectProps.prototype['cartItemSubPosition'] = undefined; diff --git a/src/model/CustomerActivityReport.js b/src/model/CustomerActivityReport.js index cfa06afc..9e598b77 100644 --- a/src/model/CustomerActivityReport.js +++ b/src/model/CustomerActivityReport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerActivityReport model module. * @module model/CustomerActivityReport - * @version 5.0.1 + * @version 6.0.0 */ class CustomerActivityReport { /** diff --git a/src/model/CustomerAnalytics.js b/src/model/CustomerAnalytics.js index 58374ba9..bdc8b7f7 100644 --- a/src/model/CustomerAnalytics.js +++ b/src/model/CustomerAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerAnalytics model module. * @module model/CustomerAnalytics - * @version 5.0.1 + * @version 6.0.0 */ class CustomerAnalytics { /** diff --git a/src/model/CustomerInventory.js b/src/model/CustomerInventory.js index 8d671ca6..e897e7c9 100644 --- a/src/model/CustomerInventory.js +++ b/src/model/CustomerInventory.js @@ -21,7 +21,7 @@ import Loyalty from './Loyalty'; /** * The CustomerInventory model module. * @module model/CustomerInventory - * @version 5.0.1 + * @version 6.0.0 */ class CustomerInventory { /** diff --git a/src/model/CustomerProfile.js b/src/model/CustomerProfile.js index 8d1688c1..b66871af 100644 --- a/src/model/CustomerProfile.js +++ b/src/model/CustomerProfile.js @@ -18,7 +18,7 @@ import LoyaltyMembership from './LoyaltyMembership'; /** * The CustomerProfile model module. * @module model/CustomerProfile - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfile { /** @@ -32,7 +32,7 @@ class CustomerProfile { * @param accountId {Number} The ID of the Talon.One account that owns this profile. * @param closedSessions {Number} The total amount of closed sessions by a customer. A closed session is a successful purchase. * @param totalSales {Number} The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. - * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * @param lastActivity {Date} Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. */ constructor(id, created, integrationId, attributes, accountId, closedSessions, totalSales, lastActivity) { @@ -161,7 +161,7 @@ CustomerProfile.prototype['loyaltyMemberships'] = undefined; CustomerProfile.prototype['audienceMemberships'] = undefined; /** - * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. + * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. * @member {Date} lastActivity */ CustomerProfile.prototype['lastActivity'] = undefined; diff --git a/src/model/CustomerProfileAudienceRequest.js b/src/model/CustomerProfileAudienceRequest.js index 4cd23f5d..465426fe 100644 --- a/src/model/CustomerProfileAudienceRequest.js +++ b/src/model/CustomerProfileAudienceRequest.js @@ -17,7 +17,7 @@ import CustomerProfileAudienceRequestItem from './CustomerProfileAudienceRequest /** * The CustomerProfileAudienceRequest model module. * @module model/CustomerProfileAudienceRequest - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfileAudienceRequest { /** diff --git a/src/model/CustomerProfileAudienceRequestItem.js b/src/model/CustomerProfileAudienceRequestItem.js index 651e5b1f..4aa658be 100644 --- a/src/model/CustomerProfileAudienceRequestItem.js +++ b/src/model/CustomerProfileAudienceRequestItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerProfileAudienceRequestItem model module. * @module model/CustomerProfileAudienceRequestItem - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfileAudienceRequestItem { /** diff --git a/src/model/CustomerProfileIntegrationRequestV2.js b/src/model/CustomerProfileIntegrationRequestV2.js index 50059e0d..4ec576a4 100644 --- a/src/model/CustomerProfileIntegrationRequestV2.js +++ b/src/model/CustomerProfileIntegrationRequestV2.js @@ -17,7 +17,7 @@ import ProfileAudiencesChanges from './ProfileAudiencesChanges'; /** * The CustomerProfileIntegrationRequestV2 model module. * @module model/CustomerProfileIntegrationRequestV2 - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfileIntegrationRequestV2 { /** diff --git a/src/model/CustomerProfileIntegrationResponseV2.js b/src/model/CustomerProfileIntegrationResponseV2.js new file mode 100644 index 00000000..baad7533 --- /dev/null +++ b/src/model/CustomerProfileIntegrationResponseV2.js @@ -0,0 +1,152 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import Campaign from './Campaign'; +import Coupon from './Coupon'; +import CustomerProfile from './CustomerProfile'; +import Effect from './Effect'; +import Event from './Event'; +import Giveaway from './Giveaway'; +import Loyalty from './Loyalty'; +import Referral from './Referral'; +import RuleFailureReason from './RuleFailureReason'; + +/** + * The CustomerProfileIntegrationResponseV2 model module. + * @module model/CustomerProfileIntegrationResponseV2 + * @version 6.0.0 + */ +class CustomerProfileIntegrationResponseV2 { + /** + * Constructs a new CustomerProfileIntegrationResponseV2. + * This is the response type returned by the updateCustomerProfileV2 endpoint. + * @alias module:model/CustomerProfileIntegrationResponseV2 + * @param effects {Array.} The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + * @param createdCoupons {Array.} + * @param createdReferrals {Array.} + */ + constructor(effects, createdCoupons, createdReferrals) { + + CustomerProfileIntegrationResponseV2.initialize(this, effects, createdCoupons, createdReferrals); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, effects, createdCoupons, createdReferrals) { + obj['effects'] = effects; + obj['createdCoupons'] = createdCoupons; + obj['createdReferrals'] = createdReferrals; + } + + /** + * Constructs a CustomerProfileIntegrationResponseV2 from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CustomerProfileIntegrationResponseV2} obj Optional instance to populate. + * @return {module:model/CustomerProfileIntegrationResponseV2} The populated CustomerProfileIntegrationResponseV2 instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new CustomerProfileIntegrationResponseV2(); + + if (data.hasOwnProperty('customerProfile')) { + obj['customerProfile'] = CustomerProfile.constructFromObject(data['customerProfile']); + } + if (data.hasOwnProperty('event')) { + obj['event'] = Event.constructFromObject(data['event']); + } + if (data.hasOwnProperty('loyalty')) { + obj['loyalty'] = Loyalty.constructFromObject(data['loyalty']); + } + if (data.hasOwnProperty('triggeredCampaigns')) { + obj['triggeredCampaigns'] = ApiClient.convertToType(data['triggeredCampaigns'], [Campaign]); + } + if (data.hasOwnProperty('ruleFailureReasons')) { + obj['ruleFailureReasons'] = ApiClient.convertToType(data['ruleFailureReasons'], [RuleFailureReason]); + } + if (data.hasOwnProperty('awardedGiveaways')) { + obj['awardedGiveaways'] = ApiClient.convertToType(data['awardedGiveaways'], [Giveaway]); + } + if (data.hasOwnProperty('effects')) { + obj['effects'] = ApiClient.convertToType(data['effects'], [Effect]); + } + if (data.hasOwnProperty('createdCoupons')) { + obj['createdCoupons'] = ApiClient.convertToType(data['createdCoupons'], [Coupon]); + } + if (data.hasOwnProperty('createdReferrals')) { + obj['createdReferrals'] = ApiClient.convertToType(data['createdReferrals'], [Referral]); + } + } + return obj; + } + + +} + +/** + * @member {module:model/CustomerProfile} customerProfile + */ +CustomerProfileIntegrationResponseV2.prototype['customerProfile'] = undefined; + +/** + * @member {module:model/Event} event + */ +CustomerProfileIntegrationResponseV2.prototype['event'] = undefined; + +/** + * @member {module:model/Loyalty} loyalty + */ +CustomerProfileIntegrationResponseV2.prototype['loyalty'] = undefined; + +/** + * @member {Array.} triggeredCampaigns + */ +CustomerProfileIntegrationResponseV2.prototype['triggeredCampaigns'] = undefined; + +/** + * @member {Array.} ruleFailureReasons + */ +CustomerProfileIntegrationResponseV2.prototype['ruleFailureReasons'] = undefined; + +/** + * @member {Array.} awardedGiveaways + */ +CustomerProfileIntegrationResponseV2.prototype['awardedGiveaways'] = undefined; + +/** + * The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + * @member {Array.} effects + */ +CustomerProfileIntegrationResponseV2.prototype['effects'] = undefined; + +/** + * @member {Array.} createdCoupons + */ +CustomerProfileIntegrationResponseV2.prototype['createdCoupons'] = undefined; + +/** + * @member {Array.} createdReferrals + */ +CustomerProfileIntegrationResponseV2.prototype['createdReferrals'] = undefined; + + + + + + +export default CustomerProfileIntegrationResponseV2; + diff --git a/src/model/CustomerProfileSearchQuery.js b/src/model/CustomerProfileSearchQuery.js index 636860ea..26079195 100644 --- a/src/model/CustomerProfileSearchQuery.js +++ b/src/model/CustomerProfileSearchQuery.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerProfileSearchQuery model module. * @module model/CustomerProfileSearchQuery - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfileSearchQuery { /** diff --git a/src/model/CustomerProfileUpdateV2Response.js b/src/model/CustomerProfileUpdateV2Response.js index 81820e78..7b2c768d 100644 --- a/src/model/CustomerProfileUpdateV2Response.js +++ b/src/model/CustomerProfileUpdateV2Response.js @@ -17,7 +17,7 @@ import CustomerProfile from './CustomerProfile'; /** * The CustomerProfileUpdateV2Response model module. * @module model/CustomerProfileUpdateV2Response - * @version 5.0.1 + * @version 6.0.0 */ class CustomerProfileUpdateV2Response { /** diff --git a/src/model/CustomerSession.js b/src/model/CustomerSession.js index 4840b8fe..a855cc11 100644 --- a/src/model/CustomerSession.js +++ b/src/model/CustomerSession.js @@ -17,7 +17,7 @@ import CartItem from './CartItem'; /** * The CustomerSession model module. * @module model/CustomerSession - * @version 5.0.1 + * @version 6.0.0 */ class CustomerSession { /** @@ -30,7 +30,7 @@ class CustomerSession { * @param profileId {String} ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. * @param coupon {String} Any coupon code entered. * @param referral {String} Any referral code entered. - * @param state {module:model/CustomerSession.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * @param state {module:model/CustomerSession.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @param cartItems {Array.} Serialized JSON representation. * @param total {Number} The total sum of the cart in one session. * @param attributes {Object} A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. @@ -161,7 +161,7 @@ CustomerSession.prototype['coupon'] = undefined; CustomerSession.prototype['referral'] = undefined; /** - * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @member {module:model/CustomerSession.StateEnum} state * @default 'open' */ diff --git a/src/model/CustomerSessionV2.js b/src/model/CustomerSessionV2.js index 84ed3d68..4f0a19a1 100644 --- a/src/model/CustomerSessionV2.js +++ b/src/model/CustomerSessionV2.js @@ -18,7 +18,7 @@ import CartItem from './CartItem'; /** * The CustomerSessionV2 model module. * @module model/CustomerSessionV2 - * @version 5.0.1 + * @version 6.0.0 */ class CustomerSessionV2 { /** @@ -30,13 +30,13 @@ class CustomerSessionV2 { * @param integrationId {String} The integration ID set by your integration layer. * @param applicationId {Number} The ID of the application that owns this entity. * @param profileId {String} ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. - * @param state {module:model/CustomerSessionV2.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). - * @param cartItems {Array.} The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. + * @param state {module:model/CustomerSessionV2.StateEnum} Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). + * @param cartItems {Array.} The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. * @param attributes {Object} Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. * @param firstSession {Boolean} Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. - * @param total {Number} The total sum of cart-items, as well as additional costs, before any discounts applied. - * @param cartItemTotal {Number} The total sum of cart-items before any discounts applied. - * @param additionalCostTotal {Number} The total sum of additional costs before any discounts applied. + * @param total {Number} The total value of cart items and additional costs in the session, before any discounts are applied. + * @param cartItemTotal {Number} The total value of cart items, before any discounts are applied. + * @param additionalCostTotal {Number} The total value of additional costs, before any discounts are applied. * @param updated {Date} Timestamp of the most recent event received on this session. */ constructor(id, created, integrationId, applicationId, profileId, state, cartItems, attributes, firstSession, total, cartItemTotal, additionalCostTotal, updated) { @@ -91,6 +91,9 @@ class CustomerSessionV2 { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('evaluableCampaignIds')) { obj['evaluableCampaignIds'] = ApiClient.convertToType(data['evaluableCampaignIds'], ['Number']); } @@ -170,6 +173,12 @@ CustomerSessionV2.prototype['applicationId'] = undefined; */ CustomerSessionV2.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +CustomerSessionV2.prototype['storeIntegrationId'] = undefined; + /** * When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. * @member {Array.} evaluableCampaignIds @@ -195,14 +204,14 @@ CustomerSessionV2.prototype['referralCode'] = undefined; CustomerSessionV2.prototype['loyaltyCards'] = undefined; /** - * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @member {module:model/CustomerSessionV2.StateEnum} state * @default 'open' */ CustomerSessionV2.prototype['state'] = 'open'; /** - * The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. + * The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. * @member {Array.} cartItems */ CustomerSessionV2.prototype['cartItems'] = undefined; @@ -232,19 +241,19 @@ CustomerSessionV2.prototype['attributes'] = undefined; CustomerSessionV2.prototype['firstSession'] = undefined; /** - * The total sum of cart-items, as well as additional costs, before any discounts applied. + * The total value of cart items and additional costs in the session, before any discounts are applied. * @member {Number} total */ CustomerSessionV2.prototype['total'] = undefined; /** - * The total sum of cart-items before any discounts applied. + * The total value of cart items, before any discounts are applied. * @member {Number} cartItemTotal */ CustomerSessionV2.prototype['cartItemTotal'] = undefined; /** - * The total sum of additional costs before any discounts applied. + * The total value of additional costs, before any discounts are applied. * @member {Number} additionalCostTotal */ CustomerSessionV2.prototype['additionalCostTotal'] = undefined; diff --git a/src/model/DeductLoyaltyPoints.js b/src/model/DeductLoyaltyPoints.js index bf7a3210..8fbc3e53 100644 --- a/src/model/DeductLoyaltyPoints.js +++ b/src/model/DeductLoyaltyPoints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The DeductLoyaltyPoints model module. * @module model/DeductLoyaltyPoints - * @version 5.0.1 + * @version 6.0.0 */ class DeductLoyaltyPoints { /** diff --git a/src/model/DeductLoyaltyPointsEffectProps.js b/src/model/DeductLoyaltyPointsEffectProps.js index 4880e717..45893699 100644 --- a/src/model/DeductLoyaltyPointsEffectProps.js +++ b/src/model/DeductLoyaltyPointsEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The DeductLoyaltyPointsEffectProps model module. * @module model/DeductLoyaltyPointsEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class DeductLoyaltyPointsEffectProps { /** diff --git a/src/model/Effect.js b/src/model/Effect.js index 8c2532b6..88f6d462 100644 --- a/src/model/Effect.js +++ b/src/model/Effect.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Effect model module. * @module model/Effect - * @version 5.0.1 + * @version 6.0.0 */ class Effect { /** @@ -81,6 +81,9 @@ class Effect { if (data.hasOwnProperty('triggeredForCatalogItem')) { obj['triggeredForCatalogItem'] = ApiClient.convertToType(data['triggeredForCatalogItem'], 'Number'); } + if (data.hasOwnProperty('conditionIndex')) { + obj['conditionIndex'] = ApiClient.convertToType(data['conditionIndex'], 'Number'); + } if (data.hasOwnProperty('props')) { obj['props'] = ApiClient.convertToType(data['props'], Object); } @@ -133,6 +136,12 @@ Effect.prototype['triggeredByCoupon'] = undefined; */ Effect.prototype['triggeredForCatalogItem'] = undefined; +/** + * The index of the condition that was triggered. + * @member {Number} conditionIndex + */ +Effect.prototype['conditionIndex'] = undefined; + /** * The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). * @member {Object} props diff --git a/src/model/EffectEntity.js b/src/model/EffectEntity.js index 8ca473ca..993fc022 100644 --- a/src/model/EffectEntity.js +++ b/src/model/EffectEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EffectEntity model module. * @module model/EffectEntity - * @version 5.0.1 + * @version 6.0.0 */ class EffectEntity { /** @@ -79,6 +79,9 @@ class EffectEntity { if (data.hasOwnProperty('triggeredForCatalogItem')) { obj['triggeredForCatalogItem'] = ApiClient.convertToType(data['triggeredForCatalogItem'], 'Number'); } + if (data.hasOwnProperty('conditionIndex')) { + obj['conditionIndex'] = ApiClient.convertToType(data['conditionIndex'], 'Number'); + } } return obj; } @@ -128,6 +131,12 @@ EffectEntity.prototype['triggeredByCoupon'] = undefined; */ EffectEntity.prototype['triggeredForCatalogItem'] = undefined; +/** + * The index of the condition that was triggered. + * @member {Number} conditionIndex + */ +EffectEntity.prototype['conditionIndex'] = undefined; + diff --git a/src/model/EmailEntity.js b/src/model/EmailEntity.js index 9af37a85..cfd111a5 100644 --- a/src/model/EmailEntity.js +++ b/src/model/EmailEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EmailEntity model module. * @module model/EmailEntity - * @version 5.0.1 + * @version 6.0.0 */ class EmailEntity { /** diff --git a/src/model/Endpoint.js b/src/model/Endpoint.js index 4ed560b0..757d8090 100644 --- a/src/model/Endpoint.js +++ b/src/model/Endpoint.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Endpoint model module. * @module model/Endpoint - * @version 5.0.1 + * @version 6.0.0 */ class Endpoint { /** diff --git a/src/model/Entity.js b/src/model/Entity.js index ba3bb4b7..1cac82a2 100644 --- a/src/model/Entity.js +++ b/src/model/Entity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Entity model module. * @module model/Entity - * @version 5.0.1 + * @version 6.0.0 */ class Entity { /** diff --git a/src/model/EntityWithTalangVisibleID.js b/src/model/EntityWithTalangVisibleID.js index 855ee5aa..91109614 100644 --- a/src/model/EntityWithTalangVisibleID.js +++ b/src/model/EntityWithTalangVisibleID.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EntityWithTalangVisibleID model module. * @module model/EntityWithTalangVisibleID - * @version 5.0.1 + * @version 6.0.0 */ class EntityWithTalangVisibleID { /** diff --git a/src/model/Environment.js b/src/model/Environment.js index 98fbebf7..cbb786cf 100644 --- a/src/model/Environment.js +++ b/src/model/Environment.js @@ -25,7 +25,7 @@ import TemplateDef from './TemplateDef'; /** * The Environment model module. * @module model/Environment - * @version 5.0.1 + * @version 6.0.0 */ class Environment { /** diff --git a/src/model/ErrorEffectProps.js b/src/model/ErrorEffectProps.js index ada77ea7..373fe1f0 100644 --- a/src/model/ErrorEffectProps.js +++ b/src/model/ErrorEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ErrorEffectProps model module. * @module model/ErrorEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class ErrorEffectProps { /** diff --git a/src/model/ErrorResponse.js b/src/model/ErrorResponse.js index dbebda7e..5f6a2272 100644 --- a/src/model/ErrorResponse.js +++ b/src/model/ErrorResponse.js @@ -17,7 +17,7 @@ import APIError from './APIError'; /** * The ErrorResponse model module. * @module model/ErrorResponse - * @version 5.0.1 + * @version 6.0.0 */ class ErrorResponse { /** diff --git a/src/model/ErrorResponseWithStatus.js b/src/model/ErrorResponseWithStatus.js index 7b0c9230..3328ef94 100644 --- a/src/model/ErrorResponseWithStatus.js +++ b/src/model/ErrorResponseWithStatus.js @@ -17,7 +17,7 @@ import APIError from './APIError'; /** * The ErrorResponseWithStatus model module. * @module model/ErrorResponseWithStatus - * @version 5.0.1 + * @version 6.0.0 */ class ErrorResponseWithStatus { /** diff --git a/src/model/ErrorSource.js b/src/model/ErrorSource.js index 5ef22909..6190d86c 100644 --- a/src/model/ErrorSource.js +++ b/src/model/ErrorSource.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ErrorSource model module. * @module model/ErrorSource - * @version 5.0.1 + * @version 6.0.0 */ class ErrorSource { /** diff --git a/src/model/EvaluableCampaignIds.js b/src/model/EvaluableCampaignIds.js index 9486da57..267feac5 100644 --- a/src/model/EvaluableCampaignIds.js +++ b/src/model/EvaluableCampaignIds.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EvaluableCampaignIds model module. * @module model/EvaluableCampaignIds - * @version 5.0.1 + * @version 6.0.0 */ class EvaluableCampaignIds { /** diff --git a/src/model/Event.js b/src/model/Event.js index 6c852977..5ce76689 100644 --- a/src/model/Event.js +++ b/src/model/Event.js @@ -18,7 +18,7 @@ import Meta from './Meta'; /** * The Event model module. * @module model/Event - * @version 5.0.1 + * @version 6.0.0 */ class Event { /** @@ -76,6 +76,9 @@ class Event { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } @@ -125,6 +128,12 @@ Event.prototype['applicationId'] = undefined; */ Event.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +Event.prototype['storeIntegrationId'] = undefined; + /** * A string representing the event. Must not be a reserved event name. * @member {String} type diff --git a/src/model/EventType.js b/src/model/EventType.js index 891ab8aa..0eb8e262 100644 --- a/src/model/EventType.js +++ b/src/model/EventType.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EventType model module. * @module model/EventType - * @version 5.0.1 + * @version 6.0.0 */ class EventType { /** diff --git a/src/model/EventV2.js b/src/model/EventV2.js index 0718e9ce..a0b01a4d 100644 --- a/src/model/EventV2.js +++ b/src/model/EventV2.js @@ -16,14 +16,14 @@ import ApiClient from '../ApiClient'; /** * The EventV2 model module. * @module model/EventV2 - * @version 5.0.1 + * @version 6.0.0 */ class EventV2 { /** * Constructs a new EventV2. * * @alias module:model/EventV2 - * @param type {String} A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + * @param type {String} A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. */ constructor(type) { @@ -53,6 +53,9 @@ class EventV2 { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('evaluableCampaignIds')) { obj['evaluableCampaignIds'] = ApiClient.convertToType(data['evaluableCampaignIds'], ['Number']); } @@ -75,6 +78,12 @@ class EventV2 { */ EventV2.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +EventV2.prototype['storeIntegrationId'] = undefined; + /** * When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. * @member {Array.} evaluableCampaignIds @@ -82,13 +91,13 @@ EventV2.prototype['profileId'] = undefined; EventV2.prototype['evaluableCampaignIds'] = undefined; /** - * A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + * A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. * @member {String} type */ EventV2.prototype['type'] = undefined; /** - * Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). + * Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). * @member {Object} attributes */ EventV2.prototype['attributes'] = undefined; diff --git a/src/model/ExpiringPointsNotificationPolicy.js b/src/model/ExpiringPointsNotificationPolicy.js index c3e6b746..2ff00779 100644 --- a/src/model/ExpiringPointsNotificationPolicy.js +++ b/src/model/ExpiringPointsNotificationPolicy.js @@ -17,7 +17,7 @@ import ExpiringPointsNotificationTrigger from './ExpiringPointsNotificationTrigg /** * The ExpiringPointsNotificationPolicy model module. * @module model/ExpiringPointsNotificationPolicy - * @version 5.0.1 + * @version 6.0.0 */ class ExpiringPointsNotificationPolicy { /** @@ -58,6 +58,9 @@ class ExpiringPointsNotificationPolicy { if (data.hasOwnProperty('triggers')) { obj['triggers'] = ApiClient.convertToType(data['triggers'], [ExpiringPointsNotificationTrigger]); } + if (data.hasOwnProperty('batchingEnabled')) { + obj['batchingEnabled'] = ApiClient.convertToType(data['batchingEnabled'], 'Boolean'); + } } return obj; } @@ -76,6 +79,13 @@ ExpiringPointsNotificationPolicy.prototype['name'] = undefined; */ ExpiringPointsNotificationPolicy.prototype['triggers'] = undefined; +/** + * Indicates whether batching is activated. + * @member {Boolean} batchingEnabled + * @default true + */ +ExpiringPointsNotificationPolicy.prototype['batchingEnabled'] = true; + diff --git a/src/model/ExpiringPointsNotificationTrigger.js b/src/model/ExpiringPointsNotificationTrigger.js index 1303da78..37ffaa12 100644 --- a/src/model/ExpiringPointsNotificationTrigger.js +++ b/src/model/ExpiringPointsNotificationTrigger.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ExpiringPointsNotificationTrigger model module. * @module model/ExpiringPointsNotificationTrigger - * @version 5.0.1 + * @version 6.0.0 */ class ExpiringPointsNotificationTrigger { /** diff --git a/src/model/FeatureFlag.js b/src/model/FeatureFlag.js index ade63614..81ecf812 100644 --- a/src/model/FeatureFlag.js +++ b/src/model/FeatureFlag.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeatureFlag model module. * @module model/FeatureFlag - * @version 5.0.1 + * @version 6.0.0 */ class FeatureFlag { /** diff --git a/src/model/FeaturesFeed.js b/src/model/FeaturesFeed.js index ff7fb0a7..defe521d 100644 --- a/src/model/FeaturesFeed.js +++ b/src/model/FeaturesFeed.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeaturesFeed model module. * @module model/FeaturesFeed - * @version 5.0.1 + * @version 6.0.0 */ class FeaturesFeed { /** diff --git a/src/model/FuncArgDef.js b/src/model/FuncArgDef.js index 9e57f1aa..aaebcd9c 100644 --- a/src/model/FuncArgDef.js +++ b/src/model/FuncArgDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FuncArgDef model module. * @module model/FuncArgDef - * @version 5.0.1 + * @version 6.0.0 */ class FuncArgDef { /** diff --git a/src/model/FunctionDef.js b/src/model/FunctionDef.js index f6360e80..f4f439ff 100644 --- a/src/model/FunctionDef.js +++ b/src/model/FunctionDef.js @@ -17,7 +17,7 @@ import FuncArgDef from './FuncArgDef'; /** * The FunctionDef model module. * @module model/FunctionDef - * @version 5.0.1 + * @version 6.0.0 */ class FunctionDef { /** diff --git a/src/model/Giveaway.js b/src/model/Giveaway.js index 973d008c..68a40e3d 100644 --- a/src/model/Giveaway.js +++ b/src/model/Giveaway.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Giveaway model module. * @module model/Giveaway - * @version 5.0.1 + * @version 6.0.0 */ class Giveaway { /** diff --git a/src/model/GiveawaysPool.js b/src/model/GiveawaysPool.js index 7d5699f5..13d58756 100644 --- a/src/model/GiveawaysPool.js +++ b/src/model/GiveawaysPool.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The GiveawaysPool model module. * @module model/GiveawaysPool - * @version 5.0.1 + * @version 6.0.0 */ class GiveawaysPool { /** diff --git a/src/model/IdentifiableEntity.js b/src/model/IdentifiableEntity.js index 4a44aa31..f198c78b 100644 --- a/src/model/IdentifiableEntity.js +++ b/src/model/IdentifiableEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IdentifiableEntity model module. * @module model/IdentifiableEntity - * @version 5.0.1 + * @version 6.0.0 */ class IdentifiableEntity { /** diff --git a/src/model/ImportEntity.js b/src/model/ImportEntity.js index 00f200ae..216ab41a 100644 --- a/src/model/ImportEntity.js +++ b/src/model/ImportEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ImportEntity model module. * @module model/ImportEntity - * @version 5.0.1 + * @version 6.0.0 */ class ImportEntity { /** diff --git a/src/model/InlineResponse200.js b/src/model/InlineResponse200.js index cbeb67fe..5e87be7f 100644 --- a/src/model/InlineResponse200.js +++ b/src/model/InlineResponse200.js @@ -17,7 +17,7 @@ import CustomerProfile from './CustomerProfile'; /** * The InlineResponse200 model module. * @module model/InlineResponse200 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse200 { /** diff --git a/src/model/InlineResponse2001.js b/src/model/InlineResponse2001.js index 890a0d20..4b641e8c 100644 --- a/src/model/InlineResponse2001.js +++ b/src/model/InlineResponse2001.js @@ -17,7 +17,7 @@ import CardLedgerTransactionLogEntryIntegrationAPI from './CardLedgerTransaction /** * The InlineResponse2001 model module. * @module model/InlineResponse2001 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2001 { /** diff --git a/src/model/InlineResponse20010.js b/src/model/InlineResponse20010.js index 7552cd78..0210d83c 100644 --- a/src/model/InlineResponse20010.js +++ b/src/model/InlineResponse20010.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import CampaignTemplate from './CampaignTemplate'; +import Referral from './Referral'; /** * The InlineResponse20010 model module. * @module model/InlineResponse20010 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20010 { /** * Constructs a new InlineResponse20010. * @alias module:model/InlineResponse20010 * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ constructor(hasMore, data) { @@ -56,7 +56,7 @@ class InlineResponse20010 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CampaignTemplate]); + obj['data'] = ApiClient.convertToType(data['data'], [Referral]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20010 { InlineResponse20010.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20010.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20011.js b/src/model/InlineResponse20011.js index f36ad7b4..14dab005 100644 --- a/src/model/InlineResponse20011.js +++ b/src/model/InlineResponse20011.js @@ -12,23 +12,23 @@ */ import ApiClient from '../ApiClient'; -import LoyaltyProgram from './LoyaltyProgram'; +import CampaignTemplate from './CampaignTemplate'; /** * The InlineResponse20011 model module. * @module model/InlineResponse20011 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20011 { /** * Constructs a new InlineResponse20011. * @alias module:model/InlineResponse20011 - * @param totalResultSize {Number} - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(hasMore, data) { - InlineResponse20011.initialize(this, totalResultSize, data); + InlineResponse20011.initialize(this, hasMore, data); } /** @@ -36,8 +36,8 @@ class InlineResponse20011 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -52,11 +52,11 @@ class InlineResponse20011 { if (data) { obj = obj || new InlineResponse20011(); - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyProgram]); + obj['data'] = ApiClient.convertToType(data['data'], [CampaignTemplate]); } } return obj; @@ -66,12 +66,12 @@ class InlineResponse20011 { } /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse20011.prototype['totalResultSize'] = undefined; +InlineResponse20011.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20011.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20012.js b/src/model/InlineResponse20012.js index 2ea66632..48acacf3 100644 --- a/src/model/InlineResponse20012.js +++ b/src/model/InlineResponse20012.js @@ -12,23 +12,23 @@ */ import ApiClient from '../ApiClient'; -import LoyaltyProgramTransaction from './LoyaltyProgramTransaction'; +import LoyaltyProgram from './LoyaltyProgram'; /** * The InlineResponse20012 model module. * @module model/InlineResponse20012 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20012 { /** * Constructs a new InlineResponse20012. * @alias module:model/InlineResponse20012 - * @param hasMore {Boolean} - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(hasMore, data) { + constructor(totalResultSize, data) { - InlineResponse20012.initialize(this, hasMore, data); + InlineResponse20012.initialize(this, totalResultSize, data); } /** @@ -36,8 +36,8 @@ class InlineResponse20012 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -52,11 +52,11 @@ class InlineResponse20012 { if (data) { obj = obj || new InlineResponse20012(); - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyProgramTransaction]); + obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyProgram]); } } return obj; @@ -66,12 +66,12 @@ class InlineResponse20012 { } /** - * @member {Boolean} hasMore + * @member {Number} totalResultSize */ -InlineResponse20012.prototype['hasMore'] = undefined; +InlineResponse20012.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20012.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20013.js b/src/model/InlineResponse20013.js index e8cf73b4..bdec9e8a 100644 --- a/src/model/InlineResponse20013.js +++ b/src/model/InlineResponse20013.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import LoyaltyCard from './LoyaltyCard'; +import LoyaltyProgramTransaction from './LoyaltyProgramTransaction'; /** * The InlineResponse20013 model module. * @module model/InlineResponse20013 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20013 { /** * Constructs a new InlineResponse20013. * @alias module:model/InlineResponse20013 * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ constructor(hasMore, data) { @@ -56,7 +56,7 @@ class InlineResponse20013 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyCard]); + obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyProgramTransaction]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20013 { InlineResponse20013.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20013.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20014.js b/src/model/InlineResponse20014.js index 4b5d39f0..482e966e 100644 --- a/src/model/InlineResponse20014.js +++ b/src/model/InlineResponse20014.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import CardLedgerTransactionLogEntry from './CardLedgerTransactionLogEntry'; +import LoyaltyCard from './LoyaltyCard'; /** * The InlineResponse20014 model module. * @module model/InlineResponse20014 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20014 { /** * Constructs a new InlineResponse20014. * @alias module:model/InlineResponse20014 - * @param hasMore {Boolean} true means there is more data in the source collection to request.. - * @param data {Array.} List of loyalty card transaction logs. + * @param hasMore {Boolean} + * @param data {Array.} */ constructor(hasMore, data) { @@ -56,7 +56,7 @@ class InlineResponse20014 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CardLedgerTransactionLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [LoyaltyCard]); } } return obj; @@ -66,14 +66,12 @@ class InlineResponse20014 { } /** - * true means there is more data in the source collection to request.. * @member {Boolean} hasMore */ InlineResponse20014.prototype['hasMore'] = undefined; /** - * List of loyalty card transaction logs. - * @member {Array.} data + * @member {Array.} data */ InlineResponse20014.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20015.js b/src/model/InlineResponse20015.js index 77dd7409..30e8a89d 100644 --- a/src/model/InlineResponse20015.js +++ b/src/model/InlineResponse20015.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import CollectionWithoutPayload from './CollectionWithoutPayload'; +import CardLedgerTransactionLogEntry from './CardLedgerTransactionLogEntry'; /** * The InlineResponse20015 model module. * @module model/InlineResponse20015 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20015 { /** * Constructs a new InlineResponse20015. * @alias module:model/InlineResponse20015 - * @param data {Array.} + * @param hasMore {Boolean} true means there is more data in the source collection to request.. + * @param data {Array.} List of loyalty card transaction logs. */ - constructor(data) { + constructor(hasMore, data) { - InlineResponse20015.initialize(this, data); + InlineResponse20015.initialize(this, hasMore, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20015 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -53,11 +55,8 @@ class InlineResponse20015 { if (data.hasOwnProperty('hasMore')) { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); - } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CollectionWithoutPayload]); + obj['data'] = ApiClient.convertToType(data['data'], [CardLedgerTransactionLogEntry]); } } return obj; @@ -67,17 +66,14 @@ class InlineResponse20015 { } /** + * true means there is more data in the source collection to request.. * @member {Boolean} hasMore */ InlineResponse20015.prototype['hasMore'] = undefined; /** - * @member {Number} totalResultSize - */ -InlineResponse20015.prototype['totalResultSize'] = undefined; - -/** - * @member {Array.} data + * List of loyalty card transaction logs. + * @member {Array.} data */ InlineResponse20015.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20016.js b/src/model/InlineResponse20016.js index 1e24c269..46e52175 100644 --- a/src/model/InlineResponse20016.js +++ b/src/model/InlineResponse20016.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import CollectionItem from './CollectionItem'; +import CollectionWithoutPayload from './CollectionWithoutPayload'; /** * The InlineResponse20016 model module. * @module model/InlineResponse20016 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20016 { /** * Constructs a new InlineResponse20016. * @alias module:model/InlineResponse20016 - * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ - constructor(hasMore, data) { + constructor(data) { - InlineResponse20016.initialize(this, hasMore, data); + InlineResponse20016.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20016 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, data) { obj['data'] = data; } @@ -55,8 +53,11 @@ class InlineResponse20016 { if (data.hasOwnProperty('hasMore')) { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CollectionItem]); + obj['data'] = ApiClient.convertToType(data['data'], [CollectionWithoutPayload]); } } return obj; @@ -71,7 +72,12 @@ class InlineResponse20016 { InlineResponse20016.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Number} totalResultSize + */ +InlineResponse20016.prototype['totalResultSize'] = undefined; + +/** + * @member {Array.} data */ InlineResponse20016.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20017.js b/src/model/InlineResponse20017.js index 859ef8f6..a2bdff14 100644 --- a/src/model/InlineResponse20017.js +++ b/src/model/InlineResponse20017.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import Collection from './Collection'; +import CollectionItem from './CollectionItem'; /** * The InlineResponse20017 model module. * @module model/InlineResponse20017 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20017 { /** * Constructs a new InlineResponse20017. * @alias module:model/InlineResponse20017 - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(data) { + constructor(hasMore, data) { - InlineResponse20017.initialize(this, data); + InlineResponse20017.initialize(this, hasMore, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20017 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -53,11 +55,8 @@ class InlineResponse20017 { if (data.hasOwnProperty('hasMore')) { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); - } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Collection]); + obj['data'] = ApiClient.convertToType(data['data'], [CollectionItem]); } } return obj; @@ -72,12 +71,7 @@ class InlineResponse20017 { InlineResponse20017.prototype['hasMore'] = undefined; /** - * @member {Number} totalResultSize - */ -InlineResponse20017.prototype['totalResultSize'] = undefined; - -/** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20017.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20018.js b/src/model/InlineResponse20018.js index 00fa8e24..03765d7b 100644 --- a/src/model/InlineResponse20018.js +++ b/src/model/InlineResponse20018.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import AccessLogEntry from './AccessLogEntry'; +import Collection from './Collection'; /** * The InlineResponse20018 model module. * @module model/InlineResponse20018 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20018 { /** * Constructs a new InlineResponse20018. * @alias module:model/InlineResponse20018 - * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ - constructor(hasMore, data) { + constructor(data) { - InlineResponse20018.initialize(this, hasMore, data); + InlineResponse20018.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20018 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, data) { obj['data'] = data; } @@ -55,8 +53,11 @@ class InlineResponse20018 { if (data.hasOwnProperty('hasMore')) { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [AccessLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [Collection]); } } return obj; @@ -71,7 +72,12 @@ class InlineResponse20018 { InlineResponse20018.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Number} totalResultSize + */ +InlineResponse20018.prototype['totalResultSize'] = undefined; + +/** + * @member {Array.} data */ InlineResponse20018.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20019.js b/src/model/InlineResponse20019.js index e7d29c1e..197a2726 100644 --- a/src/model/InlineResponse20019.js +++ b/src/model/InlineResponse20019.js @@ -17,18 +17,18 @@ import AccessLogEntry from './AccessLogEntry'; /** * The InlineResponse20019 model module. * @module model/InlineResponse20019 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20019 { /** * Constructs a new InlineResponse20019. * @alias module:model/InlineResponse20019 - * @param totalResultSize {Number} + * @param hasMore {Boolean} * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(hasMore, data) { - InlineResponse20019.initialize(this, totalResultSize, data); + InlineResponse20019.initialize(this, hasMore, data); } /** @@ -36,8 +36,8 @@ class InlineResponse20019 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -52,8 +52,8 @@ class InlineResponse20019 { if (data) { obj = obj || new InlineResponse20019(); - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { obj['data'] = ApiClient.convertToType(data['data'], [AccessLogEntry]); @@ -66,9 +66,9 @@ class InlineResponse20019 { } /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse20019.prototype['totalResultSize'] = undefined; +InlineResponse20019.prototype['hasMore'] = undefined; /** * @member {Array.} data diff --git a/src/model/InlineResponse2002.js b/src/model/InlineResponse2002.js index 9f072bc4..8c551838 100644 --- a/src/model/InlineResponse2002.js +++ b/src/model/InlineResponse2002.js @@ -17,7 +17,7 @@ import LedgerTransactionLogEntryIntegrationAPI from './LedgerTransactionLogEntry /** * The InlineResponse2002 model module. * @module model/InlineResponse2002 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2002 { /** diff --git a/src/model/InlineResponse20020.js b/src/model/InlineResponse20020.js index d50e2f0a..a4837f8e 100644 --- a/src/model/InlineResponse20020.js +++ b/src/model/InlineResponse20020.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import CampaignAnalytics from './CampaignAnalytics'; +import AccessLogEntry from './AccessLogEntry'; /** * The InlineResponse20020 model module. * @module model/InlineResponse20020 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20020 { /** * Constructs a new InlineResponse20020. * @alias module:model/InlineResponse20020 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20020 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CampaignAnalytics]); + obj['data'] = ApiClient.convertToType(data['data'], [AccessLogEntry]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20020 { InlineResponse20020.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20020.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20021.js b/src/model/InlineResponse20021.js index cf859a7a..76d16f36 100644 --- a/src/model/InlineResponse20021.js +++ b/src/model/InlineResponse20021.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import ApplicationCustomer from './ApplicationCustomer'; +import CampaignAnalytics from './CampaignAnalytics'; /** * The InlineResponse20021 model module. * @module model/InlineResponse20021 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20021 { /** * Constructs a new InlineResponse20021. * @alias module:model/InlineResponse20021 - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(data) { + constructor(totalResultSize, data) { - InlineResponse20021.initialize(this, data); + InlineResponse20021.initialize(this, totalResultSize, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20021 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -53,11 +55,8 @@ class InlineResponse20021 { if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ApplicationCustomer]); + obj['data'] = ApiClient.convertToType(data['data'], [CampaignAnalytics]); } } return obj; @@ -72,12 +71,7 @@ class InlineResponse20021 { InlineResponse20021.prototype['totalResultSize'] = undefined; /** - * @member {Boolean} hasMore - */ -InlineResponse20021.prototype['hasMore'] = undefined; - -/** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20021.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20022.js b/src/model/InlineResponse20022.js index d09f1e04..27db8b86 100644 --- a/src/model/InlineResponse20022.js +++ b/src/model/InlineResponse20022.js @@ -17,7 +17,7 @@ import ApplicationCustomer from './ApplicationCustomer'; /** * The InlineResponse20022 model module. * @module model/InlineResponse20022 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20022 { /** @@ -50,12 +50,12 @@ class InlineResponse20022 { if (data) { obj = obj || new InlineResponse20022(); - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } if (data.hasOwnProperty('data')) { obj['data'] = ApiClient.convertToType(data['data'], [ApplicationCustomer]); } @@ -67,14 +67,14 @@ class InlineResponse20022 { } /** - * @member {Boolean} hasMore + * @member {Number} totalResultSize */ -InlineResponse20022.prototype['hasMore'] = undefined; +InlineResponse20022.prototype['totalResultSize'] = undefined; /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse20022.prototype['totalResultSize'] = undefined; +InlineResponse20022.prototype['hasMore'] = undefined; /** * @member {Array.} data diff --git a/src/model/InlineResponse20023.js b/src/model/InlineResponse20023.js index d3c96bf2..b353a3ef 100644 --- a/src/model/InlineResponse20023.js +++ b/src/model/InlineResponse20023.js @@ -12,18 +12,18 @@ */ import ApiClient from '../ApiClient'; -import CustomerProfile from './CustomerProfile'; +import ApplicationCustomer from './ApplicationCustomer'; /** * The InlineResponse20023 model module. * @module model/InlineResponse20023 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20023 { /** * Constructs a new InlineResponse20023. * @alias module:model/InlineResponse20023 - * @param data {Array.} + * @param data {Array.} */ constructor(data) { @@ -57,7 +57,7 @@ class InlineResponse20023 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CustomerProfile]); + obj['data'] = ApiClient.convertToType(data['data'], [ApplicationCustomer]); } } return obj; @@ -77,7 +77,7 @@ InlineResponse20023.prototype['hasMore'] = undefined; InlineResponse20023.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20023.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20024.js b/src/model/InlineResponse20024.js index 15ddf710..b865da2d 100644 --- a/src/model/InlineResponse20024.js +++ b/src/model/InlineResponse20024.js @@ -17,18 +17,17 @@ import CustomerProfile from './CustomerProfile'; /** * The InlineResponse20024 model module. * @module model/InlineResponse20024 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20024 { /** * Constructs a new InlineResponse20024. * @alias module:model/InlineResponse20024 - * @param hasMore {Boolean} * @param data {Array.} */ - constructor(hasMore, data) { + constructor(data) { - InlineResponse20024.initialize(this, hasMore, data); + InlineResponse20024.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20024 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, data) { obj['data'] = data; } @@ -55,6 +53,9 @@ class InlineResponse20024 { if (data.hasOwnProperty('hasMore')) { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + } if (data.hasOwnProperty('data')) { obj['data'] = ApiClient.convertToType(data['data'], [CustomerProfile]); } @@ -70,6 +71,11 @@ class InlineResponse20024 { */ InlineResponse20024.prototype['hasMore'] = undefined; +/** + * @member {Number} totalResultSize + */ +InlineResponse20024.prototype['totalResultSize'] = undefined; + /** * @member {Array.} data */ diff --git a/src/model/InlineResponse20025.js b/src/model/InlineResponse20025.js index 5b451e3b..46345aa5 100644 --- a/src/model/InlineResponse20025.js +++ b/src/model/InlineResponse20025.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import CustomerActivityReport from './CustomerActivityReport'; +import CustomerProfile from './CustomerProfile'; /** * The InlineResponse20025 model module. * @module model/InlineResponse20025 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20025 { /** * Constructs a new InlineResponse20025. * @alias module:model/InlineResponse20025 * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ constructor(hasMore, data) { @@ -56,7 +56,7 @@ class InlineResponse20025 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CustomerActivityReport]); + obj['data'] = ApiClient.convertToType(data['data'], [CustomerProfile]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20025 { InlineResponse20025.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20025.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20026.js b/src/model/InlineResponse20026.js index 16b70eb0..6d3f7215 100644 --- a/src/model/InlineResponse20026.js +++ b/src/model/InlineResponse20026.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import ApplicationSession from './ApplicationSession'; +import CustomerActivityReport from './CustomerActivityReport'; /** * The InlineResponse20026 model module. * @module model/InlineResponse20026 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20026 { /** * Constructs a new InlineResponse20026. * @alias module:model/InlineResponse20026 - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(data) { + constructor(hasMore, data) { - InlineResponse20026.initialize(this, data); + InlineResponse20026.initialize(this, hasMore, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20026 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -54,7 +56,7 @@ class InlineResponse20026 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ApplicationSession]); + obj['data'] = ApiClient.convertToType(data['data'], [CustomerActivityReport]); } } return obj; @@ -69,7 +71,7 @@ class InlineResponse20026 { InlineResponse20026.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20026.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20027.js b/src/model/InlineResponse20027.js index 93d83137..7f60c8ed 100644 --- a/src/model/InlineResponse20027.js +++ b/src/model/InlineResponse20027.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import ApplicationEvent from './ApplicationEvent'; +import ApplicationSession from './ApplicationSession'; /** * The InlineResponse20027 model module. * @module model/InlineResponse20027 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20027 { /** * Constructs a new InlineResponse20027. * @alias module:model/InlineResponse20027 - * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ - constructor(hasMore, data) { + constructor(data) { - InlineResponse20027.initialize(this, hasMore, data); + InlineResponse20027.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20027 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, data) { obj['data'] = data; } @@ -56,7 +54,7 @@ class InlineResponse20027 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ApplicationEvent]); + obj['data'] = ApiClient.convertToType(data['data'], [ApplicationSession]); } } return obj; @@ -71,7 +69,7 @@ class InlineResponse20027 { InlineResponse20027.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20027.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20028.js b/src/model/InlineResponse20028.js index 3c4d4aa8..374f86ee 100644 --- a/src/model/InlineResponse20028.js +++ b/src/model/InlineResponse20028.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; +import ApplicationEvent from './ApplicationEvent'; /** * The InlineResponse20028 model module. * @module model/InlineResponse20028 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20028 { /** * Constructs a new InlineResponse20028. * @alias module:model/InlineResponse20028 - * @param totalResultSize {Number} - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(hasMore, data) { - InlineResponse20028.initialize(this, totalResultSize, data); + InlineResponse20028.initialize(this, hasMore, data); } /** @@ -35,8 +36,8 @@ class InlineResponse20028 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -51,11 +52,11 @@ class InlineResponse20028 { if (data) { obj = obj || new InlineResponse20028(); - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], ['String']); + obj['data'] = ApiClient.convertToType(data['data'], [ApplicationEvent]); } } return obj; @@ -65,12 +66,12 @@ class InlineResponse20028 { } /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse20028.prototype['totalResultSize'] = undefined; +InlineResponse20028.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20028.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20029.js b/src/model/InlineResponse20029.js index 5d057de3..fbea9412 100644 --- a/src/model/InlineResponse20029.js +++ b/src/model/InlineResponse20029.js @@ -12,22 +12,22 @@ */ import ApiClient from '../ApiClient'; -import Audience from './Audience'; /** * The InlineResponse20029 model module. * @module model/InlineResponse20029 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20029 { /** * Constructs a new InlineResponse20029. * @alias module:model/InlineResponse20029 - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(data) { + constructor(totalResultSize, data) { - InlineResponse20029.initialize(this, data); + InlineResponse20029.initialize(this, totalResultSize, data); } /** @@ -35,7 +35,8 @@ class InlineResponse20029 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -50,14 +51,11 @@ class InlineResponse20029 { if (data) { obj = obj || new InlineResponse20029(); - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Audience]); + obj['data'] = ApiClient.convertToType(data['data'], ['String']); } } return obj; @@ -66,18 +64,13 @@ class InlineResponse20029 { } -/** - * @member {Boolean} hasMore - */ -InlineResponse20029.prototype['hasMore'] = undefined; - /** * @member {Number} totalResultSize */ InlineResponse20029.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20029.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2003.js b/src/model/InlineResponse2003.js index c4a51699..1ce9624a 100644 --- a/src/model/InlineResponse2003.js +++ b/src/model/InlineResponse2003.js @@ -12,23 +12,23 @@ */ import ApiClient from '../ApiClient'; -import Application from './Application'; +import CardLedgerPointsEntryIntegrationAPI from './CardLedgerPointsEntryIntegrationAPI'; /** * The InlineResponse2003 model module. * @module model/InlineResponse2003 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2003 { /** * Constructs a new InlineResponse2003. * @alias module:model/InlineResponse2003 - * @param totalResultSize {Number} - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(hasMore, data) { - InlineResponse2003.initialize(this, totalResultSize, data); + InlineResponse2003.initialize(this, hasMore, data); } /** @@ -36,8 +36,8 @@ class InlineResponse2003 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -52,11 +52,11 @@ class InlineResponse2003 { if (data) { obj = obj || new InlineResponse2003(); - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Application]); + obj['data'] = ApiClient.convertToType(data['data'], [CardLedgerPointsEntryIntegrationAPI]); } } return obj; @@ -66,12 +66,12 @@ class InlineResponse2003 { } /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse2003.prototype['totalResultSize'] = undefined; +InlineResponse2003.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2003.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20030.js b/src/model/InlineResponse20030.js index 522a3034..73f4c926 100644 --- a/src/model/InlineResponse20030.js +++ b/src/model/InlineResponse20030.js @@ -12,18 +12,18 @@ */ import ApiClient from '../ApiClient'; -import ApplicationReferee from './ApplicationReferee'; +import Audience from './Audience'; /** * The InlineResponse20030 model module. * @module model/InlineResponse20030 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20030 { /** * Constructs a new InlineResponse20030. * @alias module:model/InlineResponse20030 - * @param data {Array.} + * @param data {Array.} */ constructor(data) { @@ -57,7 +57,7 @@ class InlineResponse20030 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ApplicationReferee]); + obj['data'] = ApiClient.convertToType(data['data'], [Audience]); } } return obj; @@ -77,7 +77,7 @@ InlineResponse20030.prototype['hasMore'] = undefined; InlineResponse20030.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20030.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20031.js b/src/model/InlineResponse20031.js index c2a7ff4a..f415f844 100644 --- a/src/model/InlineResponse20031.js +++ b/src/model/InlineResponse20031.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import Attribute from './Attribute'; +import ApplicationReferee from './ApplicationReferee'; /** * The InlineResponse20031 model module. * @module model/InlineResponse20031 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20031 { /** * Constructs a new InlineResponse20031. * @alias module:model/InlineResponse20031 - * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(data) { - InlineResponse20031.initialize(this, totalResultSize, data); + InlineResponse20031.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20031 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, data) { obj['data'] = data; } @@ -52,11 +50,14 @@ class InlineResponse20031 { if (data) { obj = obj || new InlineResponse20031(); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Attribute]); + obj['data'] = ApiClient.convertToType(data['data'], [ApplicationReferee]); } } return obj; @@ -65,13 +66,18 @@ class InlineResponse20031 { } +/** + * @member {Boolean} hasMore + */ +InlineResponse20031.prototype['hasMore'] = undefined; + /** * @member {Number} totalResultSize */ InlineResponse20031.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20031.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20032.js b/src/model/InlineResponse20032.js index 867bbb47..855691d5 100644 --- a/src/model/InlineResponse20032.js +++ b/src/model/InlineResponse20032.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import CatalogItem from './CatalogItem'; +import Attribute from './Attribute'; /** * The InlineResponse20032 model module. * @module model/InlineResponse20032 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20032 { /** * Constructs a new InlineResponse20032. * @alias module:model/InlineResponse20032 - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(data) { + constructor(totalResultSize, data) { - InlineResponse20032.initialize(this, data); + InlineResponse20032.initialize(this, totalResultSize, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20032 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -50,14 +52,11 @@ class InlineResponse20032 { if (data) { obj = obj || new InlineResponse20032(); - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [CatalogItem]); + obj['data'] = ApiClient.convertToType(data['data'], [Attribute]); } } return obj; @@ -66,18 +65,13 @@ class InlineResponse20032 { } -/** - * @member {Boolean} hasMore - */ -InlineResponse20032.prototype['hasMore'] = undefined; - /** * @member {Number} totalResultSize */ InlineResponse20032.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20032.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20033.js b/src/model/InlineResponse20033.js index 9d14d04d..c9d515c1 100644 --- a/src/model/InlineResponse20033.js +++ b/src/model/InlineResponse20033.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import AccountAdditionalCost from './AccountAdditionalCost'; +import CatalogItem from './CatalogItem'; /** * The InlineResponse20033 model module. * @module model/InlineResponse20033 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20033 { /** * Constructs a new InlineResponse20033. * @alias module:model/InlineResponse20033 - * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(data) { - InlineResponse20033.initialize(this, totalResultSize, data); + InlineResponse20033.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20033 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, data) { obj['data'] = data; } @@ -52,11 +50,14 @@ class InlineResponse20033 { if (data) { obj = obj || new InlineResponse20033(); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [AccountAdditionalCost]); + obj['data'] = ApiClient.convertToType(data['data'], [CatalogItem]); } } return obj; @@ -65,13 +66,18 @@ class InlineResponse20033 { } +/** + * @member {Boolean} hasMore + */ +InlineResponse20033.prototype['hasMore'] = undefined; + /** * @member {Number} totalResultSize */ InlineResponse20033.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20033.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20034.js b/src/model/InlineResponse20034.js index 0d08c02c..58143cb1 100644 --- a/src/model/InlineResponse20034.js +++ b/src/model/InlineResponse20034.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import WebhookWithOutgoingIntegrationDetails from './WebhookWithOutgoingIntegrationDetails'; +import AccountAdditionalCost from './AccountAdditionalCost'; /** * The InlineResponse20034 model module. * @module model/InlineResponse20034 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20034 { /** * Constructs a new InlineResponse20034. * @alias module:model/InlineResponse20034 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20034 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [WebhookWithOutgoingIntegrationDetails]); + obj['data'] = ApiClient.convertToType(data['data'], [AccountAdditionalCost]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20034 { InlineResponse20034.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20034.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20035.js b/src/model/InlineResponse20035.js index 3480ff05..0f3dcc13 100644 --- a/src/model/InlineResponse20035.js +++ b/src/model/InlineResponse20035.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import WebhookActivationLogEntry from './WebhookActivationLogEntry'; +import WebhookWithOutgoingIntegrationDetails from './WebhookWithOutgoingIntegrationDetails'; /** * The InlineResponse20035 model module. * @module model/InlineResponse20035 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20035 { /** * Constructs a new InlineResponse20035. * @alias module:model/InlineResponse20035 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20035 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [WebhookActivationLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [WebhookWithOutgoingIntegrationDetails]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20035 { InlineResponse20035.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20035.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20036.js b/src/model/InlineResponse20036.js index af23105f..49512589 100644 --- a/src/model/InlineResponse20036.js +++ b/src/model/InlineResponse20036.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import WebhookLogEntry from './WebhookLogEntry'; +import WebhookActivationLogEntry from './WebhookActivationLogEntry'; /** * The InlineResponse20036 model module. * @module model/InlineResponse20036 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20036 { /** * Constructs a new InlineResponse20036. * @alias module:model/InlineResponse20036 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20036 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [WebhookLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [WebhookActivationLogEntry]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20036 { InlineResponse20036.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20036.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20037.js b/src/model/InlineResponse20037.js index b550fe5e..4252af90 100644 --- a/src/model/InlineResponse20037.js +++ b/src/model/InlineResponse20037.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import EventType from './EventType'; +import WebhookLogEntry from './WebhookLogEntry'; /** * The InlineResponse20037 model module. * @module model/InlineResponse20037 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20037 { /** * Constructs a new InlineResponse20037. * @alias module:model/InlineResponse20037 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20037 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [EventType]); + obj['data'] = ApiClient.convertToType(data['data'], [WebhookLogEntry]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20037 { InlineResponse20037.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20037.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20038.js b/src/model/InlineResponse20038.js index 85574e3c..6c860350 100644 --- a/src/model/InlineResponse20038.js +++ b/src/model/InlineResponse20038.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import User from './User'; +import EventType from './EventType'; /** * The InlineResponse20038 model module. * @module model/InlineResponse20038 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20038 { /** * Constructs a new InlineResponse20038. * @alias module:model/InlineResponse20038 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20038 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [User]); + obj['data'] = ApiClient.convertToType(data['data'], [EventType]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20038 { InlineResponse20038.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20038.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20039.js b/src/model/InlineResponse20039.js index 2ae1286d..15267f47 100644 --- a/src/model/InlineResponse20039.js +++ b/src/model/InlineResponse20039.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import Change from './Change'; +import User from './User'; /** * The InlineResponse20039 model module. * @module model/InlineResponse20039 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20039 { /** * Constructs a new InlineResponse20039. * @alias module:model/InlineResponse20039 - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(data) { + constructor(totalResultSize, data) { - InlineResponse20039.initialize(this, data); + InlineResponse20039.initialize(this, totalResultSize, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20039 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, data) { + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -53,11 +55,8 @@ class InlineResponse20039 { if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Change]); + obj['data'] = ApiClient.convertToType(data['data'], [User]); } } return obj; @@ -72,12 +71,7 @@ class InlineResponse20039 { InlineResponse20039.prototype['totalResultSize'] = undefined; /** - * @member {Boolean} hasMore - */ -InlineResponse20039.prototype['hasMore'] = undefined; - -/** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20039.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2004.js b/src/model/InlineResponse2004.js index a74f6af3..7258cc8d 100644 --- a/src/model/InlineResponse2004.js +++ b/src/model/InlineResponse2004.js @@ -12,23 +12,23 @@ */ import ApiClient from '../ApiClient'; -import Campaign from './Campaign'; +import LedgerPointsEntryIntegrationAPI from './LedgerPointsEntryIntegrationAPI'; /** * The InlineResponse2004 model module. * @module model/InlineResponse2004 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2004 { /** * Constructs a new InlineResponse2004. * @alias module:model/InlineResponse2004 - * @param totalResultSize {Number} - * @param data {Array.} + * @param hasMore {Boolean} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(hasMore, data) { - InlineResponse2004.initialize(this, totalResultSize, data); + InlineResponse2004.initialize(this, hasMore, data); } /** @@ -36,8 +36,8 @@ class InlineResponse2004 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, hasMore, data) { + obj['hasMore'] = hasMore; obj['data'] = data; } @@ -52,11 +52,11 @@ class InlineResponse2004 { if (data) { obj = obj || new InlineResponse2004(); - if (data.hasOwnProperty('totalResultSize')) { - obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Campaign]); + obj['data'] = ApiClient.convertToType(data['data'], [LedgerPointsEntryIntegrationAPI]); } } return obj; @@ -66,12 +66,12 @@ class InlineResponse2004 { } /** - * @member {Number} totalResultSize + * @member {Boolean} hasMore */ -InlineResponse2004.prototype['totalResultSize'] = undefined; +InlineResponse2004.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2004.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20040.js b/src/model/InlineResponse20040.js index fd2c4ec2..3bcf4d73 100644 --- a/src/model/InlineResponse20040.js +++ b/src/model/InlineResponse20040.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import ModelExport from './ModelExport'; +import Change from './Change'; /** * The InlineResponse20040 model module. * @module model/InlineResponse20040 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20040 { /** * Constructs a new InlineResponse20040. * @alias module:model/InlineResponse20040 - * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(data) { - InlineResponse20040.initialize(this, totalResultSize, data); + InlineResponse20040.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20040 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, data) { obj['data'] = data; } @@ -55,8 +53,11 @@ class InlineResponse20040 { if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ModelExport]); + obj['data'] = ApiClient.convertToType(data['data'], [Change]); } } return obj; @@ -71,7 +72,12 @@ class InlineResponse20040 { InlineResponse20040.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Boolean} hasMore + */ +InlineResponse20040.prototype['hasMore'] = undefined; + +/** + * @member {Array.} data */ InlineResponse20040.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20041.js b/src/model/InlineResponse20041.js index df277932..bf11ee96 100644 --- a/src/model/InlineResponse20041.js +++ b/src/model/InlineResponse20041.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Role from './Role'; +import ModelExport from './ModelExport'; /** * The InlineResponse20041 model module. * @module model/InlineResponse20041 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse20041 { /** * Constructs a new InlineResponse20041. * @alias module:model/InlineResponse20041 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20041 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Role]); + obj['data'] = ApiClient.convertToType(data['data'], [ModelExport]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20041 { InlineResponse20041.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20041.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20042.js b/src/model/InlineResponse20042.js new file mode 100644 index 00000000..c293b8e2 --- /dev/null +++ b/src/model/InlineResponse20042.js @@ -0,0 +1,84 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import Role from './Role'; + +/** + * The InlineResponse20042 model module. + * @module model/InlineResponse20042 + * @version 6.0.0 + */ +class InlineResponse20042 { + /** + * Constructs a new InlineResponse20042. + * @alias module:model/InlineResponse20042 + * @param totalResultSize {Number} + * @param data {Array.} + */ + constructor(totalResultSize, data) { + + InlineResponse20042.initialize(this, totalResultSize, data); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; + obj['data'] = data; + } + + /** + * Constructs a InlineResponse20042 from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/InlineResponse20042} obj Optional instance to populate. + * @return {module:model/InlineResponse20042} The populated InlineResponse20042 instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new InlineResponse20042(); + + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + } + if (data.hasOwnProperty('data')) { + obj['data'] = ApiClient.convertToType(data['data'], [Role]); + } + } + return obj; + } + + +} + +/** + * @member {Number} totalResultSize + */ +InlineResponse20042.prototype['totalResultSize'] = undefined; + +/** + * @member {Array.} data + */ +InlineResponse20042.prototype['data'] = undefined; + + + + + + +export default InlineResponse20042; + diff --git a/src/model/InlineResponse20043.js b/src/model/InlineResponse20043.js new file mode 100644 index 00000000..177b8ecb --- /dev/null +++ b/src/model/InlineResponse20043.js @@ -0,0 +1,90 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import Store from './Store'; + +/** + * The InlineResponse20043 model module. + * @module model/InlineResponse20043 + * @version 6.0.0 + */ +class InlineResponse20043 { + /** + * Constructs a new InlineResponse20043. + * @alias module:model/InlineResponse20043 + * @param data {Array.} + */ + constructor(data) { + + InlineResponse20043.initialize(this, data); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, data) { + obj['data'] = data; + } + + /** + * Constructs a InlineResponse20043 from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/InlineResponse20043} obj Optional instance to populate. + * @return {module:model/InlineResponse20043} The populated InlineResponse20043 instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new InlineResponse20043(); + + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); + } + if (data.hasOwnProperty('data')) { + obj['data'] = ApiClient.convertToType(data['data'], [Store]); + } + } + return obj; + } + + +} + +/** + * @member {Boolean} hasMore + */ +InlineResponse20043.prototype['hasMore'] = undefined; + +/** + * @member {Number} totalResultSize + */ +InlineResponse20043.prototype['totalResultSize'] = undefined; + +/** + * @member {Array.} data + */ +InlineResponse20043.prototype['data'] = undefined; + + + + + + +export default InlineResponse20043; + diff --git a/src/model/InlineResponse2005.js b/src/model/InlineResponse2005.js index 414aa02b..13f9750e 100644 --- a/src/model/InlineResponse2005.js +++ b/src/model/InlineResponse2005.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import NotificationWebhook from './NotificationWebhook'; +import Application from './Application'; /** * The InlineResponse2005 model module. * @module model/InlineResponse2005 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2005 { /** * Constructs a new InlineResponse2005. * @alias module:model/InlineResponse2005 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse2005 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [NotificationWebhook]); + obj['data'] = ApiClient.convertToType(data['data'], [Application]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse2005 { InlineResponse2005.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2005.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2006.js b/src/model/InlineResponse2006.js index 41a3b00b..cba39a30 100644 --- a/src/model/InlineResponse2006.js +++ b/src/model/InlineResponse2006.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Ruleset from './Ruleset'; +import Campaign from './Campaign'; /** * The InlineResponse2006 model module. * @module model/InlineResponse2006 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2006 { /** * Constructs a new InlineResponse2006. * @alias module:model/InlineResponse2006 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse2006 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Ruleset]); + obj['data'] = ApiClient.convertToType(data['data'], [Campaign]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse2006 { InlineResponse2006.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2006.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2007.js b/src/model/InlineResponse2007.js index 45f0cbfe..a6801617 100644 --- a/src/model/InlineResponse2007.js +++ b/src/model/InlineResponse2007.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Coupon from './Coupon'; +import Ruleset from './Ruleset'; /** * The InlineResponse2007 model module. * @module model/InlineResponse2007 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2007 { /** * Constructs a new InlineResponse2007. * @alias module:model/InlineResponse2007 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse2007 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Coupon]); + obj['data'] = ApiClient.convertToType(data['data'], [Ruleset]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse2007 { InlineResponse2007.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2007.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2008.js b/src/model/InlineResponse2008.js index d544d568..0a5a130f 100644 --- a/src/model/InlineResponse2008.js +++ b/src/model/InlineResponse2008.js @@ -17,18 +17,18 @@ import Coupon from './Coupon'; /** * The InlineResponse2008 model module. * @module model/InlineResponse2008 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2008 { /** * Constructs a new InlineResponse2008. * @alias module:model/InlineResponse2008 - * @param hasMore {Boolean} + * @param totalResultSize {Number} * @param data {Array.} */ - constructor(hasMore, data) { + constructor(totalResultSize, data) { - InlineResponse2008.initialize(this, hasMore, data); + InlineResponse2008.initialize(this, totalResultSize, data); } /** @@ -36,8 +36,8 @@ class InlineResponse2008 { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, hasMore, data) { - obj['hasMore'] = hasMore; + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -52,8 +52,8 @@ class InlineResponse2008 { if (data) { obj = obj || new InlineResponse2008(); - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + if (data.hasOwnProperty('totalResultSize')) { + obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { obj['data'] = ApiClient.convertToType(data['data'], [Coupon]); @@ -66,9 +66,9 @@ class InlineResponse2008 { } /** - * @member {Boolean} hasMore + * @member {Number} totalResultSize */ -InlineResponse2008.prototype['hasMore'] = undefined; +InlineResponse2008.prototype['totalResultSize'] = undefined; /** * @member {Array.} data diff --git a/src/model/InlineResponse2009.js b/src/model/InlineResponse2009.js index 28ec1ff1..d19e5889 100644 --- a/src/model/InlineResponse2009.js +++ b/src/model/InlineResponse2009.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Referral from './Referral'; +import Coupon from './Coupon'; /** * The InlineResponse2009 model module. * @module model/InlineResponse2009 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse2009 { /** * Constructs a new InlineResponse2009. * @alias module:model/InlineResponse2009 * @param hasMore {Boolean} - * @param data {Array.} + * @param data {Array.} */ constructor(hasMore, data) { @@ -56,7 +56,7 @@ class InlineResponse2009 { obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Referral]); + obj['data'] = ApiClient.convertToType(data['data'], [Coupon]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse2009 { InlineResponse2009.prototype['hasMore'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse2009.prototype['data'] = undefined; diff --git a/src/model/InlineResponse201.js b/src/model/InlineResponse201.js index d6257242..4c747774 100644 --- a/src/model/InlineResponse201.js +++ b/src/model/InlineResponse201.js @@ -17,7 +17,7 @@ import Referral from './Referral'; /** * The InlineResponse201 model module. * @module model/InlineResponse201 - * @version 5.0.1 + * @version 6.0.0 */ class InlineResponse201 { /** diff --git a/src/model/IntegrationCoupon.js b/src/model/IntegrationCoupon.js index 4eeab0e4..f9f8e6d5 100644 --- a/src/model/IntegrationCoupon.js +++ b/src/model/IntegrationCoupon.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The IntegrationCoupon model module. * @module model/IntegrationCoupon - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationCoupon { /** @@ -126,6 +126,9 @@ class IntegrationCoupon { if (data.hasOwnProperty('isReservationMandatory')) { obj['isReservationMandatory'] = ApiClient.convertToType(data['isReservationMandatory'], 'Boolean'); } + if (data.hasOwnProperty('implicitlyReserved')) { + obj['implicitlyReserved'] = ApiClient.convertToType(data['implicitlyReserved'], 'Boolean'); + } if (data.hasOwnProperty('profileRedemptionCount')) { obj['profileRedemptionCount'] = ApiClient.convertToType(data['profileRedemptionCount'], 'Number'); } @@ -264,6 +267,12 @@ IntegrationCoupon.prototype['batchId'] = undefined; */ IntegrationCoupon.prototype['isReservationMandatory'] = true; +/** + * An indication of whether the coupon is implicitly reserved for all customers. + * @member {Boolean} implicitlyReserved + */ +IntegrationCoupon.prototype['implicitlyReserved'] = undefined; + /** * The number of times the coupon was redeemed by the profile. * @member {Number} profileRedemptionCount diff --git a/src/model/IntegrationCustomerSessionResponse.js b/src/model/IntegrationCustomerSessionResponse.js index 9a66b7d0..ac03c921 100644 --- a/src/model/IntegrationCustomerSessionResponse.js +++ b/src/model/IntegrationCustomerSessionResponse.js @@ -18,7 +18,7 @@ import Effect from './Effect'; /** * The IntegrationCustomerSessionResponse model module. * @module model/IntegrationCustomerSessionResponse - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationCustomerSessionResponse { /** diff --git a/src/model/IntegrationEntity.js b/src/model/IntegrationEntity.js index 8a8ff45c..a7c9b3d2 100644 --- a/src/model/IntegrationEntity.js +++ b/src/model/IntegrationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationEntity model module. * @module model/IntegrationEntity - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationEntity { /** diff --git a/src/model/IntegrationEvent.js b/src/model/IntegrationEvent.js index e37ec313..1fe0f97b 100644 --- a/src/model/IntegrationEvent.js +++ b/src/model/IntegrationEvent.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationEvent model module. * @module model/IntegrationEvent - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationEvent { /** @@ -55,6 +55,9 @@ class IntegrationEvent { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } @@ -74,6 +77,12 @@ class IntegrationEvent { */ IntegrationEvent.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +IntegrationEvent.prototype['storeIntegrationId'] = undefined; + /** * A string representing the event. Must not be a reserved event name. * @member {String} type diff --git a/src/model/IntegrationEventV2Request.js b/src/model/IntegrationEventV2Request.js index 0d299d52..32f02c9a 100644 --- a/src/model/IntegrationEventV2Request.js +++ b/src/model/IntegrationEventV2Request.js @@ -16,14 +16,14 @@ import ApiClient from '../ApiClient'; /** * The IntegrationEventV2Request model module. * @module model/IntegrationEventV2Request - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationEventV2Request { /** * Constructs a new IntegrationEventV2Request. * * @alias module:model/IntegrationEventV2Request - * @param type {String} A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + * @param type {String} A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. */ constructor(type) { @@ -53,6 +53,9 @@ class IntegrationEventV2Request { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('evaluableCampaignIds')) { obj['evaluableCampaignIds'] = ApiClient.convertToType(data['evaluableCampaignIds'], ['Number']); } @@ -78,6 +81,12 @@ class IntegrationEventV2Request { */ IntegrationEventV2Request.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +IntegrationEventV2Request.prototype['storeIntegrationId'] = undefined; + /** * When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. * @member {Array.} evaluableCampaignIds @@ -85,13 +94,13 @@ IntegrationEventV2Request.prototype['profileId'] = undefined; IntegrationEventV2Request.prototype['evaluableCampaignIds'] = undefined; /** - * A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + * A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. * @member {String} type */ IntegrationEventV2Request.prototype['type'] = undefined; /** - * Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). + * Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). * @member {Object} attributes */ IntegrationEventV2Request.prototype['attributes'] = undefined; diff --git a/src/model/IntegrationProfileEntity.js b/src/model/IntegrationProfileEntity.js index ce538deb..f5c01e25 100644 --- a/src/model/IntegrationProfileEntity.js +++ b/src/model/IntegrationProfileEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationProfileEntity model module. * @module model/IntegrationProfileEntity - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationProfileEntity { /** diff --git a/src/model/IntegrationRequest.js b/src/model/IntegrationRequest.js index f2d48f9b..7daf39b0 100644 --- a/src/model/IntegrationRequest.js +++ b/src/model/IntegrationRequest.js @@ -17,7 +17,7 @@ import NewCustomerSessionV2 from './NewCustomerSessionV2'; /** * The IntegrationRequest model module. * @module model/IntegrationRequest - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationRequest { /** diff --git a/src/model/IntegrationState.js b/src/model/IntegrationState.js index e4f29073..21113da8 100644 --- a/src/model/IntegrationState.js +++ b/src/model/IntegrationState.js @@ -21,7 +21,7 @@ import Loyalty from './Loyalty'; /** * The IntegrationState model module. * @module model/IntegrationState - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationState { /** diff --git a/src/model/IntegrationStateV2.js b/src/model/IntegrationStateV2.js index 839793b8..3031dd34 100644 --- a/src/model/IntegrationStateV2.js +++ b/src/model/IntegrationStateV2.js @@ -29,7 +29,7 @@ import RuleFailureReason from './RuleFailureReason'; /** * The IntegrationStateV2 model module. * @module model/IntegrationStateV2 - * @version 5.0.1 + * @version 6.0.0 */ class IntegrationStateV2 { /** diff --git a/src/model/IntegrationStoreEntity.js b/src/model/IntegrationStoreEntity.js new file mode 100644 index 00000000..44aae3c6 --- /dev/null +++ b/src/model/IntegrationStoreEntity.js @@ -0,0 +1,72 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The IntegrationStoreEntity model module. + * @module model/IntegrationStoreEntity + * @version 6.0.0 + */ +class IntegrationStoreEntity { + /** + * Constructs a new IntegrationStoreEntity. + * @alias module:model/IntegrationStoreEntity + */ + constructor() { + + IntegrationStoreEntity.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a IntegrationStoreEntity from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/IntegrationStoreEntity} obj Optional instance to populate. + * @return {module:model/IntegrationStoreEntity} The populated IntegrationStoreEntity instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new IntegrationStoreEntity(); + + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } + } + return obj; + } + + +} + +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +IntegrationStoreEntity.prototype['storeIntegrationId'] = undefined; + + + + + + +export default IntegrationStoreEntity; + diff --git a/src/model/InventoryCoupon.js b/src/model/InventoryCoupon.js index 5213adf3..473b75ea 100644 --- a/src/model/InventoryCoupon.js +++ b/src/model/InventoryCoupon.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The InventoryCoupon model module. * @module model/InventoryCoupon - * @version 5.0.1 + * @version 6.0.0 */ class InventoryCoupon { /** @@ -128,6 +128,9 @@ class InventoryCoupon { if (data.hasOwnProperty('isReservationMandatory')) { obj['isReservationMandatory'] = ApiClient.convertToType(data['isReservationMandatory'], 'Boolean'); } + if (data.hasOwnProperty('implicitlyReserved')) { + obj['implicitlyReserved'] = ApiClient.convertToType(data['implicitlyReserved'], 'Boolean'); + } if (data.hasOwnProperty('profileRedemptionCount')) { obj['profileRedemptionCount'] = ApiClient.convertToType(data['profileRedemptionCount'], 'Number'); } @@ -269,6 +272,12 @@ InventoryCoupon.prototype['batchId'] = undefined; */ InventoryCoupon.prototype['isReservationMandatory'] = true; +/** + * An indication of whether the coupon is implicitly reserved for all customers. + * @member {Boolean} implicitlyReserved + */ +InventoryCoupon.prototype['implicitlyReserved'] = undefined; + /** * The number of times the coupon was redeemed by the profile. * @member {Number} profileRedemptionCount diff --git a/src/model/InventoryReferral.js b/src/model/InventoryReferral.js index 6f627308..1bc49953 100644 --- a/src/model/InventoryReferral.js +++ b/src/model/InventoryReferral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The InventoryReferral model module. * @module model/InventoryReferral - * @version 5.0.1 + * @version 6.0.0 */ class InventoryReferral { /** diff --git a/src/model/ItemAttribute.js b/src/model/ItemAttribute.js index 17158707..ddc95a65 100644 --- a/src/model/ItemAttribute.js +++ b/src/model/ItemAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ItemAttribute model module. * @module model/ItemAttribute - * @version 5.0.1 + * @version 6.0.0 */ class ItemAttribute { /** diff --git a/src/model/LedgerEntry.js b/src/model/LedgerEntry.js index 52a5c7b4..2b8b43d2 100644 --- a/src/model/LedgerEntry.js +++ b/src/model/LedgerEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LedgerEntry model module. * @module model/LedgerEntry - * @version 5.0.1 + * @version 6.0.0 */ class LedgerEntry { /** diff --git a/src/model/LedgerInfo.js b/src/model/LedgerInfo.js index 3ce56b26..0bc77e7c 100644 --- a/src/model/LedgerInfo.js +++ b/src/model/LedgerInfo.js @@ -17,7 +17,7 @@ import Tier from './Tier'; /** * The LedgerInfo model module. * @module model/LedgerInfo - * @version 5.0.1 + * @version 6.0.0 */ class LedgerInfo { /** diff --git a/src/model/LedgerPointsEntryIntegrationAPI.js b/src/model/LedgerPointsEntryIntegrationAPI.js new file mode 100644 index 00000000..dfba04ae --- /dev/null +++ b/src/model/LedgerPointsEntryIntegrationAPI.js @@ -0,0 +1,161 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The LedgerPointsEntryIntegrationAPI model module. + * @module model/LedgerPointsEntryIntegrationAPI + * @version 6.0.0 + */ +class LedgerPointsEntryIntegrationAPI { + /** + * Constructs a new LedgerPointsEntryIntegrationAPI. + * Loyalty profile points with start and expiry dates. + * @alias module:model/LedgerPointsEntryIntegrationAPI + * @param id {Number} ID of the transaction that adds loyalty points. + * @param created {Date} Date and time the loyalty points were added. + * @param programId {Number} ID of the loyalty program. + * @param name {String} Name or reason of the transaction that adds loyalty points. + * @param startDate {String} When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. + * @param expiryDate {String} Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. + * @param subledgerId {String} ID of the subledger. + * @param amount {Number} Amount of loyalty points added in the transaction. + */ + constructor(id, created, programId, name, startDate, expiryDate, subledgerId, amount) { + + LedgerPointsEntryIntegrationAPI.initialize(this, id, created, programId, name, startDate, expiryDate, subledgerId, amount); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, programId, name, startDate, expiryDate, subledgerId, amount) { + obj['id'] = id; + obj['created'] = created; + obj['programId'] = programId; + obj['name'] = name; + obj['startDate'] = startDate; + obj['expiryDate'] = expiryDate; + obj['subledgerId'] = subledgerId; + obj['amount'] = amount; + } + + /** + * Constructs a LedgerPointsEntryIntegrationAPI from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/LedgerPointsEntryIntegrationAPI} obj Optional instance to populate. + * @return {module:model/LedgerPointsEntryIntegrationAPI} The populated LedgerPointsEntryIntegrationAPI instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new LedgerPointsEntryIntegrationAPI(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('programId')) { + obj['programId'] = ApiClient.convertToType(data['programId'], 'Number'); + } + if (data.hasOwnProperty('customerSessionId')) { + obj['customerSessionId'] = ApiClient.convertToType(data['customerSessionId'], 'String'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('startDate')) { + obj['startDate'] = ApiClient.convertToType(data['startDate'], 'String'); + } + if (data.hasOwnProperty('expiryDate')) { + obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'String'); + } + if (data.hasOwnProperty('subledgerId')) { + obj['subledgerId'] = ApiClient.convertToType(data['subledgerId'], 'String'); + } + if (data.hasOwnProperty('amount')) { + obj['amount'] = ApiClient.convertToType(data['amount'], 'Number'); + } + } + return obj; + } + + +} + +/** + * ID of the transaction that adds loyalty points. + * @member {Number} id + */ +LedgerPointsEntryIntegrationAPI.prototype['id'] = undefined; + +/** + * Date and time the loyalty points were added. + * @member {Date} created + */ +LedgerPointsEntryIntegrationAPI.prototype['created'] = undefined; + +/** + * ID of the loyalty program. + * @member {Number} programId + */ +LedgerPointsEntryIntegrationAPI.prototype['programId'] = undefined; + +/** + * ID of the customer session where points were added. + * @member {String} customerSessionId + */ +LedgerPointsEntryIntegrationAPI.prototype['customerSessionId'] = undefined; + +/** + * Name or reason of the transaction that adds loyalty points. + * @member {String} name + */ +LedgerPointsEntryIntegrationAPI.prototype['name'] = undefined; + +/** + * When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time. + * @member {String} startDate + */ +LedgerPointsEntryIntegrationAPI.prototype['startDate'] = undefined; + +/** + * Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time. + * @member {String} expiryDate + */ +LedgerPointsEntryIntegrationAPI.prototype['expiryDate'] = undefined; + +/** + * ID of the subledger. + * @member {String} subledgerId + */ +LedgerPointsEntryIntegrationAPI.prototype['subledgerId'] = undefined; + +/** + * Amount of loyalty points added in the transaction. + * @member {Number} amount + */ +LedgerPointsEntryIntegrationAPI.prototype['amount'] = undefined; + + + + + + +export default LedgerPointsEntryIntegrationAPI; + diff --git a/src/model/LedgerTransactionLogEntryIntegrationAPI.js b/src/model/LedgerTransactionLogEntryIntegrationAPI.js index eb5bab80..177b0f60 100644 --- a/src/model/LedgerTransactionLogEntryIntegrationAPI.js +++ b/src/model/LedgerTransactionLogEntryIntegrationAPI.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LedgerTransactionLogEntryIntegrationAPI model module. * @module model/LedgerTransactionLogEntryIntegrationAPI - * @version 5.0.1 + * @version 6.0.0 */ class LedgerTransactionLogEntryIntegrationAPI { /** diff --git a/src/model/LibraryAttribute.js b/src/model/LibraryAttribute.js index 2c61eb86..2a6aa932 100644 --- a/src/model/LibraryAttribute.js +++ b/src/model/LibraryAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LibraryAttribute model module. * @module model/LibraryAttribute - * @version 5.0.1 + * @version 6.0.0 */ class LibraryAttribute { /** diff --git a/src/model/LimitConfig.js b/src/model/LimitConfig.js index 27f62267..3aead2dc 100644 --- a/src/model/LimitConfig.js +++ b/src/model/LimitConfig.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LimitConfig model module. * @module model/LimitConfig - * @version 5.0.1 + * @version 6.0.0 */ class LimitConfig { /** diff --git a/src/model/LimitCounter.js b/src/model/LimitCounter.js index 492bc229..9a8cda57 100644 --- a/src/model/LimitCounter.js +++ b/src/model/LimitCounter.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LimitCounter model module. * @module model/LimitCounter - * @version 5.0.1 + * @version 6.0.0 */ class LimitCounter { /** diff --git a/src/model/LoginParams.js b/src/model/LoginParams.js index 993bcf06..8271ad0b 100644 --- a/src/model/LoginParams.js +++ b/src/model/LoginParams.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoginParams model module. * @module model/LoginParams - * @version 5.0.1 + * @version 6.0.0 */ class LoginParams { /** diff --git a/src/model/Loyalty.js b/src/model/Loyalty.js index 187b50a2..7d835ac2 100644 --- a/src/model/Loyalty.js +++ b/src/model/Loyalty.js @@ -18,7 +18,7 @@ import LoyaltyProgramLedgers from './LoyaltyProgramLedgers'; /** * The Loyalty model module. * @module model/Loyalty - * @version 5.0.1 + * @version 6.0.0 */ class Loyalty { /** diff --git a/src/model/LoyaltyBalance.js b/src/model/LoyaltyBalance.js index 3c47ad0d..77ab93bc 100644 --- a/src/model/LoyaltyBalance.js +++ b/src/model/LoyaltyBalance.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyBalance model module. * @module model/LoyaltyBalance - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyBalance { /** diff --git a/src/model/LoyaltyBalances.js b/src/model/LoyaltyBalances.js index fc970dce..13749d08 100644 --- a/src/model/LoyaltyBalances.js +++ b/src/model/LoyaltyBalances.js @@ -17,7 +17,7 @@ import LoyaltyBalance from './LoyaltyBalance'; /** * The LoyaltyBalances model module. * @module model/LoyaltyBalances - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyBalances { /** diff --git a/src/model/LoyaltyCard.js b/src/model/LoyaltyCard.js index 59501446..8bbd04cd 100644 --- a/src/model/LoyaltyCard.js +++ b/src/model/LoyaltyCard.js @@ -18,7 +18,7 @@ import LoyaltyCardProfileRegistration from './LoyaltyCardProfileRegistration'; /** * The LoyaltyCard model module. * @module model/LoyaltyCard - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyCard { /** diff --git a/src/model/LoyaltyCardProfileRegistration.js b/src/model/LoyaltyCardProfileRegistration.js index 3ab63b65..fce30936 100644 --- a/src/model/LoyaltyCardProfileRegistration.js +++ b/src/model/LoyaltyCardProfileRegistration.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyCardProfileRegistration model module. * @module model/LoyaltyCardProfileRegistration - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyCardProfileRegistration { /** diff --git a/src/model/LoyaltyCardRegistration.js b/src/model/LoyaltyCardRegistration.js index e37888f6..69e7ef9f 100644 --- a/src/model/LoyaltyCardRegistration.js +++ b/src/model/LoyaltyCardRegistration.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyCardRegistration model module. * @module model/LoyaltyCardRegistration - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyCardRegistration { /** diff --git a/src/model/LoyaltyDashboardData.js b/src/model/LoyaltyDashboardData.js index 5e4e606a..18be4ffe 100644 --- a/src/model/LoyaltyDashboardData.js +++ b/src/model/LoyaltyDashboardData.js @@ -17,7 +17,7 @@ import LoyaltyDashboardPointsBreakdown from './LoyaltyDashboardPointsBreakdown'; /** * The LoyaltyDashboardData model module. * @module model/LoyaltyDashboardData - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyDashboardData { /** diff --git a/src/model/LoyaltyDashboardPointsBreakdown.js b/src/model/LoyaltyDashboardPointsBreakdown.js index 607662e7..de72bc7b 100644 --- a/src/model/LoyaltyDashboardPointsBreakdown.js +++ b/src/model/LoyaltyDashboardPointsBreakdown.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyDashboardPointsBreakdown model module. * @module model/LoyaltyDashboardPointsBreakdown - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyDashboardPointsBreakdown { /** diff --git a/src/model/LoyaltyLedger.js b/src/model/LoyaltyLedger.js index a25cd8f6..3d0bed40 100644 --- a/src/model/LoyaltyLedger.js +++ b/src/model/LoyaltyLedger.js @@ -17,7 +17,7 @@ import LoyaltySubLedger from './LoyaltySubLedger'; /** * The LoyaltyLedger model module. * @module model/LoyaltyLedger - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyLedger { /** diff --git a/src/model/LoyaltyLedgerEntry.js b/src/model/LoyaltyLedgerEntry.js index f3081d43..b12db0d7 100644 --- a/src/model/LoyaltyLedgerEntry.js +++ b/src/model/LoyaltyLedgerEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyLedgerEntry model module. * @module model/LoyaltyLedgerEntry - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyLedgerEntry { /** diff --git a/src/model/LoyaltyLedgerTransactions.js b/src/model/LoyaltyLedgerTransactions.js index 8ff7641e..4c64b926 100644 --- a/src/model/LoyaltyLedgerTransactions.js +++ b/src/model/LoyaltyLedgerTransactions.js @@ -17,7 +17,7 @@ import LoyaltyLedgerEntry from './LoyaltyLedgerEntry'; /** * The LoyaltyLedgerTransactions model module. * @module model/LoyaltyLedgerTransactions - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyLedgerTransactions { /** diff --git a/src/model/LoyaltyMembership.js b/src/model/LoyaltyMembership.js index 384b8ad0..0689a0e7 100644 --- a/src/model/LoyaltyMembership.js +++ b/src/model/LoyaltyMembership.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyMembership model module. * @module model/LoyaltyMembership - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyMembership { /** diff --git a/src/model/LoyaltyProgram.js b/src/model/LoyaltyProgram.js index e8dbcb89..4db2f7f7 100644 --- a/src/model/LoyaltyProgram.js +++ b/src/model/LoyaltyProgram.js @@ -17,7 +17,7 @@ import LoyaltyTier from './LoyaltyTier'; /** * The LoyaltyProgram model module. * @module model/LoyaltyProgram - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgram { /** @@ -200,7 +200,7 @@ LoyaltyProgram.prototype['usersPerCardLimit'] = undefined; LoyaltyProgram.prototype['sandbox'] = undefined; /** - * The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. + * The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. * @member {String} tiersExpireIn */ LoyaltyProgram.prototype['tiersExpireIn'] = undefined; @@ -243,14 +243,14 @@ LoyaltyProgram.prototype['timezone'] = undefined; LoyaltyProgram.prototype['cardBased'] = false; /** - * True if it is possible to change tiers definition. + * `True` if the tier definitions can be updated. * @member {Boolean} canUpdateTiers * @default false */ LoyaltyProgram.prototype['canUpdateTiers'] = false; /** - * True if it is possible to introduce tiersExpireIn and tiersDowngradePolicy. + * `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. * @member {Boolean} canUpgradeToAdvancedTiers * @default false */ diff --git a/src/model/LoyaltyProgramBalance.js b/src/model/LoyaltyProgramBalance.js index f71ecfbd..12b75427 100644 --- a/src/model/LoyaltyProgramBalance.js +++ b/src/model/LoyaltyProgramBalance.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgramBalance model module. * @module model/LoyaltyProgramBalance - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgramBalance { /** diff --git a/src/model/LoyaltyProgramEntity.js b/src/model/LoyaltyProgramEntity.js index b1957c3a..4bfa2ecb 100644 --- a/src/model/LoyaltyProgramEntity.js +++ b/src/model/LoyaltyProgramEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgramEntity model module. * @module model/LoyaltyProgramEntity - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgramEntity { /** diff --git a/src/model/LoyaltyProgramLedgers.js b/src/model/LoyaltyProgramLedgers.js index d7c9eb61..f01398d9 100644 --- a/src/model/LoyaltyProgramLedgers.js +++ b/src/model/LoyaltyProgramLedgers.js @@ -17,7 +17,7 @@ import LedgerInfo from './LedgerInfo'; /** * The LoyaltyProgramLedgers model module. * @module model/LoyaltyProgramLedgers - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgramLedgers { /** diff --git a/src/model/LoyaltyProgramSubledgers.js b/src/model/LoyaltyProgramSubledgers.js index 3e016f11..5ab084dc 100644 --- a/src/model/LoyaltyProgramSubledgers.js +++ b/src/model/LoyaltyProgramSubledgers.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgramSubledgers model module. * @module model/LoyaltyProgramSubledgers - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgramSubledgers { /** diff --git a/src/model/LoyaltyProgramTransaction.js b/src/model/LoyaltyProgramTransaction.js index 73393882..b8dcc7ed 100644 --- a/src/model/LoyaltyProgramTransaction.js +++ b/src/model/LoyaltyProgramTransaction.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgramTransaction model module. * @module model/LoyaltyProgramTransaction - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyProgramTransaction { /** @@ -202,13 +202,13 @@ LoyaltyProgramTransaction.prototype['customerSessionId'] = undefined; LoyaltyProgramTransaction.prototype['importId'] = undefined; /** - * ID of the user who manually added or deducted points. Applies only for manual transactions. + * ID of the user who manually added or deducted points. Applies only to manual transactions. * @member {Number} userId */ LoyaltyProgramTransaction.prototype['userId'] = undefined; /** - * The email of the user who manually added or deducted points. Applies only for manual transactions. + * The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions. * @member {String} userEmail */ LoyaltyProgramTransaction.prototype['userEmail'] = undefined; diff --git a/src/model/LoyaltySubLedger.js b/src/model/LoyaltySubLedger.js index c6eb79df..d9bd307f 100644 --- a/src/model/LoyaltySubLedger.js +++ b/src/model/LoyaltySubLedger.js @@ -18,7 +18,7 @@ import Tier from './Tier'; /** * The LoyaltySubLedger model module. * @module model/LoyaltySubLedger - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltySubLedger { /** diff --git a/src/model/LoyaltyTier.js b/src/model/LoyaltyTier.js index 550d7bc6..e2d0aca4 100644 --- a/src/model/LoyaltyTier.js +++ b/src/model/LoyaltyTier.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyTier model module. * @module model/LoyaltyTier - * @version 5.0.1 + * @version 6.0.0 */ class LoyaltyTier { /** diff --git a/src/model/ManagementKey.js b/src/model/ManagementKey.js index beb14fa9..75e186a0 100644 --- a/src/model/ManagementKey.js +++ b/src/model/ManagementKey.js @@ -17,7 +17,7 @@ import Endpoint from './Endpoint'; /** * The ManagementKey model module. * @module model/ManagementKey - * @version 5.0.1 + * @version 6.0.0 */ class ManagementKey { /** diff --git a/src/model/ManagerConfig.js b/src/model/ManagerConfig.js index f00b37b9..85c03ef4 100644 --- a/src/model/ManagerConfig.js +++ b/src/model/ManagerConfig.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ManagerConfig model module. * @module model/ManagerConfig - * @version 5.0.1 + * @version 6.0.0 */ class ManagerConfig { /** diff --git a/src/model/Meta.js b/src/model/Meta.js index feed5f20..d739e525 100644 --- a/src/model/Meta.js +++ b/src/model/Meta.js @@ -18,7 +18,7 @@ import ReferralRejectionReason from './ReferralRejectionReason'; /** * The Meta model module. * @module model/Meta - * @version 5.0.1 + * @version 6.0.0 */ class Meta { /** diff --git a/src/model/ModelExport.js b/src/model/ModelExport.js index d9fdfee2..15783037 100644 --- a/src/model/ModelExport.js +++ b/src/model/ModelExport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ModelExport model module. * @module model/ModelExport - * @version 5.0.1 + * @version 6.0.0 */ class ModelExport { /** diff --git a/src/model/ModelImport.js b/src/model/ModelImport.js index fba3f831..a2b2f4ae 100644 --- a/src/model/ModelImport.js +++ b/src/model/ModelImport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ModelImport model module. * @module model/ModelImport - * @version 5.0.1 + * @version 6.0.0 */ class ModelImport { /** diff --git a/src/model/ModelReturn.js b/src/model/ModelReturn.js index bc5a68d5..a74b50a5 100644 --- a/src/model/ModelReturn.js +++ b/src/model/ModelReturn.js @@ -17,7 +17,7 @@ import ReturnedCartItem from './ReturnedCartItem'; /** * The ModelReturn model module. * @module model/ModelReturn - * @version 5.0.1 + * @version 6.0.0 */ class ModelReturn { /** diff --git a/src/model/MultiApplicationEntity.js b/src/model/MultiApplicationEntity.js index d74419b1..f6225db8 100644 --- a/src/model/MultiApplicationEntity.js +++ b/src/model/MultiApplicationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MultiApplicationEntity model module. * @module model/MultiApplicationEntity - * @version 5.0.1 + * @version 6.0.0 */ class MultiApplicationEntity { /** diff --git a/src/model/MultipleAttribute.js b/src/model/MultipleAttribute.js index 21b78158..bfda0c14 100644 --- a/src/model/MultipleAttribute.js +++ b/src/model/MultipleAttribute.js @@ -17,7 +17,7 @@ import Attribute from './Attribute'; /** * The MultipleAttribute model module. * @module model/MultipleAttribute - * @version 5.0.1 + * @version 6.0.0 */ class MultipleAttribute { /** diff --git a/src/model/MultipleAudiences.js b/src/model/MultipleAudiences.js index aab9b62c..4502f85e 100644 --- a/src/model/MultipleAudiences.js +++ b/src/model/MultipleAudiences.js @@ -17,7 +17,7 @@ import MultipleAudiencesItem from './MultipleAudiencesItem'; /** * The MultipleAudiences model module. * @module model/MultipleAudiences - * @version 5.0.1 + * @version 6.0.0 */ class MultipleAudiences { /** diff --git a/src/model/MultipleAudiencesItem.js b/src/model/MultipleAudiencesItem.js index d0e94693..89cd93da 100644 --- a/src/model/MultipleAudiencesItem.js +++ b/src/model/MultipleAudiencesItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MultipleAudiencesItem model module. * @module model/MultipleAudiencesItem - * @version 5.0.1 + * @version 6.0.0 */ class MultipleAudiencesItem { /** diff --git a/src/model/MultipleCustomerProfileIntegrationRequest.js b/src/model/MultipleCustomerProfileIntegrationRequest.js index eae5e3fe..b4606f1d 100644 --- a/src/model/MultipleCustomerProfileIntegrationRequest.js +++ b/src/model/MultipleCustomerProfileIntegrationRequest.js @@ -17,7 +17,7 @@ import MultipleCustomerProfileIntegrationRequestItem from './MultipleCustomerPro /** * The MultipleCustomerProfileIntegrationRequest model module. * @module model/MultipleCustomerProfileIntegrationRequest - * @version 5.0.1 + * @version 6.0.0 */ class MultipleCustomerProfileIntegrationRequest { /** diff --git a/src/model/MultipleCustomerProfileIntegrationRequestItem.js b/src/model/MultipleCustomerProfileIntegrationRequestItem.js index e2121921..a24a8ccf 100644 --- a/src/model/MultipleCustomerProfileIntegrationRequestItem.js +++ b/src/model/MultipleCustomerProfileIntegrationRequestItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MultipleCustomerProfileIntegrationRequestItem model module. * @module model/MultipleCustomerProfileIntegrationRequestItem - * @version 5.0.1 + * @version 6.0.0 */ class MultipleCustomerProfileIntegrationRequestItem { /** diff --git a/src/model/MultipleCustomerProfileIntegrationResponseV2.js b/src/model/MultipleCustomerProfileIntegrationResponseV2.js index 90be9f7a..e99ba2e7 100644 --- a/src/model/MultipleCustomerProfileIntegrationResponseV2.js +++ b/src/model/MultipleCustomerProfileIntegrationResponseV2.js @@ -17,7 +17,7 @@ import CustomerProfileUpdateV2Response from './CustomerProfileUpdateV2Response'; /** * The MultipleCustomerProfileIntegrationResponseV2 model module. * @module model/MultipleCustomerProfileIntegrationResponseV2 - * @version 5.0.1 + * @version 6.0.0 */ class MultipleCustomerProfileIntegrationResponseV2 { /** diff --git a/src/model/MultipleNewAttribute.js b/src/model/MultipleNewAttribute.js index ff4fc90a..e6feff03 100644 --- a/src/model/MultipleNewAttribute.js +++ b/src/model/MultipleNewAttribute.js @@ -17,7 +17,7 @@ import NewAttribute from './NewAttribute'; /** * The MultipleNewAttribute model module. * @module model/MultipleNewAttribute - * @version 5.0.1 + * @version 6.0.0 */ class MultipleNewAttribute { /** diff --git a/src/model/MultipleNewAudiences.js b/src/model/MultipleNewAudiences.js index 849696cf..00640783 100644 --- a/src/model/MultipleNewAudiences.js +++ b/src/model/MultipleNewAudiences.js @@ -17,7 +17,7 @@ import NewMultipleAudiencesItem from './NewMultipleAudiencesItem'; /** * The MultipleNewAudiences model module. * @module model/MultipleNewAudiences - * @version 5.0.1 + * @version 6.0.0 */ class MultipleNewAudiences { /** diff --git a/src/model/MutableEntity.js b/src/model/MutableEntity.js index cb7a7ab8..a2e3800a 100644 --- a/src/model/MutableEntity.js +++ b/src/model/MutableEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MutableEntity model module. * @module model/MutableEntity - * @version 5.0.1 + * @version 6.0.0 */ class MutableEntity { /** diff --git a/src/model/NewAccount.js b/src/model/NewAccount.js index 626f5dd4..255f66e3 100644 --- a/src/model/NewAccount.js +++ b/src/model/NewAccount.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAccount model module. * @module model/NewAccount - * @version 5.0.1 + * @version 6.0.0 */ class NewAccount { /** diff --git a/src/model/NewAccountSignUp.js b/src/model/NewAccountSignUp.js index 32e69e0c..214cb9f7 100644 --- a/src/model/NewAccountSignUp.js +++ b/src/model/NewAccountSignUp.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAccountSignUp model module. * @module model/NewAccountSignUp - * @version 5.0.1 + * @version 6.0.0 */ class NewAccountSignUp { /** diff --git a/src/model/NewAdditionalCost.js b/src/model/NewAdditionalCost.js index dce96591..1f81e59c 100644 --- a/src/model/NewAdditionalCost.js +++ b/src/model/NewAdditionalCost.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAdditionalCost model module. * @module model/NewAdditionalCost - * @version 5.0.1 + * @version 6.0.0 */ class NewAdditionalCost { /** diff --git a/src/model/NewApplication.js b/src/model/NewApplication.js index 49281fb3..1ed2a687 100644 --- a/src/model/NewApplication.js +++ b/src/model/NewApplication.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The NewApplication model module. * @module model/NewApplication - * @version 5.0.1 + * @version 6.0.0 */ class NewApplication { /** @@ -162,7 +162,7 @@ NewApplication.prototype['defaultDiscountScope'] = undefined; NewApplication.prototype['enableCascadingDiscounts'] = undefined; /** - * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). + * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. * @member {Boolean} enableFlattenedCartItems */ NewApplication.prototype['enableFlattenedCartItems'] = undefined; diff --git a/src/model/NewApplicationAPIKey.js b/src/model/NewApplicationAPIKey.js index cfea590c..9485805b 100644 --- a/src/model/NewApplicationAPIKey.js +++ b/src/model/NewApplicationAPIKey.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewApplicationAPIKey model module. * @module model/NewApplicationAPIKey - * @version 5.0.1 + * @version 6.0.0 */ class NewApplicationAPIKey { /** @@ -215,7 +215,13 @@ NewApplicationAPIKey['PlatformEnum'] = { * value: "salesforce" * @const */ - "salesforce": "salesforce" + "salesforce": "salesforce", + + /** + * value: "emarsys" + * @const + */ + "emarsys": "emarsys" }; diff --git a/src/model/NewAttribute.js b/src/model/NewAttribute.js index 0d69fae9..0bfdec74 100644 --- a/src/model/NewAttribute.js +++ b/src/model/NewAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAttribute model module. * @module model/NewAttribute - * @version 5.0.1 + * @version 6.0.0 */ class NewAttribute { /** @@ -256,7 +256,13 @@ NewAttribute['EntityEnum'] = { * value: "Referral" * @const */ - "Referral": "Referral" + "Referral": "Referral", + + /** + * value: "Store" + * @const + */ + "Store": "Store" }; diff --git a/src/model/NewAudience.js b/src/model/NewAudience.js index 647d2225..8a8f11e8 100644 --- a/src/model/NewAudience.js +++ b/src/model/NewAudience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAudience model module. * @module model/NewAudience - * @version 5.0.1 + * @version 6.0.0 */ class NewAudience { /** diff --git a/src/model/NewBaseNotification.js b/src/model/NewBaseNotification.js index 64f5a32b..769e63fa 100644 --- a/src/model/NewBaseNotification.js +++ b/src/model/NewBaseNotification.js @@ -17,7 +17,7 @@ import NewNotificationWebhook from './NewNotificationWebhook'; /** * The NewBaseNotification model module. * @module model/NewBaseNotification - * @version 5.0.1 + * @version 6.0.0 */ class NewBaseNotification { /** @@ -56,6 +56,9 @@ class NewBaseNotification { if (data.hasOwnProperty('policy')) { obj['policy'] = ApiClient.convertToType(data['policy'], Object); } + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } if (data.hasOwnProperty('webhook')) { obj['webhook'] = NewNotificationWebhook.constructFromObject(data['webhook']); } @@ -71,6 +74,13 @@ class NewBaseNotification { */ NewBaseNotification.prototype['policy'] = undefined; +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + * @default true + */ +NewBaseNotification.prototype['enabled'] = true; + /** * @member {module:model/NewNotificationWebhook} webhook */ diff --git a/src/model/NewCampaign.js b/src/model/NewCampaign.js index 52e29e21..ded98b5e 100644 --- a/src/model/NewCampaign.js +++ b/src/model/NewCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The NewCampaign model module. * @module model/NewCampaign - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaign { /** @@ -102,6 +102,12 @@ class NewCampaign { if (data.hasOwnProperty('evaluationGroupId')) { obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } } return obj; } @@ -192,6 +198,19 @@ NewCampaign.prototype['campaignGroups'] = undefined; */ NewCampaign.prototype['evaluationGroupId'] = undefined; +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/NewCampaign.TypeEnum} type + * @default 'advanced' + */ +NewCampaign.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +NewCampaign.prototype['linkedStoreIds'] = undefined; + @@ -262,6 +281,27 @@ NewCampaign['FeaturesEnum'] = { }; +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +NewCampaign['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default NewCampaign; diff --git a/src/model/NewCampaignCollection.js b/src/model/NewCampaignCollection.js index 09208437..f5d6ff24 100644 --- a/src/model/NewCampaignCollection.js +++ b/src/model/NewCampaignCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCampaignCollection model module. * @module model/NewCampaignCollection - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaignCollection { /** diff --git a/src/model/NewCampaignEvaluationGroup.js b/src/model/NewCampaignEvaluationGroup.js index b7c0af55..74ae6b75 100644 --- a/src/model/NewCampaignEvaluationGroup.js +++ b/src/model/NewCampaignEvaluationGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCampaignEvaluationGroup model module. * @module model/NewCampaignEvaluationGroup - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaignEvaluationGroup { /** @@ -24,12 +24,13 @@ class NewCampaignEvaluationGroup { * @alias module:model/NewCampaignEvaluationGroup * @param name {String} The name of the campaign evaluation group. * @param parentId {Number} The ID of the parent group that contains the campaign evaluation group. - * @param evaluationMode {module:model/NewCampaignEvaluationGroup.EvaluationModeEnum} + * @param evaluationMode {module:model/NewCampaignEvaluationGroup.EvaluationModeEnum} The mode by which campaigns in the campaign evaluation group are evaluated. + * @param evaluationScope {module:model/NewCampaignEvaluationGroup.EvaluationScopeEnum} The evaluation scope of the campaign evaluation group. * @param locked {Boolean} An indicator of whether the campaign evaluation group is locked for modification. */ - constructor(name, parentId, evaluationMode, locked) { + constructor(name, parentId, evaluationMode, evaluationScope, locked) { - NewCampaignEvaluationGroup.initialize(this, name, parentId, evaluationMode, locked); + NewCampaignEvaluationGroup.initialize(this, name, parentId, evaluationMode, evaluationScope, locked); } /** @@ -37,10 +38,11 @@ class NewCampaignEvaluationGroup { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, name, parentId, evaluationMode, locked) { + static initialize(obj, name, parentId, evaluationMode, evaluationScope, locked) { obj['name'] = name; obj['parentId'] = parentId; obj['evaluationMode'] = evaluationMode; + obj['evaluationScope'] = evaluationScope; obj['locked'] = locked; } @@ -67,6 +69,9 @@ class NewCampaignEvaluationGroup { if (data.hasOwnProperty('evaluationMode')) { obj['evaluationMode'] = ApiClient.convertToType(data['evaluationMode'], 'String'); } + if (data.hasOwnProperty('evaluationScope')) { + obj['evaluationScope'] = ApiClient.convertToType(data['evaluationScope'], 'String'); + } if (data.hasOwnProperty('locked')) { obj['locked'] = ApiClient.convertToType(data['locked'], 'Boolean'); } @@ -96,10 +101,17 @@ NewCampaignEvaluationGroup.prototype['parentId'] = undefined; NewCampaignEvaluationGroup.prototype['description'] = undefined; /** + * The mode by which campaigns in the campaign evaluation group are evaluated. * @member {module:model/NewCampaignEvaluationGroup.EvaluationModeEnum} evaluationMode */ NewCampaignEvaluationGroup.prototype['evaluationMode'] = undefined; +/** + * The evaluation scope of the campaign evaluation group. + * @member {module:model/NewCampaignEvaluationGroup.EvaluationScopeEnum} evaluationScope + */ +NewCampaignEvaluationGroup.prototype['evaluationScope'] = undefined; + /** * An indicator of whether the campaign evaluation group is locked for modification. * @member {Boolean} locked @@ -143,6 +155,27 @@ NewCampaignEvaluationGroup['EvaluationModeEnum'] = { }; +/** + * Allowed values for the evaluationScope property. + * @enum {String} + * @readonly + */ +NewCampaignEvaluationGroup['EvaluationScopeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "session" + * @const + */ + "session": "session" +}; + + export default NewCampaignEvaluationGroup; diff --git a/src/model/NewCampaignGroup.js b/src/model/NewCampaignGroup.js index 67c37add..3d52042e 100644 --- a/src/model/NewCampaignGroup.js +++ b/src/model/NewCampaignGroup.js @@ -16,13 +16,13 @@ import ApiClient from '../ApiClient'; /** * The NewCampaignGroup model module. * @module model/NewCampaignGroup - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaignGroup { /** * Constructs a new NewCampaignGroup. * @alias module:model/NewCampaignGroup - * @param name {String} The name of this campaign group. + * @param name {String} The name of this campaign access group. */ constructor(name) { @@ -69,25 +69,25 @@ class NewCampaignGroup { } /** - * The name of this campaign group. + * The name of this campaign access group. * @member {String} name */ NewCampaignGroup.prototype['name'] = undefined; /** - * A longer description of the campaign group. + * A longer description of the campaign access group. * @member {String} description */ NewCampaignGroup.prototype['description'] = undefined; /** - * A list of the IDs of the applications that this campaign group is enabled for. + * A list of IDs of the Applications that this campaign access group is enabled for. * @member {Array.} subscribedApplicationsIds */ NewCampaignGroup.prototype['subscribedApplicationsIds'] = undefined; /** - * A list of the IDs of the campaigns that this campaign group owns. + * A list of IDs of the campaigns that are part of the campaign access group. * @member {Array.} campaignIds */ NewCampaignGroup.prototype['campaignIds'] = undefined; diff --git a/src/model/NewCampaignSet.js b/src/model/NewCampaignSet.js index 4c0a1bb3..6c532209 100644 --- a/src/model/NewCampaignSet.js +++ b/src/model/NewCampaignSet.js @@ -17,7 +17,7 @@ import CampaignSetBranchNode from './CampaignSetBranchNode'; /** * The NewCampaignSet model module. * @module model/NewCampaignSet - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaignSet { /** diff --git a/src/model/NewCampaignTemplate.js b/src/model/NewCampaignTemplate.js index becd36ad..3ee9c744 100644 --- a/src/model/NewCampaignTemplate.js +++ b/src/model/NewCampaignTemplate.js @@ -20,7 +20,7 @@ import TemplateLimitConfig from './TemplateLimitConfig'; /** * The NewCampaignTemplate model module. * @module model/NewCampaignTemplate - * @version 5.0.1 + * @version 6.0.0 */ class NewCampaignTemplate { /** @@ -30,10 +30,11 @@ class NewCampaignTemplate { * @param description {String} Customer-facing text that explains the objective of the template. * @param instructions {String} Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. * @param state {module:model/NewCampaignTemplate.StateEnum} Only Campaign Templates in 'available' state may be used to create Campaigns. + * @param campaignType {module:model/NewCampaignTemplate.CampaignTypeEnum} The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. */ - constructor(name, description, instructions, state) { + constructor(name, description, instructions, state, campaignType) { - NewCampaignTemplate.initialize(this, name, description, instructions, state); + NewCampaignTemplate.initialize(this, name, description, instructions, state, campaignType); } /** @@ -41,11 +42,12 @@ class NewCampaignTemplate { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, name, description, instructions, state) { + static initialize(obj, name, description, instructions, state, campaignType) { obj['name'] = name; obj['description'] = description; obj['instructions'] = instructions; obj['state'] = state; + obj['campaignType'] = campaignType; } /** @@ -101,6 +103,9 @@ class NewCampaignTemplate { if (data.hasOwnProperty('defaultCampaignGroupId')) { obj['defaultCampaignGroupId'] = ApiClient.convertToType(data['defaultCampaignGroupId'], 'Number'); } + if (data.hasOwnProperty('campaignType')) { + obj['campaignType'] = ApiClient.convertToType(data['campaignType'], 'String'); + } } return obj; } @@ -190,6 +195,13 @@ NewCampaignTemplate.prototype['campaignCollections'] = undefined; */ NewCampaignTemplate.prototype['defaultCampaignGroupId'] = undefined; +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/NewCampaignTemplate.CampaignTypeEnum} campaignType + * @default 'advanced' + */ +NewCampaignTemplate.prototype['campaignType'] = 'advanced'; + @@ -260,6 +272,27 @@ NewCampaignTemplate['FeaturesEnum'] = { }; +/** + * Allowed values for the campaignType property. + * @enum {String} + * @readonly + */ +NewCampaignTemplate['CampaignTypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default NewCampaignTemplate; diff --git a/src/model/NewCatalog.js b/src/model/NewCatalog.js index 46f717a7..fc8409d9 100644 --- a/src/model/NewCatalog.js +++ b/src/model/NewCatalog.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCatalog model module. * @module model/NewCatalog - * @version 5.0.1 + * @version 6.0.0 */ class NewCatalog { /** diff --git a/src/model/NewCollection.js b/src/model/NewCollection.js index 3c132efb..7d426d38 100644 --- a/src/model/NewCollection.js +++ b/src/model/NewCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCollection model module. * @module model/NewCollection - * @version 5.0.1 + * @version 6.0.0 */ class NewCollection { /** diff --git a/src/model/NewCouponCreationJob.js b/src/model/NewCouponCreationJob.js index 6a7fd699..8ac5e190 100644 --- a/src/model/NewCouponCreationJob.js +++ b/src/model/NewCouponCreationJob.js @@ -17,7 +17,7 @@ import CodeGeneratorSettings from './CodeGeneratorSettings'; /** * The NewCouponCreationJob model module. * @module model/NewCouponCreationJob - * @version 5.0.1 + * @version 6.0.0 */ class NewCouponCreationJob { /** diff --git a/src/model/NewCoupons.js b/src/model/NewCoupons.js index 3e6fe70d..afe588e7 100644 --- a/src/model/NewCoupons.js +++ b/src/model/NewCoupons.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The NewCoupons model module. * @module model/NewCoupons - * @version 5.0.1 + * @version 6.0.0 */ class NewCoupons { /** @@ -92,6 +92,9 @@ class NewCoupons { if (data.hasOwnProperty('isReservationMandatory')) { obj['isReservationMandatory'] = ApiClient.convertToType(data['isReservationMandatory'], 'Boolean'); } + if (data.hasOwnProperty('implicitlyReserved')) { + obj['implicitlyReserved'] = ApiClient.convertToType(data['implicitlyReserved'], 'Boolean'); + } } return obj; } @@ -178,6 +181,12 @@ NewCoupons.prototype['couponPattern'] = undefined; */ NewCoupons.prototype['isReservationMandatory'] = true; +/** + * An indication of whether the coupon is implicitly reserved for all customers. + * @member {Boolean} implicitlyReserved + */ +NewCoupons.prototype['implicitlyReserved'] = undefined; + diff --git a/src/model/NewCouponsForMultipleRecipients.js b/src/model/NewCouponsForMultipleRecipients.js index eac6ce96..8da22dba 100644 --- a/src/model/NewCouponsForMultipleRecipients.js +++ b/src/model/NewCouponsForMultipleRecipients.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCouponsForMultipleRecipients model module. * @module model/NewCouponsForMultipleRecipients - * @version 5.0.1 + * @version 6.0.0 */ class NewCouponsForMultipleRecipients { /** diff --git a/src/model/NewCustomEffect.js b/src/model/NewCustomEffect.js index daaafa6d..b5d8e144 100644 --- a/src/model/NewCustomEffect.js +++ b/src/model/NewCustomEffect.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The NewCustomEffect model module. * @module model/NewCustomEffect - * @version 5.0.1 + * @version 6.0.0 */ class NewCustomEffect { /** diff --git a/src/model/NewCustomerProfile.js b/src/model/NewCustomerProfile.js index 7bb56645..003fa6a8 100644 --- a/src/model/NewCustomerProfile.js +++ b/src/model/NewCustomerProfile.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCustomerProfile model module. * @module model/NewCustomerProfile - * @version 5.0.1 + * @version 6.0.0 */ class NewCustomerProfile { /** diff --git a/src/model/NewCustomerSession.js b/src/model/NewCustomerSession.js index e44a1f20..cc1b0a0f 100644 --- a/src/model/NewCustomerSession.js +++ b/src/model/NewCustomerSession.js @@ -17,7 +17,7 @@ import CartItem from './CartItem'; /** * The NewCustomerSession model module. * @module model/NewCustomerSession - * @version 5.0.1 + * @version 6.0.0 */ class NewCustomerSession { /** @@ -99,7 +99,7 @@ NewCustomerSession.prototype['coupon'] = undefined; NewCustomerSession.prototype['referral'] = undefined; /** - * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @member {module:model/NewCustomerSession.StateEnum} state * @default 'open' */ diff --git a/src/model/NewCustomerSessionV2.js b/src/model/NewCustomerSessionV2.js index 79611cd1..16bbe495 100644 --- a/src/model/NewCustomerSessionV2.js +++ b/src/model/NewCustomerSessionV2.js @@ -18,7 +18,7 @@ import CartItem from './CartItem'; /** * The NewCustomerSessionV2 model module. * @module model/NewCustomerSessionV2 - * @version 5.0.1 + * @version 6.0.0 */ class NewCustomerSessionV2 { /** @@ -53,6 +53,9 @@ class NewCustomerSessionV2 { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('evaluableCampaignIds')) { obj['evaluableCampaignIds'] = ApiClient.convertToType(data['evaluableCampaignIds'], ['Number']); } @@ -93,6 +96,12 @@ class NewCustomerSessionV2 { */ NewCustomerSessionV2.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +NewCustomerSessionV2.prototype['storeIntegrationId'] = undefined; + /** * When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. * @member {Array.} evaluableCampaignIds @@ -118,14 +127,14 @@ NewCustomerSessionV2.prototype['referralCode'] = undefined; NewCustomerSessionV2.prototype['loyaltyCards'] = undefined; /** - * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + * Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). * @member {module:model/NewCustomerSessionV2.StateEnum} state * @default 'open' */ NewCustomerSessionV2.prototype['state'] = 'open'; /** - * The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. + * The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. * @member {Array.} cartItems */ NewCustomerSessionV2.prototype['cartItems'] = undefined; diff --git a/src/model/NewEvent.js b/src/model/NewEvent.js index dafcc71c..acfb4d3b 100644 --- a/src/model/NewEvent.js +++ b/src/model/NewEvent.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewEvent model module. * @module model/NewEvent - * @version 5.0.1 + * @version 6.0.0 */ class NewEvent { /** @@ -57,6 +57,9 @@ class NewEvent { if (data.hasOwnProperty('profileId')) { obj['profileId'] = ApiClient.convertToType(data['profileId'], 'String'); } + if (data.hasOwnProperty('storeIntegrationId')) { + obj['storeIntegrationId'] = ApiClient.convertToType(data['storeIntegrationId'], 'String'); + } if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } @@ -79,6 +82,12 @@ class NewEvent { */ NewEvent.prototype['profileId'] = undefined; +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} storeIntegrationId + */ +NewEvent.prototype['storeIntegrationId'] = undefined; + /** * A string representing the event. Must not be a reserved event name. * @member {String} type diff --git a/src/model/NewEventType.js b/src/model/NewEventType.js index 6fcb7e4a..cb7db6fc 100644 --- a/src/model/NewEventType.js +++ b/src/model/NewEventType.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewEventType model module. * @module model/NewEventType - * @version 5.0.1 + * @version 6.0.0 */ class NewEventType { /** diff --git a/src/model/NewGiveawaysPool.js b/src/model/NewGiveawaysPool.js index f6e4d3c7..ec028c77 100644 --- a/src/model/NewGiveawaysPool.js +++ b/src/model/NewGiveawaysPool.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewGiveawaysPool model module. * @module model/NewGiveawaysPool - * @version 5.0.1 + * @version 6.0.0 */ class NewGiveawaysPool { /** diff --git a/src/model/NewInternalAudience.js b/src/model/NewInternalAudience.js index 274a67eb..1e45e370 100644 --- a/src/model/NewInternalAudience.js +++ b/src/model/NewInternalAudience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewInternalAudience model module. * @module model/NewInternalAudience - * @version 5.0.1 + * @version 6.0.0 */ class NewInternalAudience { /** diff --git a/src/model/NewInvitation.js b/src/model/NewInvitation.js index 0397421d..e69b93cb 100644 --- a/src/model/NewInvitation.js +++ b/src/model/NewInvitation.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewInvitation model module. * @module model/NewInvitation - * @version 5.0.1 + * @version 6.0.0 */ class NewInvitation { /** @@ -24,11 +24,10 @@ class NewInvitation { * Parameters for inviting a new user. * @alias module:model/NewInvitation * @param email {String} - * @param acl {String} The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` */ - constructor(email, acl) { + constructor(email) { - NewInvitation.initialize(this, email, acl); + NewInvitation.initialize(this, email); } /** @@ -36,9 +35,8 @@ class NewInvitation { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, email, acl) { + static initialize(obj, email) { obj['email'] = email; - obj['acl'] = acl; } /** @@ -61,6 +59,9 @@ class NewInvitation { if (data.hasOwnProperty('acl')) { obj['acl'] = ApiClient.convertToType(data['acl'], 'String'); } + if (data.hasOwnProperty('isAdmin')) { + obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); + } if (data.hasOwnProperty('roles')) { obj['roles'] = ApiClient.convertToType(data['roles'], ['Number']); } @@ -89,7 +90,13 @@ NewInvitation.prototype['email'] = undefined; NewInvitation.prototype['acl'] = undefined; /** - * An array of roleIDs to assign the new user to. + * An indication of whether the user has admin permissions. We recommend using this flag over using the `acl` with value `{\"Role\": 127}`. + * @member {Boolean} isAdmin + */ +NewInvitation.prototype['isAdmin'] = undefined; + +/** + * An array of role IDs to assign to the new user. * @member {Array.} roles */ NewInvitation.prototype['roles'] = undefined; diff --git a/src/model/NewInviteEmail.js b/src/model/NewInviteEmail.js index 8f8b9454..2b9813cf 100644 --- a/src/model/NewInviteEmail.js +++ b/src/model/NewInviteEmail.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewInviteEmail model module. * @module model/NewInviteEmail - * @version 5.0.1 + * @version 6.0.0 */ class NewInviteEmail { /** diff --git a/src/model/NewLoyaltyProgram.js b/src/model/NewLoyaltyProgram.js index b2fb05bf..09a9a1ae 100644 --- a/src/model/NewLoyaltyProgram.js +++ b/src/model/NewLoyaltyProgram.js @@ -17,7 +17,7 @@ import NewLoyaltyTier from './NewLoyaltyTier'; /** * The NewLoyaltyProgram model module. * @module model/NewLoyaltyProgram - * @version 5.0.1 + * @version 6.0.0 */ class NewLoyaltyProgram { /** @@ -163,7 +163,7 @@ NewLoyaltyProgram.prototype['usersPerCardLimit'] = undefined; NewLoyaltyProgram.prototype['sandbox'] = undefined; /** - * The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. + * The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. * @member {String} tiersExpireIn */ NewLoyaltyProgram.prototype['tiersExpireIn'] = undefined; diff --git a/src/model/NewLoyaltyTier.js b/src/model/NewLoyaltyTier.js index a6d4ec47..61976b5e 100644 --- a/src/model/NewLoyaltyTier.js +++ b/src/model/NewLoyaltyTier.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewLoyaltyTier model module. * @module model/NewLoyaltyTier - * @version 5.0.1 + * @version 6.0.0 */ class NewLoyaltyTier { /** diff --git a/src/model/NewManagementKey.js b/src/model/NewManagementKey.js index 2018be91..f3b44b05 100644 --- a/src/model/NewManagementKey.js +++ b/src/model/NewManagementKey.js @@ -17,7 +17,7 @@ import Endpoint from './Endpoint'; /** * The NewManagementKey model module. * @module model/NewManagementKey - * @version 5.0.1 + * @version 6.0.0 */ class NewManagementKey { /** diff --git a/src/model/NewMultipleAudiencesItem.js b/src/model/NewMultipleAudiencesItem.js index baf84910..117861ed 100644 --- a/src/model/NewMultipleAudiencesItem.js +++ b/src/model/NewMultipleAudiencesItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewMultipleAudiencesItem model module. * @module model/NewMultipleAudiencesItem - * @version 5.0.1 + * @version 6.0.0 */ class NewMultipleAudiencesItem { /** diff --git a/src/model/NewNotificationTest.js b/src/model/NewNotificationTest.js new file mode 100644 index 00000000..f9bff9d1 --- /dev/null +++ b/src/model/NewNotificationTest.js @@ -0,0 +1,227 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The NewNotificationTest model module. + * @module model/NewNotificationTest + * @version 6.0.0 + */ +class NewNotificationTest { + /** + * Constructs a new NewNotificationTest. + * @alias module:model/NewNotificationTest + * @param type {module:model/NewNotificationTest.TypeEnum} The notification type. + * @param verb {module:model/NewNotificationTest.VerbEnum} API method for this notification. + * @param url {String} API URL for the given notification. + * @param payload {String} API payload of this notification. + */ + constructor(type, verb, url, payload) { + + NewNotificationTest.initialize(this, type, verb, url, payload); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, type, verb, url, payload) { + obj['type'] = type; + obj['verb'] = verb; + obj['url'] = url; + obj['payload'] = payload; + } + + /** + * Constructs a NewNotificationTest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/NewNotificationTest} obj Optional instance to populate. + * @return {module:model/NewNotificationTest} The populated NewNotificationTest instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new NewNotificationTest(); + + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('queryParams')) { + obj['queryParams'] = ApiClient.convertToType(data['queryParams'], ['String']); + } + if (data.hasOwnProperty('headers')) { + obj['headers'] = ApiClient.convertToType(data['headers'], ['String']); + } + if (data.hasOwnProperty('verb')) { + obj['verb'] = ApiClient.convertToType(data['verb'], 'String'); + } + if (data.hasOwnProperty('url')) { + obj['url'] = ApiClient.convertToType(data['url'], 'String'); + } + if (data.hasOwnProperty('payload')) { + obj['payload'] = ApiClient.convertToType(data['payload'], 'String'); + } + } + return obj; + } + + +} + +/** + * The notification type. + * @member {module:model/NewNotificationTest.TypeEnum} type + */ +NewNotificationTest.prototype['type'] = undefined; + +/** + * Array of query parameters. + * @member {Array.} queryParams + */ +NewNotificationTest.prototype['queryParams'] = undefined; + +/** + * List of API HTTP headers for the given webhook-based notification. + * @member {Array.} headers + */ +NewNotificationTest.prototype['headers'] = undefined; + +/** + * API method for this notification. + * @member {module:model/NewNotificationTest.VerbEnum} verb + */ +NewNotificationTest.prototype['verb'] = undefined; + +/** + * API URL for the given notification. + * @member {String} url + */ +NewNotificationTest.prototype['url'] = undefined; + +/** + * API payload of this notification. + * @member {String} payload + */ +NewNotificationTest.prototype['payload'] = undefined; + + + + + +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +NewNotificationTest['TypeEnum'] = { + + /** + * value: "campaign" + * @const + */ + "campaign": "campaign", + + /** + * value: "loyalty_added_deducted_points" + * @const + */ + "loyalty_added_deducted_points": "loyalty_added_deducted_points", + + /** + * value: "coupon" + * @const + */ + "coupon": "coupon", + + /** + * value: "expiring_points" + * @const + */ + "expiring_points": "expiring_points", + + /** + * value: "pending_to_active_points" + * @const + */ + "pending_to_active_points": "pending_to_active_points", + + /** + * value: "strikethrough_pricing" + * @const + */ + "strikethrough_pricing": "strikethrough_pricing", + + /** + * value: "tier_downgrade" + * @const + */ + "tier_downgrade": "tier_downgrade", + + /** + * value: "tier_upgrade" + * @const + */ + "tier_upgrade": "tier_upgrade", + + /** + * value: "tier_will_downgrade" + * @const + */ + "tier_will_downgrade": "tier_will_downgrade" +}; + + +/** + * Allowed values for the verb property. + * @enum {String} + * @readonly + */ +NewNotificationTest['VerbEnum'] = { + + /** + * value: "POST" + * @const + */ + "POST": "POST", + + /** + * value: "PUT" + * @const + */ + "PUT": "PUT", + + /** + * value: "GET" + * @const + */ + "GET": "GET", + + /** + * value: "DELETE" + * @const + */ + "DELETE": "DELETE", + + /** + * value: "PATCH" + * @const + */ + "PATCH": "PATCH" +}; + + + +export default NewNotificationTest; + diff --git a/src/model/NewNotificationWebhook.js b/src/model/NewNotificationWebhook.js index 676c1396..b98d8c53 100644 --- a/src/model/NewNotificationWebhook.js +++ b/src/model/NewNotificationWebhook.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewNotificationWebhook model module. * @module model/NewNotificationWebhook - * @version 5.0.1 + * @version 6.0.0 */ class NewNotificationWebhook { /** @@ -57,6 +57,9 @@ class NewNotificationWebhook { if (data.hasOwnProperty('headers')) { obj['headers'] = ApiClient.convertToType(data['headers'], ['String']); } + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } } return obj; } @@ -76,6 +79,13 @@ NewNotificationWebhook.prototype['url'] = undefined; */ NewNotificationWebhook.prototype['headers'] = undefined; +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + * @default true + */ +NewNotificationWebhook.prototype['enabled'] = true; + diff --git a/src/model/NewOutgoingIntegrationWebhook.js b/src/model/NewOutgoingIntegrationWebhook.js index b8c1b900..d7d6aee8 100644 --- a/src/model/NewOutgoingIntegrationWebhook.js +++ b/src/model/NewOutgoingIntegrationWebhook.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewOutgoingIntegrationWebhook model module. * @module model/NewOutgoingIntegrationWebhook - * @version 5.0.1 + * @version 6.0.0 */ class NewOutgoingIntegrationWebhook { /** diff --git a/src/model/NewPassword.js b/src/model/NewPassword.js index 42bf3b0f..66c36b6f 100644 --- a/src/model/NewPassword.js +++ b/src/model/NewPassword.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewPassword model module. * @module model/NewPassword - * @version 5.0.1 + * @version 6.0.0 */ class NewPassword { /** diff --git a/src/model/NewPasswordEmail.js b/src/model/NewPasswordEmail.js index e12bcdb3..5209711f 100644 --- a/src/model/NewPasswordEmail.js +++ b/src/model/NewPasswordEmail.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewPasswordEmail model module. * @module model/NewPasswordEmail - * @version 5.0.1 + * @version 6.0.0 */ class NewPasswordEmail { /** diff --git a/src/model/NewPicklist.js b/src/model/NewPicklist.js index 78dd5ed3..84fdf642 100644 --- a/src/model/NewPicklist.js +++ b/src/model/NewPicklist.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewPicklist model module. * @module model/NewPicklist - * @version 5.0.1 + * @version 6.0.0 */ class NewPicklist { /** diff --git a/src/model/NewReferral.js b/src/model/NewReferral.js index da728e83..d3e6f821 100644 --- a/src/model/NewReferral.js +++ b/src/model/NewReferral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewReferral model module. * @module model/NewReferral - * @version 5.0.1 + * @version 6.0.0 */ class NewReferral { /** diff --git a/src/model/NewReferralsForMultipleAdvocates.js b/src/model/NewReferralsForMultipleAdvocates.js index 7ec86949..66c34af0 100644 --- a/src/model/NewReferralsForMultipleAdvocates.js +++ b/src/model/NewReferralsForMultipleAdvocates.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewReferralsForMultipleAdvocates model module. * @module model/NewReferralsForMultipleAdvocates - * @version 5.0.1 + * @version 6.0.0 */ class NewReferralsForMultipleAdvocates { /** diff --git a/src/model/NewReturn.js b/src/model/NewReturn.js index 725a5a9f..6889a875 100644 --- a/src/model/NewReturn.js +++ b/src/model/NewReturn.js @@ -17,7 +17,7 @@ import ReturnedCartItem from './ReturnedCartItem'; /** * The NewReturn model module. * @module model/NewReturn - * @version 5.0.1 + * @version 6.0.0 */ class NewReturn { /** diff --git a/src/model/NewRole.js b/src/model/NewRole.js index bd15c27e..71d95c92 100644 --- a/src/model/NewRole.js +++ b/src/model/NewRole.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewRole model module. * @module model/NewRole - * @version 5.0.1 + * @version 6.0.0 */ class NewRole { /** diff --git a/src/model/NewRoleV2.js b/src/model/NewRoleV2.js index 2362ba08..822bac83 100644 --- a/src/model/NewRoleV2.js +++ b/src/model/NewRoleV2.js @@ -17,7 +17,7 @@ import RoleV2Permissions from './RoleV2Permissions'; /** * The NewRoleV2 model module. * @module model/NewRoleV2 - * @version 5.0.1 + * @version 6.0.0 */ class NewRoleV2 { /** @@ -59,9 +59,6 @@ class NewRoleV2 { if (data.hasOwnProperty('description')) { obj['description'] = ApiClient.convertToType(data['description'], 'String'); } - if (data.hasOwnProperty('isAdmin')) { - obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); - } if (data.hasOwnProperty('permissions')) { obj['permissions'] = RoleV2Permissions.constructFromObject(data['permissions']); } @@ -87,12 +84,6 @@ NewRoleV2.prototype['name'] = undefined; */ NewRoleV2.prototype['description'] = undefined; -/** - * Indicates whether the role grants admin permissions. - * @member {Boolean} isAdmin - */ -NewRoleV2.prototype['isAdmin'] = undefined; - /** * @member {module:model/RoleV2Permissions} permissions */ diff --git a/src/model/NewRuleset.js b/src/model/NewRuleset.js index 7b7a7b97..78346259 100644 --- a/src/model/NewRuleset.js +++ b/src/model/NewRuleset.js @@ -18,7 +18,7 @@ import Rule from './Rule'; /** * The NewRuleset model module. * @module model/NewRuleset - * @version 5.0.1 + * @version 6.0.0 */ class NewRuleset { /** diff --git a/src/model/NewSamlConnection.js b/src/model/NewSamlConnection.js index ca19b439..5c63f4e1 100644 --- a/src/model/NewSamlConnection.js +++ b/src/model/NewSamlConnection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewSamlConnection model module. * @module model/NewSamlConnection - * @version 5.0.1 + * @version 6.0.0 */ class NewSamlConnection { /** diff --git a/src/model/NewStore.js b/src/model/NewStore.js new file mode 100644 index 00000000..4ba98115 --- /dev/null +++ b/src/model/NewStore.js @@ -0,0 +1,106 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The NewStore model module. + * @module model/NewStore + * @version 6.0.0 + */ +class NewStore { + /** + * Constructs a new NewStore. + * + * @alias module:model/NewStore + * @param name {String} The name of the store. + * @param description {String} The description of the store. + * @param integrationId {String} The integration ID of the store. You choose this ID when you create a store. + */ + constructor(name, description, integrationId) { + + NewStore.initialize(this, name, description, integrationId); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name, description, integrationId) { + obj['name'] = name; + obj['description'] = description; + obj['integrationId'] = integrationId; + } + + /** + * Constructs a NewStore from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/NewStore} obj Optional instance to populate. + * @return {module:model/NewStore} The populated NewStore instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new NewStore(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('integrationId')) { + obj['integrationId'] = ApiClient.convertToType(data['integrationId'], 'String'); + } + } + return obj; + } + + +} + +/** + * The name of the store. + * @member {String} name + */ +NewStore.prototype['name'] = undefined; + +/** + * The description of the store. + * @member {String} description + */ +NewStore.prototype['description'] = undefined; + +/** + * The attributes of the store. + * @member {Object} attributes + */ +NewStore.prototype['attributes'] = undefined; + +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} integrationId + */ +NewStore.prototype['integrationId'] = undefined; + + + + + + +export default NewStore; + diff --git a/src/model/NewTemplateDef.js b/src/model/NewTemplateDef.js index ceb76849..88d937e9 100644 --- a/src/model/NewTemplateDef.js +++ b/src/model/NewTemplateDef.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The NewTemplateDef model module. * @module model/NewTemplateDef - * @version 5.0.1 + * @version 6.0.0 */ class NewTemplateDef { /** diff --git a/src/model/NewUser.js b/src/model/NewUser.js index 7c3e08ed..d750da30 100644 --- a/src/model/NewUser.js +++ b/src/model/NewUser.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewUser model module. * @module model/NewUser - * @version 5.0.1 + * @version 6.0.0 */ class NewUser { /** diff --git a/src/model/NewWebhook.js b/src/model/NewWebhook.js index be2c3be8..9fbc80cb 100644 --- a/src/model/NewWebhook.js +++ b/src/model/NewWebhook.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The NewWebhook model module. * @module model/NewWebhook - * @version 5.0.1 + * @version 6.0.0 */ class NewWebhook { /** diff --git a/src/model/Notification.js b/src/model/Notification.js index d6433463..706b467e 100644 --- a/src/model/Notification.js +++ b/src/model/Notification.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Notification model module. * @module model/Notification - * @version 5.0.1 + * @version 6.0.0 */ class Notification { /** diff --git a/src/model/NotificationActivation.js b/src/model/NotificationActivation.js new file mode 100644 index 00000000..4e5812e8 --- /dev/null +++ b/src/model/NotificationActivation.js @@ -0,0 +1,74 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The NotificationActivation model module. + * @module model/NotificationActivation + * @version 6.0.0 + */ +class NotificationActivation { + /** + * Constructs a new NotificationActivation. + * @alias module:model/NotificationActivation + * @param enabled {Boolean} Indicates whether the notification is activated. + */ + constructor(enabled) { + + NotificationActivation.initialize(this, enabled); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, enabled) { + obj['enabled'] = enabled; + } + + /** + * Constructs a NotificationActivation from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/NotificationActivation} obj Optional instance to populate. + * @return {module:model/NotificationActivation} The populated NotificationActivation instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new NotificationActivation(); + + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } + } + return obj; + } + + +} + +/** + * Indicates whether the notification is activated. + * @member {Boolean} enabled + */ +NotificationActivation.prototype['enabled'] = undefined; + + + + + + +export default NotificationActivation; + diff --git a/src/model/NotificationTest.js b/src/model/NotificationTest.js new file mode 100644 index 00000000..6a3a1476 --- /dev/null +++ b/src/model/NotificationTest.js @@ -0,0 +1,85 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The NotificationTest model module. + * @module model/NotificationTest + * @version 6.0.0 + */ +class NotificationTest { + /** + * Constructs a new NotificationTest. + * @alias module:model/NotificationTest + * @param httpResponse {String} The returned http response. + * @param httpStatus {String} The returned http status code and status message. + */ + constructor(httpResponse, httpStatus) { + + NotificationTest.initialize(this, httpResponse, httpStatus); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, httpResponse, httpStatus) { + obj['httpResponse'] = httpResponse; + obj['httpStatus'] = httpStatus; + } + + /** + * Constructs a NotificationTest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/NotificationTest} obj Optional instance to populate. + * @return {module:model/NotificationTest} The populated NotificationTest instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new NotificationTest(); + + if (data.hasOwnProperty('httpResponse')) { + obj['httpResponse'] = ApiClient.convertToType(data['httpResponse'], 'String'); + } + if (data.hasOwnProperty('httpStatus')) { + obj['httpStatus'] = ApiClient.convertToType(data['httpStatus'], 'String'); + } + } + return obj; + } + + +} + +/** + * The returned http response. + * @member {String} httpResponse + */ +NotificationTest.prototype['httpResponse'] = undefined; + +/** + * The returned http status code and status message. + * @member {String} httpStatus + */ +NotificationTest.prototype['httpStatus'] = undefined; + + + + + + +export default NotificationTest; + diff --git a/src/model/OneTimeCode.js b/src/model/OneTimeCode.js new file mode 100644 index 00000000..45f897c6 --- /dev/null +++ b/src/model/OneTimeCode.js @@ -0,0 +1,105 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The OneTimeCode model module. + * @module model/OneTimeCode + * @version 6.0.0 + */ +class OneTimeCode { + /** + * Constructs a new OneTimeCode. + * @alias module:model/OneTimeCode + * @param userId {Number} The ID of the user. + * @param accountId {Number} The ID of the account. + * @param token {String} The two-factor authentication token created during sign-in. This token is used to ensure that the correct user is trying to sign in with a given one-time security code. + */ + constructor(userId, accountId, token) { + + OneTimeCode.initialize(this, userId, accountId, token); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, userId, accountId, token) { + obj['userId'] = userId; + obj['accountId'] = accountId; + obj['token'] = token; + } + + /** + * Constructs a OneTimeCode from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OneTimeCode} obj Optional instance to populate. + * @return {module:model/OneTimeCode} The populated OneTimeCode instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new OneTimeCode(); + + if (data.hasOwnProperty('userId')) { + obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); + } + if (data.hasOwnProperty('accountId')) { + obj['accountId'] = ApiClient.convertToType(data['accountId'], 'Number'); + } + if (data.hasOwnProperty('token')) { + obj['token'] = ApiClient.convertToType(data['token'], 'String'); + } + if (data.hasOwnProperty('code')) { + obj['code'] = ApiClient.convertToType(data['code'], 'String'); + } + } + return obj; + } + + +} + +/** + * The ID of the user. + * @member {Number} userId + */ +OneTimeCode.prototype['userId'] = undefined; + +/** + * The ID of the account. + * @member {Number} accountId + */ +OneTimeCode.prototype['accountId'] = undefined; + +/** + * The two-factor authentication token created during sign-in. This token is used to ensure that the correct user is trying to sign in with a given one-time security code. + * @member {String} token + */ +OneTimeCode.prototype['token'] = undefined; + +/** + * The one-time security code used for signing in. + * @member {String} code + */ +OneTimeCode.prototype['code'] = undefined; + + + + + + +export default OneTimeCode; + diff --git a/src/model/OutgoingIntegrationBrazePolicy.js b/src/model/OutgoingIntegrationBrazePolicy.js index a1e6c2ae..c3419638 100644 --- a/src/model/OutgoingIntegrationBrazePolicy.js +++ b/src/model/OutgoingIntegrationBrazePolicy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The OutgoingIntegrationBrazePolicy model module. * @module model/OutgoingIntegrationBrazePolicy - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationBrazePolicy { /** diff --git a/src/model/OutgoingIntegrationCleverTapPolicy.js b/src/model/OutgoingIntegrationCleverTapPolicy.js new file mode 100644 index 00000000..e91ff1c0 --- /dev/null +++ b/src/model/OutgoingIntegrationCleverTapPolicy.js @@ -0,0 +1,96 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The OutgoingIntegrationCleverTapPolicy model module. + * @module model/OutgoingIntegrationCleverTapPolicy + * @version 6.0.0 + */ +class OutgoingIntegrationCleverTapPolicy { + /** + * Constructs a new OutgoingIntegrationCleverTapPolicy. + * @alias module:model/OutgoingIntegrationCleverTapPolicy + * @param baseUrl {String} The base URL that is based on the region key of your CleverTap account. + * @param accountId {String} The CleverTap Project ID. + * @param passcode {String} The CleverTap Project passcode. + */ + constructor(baseUrl, accountId, passcode) { + + OutgoingIntegrationCleverTapPolicy.initialize(this, baseUrl, accountId, passcode); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, baseUrl, accountId, passcode) { + obj['baseUrl'] = baseUrl; + obj['accountId'] = accountId; + obj['passcode'] = passcode; + } + + /** + * Constructs a OutgoingIntegrationCleverTapPolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OutgoingIntegrationCleverTapPolicy} obj Optional instance to populate. + * @return {module:model/OutgoingIntegrationCleverTapPolicy} The populated OutgoingIntegrationCleverTapPolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new OutgoingIntegrationCleverTapPolicy(); + + if (data.hasOwnProperty('baseUrl')) { + obj['baseUrl'] = ApiClient.convertToType(data['baseUrl'], 'String'); + } + if (data.hasOwnProperty('accountId')) { + obj['accountId'] = ApiClient.convertToType(data['accountId'], 'String'); + } + if (data.hasOwnProperty('passcode')) { + obj['passcode'] = ApiClient.convertToType(data['passcode'], 'String'); + } + } + return obj; + } + + +} + +/** + * The base URL that is based on the region key of your CleverTap account. + * @member {String} baseUrl + */ +OutgoingIntegrationCleverTapPolicy.prototype['baseUrl'] = undefined; + +/** + * The CleverTap Project ID. + * @member {String} accountId + */ +OutgoingIntegrationCleverTapPolicy.prototype['accountId'] = undefined; + +/** + * The CleverTap Project passcode. + * @member {String} passcode + */ +OutgoingIntegrationCleverTapPolicy.prototype['passcode'] = undefined; + + + + + + +export default OutgoingIntegrationCleverTapPolicy; + diff --git a/src/model/OutgoingIntegrationConfiguration.js b/src/model/OutgoingIntegrationConfiguration.js index 65332b2f..8b45abe3 100644 --- a/src/model/OutgoingIntegrationConfiguration.js +++ b/src/model/OutgoingIntegrationConfiguration.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The OutgoingIntegrationConfiguration model module. * @module model/OutgoingIntegrationConfiguration - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationConfiguration { /** diff --git a/src/model/OutgoingIntegrationIterablePolicy.js b/src/model/OutgoingIntegrationIterablePolicy.js new file mode 100644 index 00000000..1c7accb9 --- /dev/null +++ b/src/model/OutgoingIntegrationIterablePolicy.js @@ -0,0 +1,85 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The OutgoingIntegrationIterablePolicy model module. + * @module model/OutgoingIntegrationIterablePolicy + * @version 6.0.0 + */ +class OutgoingIntegrationIterablePolicy { + /** + * Constructs a new OutgoingIntegrationIterablePolicy. + * @alias module:model/OutgoingIntegrationIterablePolicy + * @param baseUrl {String} The base URL that is based on the region key of your Iterable account. + * @param apiKey {String} The API key generated from your Iterable account. See [Iterable API Key Guide](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) + */ + constructor(baseUrl, apiKey) { + + OutgoingIntegrationIterablePolicy.initialize(this, baseUrl, apiKey); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, baseUrl, apiKey) { + obj['baseUrl'] = baseUrl; + obj['apiKey'] = apiKey; + } + + /** + * Constructs a OutgoingIntegrationIterablePolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OutgoingIntegrationIterablePolicy} obj Optional instance to populate. + * @return {module:model/OutgoingIntegrationIterablePolicy} The populated OutgoingIntegrationIterablePolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new OutgoingIntegrationIterablePolicy(); + + if (data.hasOwnProperty('baseUrl')) { + obj['baseUrl'] = ApiClient.convertToType(data['baseUrl'], 'String'); + } + if (data.hasOwnProperty('apiKey')) { + obj['apiKey'] = ApiClient.convertToType(data['apiKey'], 'String'); + } + } + return obj; + } + + +} + +/** + * The base URL that is based on the region key of your Iterable account. + * @member {String} baseUrl + */ +OutgoingIntegrationIterablePolicy.prototype['baseUrl'] = undefined; + +/** + * The API key generated from your Iterable account. See [Iterable API Key Guide](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) + * @member {String} apiKey + */ +OutgoingIntegrationIterablePolicy.prototype['apiKey'] = undefined; + + + + + + +export default OutgoingIntegrationIterablePolicy; + diff --git a/src/model/OutgoingIntegrationMoEngagePolicy.js b/src/model/OutgoingIntegrationMoEngagePolicy.js new file mode 100644 index 00000000..eaa34f9c --- /dev/null +++ b/src/model/OutgoingIntegrationMoEngagePolicy.js @@ -0,0 +1,107 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The OutgoingIntegrationMoEngagePolicy model module. + * @module model/OutgoingIntegrationMoEngagePolicy + * @version 6.0.0 + */ +class OutgoingIntegrationMoEngagePolicy { + /** + * Constructs a new OutgoingIntegrationMoEngagePolicy. + * @alias module:model/OutgoingIntegrationMoEngagePolicy + * @param baseUrl {String} The base URL of your MoEngage deployment, containing the MoEngage data center number (represented by `0X`). + * @param appId {String} MoEngage APP ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + * @param dataApiId {String} MoEngage DATA API ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + * @param dataApiKey {String} MoEngage DATA API Key. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + */ + constructor(baseUrl, appId, dataApiId, dataApiKey) { + + OutgoingIntegrationMoEngagePolicy.initialize(this, baseUrl, appId, dataApiId, dataApiKey); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, baseUrl, appId, dataApiId, dataApiKey) { + obj['baseUrl'] = baseUrl; + obj['appId'] = appId; + obj['dataApiId'] = dataApiId; + obj['dataApiKey'] = dataApiKey; + } + + /** + * Constructs a OutgoingIntegrationMoEngagePolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OutgoingIntegrationMoEngagePolicy} obj Optional instance to populate. + * @return {module:model/OutgoingIntegrationMoEngagePolicy} The populated OutgoingIntegrationMoEngagePolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new OutgoingIntegrationMoEngagePolicy(); + + if (data.hasOwnProperty('baseUrl')) { + obj['baseUrl'] = ApiClient.convertToType(data['baseUrl'], 'String'); + } + if (data.hasOwnProperty('appId')) { + obj['appId'] = ApiClient.convertToType(data['appId'], 'String'); + } + if (data.hasOwnProperty('dataApiId')) { + obj['dataApiId'] = ApiClient.convertToType(data['dataApiId'], 'String'); + } + if (data.hasOwnProperty('dataApiKey')) { + obj['dataApiKey'] = ApiClient.convertToType(data['dataApiKey'], 'String'); + } + } + return obj; + } + + +} + +/** + * The base URL of your MoEngage deployment, containing the MoEngage data center number (represented by `0X`). + * @member {String} baseUrl + */ +OutgoingIntegrationMoEngagePolicy.prototype['baseUrl'] = undefined; + +/** + * MoEngage APP ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + * @member {String} appId + */ +OutgoingIntegrationMoEngagePolicy.prototype['appId'] = undefined; + +/** + * MoEngage DATA API ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + * @member {String} dataApiId + */ +OutgoingIntegrationMoEngagePolicy.prototype['dataApiId'] = undefined; + +/** + * MoEngage DATA API Key. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). + * @member {String} dataApiKey + */ +OutgoingIntegrationMoEngagePolicy.prototype['dataApiKey'] = undefined; + + + + + + +export default OutgoingIntegrationMoEngagePolicy; + diff --git a/src/model/OutgoingIntegrationTemplate.js b/src/model/OutgoingIntegrationTemplate.js index 943db738..5d8d8a05 100644 --- a/src/model/OutgoingIntegrationTemplate.js +++ b/src/model/OutgoingIntegrationTemplate.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The OutgoingIntegrationTemplate model module. * @module model/OutgoingIntegrationTemplate - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationTemplate { /** diff --git a/src/model/OutgoingIntegrationTemplateWithConfigurationDetails.js b/src/model/OutgoingIntegrationTemplateWithConfigurationDetails.js index f54a3385..e08a54bb 100644 --- a/src/model/OutgoingIntegrationTemplateWithConfigurationDetails.js +++ b/src/model/OutgoingIntegrationTemplateWithConfigurationDetails.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The OutgoingIntegrationTemplateWithConfigurationDetails model module. * @module model/OutgoingIntegrationTemplateWithConfigurationDetails - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationTemplateWithConfigurationDetails { /** diff --git a/src/model/OutgoingIntegrationTemplates.js b/src/model/OutgoingIntegrationTemplates.js index 255e9872..2b2e0da0 100644 --- a/src/model/OutgoingIntegrationTemplates.js +++ b/src/model/OutgoingIntegrationTemplates.js @@ -17,7 +17,7 @@ import OutgoingIntegrationTemplate from './OutgoingIntegrationTemplate'; /** * The OutgoingIntegrationTemplates model module. * @module model/OutgoingIntegrationTemplates - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationTemplates { /** diff --git a/src/model/OutgoingIntegrationType.js b/src/model/OutgoingIntegrationType.js index 91ad36c6..aa2c929d 100644 --- a/src/model/OutgoingIntegrationType.js +++ b/src/model/OutgoingIntegrationType.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The OutgoingIntegrationType model module. * @module model/OutgoingIntegrationType - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationType { /** diff --git a/src/model/OutgoingIntegrationTypes.js b/src/model/OutgoingIntegrationTypes.js index 0d61a55f..4900db77 100644 --- a/src/model/OutgoingIntegrationTypes.js +++ b/src/model/OutgoingIntegrationTypes.js @@ -17,7 +17,7 @@ import OutgoingIntegrationType from './OutgoingIntegrationType'; /** * The OutgoingIntegrationTypes model module. * @module model/OutgoingIntegrationTypes - * @version 5.0.1 + * @version 6.0.0 */ class OutgoingIntegrationTypes { /** diff --git a/src/model/PatchItemCatalogAction.js b/src/model/PatchItemCatalogAction.js index 0ae1f69c..3945edac 100644 --- a/src/model/PatchItemCatalogAction.js +++ b/src/model/PatchItemCatalogAction.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The PatchItemCatalogAction model module. * @module model/PatchItemCatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class PatchItemCatalogAction { /** diff --git a/src/model/PatchManyItemsCatalogAction.js b/src/model/PatchManyItemsCatalogAction.js index 343e4bc6..a1bdacf7 100644 --- a/src/model/PatchManyItemsCatalogAction.js +++ b/src/model/PatchManyItemsCatalogAction.js @@ -17,7 +17,7 @@ import CatalogActionFilter from './CatalogActionFilter'; /** * The PatchManyItemsCatalogAction model module. * @module model/PatchManyItemsCatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class PatchManyItemsCatalogAction { /** diff --git a/src/model/PendingPointsNotificationPolicy.js b/src/model/PendingPointsNotificationPolicy.js index 3bc0ecb7..19b3356e 100644 --- a/src/model/PendingPointsNotificationPolicy.js +++ b/src/model/PendingPointsNotificationPolicy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The PendingPointsNotificationPolicy model module. * @module model/PendingPointsNotificationPolicy - * @version 5.0.1 + * @version 6.0.0 */ class PendingPointsNotificationPolicy { /** diff --git a/src/model/Picklist.js b/src/model/Picklist.js index b30dd6d1..69a4c591 100644 --- a/src/model/Picklist.js +++ b/src/model/Picklist.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Picklist model module. * @module model/Picklist - * @version 5.0.1 + * @version 6.0.0 */ class Picklist { /** diff --git a/src/model/ProfileAudiencesChanges.js b/src/model/ProfileAudiencesChanges.js index c5dca5ef..977debef 100644 --- a/src/model/ProfileAudiencesChanges.js +++ b/src/model/ProfileAudiencesChanges.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ProfileAudiencesChanges model module. * @module model/ProfileAudiencesChanges - * @version 5.0.1 + * @version 6.0.0 */ class ProfileAudiencesChanges { /** diff --git a/src/model/RedeemReferralEffectProps.js b/src/model/RedeemReferralEffectProps.js index c32b201a..14c7f15a 100644 --- a/src/model/RedeemReferralEffectProps.js +++ b/src/model/RedeemReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RedeemReferralEffectProps model module. * @module model/RedeemReferralEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RedeemReferralEffectProps { /** diff --git a/src/model/Referral.js b/src/model/Referral.js index aeed980c..a5be66cf 100644 --- a/src/model/Referral.js +++ b/src/model/Referral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Referral model module. * @module model/Referral - * @version 5.0.1 + * @version 6.0.0 */ class Referral { /** diff --git a/src/model/ReferralConstraints.js b/src/model/ReferralConstraints.js index 1c0335e9..8a9320c8 100644 --- a/src/model/ReferralConstraints.js +++ b/src/model/ReferralConstraints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReferralConstraints model module. * @module model/ReferralConstraints - * @version 5.0.1 + * @version 6.0.0 */ class ReferralConstraints { /** diff --git a/src/model/ReferralCreatedEffectProps.js b/src/model/ReferralCreatedEffectProps.js index 97630562..5f75ca0f 100644 --- a/src/model/ReferralCreatedEffectProps.js +++ b/src/model/ReferralCreatedEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReferralCreatedEffectProps model module. * @module model/ReferralCreatedEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class ReferralCreatedEffectProps { /** diff --git a/src/model/ReferralRejectionReason.js b/src/model/ReferralRejectionReason.js index ced02ea8..c5be7c5a 100644 --- a/src/model/ReferralRejectionReason.js +++ b/src/model/ReferralRejectionReason.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReferralRejectionReason model module. * @module model/ReferralRejectionReason - * @version 5.0.1 + * @version 6.0.0 */ class ReferralRejectionReason { /** diff --git a/src/model/RejectCouponEffectProps.js b/src/model/RejectCouponEffectProps.js index abf0eaaa..52f0ab7d 100644 --- a/src/model/RejectCouponEffectProps.js +++ b/src/model/RejectCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RejectCouponEffectProps model module. * @module model/RejectCouponEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RejectCouponEffectProps { /** diff --git a/src/model/RejectReferralEffectProps.js b/src/model/RejectReferralEffectProps.js index c3589aea..c283b4de 100644 --- a/src/model/RejectReferralEffectProps.js +++ b/src/model/RejectReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RejectReferralEffectProps model module. * @module model/RejectReferralEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RejectReferralEffectProps { /** diff --git a/src/model/RemoveFromAudienceEffectProps.js b/src/model/RemoveFromAudienceEffectProps.js new file mode 100644 index 00000000..5859fa02 --- /dev/null +++ b/src/model/RemoveFromAudienceEffectProps.js @@ -0,0 +1,100 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The RemoveFromAudienceEffectProps model module. + * @module model/RemoveFromAudienceEffectProps + * @version 6.0.0 + */ +class RemoveFromAudienceEffectProps { + /** + * Constructs a new RemoveFromAudienceEffectProps. + * The properties specific to the \"removeFromAudience\" effect. This gets triggered whenever a validated rule contains a \"removeFromAudience\" effect. + * @alias module:model/RemoveFromAudienceEffectProps + */ + constructor() { + + RemoveFromAudienceEffectProps.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a RemoveFromAudienceEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RemoveFromAudienceEffectProps} obj Optional instance to populate. + * @return {module:model/RemoveFromAudienceEffectProps} The populated RemoveFromAudienceEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new RemoveFromAudienceEffectProps(); + + if (data.hasOwnProperty('audienceId')) { + obj['audienceId'] = ApiClient.convertToType(data['audienceId'], 'Number'); + } + if (data.hasOwnProperty('audienceName')) { + obj['audienceName'] = ApiClient.convertToType(data['audienceName'], 'String'); + } + if (data.hasOwnProperty('profileIntegrationId')) { + obj['profileIntegrationId'] = ApiClient.convertToType(data['profileIntegrationId'], 'String'); + } + if (data.hasOwnProperty('profileId')) { + obj['profileId'] = ApiClient.convertToType(data['profileId'], 'Number'); + } + } + return obj; + } + + +} + +/** + * The internal ID of the audience. + * @member {Number} audienceId + */ +RemoveFromAudienceEffectProps.prototype['audienceId'] = undefined; + +/** + * The name of the audience. + * @member {String} audienceName + */ +RemoveFromAudienceEffectProps.prototype['audienceName'] = undefined; + +/** + * The ID of the customer profile in the third-party integration platform. + * @member {String} profileIntegrationId + */ +RemoveFromAudienceEffectProps.prototype['profileIntegrationId'] = undefined; + +/** + * The internal ID of the customer profile. + * @member {Number} profileId + */ +RemoveFromAudienceEffectProps.prototype['profileId'] = undefined; + + + + + + +export default RemoveFromAudienceEffectProps; + diff --git a/src/model/RemoveItemCatalogAction.js b/src/model/RemoveItemCatalogAction.js index 1fad9478..2bc2dd1a 100644 --- a/src/model/RemoveItemCatalogAction.js +++ b/src/model/RemoveItemCatalogAction.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RemoveItemCatalogAction model module. * @module model/RemoveItemCatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class RemoveItemCatalogAction { /** diff --git a/src/model/RemoveManyItemsCatalogAction.js b/src/model/RemoveManyItemsCatalogAction.js index 32dadb63..a5b23935 100644 --- a/src/model/RemoveManyItemsCatalogAction.js +++ b/src/model/RemoveManyItemsCatalogAction.js @@ -17,7 +17,7 @@ import CatalogActionFilter from './CatalogActionFilter'; /** * The RemoveManyItemsCatalogAction model module. * @module model/RemoveManyItemsCatalogAction - * @version 5.0.1 + * @version 6.0.0 */ class RemoveManyItemsCatalogAction { /** diff --git a/src/model/ReopenSessionResponse.js b/src/model/ReopenSessionResponse.js index 2316f1d3..d10fa289 100644 --- a/src/model/ReopenSessionResponse.js +++ b/src/model/ReopenSessionResponse.js @@ -17,7 +17,7 @@ import Effect from './Effect'; /** * The ReopenSessionResponse model module. * @module model/ReopenSessionResponse - * @version 5.0.1 + * @version 6.0.0 */ class ReopenSessionResponse { /** diff --git a/src/model/ReserveCouponEffectProps.js b/src/model/ReserveCouponEffectProps.js index 49431de4..2073c2a8 100644 --- a/src/model/ReserveCouponEffectProps.js +++ b/src/model/ReserveCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReserveCouponEffectProps model module. * @module model/ReserveCouponEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class ReserveCouponEffectProps { /** diff --git a/src/model/ReturnIntegrationRequest.js b/src/model/ReturnIntegrationRequest.js index 96b4ec05..6c600cc7 100644 --- a/src/model/ReturnIntegrationRequest.js +++ b/src/model/ReturnIntegrationRequest.js @@ -17,7 +17,7 @@ import NewReturn from './NewReturn'; /** * The ReturnIntegrationRequest model module. * @module model/ReturnIntegrationRequest - * @version 5.0.1 + * @version 6.0.0 */ class ReturnIntegrationRequest { /** diff --git a/src/model/ReturnedCartItem.js b/src/model/ReturnedCartItem.js index 55840b36..ad8e5904 100644 --- a/src/model/ReturnedCartItem.js +++ b/src/model/ReturnedCartItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReturnedCartItem model module. * @module model/ReturnedCartItem - * @version 5.0.1 + * @version 6.0.0 */ class ReturnedCartItem { /** @@ -69,7 +69,7 @@ class ReturnedCartItem { ReturnedCartItem.prototype['position'] = undefined; /** - * Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. + * Number of cart items to return. * @member {Number} quantity */ ReturnedCartItem.prototype['quantity'] = undefined; diff --git a/src/model/Role.js b/src/model/Role.js index e6ec72f8..bc0b96ac 100644 --- a/src/model/Role.js +++ b/src/model/Role.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Role model module. * @module model/Role - * @version 5.0.1 + * @version 6.0.0 */ class Role { /** diff --git a/src/model/RoleAssign.js b/src/model/RoleAssign.js index 4e80d665..170c38f5 100644 --- a/src/model/RoleAssign.js +++ b/src/model/RoleAssign.js @@ -16,15 +16,15 @@ import ApiClient from '../ApiClient'; /** * The RoleAssign model module. * @module model/RoleAssign - * @version 5.0.1 + * @version 6.0.0 */ class RoleAssign { /** * Constructs a new RoleAssign. * * @alias module:model/RoleAssign - * @param users {Array.} An array of userIDs. - * @param roles {Array.} An array of roleIDs. + * @param users {Array.} An array of user IDs. + * @param roles {Array.} An array of role IDs. */ constructor(users, roles) { @@ -66,13 +66,13 @@ class RoleAssign { } /** - * An array of userIDs. + * An array of user IDs. * @member {Array.} users */ RoleAssign.prototype['users'] = undefined; /** - * An array of roleIDs. + * An array of role IDs. * @member {Array.} roles */ RoleAssign.prototype['roles'] = undefined; diff --git a/src/model/RoleMembership.js b/src/model/RoleMembership.js index b06ab22d..94009261 100644 --- a/src/model/RoleMembership.js +++ b/src/model/RoleMembership.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RoleMembership model module. * @module model/RoleMembership - * @version 5.0.1 + * @version 6.0.0 */ class RoleMembership { /** diff --git a/src/model/RoleV2.js b/src/model/RoleV2.js index 2c450e2d..1cb1c624 100644 --- a/src/model/RoleV2.js +++ b/src/model/RoleV2.js @@ -17,7 +17,7 @@ import RoleV2Permissions from './RoleV2Permissions'; /** * The RoleV2 model module. * @module model/RoleV2 - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2 { /** @@ -75,9 +75,6 @@ class RoleV2 { if (data.hasOwnProperty('description')) { obj['description'] = ApiClient.convertToType(data['description'], 'String'); } - if (data.hasOwnProperty('isAdmin')) { - obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); - } if (data.hasOwnProperty('permissions')) { obj['permissions'] = RoleV2Permissions.constructFromObject(data['permissions']); } @@ -127,12 +124,6 @@ RoleV2.prototype['name'] = undefined; */ RoleV2.prototype['description'] = undefined; -/** - * Indicates whether the role grants admin permissions. - * @member {Boolean} isAdmin - */ -RoleV2.prototype['isAdmin'] = undefined; - /** * @member {module:model/RoleV2Permissions} permissions */ diff --git a/src/model/RoleV2ApplicationDetails.js b/src/model/RoleV2ApplicationDetails.js index 373097af..0767a9da 100644 --- a/src/model/RoleV2ApplicationDetails.js +++ b/src/model/RoleV2ApplicationDetails.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RoleV2ApplicationDetails model module. * @module model/RoleV2ApplicationDetails - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2ApplicationDetails { /** @@ -56,6 +56,9 @@ class RoleV2ApplicationDetails { if (data.hasOwnProperty('draftCampaign')) { obj['draftCampaign'] = ApiClient.convertToType(data['draftCampaign'], 'String'); } + if (data.hasOwnProperty('tools')) { + obj['tools'] = ApiClient.convertToType(data['tools'], 'String'); + } } return obj; } @@ -81,6 +84,12 @@ RoleV2ApplicationDetails.prototype['campaign'] = undefined; */ RoleV2ApplicationDetails.prototype['draftCampaign'] = undefined; +/** + * Name of the tools-related permission set. + * @member {String} tools + */ +RoleV2ApplicationDetails.prototype['tools'] = undefined; + diff --git a/src/model/RoleV2Base.js b/src/model/RoleV2Base.js index 1bcc0639..4e45b86c 100644 --- a/src/model/RoleV2Base.js +++ b/src/model/RoleV2Base.js @@ -17,7 +17,7 @@ import RoleV2Permissions from './RoleV2Permissions'; /** * The RoleV2Base model module. * @module model/RoleV2Base - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2Base { /** @@ -54,9 +54,6 @@ class RoleV2Base { if (data.hasOwnProperty('description')) { obj['description'] = ApiClient.convertToType(data['description'], 'String'); } - if (data.hasOwnProperty('isAdmin')) { - obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); - } if (data.hasOwnProperty('permissions')) { obj['permissions'] = RoleV2Permissions.constructFromObject(data['permissions']); } @@ -82,12 +79,6 @@ RoleV2Base.prototype['name'] = undefined; */ RoleV2Base.prototype['description'] = undefined; -/** - * Indicates whether the role grants admin permissions. - * @member {Boolean} isAdmin - */ -RoleV2Base.prototype['isAdmin'] = undefined; - /** * @member {module:model/RoleV2Permissions} permissions */ diff --git a/src/model/RoleV2PermissionSet.js b/src/model/RoleV2PermissionSet.js index c302ec3d..3c8df77e 100644 --- a/src/model/RoleV2PermissionSet.js +++ b/src/model/RoleV2PermissionSet.js @@ -16,14 +16,14 @@ import ApiClient from '../ApiClient'; /** * The RoleV2PermissionSet model module. * @module model/RoleV2PermissionSet - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2PermissionSet { /** * Constructs a new RoleV2PermissionSet. * @alias module:model/RoleV2PermissionSet * @param name {String} Name of the permission set. - * @param logicalOperations {Array.} List of logical operations in the permission set. Each logical operation must be shown under the `x-logicalPermissionOperation` tag on an endpoint level. + * @param logicalOperations {Array.} List of logical operations in the permission set. Each logical operation must be shown under the `x-permission` tag on an endpoint level. */ constructor(name, logicalOperations) { @@ -71,7 +71,7 @@ class RoleV2PermissionSet { RoleV2PermissionSet.prototype['name'] = undefined; /** - * List of logical operations in the permission set. Each logical operation must be shown under the `x-logicalPermissionOperation` tag on an endpoint level. + * List of logical operations in the permission set. Each logical operation must be shown under the `x-permission` tag on an endpoint level. * @member {Array.} logicalOperations */ RoleV2PermissionSet.prototype['logicalOperations'] = undefined; diff --git a/src/model/RoleV2Permissions.js b/src/model/RoleV2Permissions.js index 10aff446..f4ce8eea 100644 --- a/src/model/RoleV2Permissions.js +++ b/src/model/RoleV2Permissions.js @@ -18,7 +18,7 @@ import RoleV2RolesGroup from './RoleV2RolesGroup'; /** * The RoleV2Permissions model module. * @module model/RoleV2Permissions - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2Permissions { /** diff --git a/src/model/RoleV2RolesGroup.js b/src/model/RoleV2RolesGroup.js index 343b125a..2566dfbe 100644 --- a/src/model/RoleV2RolesGroup.js +++ b/src/model/RoleV2RolesGroup.js @@ -17,7 +17,7 @@ import RoleV2ApplicationDetails from './RoleV2ApplicationDetails'; /** * The RoleV2RolesGroup model module. * @module model/RoleV2RolesGroup - * @version 5.0.1 + * @version 6.0.0 */ class RoleV2RolesGroup { /** diff --git a/src/model/RollbackAddedLoyaltyPointsEffectProps.js b/src/model/RollbackAddedLoyaltyPointsEffectProps.js index bc29617e..e9b1a20f 100644 --- a/src/model/RollbackAddedLoyaltyPointsEffectProps.js +++ b/src/model/RollbackAddedLoyaltyPointsEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackAddedLoyaltyPointsEffectProps model module. * @module model/RollbackAddedLoyaltyPointsEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RollbackAddedLoyaltyPointsEffectProps { /** @@ -126,7 +126,7 @@ RollbackAddedLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined; RollbackAddedLoyaltyPointsEffectProps.prototype['cartItemPosition'] = undefined; /** - * The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. + * For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back. * @member {Number} cartItemSubPosition */ RollbackAddedLoyaltyPointsEffectProps.prototype['cartItemSubPosition'] = undefined; diff --git a/src/model/RollbackCouponEffectProps.js b/src/model/RollbackCouponEffectProps.js index 344d6ebd..a88c81ec 100644 --- a/src/model/RollbackCouponEffectProps.js +++ b/src/model/RollbackCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackCouponEffectProps model module. * @module model/RollbackCouponEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RollbackCouponEffectProps { /** diff --git a/src/model/RollbackDeductedLoyaltyPointsEffectProps.js b/src/model/RollbackDeductedLoyaltyPointsEffectProps.js index 352a852f..b948f597 100644 --- a/src/model/RollbackDeductedLoyaltyPointsEffectProps.js +++ b/src/model/RollbackDeductedLoyaltyPointsEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackDeductedLoyaltyPointsEffectProps model module. * @module model/RollbackDeductedLoyaltyPointsEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RollbackDeductedLoyaltyPointsEffectProps { /** diff --git a/src/model/RollbackDiscountEffectProps.js b/src/model/RollbackDiscountEffectProps.js index 6aa3447c..701999fc 100644 --- a/src/model/RollbackDiscountEffectProps.js +++ b/src/model/RollbackDiscountEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackDiscountEffectProps model module. * @module model/RollbackDiscountEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RollbackDiscountEffectProps { /** @@ -99,7 +99,7 @@ RollbackDiscountEffectProps.prototype['value'] = undefined; RollbackDiscountEffectProps.prototype['cartItemPosition'] = undefined; /** - * The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled. + * For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item. * @member {Number} cartItemSubPosition */ RollbackDiscountEffectProps.prototype['cartItemSubPosition'] = undefined; diff --git a/src/model/RollbackReferralEffectProps.js b/src/model/RollbackReferralEffectProps.js index d85e3563..39f3ef10 100644 --- a/src/model/RollbackReferralEffectProps.js +++ b/src/model/RollbackReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackReferralEffectProps model module. * @module model/RollbackReferralEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class RollbackReferralEffectProps { /** diff --git a/src/model/Rule.js b/src/model/Rule.js index 198b6f00..017189fa 100644 --- a/src/model/Rule.js +++ b/src/model/Rule.js @@ -17,7 +17,7 @@ import Binding from './Binding'; /** * The Rule model module. * @module model/Rule - * @version 5.0.1 + * @version 6.0.0 */ class Rule { /** diff --git a/src/model/RuleFailureReason.js b/src/model/RuleFailureReason.js index a5676759..5819aa90 100644 --- a/src/model/RuleFailureReason.js +++ b/src/model/RuleFailureReason.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RuleFailureReason model module. * @module model/RuleFailureReason - * @version 5.0.1 + * @version 6.0.0 */ class RuleFailureReason { /** diff --git a/src/model/Ruleset.js b/src/model/Ruleset.js index 44e82bc8..5771e688 100644 --- a/src/model/Ruleset.js +++ b/src/model/Ruleset.js @@ -18,7 +18,7 @@ import Rule from './Rule'; /** * The Ruleset model module. * @module model/Ruleset - * @version 5.0.1 + * @version 6.0.0 */ class Ruleset { /** diff --git a/src/model/SSOConfig.js b/src/model/SSOConfig.js new file mode 100644 index 00000000..f0d92bec --- /dev/null +++ b/src/model/SSOConfig.js @@ -0,0 +1,74 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The SSOConfig model module. + * @module model/SSOConfig + * @version 6.0.0 + */ +class SSOConfig { + /** + * Constructs a new SSOConfig. + * @alias module:model/SSOConfig + * @param enforced {Boolean} An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. + */ + constructor(enforced) { + + SSOConfig.initialize(this, enforced); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, enforced) { + obj['enforced'] = enforced; + } + + /** + * Constructs a SSOConfig from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SSOConfig} obj Optional instance to populate. + * @return {module:model/SSOConfig} The populated SSOConfig instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new SSOConfig(); + + if (data.hasOwnProperty('enforced')) { + obj['enforced'] = ApiClient.convertToType(data['enforced'], 'Boolean'); + } + } + return obj; + } + + +} + +/** + * An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. + * @member {Boolean} enforced + */ +SSOConfig.prototype['enforced'] = undefined; + + + + + + +export default SSOConfig; + diff --git a/src/model/SamlConnection.js b/src/model/SamlConnection.js index 5644c80f..c6f6d9a1 100644 --- a/src/model/SamlConnection.js +++ b/src/model/SamlConnection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SamlConnection model module. * @module model/SamlConnection - * @version 5.0.1 + * @version 6.0.0 */ class SamlConnection { /** diff --git a/src/model/SamlConnectionMetadata.js b/src/model/SamlConnectionMetadata.js index ae9f1798..1ff343ae 100644 --- a/src/model/SamlConnectionMetadata.js +++ b/src/model/SamlConnectionMetadata.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SamlConnectionMetadata model module. * @module model/SamlConnectionMetadata - * @version 5.0.1 + * @version 6.0.0 */ class SamlConnectionMetadata { /** diff --git a/src/model/SamlLoginEndpoint.js b/src/model/SamlLoginEndpoint.js index 9ce8197f..59b64e4a 100644 --- a/src/model/SamlLoginEndpoint.js +++ b/src/model/SamlLoginEndpoint.js @@ -16,18 +16,19 @@ import ApiClient from '../ApiClient'; /** * The SamlLoginEndpoint model module. * @module model/SamlLoginEndpoint - * @version 5.0.1 + * @version 6.0.0 */ class SamlLoginEndpoint { /** * Constructs a new SamlLoginEndpoint. * @alias module:model/SamlLoginEndpoint + * @param id {Number} ID of the SAML login endpoint. * @param name {String} ID of the SAML service. * @param loginURL {String} Single Sign-On URL. */ - constructor(name, loginURL) { + constructor(id, name, loginURL) { - SamlLoginEndpoint.initialize(this, name, loginURL); + SamlLoginEndpoint.initialize(this, id, name, loginURL); } /** @@ -35,7 +36,8 @@ class SamlLoginEndpoint { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, name, loginURL) { + static initialize(obj, id, name, loginURL) { + obj['id'] = id; obj['name'] = name; obj['loginURL'] = loginURL; } @@ -51,6 +53,9 @@ class SamlLoginEndpoint { if (data) { obj = obj || new SamlLoginEndpoint(); + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } if (data.hasOwnProperty('name')) { obj['name'] = ApiClient.convertToType(data['name'], 'String'); } @@ -64,6 +69,12 @@ class SamlLoginEndpoint { } +/** + * ID of the SAML login endpoint. + * @member {Number} id + */ +SamlLoginEndpoint.prototype['id'] = undefined; + /** * ID of the SAML service. * @member {String} name diff --git a/src/model/Session.js b/src/model/Session.js index 84fc00bd..3cc44684 100644 --- a/src/model/Session.js +++ b/src/model/Session.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Session model module. * @module model/Session - * @version 5.0.1 + * @version 6.0.0 */ class Session { /** diff --git a/src/model/SetDiscountEffectProps.js b/src/model/SetDiscountEffectProps.js index 683b0cd9..5c5987d4 100644 --- a/src/model/SetDiscountEffectProps.js +++ b/src/model/SetDiscountEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountEffectProps model module. * @module model/SetDiscountEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class SetDiscountEffectProps { /** diff --git a/src/model/SetDiscountPerAdditionalCostEffectProps.js b/src/model/SetDiscountPerAdditionalCostEffectProps.js index 70a8d431..d7e2bcfa 100644 --- a/src/model/SetDiscountPerAdditionalCostEffectProps.js +++ b/src/model/SetDiscountPerAdditionalCostEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountPerAdditionalCostEffectProps model module. * @module model/SetDiscountPerAdditionalCostEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class SetDiscountPerAdditionalCostEffectProps { /** diff --git a/src/model/SetDiscountPerAdditionalCostPerItemEffectProps.js b/src/model/SetDiscountPerAdditionalCostPerItemEffectProps.js index a2b97330..b735f1c4 100644 --- a/src/model/SetDiscountPerAdditionalCostPerItemEffectProps.js +++ b/src/model/SetDiscountPerAdditionalCostPerItemEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountPerAdditionalCostPerItemEffectProps model module. * @module model/SetDiscountPerAdditionalCostPerItemEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class SetDiscountPerAdditionalCostPerItemEffectProps { /** @@ -111,7 +111,7 @@ SetDiscountPerAdditionalCostPerItemEffectProps.prototype['value'] = undefined; SetDiscountPerAdditionalCostPerItemEffectProps.prototype['position'] = undefined; /** - * Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. + * For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. * @member {Number} subPosition */ SetDiscountPerAdditionalCostPerItemEffectProps.prototype['subPosition'] = undefined; diff --git a/src/model/SetDiscountPerItemEffectProps.js b/src/model/SetDiscountPerItemEffectProps.js index e591338c..54f817c0 100644 --- a/src/model/SetDiscountPerItemEffectProps.js +++ b/src/model/SetDiscountPerItemEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountPerItemEffectProps model module. * @module model/SetDiscountPerItemEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class SetDiscountPerItemEffectProps { /** @@ -84,6 +84,12 @@ class SetDiscountPerItemEffectProps { if (data.hasOwnProperty('bundleName')) { obj['bundleName'] = ApiClient.convertToType(data['bundleName'], 'String'); } + if (data.hasOwnProperty('targetedItemPosition')) { + obj['targetedItemPosition'] = ApiClient.convertToType(data['targetedItemPosition'], 'Number'); + } + if (data.hasOwnProperty('targetedItemSubPosition')) { + obj['targetedItemSubPosition'] = ApiClient.convertToType(data['targetedItemSubPosition'], 'Number'); + } } return obj; } @@ -110,7 +116,7 @@ SetDiscountPerItemEffectProps.prototype['value'] = undefined; SetDiscountPerItemEffectProps.prototype['position'] = undefined; /** - * Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. + * For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. * @member {Number} subPosition */ SetDiscountPerItemEffectProps.prototype['subPosition'] = undefined; @@ -151,6 +157,18 @@ SetDiscountPerItemEffectProps.prototype['bundleIndex'] = undefined; */ SetDiscountPerItemEffectProps.prototype['bundleName'] = undefined; +/** + * The index of the targeted bundle item on which the applied discount is based. + * @member {Number} targetedItemPosition + */ +SetDiscountPerItemEffectProps.prototype['targetedItemPosition'] = undefined; + +/** + * The sub-position of the targeted bundle item on which the applied discount is based. + * @member {Number} targetedItemSubPosition + */ +SetDiscountPerItemEffectProps.prototype['targetedItemSubPosition'] = undefined; + diff --git a/src/model/ShowBundleMetadataEffectProps.js b/src/model/ShowBundleMetadataEffectProps.js index a409db12..f308fc9f 100644 --- a/src/model/ShowBundleMetadataEffectProps.js +++ b/src/model/ShowBundleMetadataEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ShowBundleMetadataEffectProps model module. * @module model/ShowBundleMetadataEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class ShowBundleMetadataEffectProps { /** diff --git a/src/model/ShowNotificationEffectProps.js b/src/model/ShowNotificationEffectProps.js index cb41189f..1c680489 100644 --- a/src/model/ShowNotificationEffectProps.js +++ b/src/model/ShowNotificationEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ShowNotificationEffectProps model module. * @module model/ShowNotificationEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class ShowNotificationEffectProps { /** diff --git a/src/model/SlotDef.js b/src/model/SlotDef.js index b3f95ba1..53df337a 100644 --- a/src/model/SlotDef.js +++ b/src/model/SlotDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SlotDef model module. * @module model/SlotDef - * @version 5.0.1 + * @version 6.0.0 */ class SlotDef { /** diff --git a/src/model/Store.js b/src/model/Store.js new file mode 100644 index 00000000..bd7b8498 --- /dev/null +++ b/src/model/Store.js @@ -0,0 +1,159 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The Store model module. + * @module model/Store + * @version 6.0.0 + */ +class Store { + /** + * Constructs a new Store. + * + * @alias module:model/Store + * @param id {Number} Internal ID of this entity. + * @param created {Date} The time this entity was created. The time this entity was created. + * @param name {String} The name of the store. + * @param description {String} The description of the store. + * @param integrationId {String} The integration ID of the store. You choose this ID when you create a store. + * @param applicationId {Number} The ID of the application that owns this entity. + * @param updated {Date} Timestamp of the most recent update on this entity. + */ + constructor(id, created, name, description, integrationId, applicationId, updated) { + + Store.initialize(this, id, created, name, description, integrationId, applicationId, updated); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, id, created, name, description, integrationId, applicationId, updated) { + obj['id'] = id; + obj['created'] = created; + obj['name'] = name; + obj['description'] = description; + obj['integrationId'] = integrationId; + obj['applicationId'] = applicationId; + obj['updated'] = updated; + } + + /** + * Constructs a Store from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Store} obj Optional instance to populate. + * @return {module:model/Store} The populated Store instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new Store(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'Date'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('integrationId')) { + obj['integrationId'] = ApiClient.convertToType(data['integrationId'], 'String'); + } + if (data.hasOwnProperty('applicationId')) { + obj['applicationId'] = ApiClient.convertToType(data['applicationId'], 'Number'); + } + if (data.hasOwnProperty('updated')) { + obj['updated'] = ApiClient.convertToType(data['updated'], 'Date'); + } + if (data.hasOwnProperty('linkedCampaignIds')) { + obj['linkedCampaignIds'] = ApiClient.convertToType(data['linkedCampaignIds'], ['Number']); + } + } + return obj; + } + + +} + +/** + * Internal ID of this entity. + * @member {Number} id + */ +Store.prototype['id'] = undefined; + +/** + * The time this entity was created. The time this entity was created. + * @member {Date} created + */ +Store.prototype['created'] = undefined; + +/** + * The name of the store. + * @member {String} name + */ +Store.prototype['name'] = undefined; + +/** + * The description of the store. + * @member {String} description + */ +Store.prototype['description'] = undefined; + +/** + * The attributes of the store. + * @member {Object} attributes + */ +Store.prototype['attributes'] = undefined; + +/** + * The integration ID of the store. You choose this ID when you create a store. + * @member {String} integrationId + */ +Store.prototype['integrationId'] = undefined; + +/** + * The ID of the application that owns this entity. + * @member {Number} applicationId + */ +Store.prototype['applicationId'] = undefined; + +/** + * Timestamp of the most recent update on this entity. + * @member {Date} updated + */ +Store.prototype['updated'] = undefined; + +/** + * A list of IDs of the campaigns that are linked with current store. + * @member {Array.} linkedCampaignIds + */ +Store.prototype['linkedCampaignIds'] = undefined; + + + + + + +export default Store; + diff --git a/src/model/StrikethroughChangedItem.js b/src/model/StrikethroughChangedItem.js index d4c0ffe7..b3a35f72 100644 --- a/src/model/StrikethroughChangedItem.js +++ b/src/model/StrikethroughChangedItem.js @@ -17,7 +17,7 @@ import StrikethroughEffect from './StrikethroughEffect'; /** * The StrikethroughChangedItem model module. * @module model/StrikethroughChangedItem - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughChangedItem { /** diff --git a/src/model/StrikethroughCustomEffectPerItemProps.js b/src/model/StrikethroughCustomEffectPerItemProps.js index b4d92428..a1237480 100644 --- a/src/model/StrikethroughCustomEffectPerItemProps.js +++ b/src/model/StrikethroughCustomEffectPerItemProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The StrikethroughCustomEffectPerItemProps model module. * @module model/StrikethroughCustomEffectPerItemProps - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughCustomEffectPerItemProps { /** diff --git a/src/model/StrikethroughEffect.js b/src/model/StrikethroughEffect.js index 75dc83bf..2de9d3af 100644 --- a/src/model/StrikethroughEffect.js +++ b/src/model/StrikethroughEffect.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The StrikethroughEffect model module. * @module model/StrikethroughEffect - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughEffect { /** diff --git a/src/model/StrikethroughLabelingNotification.js b/src/model/StrikethroughLabelingNotification.js index 670a870f..77cc876f 100644 --- a/src/model/StrikethroughLabelingNotification.js +++ b/src/model/StrikethroughLabelingNotification.js @@ -18,7 +18,7 @@ import StrikethroughTrigger from './StrikethroughTrigger'; /** * The StrikethroughLabelingNotification model module. * @module model/StrikethroughLabelingNotification - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughLabelingNotification { /** diff --git a/src/model/StrikethroughSetDiscountPerItemEffectProps.js b/src/model/StrikethroughSetDiscountPerItemEffectProps.js index 94213a21..77b10c7a 100644 --- a/src/model/StrikethroughSetDiscountPerItemEffectProps.js +++ b/src/model/StrikethroughSetDiscountPerItemEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The StrikethroughSetDiscountPerItemEffectProps model module. * @module model/StrikethroughSetDiscountPerItemEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughSetDiscountPerItemEffectProps { /** diff --git a/src/model/StrikethroughTrigger.js b/src/model/StrikethroughTrigger.js index 20dcdbdf..c5db3545 100644 --- a/src/model/StrikethroughTrigger.js +++ b/src/model/StrikethroughTrigger.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The StrikethroughTrigger model module. * @module model/StrikethroughTrigger - * @version 5.0.1 + * @version 6.0.0 */ class StrikethroughTrigger { /** diff --git a/src/model/TalangAttribute.js b/src/model/TalangAttribute.js index 6dfe36a0..31019273 100644 --- a/src/model/TalangAttribute.js +++ b/src/model/TalangAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TalangAttribute model module. * @module model/TalangAttribute - * @version 5.0.1 + * @version 6.0.0 */ class TalangAttribute { /** @@ -258,7 +258,13 @@ TalangAttribute['EntityEnum'] = { * value: "Session" * @const */ - "Session": "Session" + "Session": "Session", + + /** + * value: "Store" + * @const + */ + "Store": "Store" }; diff --git a/src/model/TalangAttributeVisibility.js b/src/model/TalangAttributeVisibility.js index 6bf9cf3b..48e5e614 100644 --- a/src/model/TalangAttributeVisibility.js +++ b/src/model/TalangAttributeVisibility.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TalangAttributeVisibility model module. * @module model/TalangAttributeVisibility - * @version 5.0.1 + * @version 6.0.0 */ class TalangAttributeVisibility { /** diff --git a/src/model/TemplateArgDef.js b/src/model/TemplateArgDef.js index b7246db2..5bd0a803 100644 --- a/src/model/TemplateArgDef.js +++ b/src/model/TemplateArgDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TemplateArgDef model module. * @module model/TemplateArgDef - * @version 5.0.1 + * @version 6.0.0 */ class TemplateArgDef { /** diff --git a/src/model/TemplateDef.js b/src/model/TemplateDef.js index 5344d9b5..fa747d9c 100644 --- a/src/model/TemplateDef.js +++ b/src/model/TemplateDef.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The TemplateDef model module. * @module model/TemplateDef - * @version 5.0.1 + * @version 6.0.0 */ class TemplateDef { /** diff --git a/src/model/TemplateLimitConfig.js b/src/model/TemplateLimitConfig.js index 17f61b9c..fac98d18 100644 --- a/src/model/TemplateLimitConfig.js +++ b/src/model/TemplateLimitConfig.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TemplateLimitConfig model module. * @module model/TemplateLimitConfig - * @version 5.0.1 + * @version 6.0.0 */ class TemplateLimitConfig { /** diff --git a/src/model/Tier.js b/src/model/Tier.js index b740b396..669522ac 100644 --- a/src/model/Tier.js +++ b/src/model/Tier.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Tier model module. * @module model/Tier - * @version 5.0.1 + * @version 6.0.0 */ class Tier { /** diff --git a/src/model/TierDowngradeNotificationPolicy.js b/src/model/TierDowngradeNotificationPolicy.js new file mode 100644 index 00000000..41c7a419 --- /dev/null +++ b/src/model/TierDowngradeNotificationPolicy.js @@ -0,0 +1,74 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The TierDowngradeNotificationPolicy model module. + * @module model/TierDowngradeNotificationPolicy + * @version 6.0.0 + */ +class TierDowngradeNotificationPolicy { + /** + * Constructs a new TierDowngradeNotificationPolicy. + * @alias module:model/TierDowngradeNotificationPolicy + * @param name {String} The name of the notification. + */ + constructor(name) { + + TierDowngradeNotificationPolicy.initialize(this, name); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name) { + obj['name'] = name; + } + + /** + * Constructs a TierDowngradeNotificationPolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TierDowngradeNotificationPolicy} obj Optional instance to populate. + * @return {module:model/TierDowngradeNotificationPolicy} The populated TierDowngradeNotificationPolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TierDowngradeNotificationPolicy(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + } + return obj; + } + + +} + +/** + * The name of the notification. + * @member {String} name + */ +TierDowngradeNotificationPolicy.prototype['name'] = undefined; + + + + + + +export default TierDowngradeNotificationPolicy; + diff --git a/src/model/TierUpgradeNotificationPolicy.js b/src/model/TierUpgradeNotificationPolicy.js new file mode 100644 index 00000000..45d4b495 --- /dev/null +++ b/src/model/TierUpgradeNotificationPolicy.js @@ -0,0 +1,74 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The TierUpgradeNotificationPolicy model module. + * @module model/TierUpgradeNotificationPolicy + * @version 6.0.0 + */ +class TierUpgradeNotificationPolicy { + /** + * Constructs a new TierUpgradeNotificationPolicy. + * @alias module:model/TierUpgradeNotificationPolicy + * @param name {String} Notification name. + */ + constructor(name) { + + TierUpgradeNotificationPolicy.initialize(this, name); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name) { + obj['name'] = name; + } + + /** + * Constructs a TierUpgradeNotificationPolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TierUpgradeNotificationPolicy} obj Optional instance to populate. + * @return {module:model/TierUpgradeNotificationPolicy} The populated TierUpgradeNotificationPolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TierUpgradeNotificationPolicy(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + } + return obj; + } + + +} + +/** + * Notification name. + * @member {String} name + */ +TierUpgradeNotificationPolicy.prototype['name'] = undefined; + + + + + + +export default TierUpgradeNotificationPolicy; + diff --git a/src/model/TierWillDowngradeNotificationPolicy.js b/src/model/TierWillDowngradeNotificationPolicy.js new file mode 100644 index 00000000..f210aafc --- /dev/null +++ b/src/model/TierWillDowngradeNotificationPolicy.js @@ -0,0 +1,85 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import TierWillDowngradeNotificationTrigger from './TierWillDowngradeNotificationTrigger'; + +/** + * The TierWillDowngradeNotificationPolicy model module. + * @module model/TierWillDowngradeNotificationPolicy + * @version 6.0.0 + */ +class TierWillDowngradeNotificationPolicy { + /** + * Constructs a new TierWillDowngradeNotificationPolicy. + * @alias module:model/TierWillDowngradeNotificationPolicy + * @param name {String} The name of the notification. + * @param triggers {Array.} + */ + constructor(name, triggers) { + + TierWillDowngradeNotificationPolicy.initialize(this, name, triggers); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name, triggers) { + obj['name'] = name; + obj['triggers'] = triggers; + } + + /** + * Constructs a TierWillDowngradeNotificationPolicy from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TierWillDowngradeNotificationPolicy} obj Optional instance to populate. + * @return {module:model/TierWillDowngradeNotificationPolicy} The populated TierWillDowngradeNotificationPolicy instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TierWillDowngradeNotificationPolicy(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('triggers')) { + obj['triggers'] = ApiClient.convertToType(data['triggers'], [TierWillDowngradeNotificationTrigger]); + } + } + return obj; + } + + +} + +/** + * The name of the notification. + * @member {String} name + */ +TierWillDowngradeNotificationPolicy.prototype['name'] = undefined; + +/** + * @member {Array.} triggers + */ +TierWillDowngradeNotificationPolicy.prototype['triggers'] = undefined; + + + + + + +export default TierWillDowngradeNotificationPolicy; + diff --git a/src/model/TierWillDowngradeNotificationTrigger.js b/src/model/TierWillDowngradeNotificationTrigger.js new file mode 100644 index 00000000..cfe74d81 --- /dev/null +++ b/src/model/TierWillDowngradeNotificationTrigger.js @@ -0,0 +1,106 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The TierWillDowngradeNotificationTrigger model module. + * @module model/TierWillDowngradeNotificationTrigger + * @version 6.0.0 + */ +class TierWillDowngradeNotificationTrigger { + /** + * Constructs a new TierWillDowngradeNotificationTrigger. + * @alias module:model/TierWillDowngradeNotificationTrigger + * @param amount {Number} The amount of period. + * @param period {module:model/TierWillDowngradeNotificationTrigger.PeriodEnum} Notification period indicated by a letter; \"w\" means week, \"d\" means day. + */ + constructor(amount, period) { + + TierWillDowngradeNotificationTrigger.initialize(this, amount, period); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, amount, period) { + obj['amount'] = amount; + obj['period'] = period; + } + + /** + * Constructs a TierWillDowngradeNotificationTrigger from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TierWillDowngradeNotificationTrigger} obj Optional instance to populate. + * @return {module:model/TierWillDowngradeNotificationTrigger} The populated TierWillDowngradeNotificationTrigger instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TierWillDowngradeNotificationTrigger(); + + if (data.hasOwnProperty('amount')) { + obj['amount'] = ApiClient.convertToType(data['amount'], 'Number'); + } + if (data.hasOwnProperty('period')) { + obj['period'] = ApiClient.convertToType(data['period'], 'String'); + } + } + return obj; + } + + +} + +/** + * The amount of period. + * @member {Number} amount + */ +TierWillDowngradeNotificationTrigger.prototype['amount'] = undefined; + +/** + * Notification period indicated by a letter; \"w\" means week, \"d\" means day. + * @member {module:model/TierWillDowngradeNotificationTrigger.PeriodEnum} period + */ +TierWillDowngradeNotificationTrigger.prototype['period'] = undefined; + + + + + +/** + * Allowed values for the period property. + * @enum {String} + * @readonly + */ +TierWillDowngradeNotificationTrigger['PeriodEnum'] = { + + /** + * value: "w" + * @const + */ + "w": "w", + + /** + * value: "d" + * @const + */ + "d": "d" +}; + + + +export default TierWillDowngradeNotificationTrigger; + diff --git a/src/model/TimePoint.js b/src/model/TimePoint.js new file mode 100644 index 00000000..70c49993 --- /dev/null +++ b/src/model/TimePoint.js @@ -0,0 +1,124 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The TimePoint model module. + * @module model/TimePoint + * @version 6.0.0 + */ +class TimePoint { + /** + * Constructs a new TimePoint. + * The absolute duration after which the achievement is reset for a particular customer profile. + * @alias module:model/TimePoint + * @param hour {Number} The achievement is reset at this hour. + * @param minute {Number} The achievement is reset at this minute. + * @param second {Number} The achievement is reset at this second. + */ + constructor(hour, minute, second) { + + TimePoint.initialize(this, hour, minute, second); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, hour, minute, second) { + obj['hour'] = hour; + obj['minute'] = minute; + obj['second'] = second; + } + + /** + * Constructs a TimePoint from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TimePoint} obj Optional instance to populate. + * @return {module:model/TimePoint} The populated TimePoint instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TimePoint(); + + if (data.hasOwnProperty('month')) { + obj['month'] = ApiClient.convertToType(data['month'], 'Number'); + } + if (data.hasOwnProperty('dayOfMonth')) { + obj['dayOfMonth'] = ApiClient.convertToType(data['dayOfMonth'], 'Number'); + } + if (data.hasOwnProperty('dayOfWeek')) { + obj['dayOfWeek'] = ApiClient.convertToType(data['dayOfWeek'], 'Number'); + } + if (data.hasOwnProperty('hour')) { + obj['hour'] = ApiClient.convertToType(data['hour'], 'Number'); + } + if (data.hasOwnProperty('minute')) { + obj['minute'] = ApiClient.convertToType(data['minute'], 'Number'); + } + if (data.hasOwnProperty('second')) { + obj['second'] = ApiClient.convertToType(data['second'], 'Number'); + } + } + return obj; + } + + +} + +/** + * The achievement is reset in this month. **Note**: Only applicable if the period is set to `Y`. + * @member {Number} month + */ +TimePoint.prototype['month'] = undefined; + +/** + * The achievement is reset on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. + * @member {Number} dayOfMonth + */ +TimePoint.prototype['dayOfMonth'] = undefined; + +/** + * The achievement is reset on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. + * @member {Number} dayOfWeek + */ +TimePoint.prototype['dayOfWeek'] = undefined; + +/** + * The achievement is reset at this hour. + * @member {Number} hour + */ +TimePoint.prototype['hour'] = undefined; + +/** + * The achievement is reset at this minute. + * @member {Number} minute + */ +TimePoint.prototype['minute'] = undefined; + +/** + * The achievement is reset at this second. + * @member {Number} second + */ +TimePoint.prototype['second'] = undefined; + + + + + + +export default TimePoint; + diff --git a/src/model/TrackEventV2Response.js b/src/model/TrackEventV2Response.js new file mode 100644 index 00000000..c7e2de28 --- /dev/null +++ b/src/model/TrackEventV2Response.js @@ -0,0 +1,152 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import Campaign from './Campaign'; +import Coupon from './Coupon'; +import CustomerProfile from './CustomerProfile'; +import Effect from './Effect'; +import Event from './Event'; +import Giveaway from './Giveaway'; +import Loyalty from './Loyalty'; +import Referral from './Referral'; +import RuleFailureReason from './RuleFailureReason'; + +/** + * The TrackEventV2Response model module. + * @module model/TrackEventV2Response + * @version 6.0.0 + */ +class TrackEventV2Response { + /** + * Constructs a new TrackEventV2Response. + * This is the response type returned by the trackEventV2 endpoint. + * @alias module:model/TrackEventV2Response + * @param effects {Array.} The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + * @param createdCoupons {Array.} + * @param createdReferrals {Array.} + */ + constructor(effects, createdCoupons, createdReferrals) { + + TrackEventV2Response.initialize(this, effects, createdCoupons, createdReferrals); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, effects, createdCoupons, createdReferrals) { + obj['effects'] = effects; + obj['createdCoupons'] = createdCoupons; + obj['createdReferrals'] = createdReferrals; + } + + /** + * Constructs a TrackEventV2Response from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TrackEventV2Response} obj Optional instance to populate. + * @return {module:model/TrackEventV2Response} The populated TrackEventV2Response instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TrackEventV2Response(); + + if (data.hasOwnProperty('customerProfile')) { + obj['customerProfile'] = CustomerProfile.constructFromObject(data['customerProfile']); + } + if (data.hasOwnProperty('event')) { + obj['event'] = Event.constructFromObject(data['event']); + } + if (data.hasOwnProperty('loyalty')) { + obj['loyalty'] = Loyalty.constructFromObject(data['loyalty']); + } + if (data.hasOwnProperty('triggeredCampaigns')) { + obj['triggeredCampaigns'] = ApiClient.convertToType(data['triggeredCampaigns'], [Campaign]); + } + if (data.hasOwnProperty('ruleFailureReasons')) { + obj['ruleFailureReasons'] = ApiClient.convertToType(data['ruleFailureReasons'], [RuleFailureReason]); + } + if (data.hasOwnProperty('awardedGiveaways')) { + obj['awardedGiveaways'] = ApiClient.convertToType(data['awardedGiveaways'], [Giveaway]); + } + if (data.hasOwnProperty('effects')) { + obj['effects'] = ApiClient.convertToType(data['effects'], [Effect]); + } + if (data.hasOwnProperty('createdCoupons')) { + obj['createdCoupons'] = ApiClient.convertToType(data['createdCoupons'], [Coupon]); + } + if (data.hasOwnProperty('createdReferrals')) { + obj['createdReferrals'] = ApiClient.convertToType(data['createdReferrals'], [Referral]); + } + } + return obj; + } + + +} + +/** + * @member {module:model/CustomerProfile} customerProfile + */ +TrackEventV2Response.prototype['customerProfile'] = undefined; + +/** + * @member {module:model/Event} event + */ +TrackEventV2Response.prototype['event'] = undefined; + +/** + * @member {module:model/Loyalty} loyalty + */ +TrackEventV2Response.prototype['loyalty'] = undefined; + +/** + * @member {Array.} triggeredCampaigns + */ +TrackEventV2Response.prototype['triggeredCampaigns'] = undefined; + +/** + * @member {Array.} ruleFailureReasons + */ +TrackEventV2Response.prototype['ruleFailureReasons'] = undefined; + +/** + * @member {Array.} awardedGiveaways + */ +TrackEventV2Response.prototype['awardedGiveaways'] = undefined; + +/** + * The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + * @member {Array.} effects + */ +TrackEventV2Response.prototype['effects'] = undefined; + +/** + * @member {Array.} createdCoupons + */ +TrackEventV2Response.prototype['createdCoupons'] = undefined; + +/** + * @member {Array.} createdReferrals + */ +TrackEventV2Response.prototype['createdReferrals'] = undefined; + + + + + + +export default TrackEventV2Response; + diff --git a/src/model/TransferLoyaltyCard.js b/src/model/TransferLoyaltyCard.js index 8c31c0aa..a99cf746 100644 --- a/src/model/TransferLoyaltyCard.js +++ b/src/model/TransferLoyaltyCard.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TransferLoyaltyCard model module. * @module model/TransferLoyaltyCard - * @version 5.0.1 + * @version 6.0.0 */ class TransferLoyaltyCard { /** diff --git a/src/model/TriggerWebhookEffectProps.js b/src/model/TriggerWebhookEffectProps.js index da078939..db43b233 100644 --- a/src/model/TriggerWebhookEffectProps.js +++ b/src/model/TriggerWebhookEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TriggerWebhookEffectProps model module. * @module model/TriggerWebhookEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class TriggerWebhookEffectProps { /** diff --git a/src/model/TwoFAConfig.js b/src/model/TwoFAConfig.js new file mode 100644 index 00000000..a38f33fc --- /dev/null +++ b/src/model/TwoFAConfig.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The TwoFAConfig model module. + * @module model/TwoFAConfig + * @version 6.0.0 + */ +class TwoFAConfig { + /** + * Constructs a new TwoFAConfig. + * @alias module:model/TwoFAConfig + * @param enabled {Boolean} An indication of whether two-factor authentication is enabled for the account. + */ + constructor(enabled) { + + TwoFAConfig.initialize(this, enabled); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, enabled) { + obj['enabled'] = enabled; + } + + /** + * Constructs a TwoFAConfig from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TwoFAConfig} obj Optional instance to populate. + * @return {module:model/TwoFAConfig} The populated TwoFAConfig instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new TwoFAConfig(); + + if (data.hasOwnProperty('enabled')) { + obj['enabled'] = ApiClient.convertToType(data['enabled'], 'Boolean'); + } + if (data.hasOwnProperty('requireEverySignIn')) { + obj['requireEverySignIn'] = ApiClient.convertToType(data['requireEverySignIn'], 'Boolean'); + } + } + return obj; + } + + +} + +/** + * An indication of whether two-factor authentication is enabled for the account. + * @member {Boolean} enabled + */ +TwoFAConfig.prototype['enabled'] = undefined; + +/** + * Can be `true` or `false`. - `true`: Two-factor authentication is required each time a user signs in to their Talon.One account. - `false`: Two-factor authentication is only required when a user signs in to their Talon.One account on a new device, and every 30 days after that. + * @member {Boolean} requireEverySignIn + */ +TwoFAConfig.prototype['requireEverySignIn'] = undefined; + + + + + + +export default TwoFAConfig; + diff --git a/src/model/UpdateAccount.js b/src/model/UpdateAccount.js index e08c7f3f..d3682ee2 100644 --- a/src/model/UpdateAccount.js +++ b/src/model/UpdateAccount.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAccount model module. * @module model/UpdateAccount - * @version 5.0.1 + * @version 6.0.0 */ class UpdateAccount { /** diff --git a/src/model/UpdateAchievement.js b/src/model/UpdateAchievement.js new file mode 100644 index 00000000..0a03df56 --- /dev/null +++ b/src/model/UpdateAchievement.js @@ -0,0 +1,81 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The UpdateAchievement model module. + * @module model/UpdateAchievement + * @version 6.0.0 + */ +class UpdateAchievement { + /** + * Constructs a new UpdateAchievement. + * @alias module:model/UpdateAchievement + */ + constructor() { + + UpdateAchievement.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a UpdateAchievement from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/UpdateAchievement} obj Optional instance to populate. + * @return {module:model/UpdateAchievement} The populated UpdateAchievement instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new UpdateAchievement(); + + if (data.hasOwnProperty('title')) { + obj['title'] = ApiClient.convertToType(data['title'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + } + return obj; + } + + +} + +/** + * The display name for the achievement in the Campaign Manager. + * @member {String} title + */ +UpdateAchievement.prototype['title'] = undefined; + +/** + * A description of the achievement. + * @member {String} description + */ +UpdateAchievement.prototype['description'] = undefined; + + + + + + +export default UpdateAchievement; + diff --git a/src/model/UpdateApplication.js b/src/model/UpdateApplication.js index d8dd1ca9..cab637d9 100644 --- a/src/model/UpdateApplication.js +++ b/src/model/UpdateApplication.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The UpdateApplication model module. * @module model/UpdateApplication - * @version 5.0.1 + * @version 6.0.0 */ class UpdateApplication { /** @@ -162,7 +162,7 @@ UpdateApplication.prototype['defaultDiscountScope'] = undefined; UpdateApplication.prototype['enableCascadingDiscounts'] = undefined; /** - * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/managing-general-settings#flattening). + * Indicates if cart items of quantity larger than one should be separated into different items of quantity one. * @member {Boolean} enableFlattenedCartItems */ UpdateApplication.prototype['enableFlattenedCartItems'] = undefined; diff --git a/src/model/UpdateAttributeEffectProps.js b/src/model/UpdateAttributeEffectProps.js index cf5a3c63..3f270999 100644 --- a/src/model/UpdateAttributeEffectProps.js +++ b/src/model/UpdateAttributeEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAttributeEffectProps model module. * @module model/UpdateAttributeEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class UpdateAttributeEffectProps { /** diff --git a/src/model/UpdateAudience.js b/src/model/UpdateAudience.js index 6010138a..25de1a90 100644 --- a/src/model/UpdateAudience.js +++ b/src/model/UpdateAudience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAudience model module. * @module model/UpdateAudience - * @version 5.0.1 + * @version 6.0.0 */ class UpdateAudience { /** diff --git a/src/model/UpdateCampaign.js b/src/model/UpdateCampaign.js index 60ac816d..f4e1bb09 100644 --- a/src/model/UpdateCampaign.js +++ b/src/model/UpdateCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The UpdateCampaign model module. * @module model/UpdateCampaign - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCampaign { /** @@ -96,6 +96,15 @@ class UpdateCampaign { if (data.hasOwnProperty('campaignGroups')) { obj['campaignGroups'] = ApiClient.convertToType(data['campaignGroups'], ['Number']); } + if (data.hasOwnProperty('evaluationGroupId')) { + obj['evaluationGroupId'] = ApiClient.convertToType(data['evaluationGroupId'], 'Number'); + } + if (data.hasOwnProperty('type')) { + obj['type'] = ApiClient.convertToType(data['type'], 'String'); + } + if (data.hasOwnProperty('linkedStoreIds')) { + obj['linkedStoreIds'] = ApiClient.convertToType(data['linkedStoreIds'], ['Number']); + } } return obj; } @@ -180,6 +189,25 @@ UpdateCampaign.prototype['limits'] = undefined; */ UpdateCampaign.prototype['campaignGroups'] = undefined; +/** + * The ID of the campaign evaluation group the campaign belongs to. + * @member {Number} evaluationGroupId + */ +UpdateCampaign.prototype['evaluationGroupId'] = undefined; + +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/UpdateCampaign.TypeEnum} type + * @default 'advanced' + */ +UpdateCampaign.prototype['type'] = 'advanced'; + +/** + * A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + * @member {Array.} linkedStoreIds + */ +UpdateCampaign.prototype['linkedStoreIds'] = undefined; + @@ -250,6 +278,27 @@ UpdateCampaign['FeaturesEnum'] = { }; +/** + * Allowed values for the type property. + * @enum {String} + * @readonly + */ +UpdateCampaign['TypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default UpdateCampaign; diff --git a/src/model/UpdateCampaignCollection.js b/src/model/UpdateCampaignCollection.js index bcd9fd08..6291ce6d 100644 --- a/src/model/UpdateCampaignCollection.js +++ b/src/model/UpdateCampaignCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCampaignCollection model module. * @module model/UpdateCampaignCollection - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCampaignCollection { /** diff --git a/src/model/UpdateCampaignEvaluationGroup.js b/src/model/UpdateCampaignEvaluationGroup.js index f38e1fa4..ae2688cc 100644 --- a/src/model/UpdateCampaignEvaluationGroup.js +++ b/src/model/UpdateCampaignEvaluationGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCampaignEvaluationGroup model module. * @module model/UpdateCampaignEvaluationGroup - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCampaignEvaluationGroup { /** @@ -25,12 +25,13 @@ class UpdateCampaignEvaluationGroup { * @alias module:model/UpdateCampaignEvaluationGroup * @param name {String} The name of the campaign evaluation group. * @param parentId {Number} The ID of the parent group that contains the campaign evaluation group. - * @param evaluationMode {module:model/UpdateCampaignEvaluationGroup.EvaluationModeEnum} + * @param evaluationMode {module:model/UpdateCampaignEvaluationGroup.EvaluationModeEnum} The mode by which campaigns in the campaign evaluation group are evaluated. + * @param evaluationScope {module:model/UpdateCampaignEvaluationGroup.EvaluationScopeEnum} The evaluation scope of the campaign evaluation group. * @param locked {Boolean} An indicator of whether the campaign evaluation group is locked for modification. */ - constructor(name, parentId, evaluationMode, locked) { + constructor(name, parentId, evaluationMode, evaluationScope, locked) { - UpdateCampaignEvaluationGroup.initialize(this, name, parentId, evaluationMode, locked); + UpdateCampaignEvaluationGroup.initialize(this, name, parentId, evaluationMode, evaluationScope, locked); } /** @@ -38,10 +39,11 @@ class UpdateCampaignEvaluationGroup { * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). * Only for internal use. */ - static initialize(obj, name, parentId, evaluationMode, locked) { + static initialize(obj, name, parentId, evaluationMode, evaluationScope, locked) { obj['name'] = name; obj['parentId'] = parentId; obj['evaluationMode'] = evaluationMode; + obj['evaluationScope'] = evaluationScope; obj['locked'] = locked; } @@ -68,6 +70,9 @@ class UpdateCampaignEvaluationGroup { if (data.hasOwnProperty('evaluationMode')) { obj['evaluationMode'] = ApiClient.convertToType(data['evaluationMode'], 'String'); } + if (data.hasOwnProperty('evaluationScope')) { + obj['evaluationScope'] = ApiClient.convertToType(data['evaluationScope'], 'String'); + } if (data.hasOwnProperty('locked')) { obj['locked'] = ApiClient.convertToType(data['locked'], 'Boolean'); } @@ -97,10 +102,17 @@ UpdateCampaignEvaluationGroup.prototype['parentId'] = undefined; UpdateCampaignEvaluationGroup.prototype['description'] = undefined; /** + * The mode by which campaigns in the campaign evaluation group are evaluated. * @member {module:model/UpdateCampaignEvaluationGroup.EvaluationModeEnum} evaluationMode */ UpdateCampaignEvaluationGroup.prototype['evaluationMode'] = undefined; +/** + * The evaluation scope of the campaign evaluation group. + * @member {module:model/UpdateCampaignEvaluationGroup.EvaluationScopeEnum} evaluationScope + */ +UpdateCampaignEvaluationGroup.prototype['evaluationScope'] = undefined; + /** * An indicator of whether the campaign evaluation group is locked for modification. * @member {Boolean} locked @@ -144,6 +156,27 @@ UpdateCampaignEvaluationGroup['EvaluationModeEnum'] = { }; +/** + * Allowed values for the evaluationScope property. + * @enum {String} + * @readonly + */ +UpdateCampaignEvaluationGroup['EvaluationScopeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "session" + * @const + */ + "session": "session" +}; + + export default UpdateCampaignEvaluationGroup; diff --git a/src/model/UpdateCampaignGroup.js b/src/model/UpdateCampaignGroup.js index 27bf1fa9..855a5195 100644 --- a/src/model/UpdateCampaignGroup.js +++ b/src/model/UpdateCampaignGroup.js @@ -16,14 +16,14 @@ import ApiClient from '../ApiClient'; /** * The UpdateCampaignGroup model module. * @module model/UpdateCampaignGroup - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCampaignGroup { /** * Constructs a new UpdateCampaignGroup. * * @alias module:model/UpdateCampaignGroup - * @param name {String} The name of this campaign group. + * @param name {String} The name of this campaign access group. */ constructor(name) { @@ -70,25 +70,25 @@ class UpdateCampaignGroup { } /** - * The name of this campaign group. + * The name of this campaign access group. * @member {String} name */ UpdateCampaignGroup.prototype['name'] = undefined; /** - * A longer description of the campaign group. + * A longer description of the campaign access group. * @member {String} description */ UpdateCampaignGroup.prototype['description'] = undefined; /** - * A list of the IDs of the applications that this campaign group is enabled for. + * A list of IDs of the Applications that this campaign access group is enabled for. * @member {Array.} subscribedApplicationsIds */ UpdateCampaignGroup.prototype['subscribedApplicationsIds'] = undefined; /** - * A list of the IDs of the campaigns that this campaign group owns. + * A list of IDs of the campaigns that are part of the campaign access group. * @member {Array.} campaignIds */ UpdateCampaignGroup.prototype['campaignIds'] = undefined; diff --git a/src/model/UpdateCampaignTemplate.js b/src/model/UpdateCampaignTemplate.js index 12b55c27..55ca5427 100644 --- a/src/model/UpdateCampaignTemplate.js +++ b/src/model/UpdateCampaignTemplate.js @@ -20,7 +20,7 @@ import TemplateLimitConfig from './TemplateLimitConfig'; /** * The UpdateCampaignTemplate model module. * @module model/UpdateCampaignTemplate - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCampaignTemplate { /** @@ -109,6 +109,9 @@ class UpdateCampaignTemplate { if (data.hasOwnProperty('defaultCampaignGroupId')) { obj['defaultCampaignGroupId'] = ApiClient.convertToType(data['defaultCampaignGroupId'], 'Number'); } + if (data.hasOwnProperty('campaignType')) { + obj['campaignType'] = ApiClient.convertToType(data['campaignType'], 'String'); + } } return obj; } @@ -210,6 +213,13 @@ UpdateCampaignTemplate.prototype['campaignCollections'] = undefined; */ UpdateCampaignTemplate.prototype['defaultCampaignGroupId'] = undefined; +/** + * The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + * @member {module:model/UpdateCampaignTemplate.CampaignTypeEnum} campaignType + * @default 'advanced' + */ +UpdateCampaignTemplate.prototype['campaignType'] = 'advanced'; + @@ -280,6 +290,27 @@ UpdateCampaignTemplate['FeaturesEnum'] = { }; +/** + * Allowed values for the campaignType property. + * @enum {String} + * @readonly + */ +UpdateCampaignTemplate['CampaignTypeEnum'] = { + + /** + * value: "cartItem" + * @const + */ + "cartItem": "cartItem", + + /** + * value: "advanced" + * @const + */ + "advanced": "advanced" +}; + + export default UpdateCampaignTemplate; diff --git a/src/model/UpdateCatalog.js b/src/model/UpdateCatalog.js index e6548cdd..2c22fa43 100644 --- a/src/model/UpdateCatalog.js +++ b/src/model/UpdateCatalog.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCatalog model module. * @module model/UpdateCatalog - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCatalog { /** diff --git a/src/model/UpdateCollection.js b/src/model/UpdateCollection.js index 04664368..a91fe6b5 100644 --- a/src/model/UpdateCollection.js +++ b/src/model/UpdateCollection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCollection model module. * @module model/UpdateCollection - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCollection { /** diff --git a/src/model/UpdateCoupon.js b/src/model/UpdateCoupon.js index 78327711..751e9d8f 100644 --- a/src/model/UpdateCoupon.js +++ b/src/model/UpdateCoupon.js @@ -17,7 +17,7 @@ import LimitConfig from './LimitConfig'; /** * The UpdateCoupon model module. * @module model/UpdateCoupon - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCoupon { /** @@ -76,6 +76,9 @@ class UpdateCoupon { if (data.hasOwnProperty('isReservationMandatory')) { obj['isReservationMandatory'] = ApiClient.convertToType(data['isReservationMandatory'], 'Boolean'); } + if (data.hasOwnProperty('implicitlyReserved')) { + obj['implicitlyReserved'] = ApiClient.convertToType(data['implicitlyReserved'], 'Boolean'); + } } return obj; } @@ -138,6 +141,12 @@ UpdateCoupon.prototype['attributes'] = undefined; */ UpdateCoupon.prototype['isReservationMandatory'] = true; +/** + * An indication of whether the coupon is implicitly reserved for all customers. + * @member {Boolean} implicitlyReserved + */ +UpdateCoupon.prototype['implicitlyReserved'] = undefined; + diff --git a/src/model/UpdateCouponBatch.js b/src/model/UpdateCouponBatch.js index 1dbc2d19..dba4cee6 100644 --- a/src/model/UpdateCouponBatch.js +++ b/src/model/UpdateCouponBatch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCouponBatch model module. * @module model/UpdateCouponBatch - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCouponBatch { /** @@ -107,13 +107,13 @@ UpdateCouponBatch.prototype['startDate'] = undefined; UpdateCouponBatch.prototype['expiryDate'] = undefined; /** - * Arbitrary properties associated with this item. + * Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. * @member {Object} attributes */ UpdateCouponBatch.prototype['attributes'] = undefined; /** - * The id of the batch the coupon belongs to. + * The ID of the batch the coupon(s) belong to. * @member {String} batchID */ UpdateCouponBatch.prototype['batchID'] = undefined; diff --git a/src/model/UpdateCustomEffect.js b/src/model/UpdateCustomEffect.js index 03d8f47b..1ef0cd22 100644 --- a/src/model/UpdateCustomEffect.js +++ b/src/model/UpdateCustomEffect.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The UpdateCustomEffect model module. * @module model/UpdateCustomEffect - * @version 5.0.1 + * @version 6.0.0 */ class UpdateCustomEffect { /** diff --git a/src/model/UpdateLoyaltyCard.js b/src/model/UpdateLoyaltyCard.js index 91604e39..ba677a96 100644 --- a/src/model/UpdateLoyaltyCard.js +++ b/src/model/UpdateLoyaltyCard.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateLoyaltyCard model module. * @module model/UpdateLoyaltyCard - * @version 5.0.1 + * @version 6.0.0 */ class UpdateLoyaltyCard { /** diff --git a/src/model/UpdateLoyaltyProgram.js b/src/model/UpdateLoyaltyProgram.js index 64bb2337..d0d66ed3 100644 --- a/src/model/UpdateLoyaltyProgram.js +++ b/src/model/UpdateLoyaltyProgram.js @@ -17,7 +17,7 @@ import NewLoyaltyTier from './NewLoyaltyTier'; /** * The UpdateLoyaltyProgram model module. * @module model/UpdateLoyaltyProgram - * @version 5.0.1 + * @version 6.0.0 */ class UpdateLoyaltyProgram { /** @@ -138,7 +138,7 @@ UpdateLoyaltyProgram.prototype['usersPerCardLimit'] = undefined; UpdateLoyaltyProgram.prototype['sandbox'] = undefined; /** - * The duration is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. + * The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. * @member {String} tiersExpireIn */ UpdateLoyaltyProgram.prototype['tiersExpireIn'] = undefined; diff --git a/src/model/UpdatePicklist.js b/src/model/UpdatePicklist.js index c6f24210..be385ba0 100644 --- a/src/model/UpdatePicklist.js +++ b/src/model/UpdatePicklist.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdatePicklist model module. * @module model/UpdatePicklist - * @version 5.0.1 + * @version 6.0.0 */ class UpdatePicklist { /** diff --git a/src/model/UpdateReferral.js b/src/model/UpdateReferral.js index a77bad0e..51b2b97b 100644 --- a/src/model/UpdateReferral.js +++ b/src/model/UpdateReferral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateReferral model module. * @module model/UpdateReferral - * @version 5.0.1 + * @version 6.0.0 */ class UpdateReferral { /** diff --git a/src/model/UpdateReferralBatch.js b/src/model/UpdateReferralBatch.js index fe0f55bd..6f76aabe 100644 --- a/src/model/UpdateReferralBatch.js +++ b/src/model/UpdateReferralBatch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateReferralBatch model module. * @module model/UpdateReferralBatch - * @version 5.0.1 + * @version 6.0.0 */ class UpdateReferralBatch { /** diff --git a/src/model/UpdateRole.js b/src/model/UpdateRole.js index 9a8a7e9a..a3291c6d 100644 --- a/src/model/UpdateRole.js +++ b/src/model/UpdateRole.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateRole model module. * @module model/UpdateRole - * @version 5.0.1 + * @version 6.0.0 */ class UpdateRole { /** diff --git a/src/model/UpdateStore.js b/src/model/UpdateStore.js new file mode 100644 index 00000000..708126fa --- /dev/null +++ b/src/model/UpdateStore.js @@ -0,0 +1,94 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The UpdateStore model module. + * @module model/UpdateStore + * @version 6.0.0 + */ +class UpdateStore { + /** + * Constructs a new UpdateStore. + * @alias module:model/UpdateStore + * @param name {String} The name of the store. + * @param description {String} The description of the store. + */ + constructor(name, description) { + + UpdateStore.initialize(this, name, description); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj, name, description) { + obj['name'] = name; + obj['description'] = description; + } + + /** + * Constructs a UpdateStore from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/UpdateStore} obj Optional instance to populate. + * @return {module:model/UpdateStore} The populated UpdateStore instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new UpdateStore(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + } + return obj; + } + + +} + +/** + * The name of the store. + * @member {String} name + */ +UpdateStore.prototype['name'] = undefined; + +/** + * The description of the store. + * @member {String} description + */ +UpdateStore.prototype['description'] = undefined; + +/** + * The attributes of the store. + * @member {Object} attributes + */ +UpdateStore.prototype['attributes'] = undefined; + + + + + + +export default UpdateStore; + diff --git a/src/model/UpdateUser.js b/src/model/UpdateUser.js index 20ffb6e3..fffb44e9 100644 --- a/src/model/UpdateUser.js +++ b/src/model/UpdateUser.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateUser model module. * @module model/UpdateUser - * @version 5.0.1 + * @version 6.0.0 */ class UpdateUser { /** @@ -62,6 +62,9 @@ class UpdateUser { if (data.hasOwnProperty('applicationNotificationSubscriptions')) { obj['applicationNotificationSubscriptions'] = ApiClient.convertToType(data['applicationNotificationSubscriptions'], Object); } + if (data.hasOwnProperty('isAdmin')) { + obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); + } } return obj; } @@ -98,6 +101,12 @@ UpdateUser.prototype['roles'] = undefined; */ UpdateUser.prototype['applicationNotificationSubscriptions'] = undefined; +/** + * An indication of whether the user has admin permissions. + * @member {Boolean} isAdmin + */ +UpdateUser.prototype['isAdmin'] = undefined; + diff --git a/src/model/User.js b/src/model/User.js index 542aef01..f5af3cfa 100644 --- a/src/model/User.js +++ b/src/model/User.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The User model module. * @module model/User - * @version 5.0.1 + * @version 6.0.0 */ class User { /** @@ -105,6 +105,15 @@ class User { if (data.hasOwnProperty('authMethod')) { obj['authMethod'] = ApiClient.convertToType(data['authMethod'], 'String'); } + if (data.hasOwnProperty('isAdmin')) { + obj['isAdmin'] = ApiClient.convertToType(data['isAdmin'], 'Boolean'); + } + if (data.hasOwnProperty('lastSignedIn')) { + obj['lastSignedIn'] = ApiClient.convertToType(data['lastSignedIn'], 'Date'); + } + if (data.hasOwnProperty('lastAccessed')) { + obj['lastAccessed'] = ApiClient.convertToType(data['lastAccessed'], 'Date'); + } } return obj; } @@ -189,6 +198,24 @@ User.prototype['applicationNotificationSubscriptions'] = undefined; */ User.prototype['authMethod'] = undefined; +/** + * An indication of whether the user has admin permissions. + * @member {Boolean} isAdmin + */ +User.prototype['isAdmin'] = undefined; + +/** + * Date and time when the user last signed in to Talon.One. + * @member {Date} lastSignedIn + */ +User.prototype['lastSignedIn'] = undefined; + +/** + * Date and time of the user's last activity after signing in to Talon.One. + * @member {Date} lastAccessed + */ +User.prototype['lastAccessed'] = undefined; + diff --git a/src/model/UserEntity.js b/src/model/UserEntity.js index f76b2122..bf772c4c 100644 --- a/src/model/UserEntity.js +++ b/src/model/UserEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UserEntity model module. * @module model/UserEntity - * @version 5.0.1 + * @version 6.0.0 */ class UserEntity { /** diff --git a/src/model/Webhook.js b/src/model/Webhook.js index 59633360..a8cc4877 100644 --- a/src/model/Webhook.js +++ b/src/model/Webhook.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The Webhook model module. * @module model/Webhook - * @version 5.0.1 + * @version 6.0.0 */ class Webhook { /** diff --git a/src/model/WebhookActivationLogEntry.js b/src/model/WebhookActivationLogEntry.js index 351850bc..6da0c796 100644 --- a/src/model/WebhookActivationLogEntry.js +++ b/src/model/WebhookActivationLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The WebhookActivationLogEntry model module. * @module model/WebhookActivationLogEntry - * @version 5.0.1 + * @version 6.0.0 */ class WebhookActivationLogEntry { /** diff --git a/src/model/WebhookLogEntry.js b/src/model/WebhookLogEntry.js index 08282835..29a73431 100644 --- a/src/model/WebhookLogEntry.js +++ b/src/model/WebhookLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The WebhookLogEntry model module. * @module model/WebhookLogEntry - * @version 5.0.1 + * @version 6.0.0 */ class WebhookLogEntry { /** diff --git a/src/model/WebhookWithOutgoingIntegrationDetails.js b/src/model/WebhookWithOutgoingIntegrationDetails.js index a1fb515b..285c22d3 100644 --- a/src/model/WebhookWithOutgoingIntegrationDetails.js +++ b/src/model/WebhookWithOutgoingIntegrationDetails.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The WebhookWithOutgoingIntegrationDetails model module. * @module model/WebhookWithOutgoingIntegrationDetails - * @version 5.0.1 + * @version 6.0.0 */ class WebhookWithOutgoingIntegrationDetails { /** diff --git a/src/model/WillAwardGiveawayEffectProps.js b/src/model/WillAwardGiveawayEffectProps.js index 4f2ae570..bb4a8131 100644 --- a/src/model/WillAwardGiveawayEffectProps.js +++ b/src/model/WillAwardGiveawayEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The WillAwardGiveawayEffectProps model module. * @module model/WillAwardGiveawayEffectProps - * @version 5.0.1 + * @version 6.0.0 */ class WillAwardGiveawayEffectProps { /** diff --git a/test/api/IntegrationApi.spec.js b/test/api/IntegrationApi.spec.js index ad70b86b..37d52529 100644 --- a/test/api/IntegrationApi.spec.js +++ b/test/api/IntegrationApi.spec.js @@ -168,6 +168,16 @@ done(); }); }); + describe('getLoyaltyCardPoints', function() { + it('should call getLoyaltyCardPoints successfully', function(done) { + //uncomment below and update the code to test getLoyaltyCardPoints + //instance.getLoyaltyCardPoints(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('getLoyaltyCardTransactions', function() { it('should call getLoyaltyCardTransactions successfully', function(done) { //uncomment below and update the code to test getLoyaltyCardTransactions @@ -178,6 +188,16 @@ done(); }); }); + describe('getLoyaltyProgramProfilePoints', function() { + it('should call getLoyaltyProgramProfilePoints successfully', function(done) { + //uncomment below and update the code to test getLoyaltyProgramProfilePoints + //instance.getLoyaltyProgramProfilePoints(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('getLoyaltyProgramProfileTransactions', function() { it('should call getLoyaltyProgramProfileTransactions successfully', function(done) { //uncomment below and update the code to test getLoyaltyProgramProfileTransactions diff --git a/test/api/ManagementApi.spec.js b/test/api/ManagementApi.spec.js index 72fafa81..033353da 100644 --- a/test/api/ManagementApi.spec.js +++ b/test/api/ManagementApi.spec.js @@ -158,16 +158,6 @@ done(); }); }); - describe('createNotificationWebhook', function() { - it('should call createNotificationWebhook successfully', function(done) { - //uncomment below and update the code to test createNotificationWebhook - //instance.createNotificationWebhook(function(error) { - // if (error) throw error; - //expect().to.be(); - //}); - done(); - }); - }); describe('createPasswordRecoveryEmail', function() { it('should call createPasswordRecoveryEmail successfully', function(done) { //uncomment below and update the code to test createPasswordRecoveryEmail @@ -188,6 +178,16 @@ done(); }); }); + describe('createStore', function() { + it('should call createStore successfully', function(done) { + //uncomment below and update the code to test createStore + //instance.createStore(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('deductLoyaltyCardPoints', function() { it('should call deductLoyaltyCardPoints successfully', function(done) { //uncomment below and update the code to test deductLoyaltyCardPoints @@ -258,20 +258,20 @@ done(); }); }); - describe('deleteNotificationWebhook', function() { - it('should call deleteNotificationWebhook successfully', function(done) { - //uncomment below and update the code to test deleteNotificationWebhook - //instance.deleteNotificationWebhook(function(error) { + describe('deleteReferral', function() { + it('should call deleteReferral successfully', function(done) { + //uncomment below and update the code to test deleteReferral + //instance.deleteReferral(function(error) { // if (error) throw error; //expect().to.be(); //}); done(); }); }); - describe('deleteReferral', function() { - it('should call deleteReferral successfully', function(done) { - //uncomment below and update the code to test deleteReferral - //instance.deleteReferral(function(error) { + describe('deleteStore', function() { + it('should call deleteStore successfully', function(done) { + //uncomment below and update the code to test deleteStore + //instance.deleteStore(function(error) { // if (error) throw error; //expect().to.be(); //}); @@ -328,6 +328,16 @@ done(); }); }); + describe('exportCustomersTiers', function() { + it('should call exportCustomersTiers successfully', function(done) { + //uncomment below and update the code to test exportCustomersTiers + //instance.exportCustomersTiers(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('exportEffects', function() { it('should call exportEffects successfully', function(done) { //uncomment below and update the code to test exportEffects @@ -878,26 +888,6 @@ done(); }); }); - describe('getNotificationWebhook', function() { - it('should call getNotificationWebhook successfully', function(done) { - //uncomment below and update the code to test getNotificationWebhook - //instance.getNotificationWebhook(function(error) { - // if (error) throw error; - //expect().to.be(); - //}); - done(); - }); - }); - describe('getNotificationWebhooks', function() { - it('should call getNotificationWebhooks successfully', function(done) { - //uncomment below and update the code to test getNotificationWebhooks - //instance.getNotificationWebhooks(function(error) { - // if (error) throw error; - //expect().to.be(); - //}); - done(); - }); - }); describe('getReferralsWithoutTotalCount', function() { it('should call getReferralsWithoutTotalCount successfully', function(done) { //uncomment below and update the code to test getReferralsWithoutTotalCount @@ -938,6 +928,16 @@ done(); }); }); + describe('getStore', function() { + it('should call getStore successfully', function(done) { + //uncomment below and update the code to test getStore + //instance.getStore(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('getUser', function() { it('should call getUser successfully', function(done) { //uncomment below and update the code to test getUser @@ -1128,6 +1128,26 @@ done(); }); }); + describe('listStores', function() { + it('should call listStores successfully', function(done) { + //uncomment below and update the code to test listStores + //instance.listStores(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('notificationActivation', function() { + it('should call notificationActivation successfully', function(done) { + //uncomment below and update the code to test notificationActivation + //instance.notificationActivation(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('postAddedDeductedPointsNotification', function() { it('should call postAddedDeductedPointsNotification successfully', function(done) { //uncomment below and update the code to test postAddedDeductedPointsNotification @@ -1288,20 +1308,20 @@ done(); }); }); - describe('updateNotificationWebhook', function() { - it('should call updateNotificationWebhook successfully', function(done) { - //uncomment below and update the code to test updateNotificationWebhook - //instance.updateNotificationWebhook(function(error) { + describe('updateReferral', function() { + it('should call updateReferral successfully', function(done) { + //uncomment below and update the code to test updateReferral + //instance.updateReferral(function(error) { // if (error) throw error; //expect().to.be(); //}); done(); }); }); - describe('updateReferral', function() { - it('should call updateReferral successfully', function(done) { - //uncomment below and update the code to test updateReferral - //instance.updateReferral(function(error) { + describe('updateStore', function() { + it('should call updateStore successfully', function(done) { + //uncomment below and update the code to test updateStore + //instance.updateStore(function(error) { // if (error) throw error; //expect().to.be(); //}); diff --git a/test/model/AccountAnalytics.spec.js b/test/model/AccountAnalytics.spec.js index 6a5ab87c..866133f7 100644 --- a/test/model/AccountAnalytics.spec.js +++ b/test/model/AccountAnalytics.spec.js @@ -168,6 +168,12 @@ //expect(instance).to.be(); }); + it('should have the property lastUpdatedAt (base name: "lastUpdatedAt")', function() { + // uncomment below and update the code to test the property lastUpdatedAt + //var instane = new TalonOne.AccountAnalytics(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/AccountDashboardStatisticCampaigns.spec.js b/test/model/AccountDashboardStatisticCampaigns.spec.js index b8ccc374..c6296743 100644 --- a/test/model/AccountDashboardStatisticCampaigns.spec.js +++ b/test/model/AccountDashboardStatisticCampaigns.spec.js @@ -66,6 +66,12 @@ //expect(instance).to.be(); }); + it('should have the property lowOnBudget (base name: "lowOnBudget")', function() { + // uncomment below and update the code to test the property lowOnBudget + //var instane = new TalonOne.AccountDashboardStatisticCampaigns(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Achievement.spec.js b/test/model/Achievement.spec.js new file mode 100644 index 00000000..c3114003 --- /dev/null +++ b/test/model/Achievement.spec.js @@ -0,0 +1,119 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.Achievement(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('Achievement', function() { + it('should create an instance of Achievement', function() { + // uncomment below and update the code to test Achievement + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be.a(TalonOne.Achievement); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property title (base name: "title")', function() { + // uncomment below and update the code to test the property title + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property target (base name: "target")', function() { + // uncomment below and update the code to test the property target + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property period (base name: "period")', function() { + // uncomment below and update the code to test the property period + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property periodEndOverride (base name: "periodEndOverride")', function() { + // uncomment below and update the code to test the property periodEndOverride + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property userId (base name: "userId")', function() { + // uncomment below and update the code to test the property userId + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + it('should have the property createdBy (base name: "createdBy")', function() { + // uncomment below and update the code to test the property createdBy + //var instane = new TalonOne.Achievement(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/AchievementAdditionalProperties.spec.js b/test/model/AchievementAdditionalProperties.spec.js new file mode 100644 index 00000000..859f2db8 --- /dev/null +++ b/test/model/AchievementAdditionalProperties.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.AchievementAdditionalProperties(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('AchievementAdditionalProperties', function() { + it('should create an instance of AchievementAdditionalProperties', function() { + // uncomment below and update the code to test AchievementAdditionalProperties + //var instane = new TalonOne.AchievementAdditionalProperties(); + //expect(instance).to.be.a(TalonOne.AchievementAdditionalProperties); + }); + + it('should have the property userId (base name: "userId")', function() { + // uncomment below and update the code to test the property userId + //var instane = new TalonOne.AchievementAdditionalProperties(); + //expect(instance).to.be(); + }); + + it('should have the property createdBy (base name: "createdBy")', function() { + // uncomment below and update the code to test the property createdBy + //var instane = new TalonOne.AchievementAdditionalProperties(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/AddToAudienceEffectProps.spec.js b/test/model/AddToAudienceEffectProps.spec.js new file mode 100644 index 00000000..451db5f9 --- /dev/null +++ b/test/model/AddToAudienceEffectProps.spec.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.AddToAudienceEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('AddToAudienceEffectProps', function() { + it('should create an instance of AddToAudienceEffectProps', function() { + // uncomment below and update the code to test AddToAudienceEffectProps + //var instane = new TalonOne.AddToAudienceEffectProps(); + //expect(instance).to.be.a(TalonOne.AddToAudienceEffectProps); + }); + + it('should have the property audienceId (base name: "audienceId")', function() { + // uncomment below and update the code to test the property audienceId + //var instane = new TalonOne.AddToAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property audienceName (base name: "audienceName")', function() { + // uncomment below and update the code to test the property audienceName + //var instane = new TalonOne.AddToAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property profileIntegrationId (base name: "profileIntegrationId")', function() { + // uncomment below and update the code to test the property profileIntegrationId + //var instane = new TalonOne.AddToAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property profileId (base name: "profileId")', function() { + // uncomment below and update the code to test the property profileId + //var instane = new TalonOne.AddToAudienceEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/AdditionalCampaignProperties.spec.js b/test/model/AdditionalCampaignProperties.spec.js new file mode 100644 index 00000000..fb6fe881 --- /dev/null +++ b/test/model/AdditionalCampaignProperties.spec.js @@ -0,0 +1,185 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.AdditionalCampaignProperties(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('AdditionalCampaignProperties', function() { + it('should create an instance of AdditionalCampaignProperties', function() { + // uncomment below and update the code to test AdditionalCampaignProperties + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be.a(TalonOne.AdditionalCampaignProperties); + }); + + it('should have the property budgets (base name: "budgets")', function() { + // uncomment below and update the code to test the property budgets + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property couponRedemptionCount (base name: "couponRedemptionCount")', function() { + // uncomment below and update the code to test the property couponRedemptionCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property referralRedemptionCount (base name: "referralRedemptionCount")', function() { + // uncomment below and update the code to test the property referralRedemptionCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property discountCount (base name: "discountCount")', function() { + // uncomment below and update the code to test the property discountCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property discountEffectCount (base name: "discountEffectCount")', function() { + // uncomment below and update the code to test the property discountEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property couponCreationCount (base name: "couponCreationCount")', function() { + // uncomment below and update the code to test the property couponCreationCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property customEffectCount (base name: "customEffectCount")', function() { + // uncomment below and update the code to test the property customEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property referralCreationCount (base name: "referralCreationCount")', function() { + // uncomment below and update the code to test the property referralCreationCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property addFreeItemEffectCount (base name: "addFreeItemEffectCount")', function() { + // uncomment below and update the code to test the property addFreeItemEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property awardedGiveawaysCount (base name: "awardedGiveawaysCount")', function() { + // uncomment below and update the code to test the property awardedGiveawaysCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsCount (base name: "createdLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsEffectCount (base name: "createdLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsCount (base name: "redeemedLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsEffectCount (base name: "redeemedLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property callApiEffectCount (base name: "callApiEffectCount")', function() { + // uncomment below and update the code to test the property callApiEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property reservecouponEffectCount (base name: "reservecouponEffectCount")', function() { + // uncomment below and update the code to test the property reservecouponEffectCount + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property lastActivity (base name: "lastActivity")', function() { + // uncomment below and update the code to test the property lastActivity + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property updated (base name: "updated")', function() { + // uncomment below and update the code to test the property updated + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property createdBy (base name: "createdBy")', function() { + // uncomment below and update the code to test the property createdBy + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property updatedBy (base name: "updatedBy")', function() { + // uncomment below and update the code to test the property updatedBy + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + it('should have the property templateId (base name: "templateId")', function() { + // uncomment below and update the code to test the property templateId + //var instane = new TalonOne.AdditionalCampaignProperties(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/ApplicationEvent.spec.js b/test/model/ApplicationEvent.spec.js index c7679a20..ffb5e987 100644 --- a/test/model/ApplicationEvent.spec.js +++ b/test/model/ApplicationEvent.spec.js @@ -78,6 +78,18 @@ //expect(instance).to.be(); }); + it('should have the property storeId (base name: "storeId")', function() { + // uncomment below and update the code to test the property storeId + //var instane = new TalonOne.ApplicationEvent(); + //expect(instance).to.be(); + }); + + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.ApplicationEvent(); + //expect(instance).to.be(); + }); + it('should have the property sessionId (base name: "sessionId")', function() { // uncomment below and update the code to test the property sessionId //var instane = new TalonOne.ApplicationEvent(); diff --git a/test/model/ApplicationSession.spec.js b/test/model/ApplicationSession.spec.js index d13d6c1f..32039686 100644 --- a/test/model/ApplicationSession.spec.js +++ b/test/model/ApplicationSession.spec.js @@ -66,20 +66,26 @@ //expect(instance).to.be(); }); - it('should have the property applicationId (base name: "applicationId")', function() { - // uncomment below and update the code to test the property applicationId + it('should have the property integrationId (base name: "integrationId")', function() { + // uncomment below and update the code to test the property integrationId //var instane = new TalonOne.ApplicationSession(); //expect(instance).to.be(); }); - it('should have the property profileId (base name: "profileId")', function() { - // uncomment below and update the code to test the property profileId + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId //var instane = new TalonOne.ApplicationSession(); //expect(instance).to.be(); }); - it('should have the property integrationId (base name: "integrationId")', function() { - // uncomment below and update the code to test the property integrationId + it('should have the property applicationId (base name: "applicationId")', function() { + // uncomment below and update the code to test the property applicationId + //var instane = new TalonOne.ApplicationSession(); + //expect(instance).to.be(); + }); + + it('should have the property profileId (base name: "profileId")', function() { + // uncomment below and update the code to test the property profileId //var instane = new TalonOne.ApplicationSession(); //expect(instance).to.be(); }); diff --git a/test/model/ApplicationStoreEntity.spec.js b/test/model/ApplicationStoreEntity.spec.js new file mode 100644 index 00000000..52da1d09 --- /dev/null +++ b/test/model/ApplicationStoreEntity.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.ApplicationStoreEntity(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('ApplicationStoreEntity', function() { + it('should create an instance of ApplicationStoreEntity', function() { + // uncomment below and update the code to test ApplicationStoreEntity + //var instane = new TalonOne.ApplicationStoreEntity(); + //expect(instance).to.be.a(TalonOne.ApplicationStoreEntity); + }); + + it('should have the property storeId (base name: "storeId")', function() { + // uncomment below and update the code to test the property storeId + //var instane = new TalonOne.ApplicationStoreEntity(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/BaseCampaign.spec.js b/test/model/BaseCampaign.spec.js index c52b2c2b..65b62ec1 100644 --- a/test/model/BaseCampaign.spec.js +++ b/test/model/BaseCampaign.spec.js @@ -132,6 +132,24 @@ //expect(instance).to.be(); }); + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.BaseCampaign(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.BaseCampaign(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.BaseCampaign(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/BaseCampaignForNotification.spec.js b/test/model/BaseCampaignForNotification.spec.js new file mode 100644 index 00000000..9ed54fe0 --- /dev/null +++ b/test/model/BaseCampaignForNotification.spec.js @@ -0,0 +1,155 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.BaseCampaignForNotification(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('BaseCampaignForNotification', function() { + it('should create an instance of BaseCampaignForNotification', function() { + // uncomment below and update the code to test BaseCampaignForNotification + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be.a(TalonOne.BaseCampaignForNotification); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property startTime (base name: "startTime")', function() { + // uncomment below and update the code to test the property startTime + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property endTime (base name: "endTime")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property state (base name: "state")', function() { + // uncomment below and update the code to test the property state + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property activeRulesetId (base name: "activeRulesetId")', function() { + // uncomment below and update the code to test the property activeRulesetId + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property tags (base name: "tags")', function() { + // uncomment below and update the code to test the property tags + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property features (base name: "features")', function() { + // uncomment below and update the code to test the property features + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponSettings (base name: "couponSettings")', function() { + // uncomment below and update the code to test the property couponSettings + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralSettings (base name: "referralSettings")', function() { + // uncomment below and update the code to test the property referralSettings + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property limits (base name: "limits")', function() { + // uncomment below and update the code to test the property limits + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property campaignGroups (base name: "campaignGroups")', function() { + // uncomment below and update the code to test the property campaignGroups + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.BaseCampaignForNotification(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/BaseNotification.spec.js b/test/model/BaseNotification.spec.js index 6e73288a..4628b8bb 100644 --- a/test/model/BaseNotification.spec.js +++ b/test/model/BaseNotification.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.BaseNotification(); + //expect(instance).to.be(); + }); + it('should have the property webhook (base name: "webhook")', function() { // uncomment below and update the code to test the property webhook //var instane = new TalonOne.BaseNotification(); @@ -72,6 +78,12 @@ //expect(instance).to.be(); }); + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.BaseNotification(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/BaseNotificationEntity.spec.js b/test/model/BaseNotificationEntity.spec.js index 7898201e..ef3922bf 100644 --- a/test/model/BaseNotificationEntity.spec.js +++ b/test/model/BaseNotificationEntity.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.BaseNotificationEntity(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/BaseNotificationWebhook.spec.js b/test/model/BaseNotificationWebhook.spec.js index 2f0da22c..61d99779 100644 --- a/test/model/BaseNotificationWebhook.spec.js +++ b/test/model/BaseNotificationWebhook.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.BaseNotificationWebhook(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/BulkOperationOnCampaigns.spec.js b/test/model/BulkOperationOnCampaigns.spec.js new file mode 100644 index 00000000..cba6f15e --- /dev/null +++ b/test/model/BulkOperationOnCampaigns.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.BulkOperationOnCampaigns(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('BulkOperationOnCampaigns', function() { + it('should create an instance of BulkOperationOnCampaigns', function() { + // uncomment below and update the code to test BulkOperationOnCampaigns + //var instane = new TalonOne.BulkOperationOnCampaigns(); + //expect(instance).to.be.a(TalonOne.BulkOperationOnCampaigns); + }); + + it('should have the property operation (base name: "operation")', function() { + // uncomment below and update the code to test the property operation + //var instane = new TalonOne.BulkOperationOnCampaigns(); + //expect(instance).to.be(); + }); + + it('should have the property campaignIds (base name: "campaignIds")', function() { + // uncomment below and update the code to test the property campaignIds + //var instane = new TalonOne.BulkOperationOnCampaigns(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/Campaign.spec.js b/test/model/Campaign.spec.js index f8a308de..8929f59b 100644 --- a/test/model/Campaign.spec.js +++ b/test/model/Campaign.spec.js @@ -156,6 +156,30 @@ //expect(instance).to.be(); }); + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property budgets (base name: "budgets")', function() { + // uncomment below and update the code to test the property budgets + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + it('should have the property couponRedemptionCount (base name: "couponRedemptionCount")', function() { // uncomment below and update the code to test the property couponRedemptionCount //var instane = new TalonOne.Campaign(); diff --git a/test/model/CampaignBudget.spec.js b/test/model/CampaignBudget.spec.js new file mode 100644 index 00000000..5d70638f --- /dev/null +++ b/test/model/CampaignBudget.spec.js @@ -0,0 +1,77 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CampaignBudget(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CampaignBudget', function() { + it('should create an instance of CampaignBudget', function() { + // uncomment below and update the code to test CampaignBudget + //var instane = new TalonOne.CampaignBudget(); + //expect(instance).to.be.a(TalonOne.CampaignBudget); + }); + + it('should have the property action (base name: "action")', function() { + // uncomment below and update the code to test the property action + //var instane = new TalonOne.CampaignBudget(); + //expect(instance).to.be(); + }); + + it('should have the property limit (base name: "limit")', function() { + // uncomment below and update the code to test the property limit + //var instane = new TalonOne.CampaignBudget(); + //expect(instance).to.be(); + }); + + it('should have the property counter (base name: "counter")', function() { + // uncomment below and update the code to test the property counter + //var instane = new TalonOne.CampaignBudget(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CampaignEvaluationGroup.spec.js b/test/model/CampaignEvaluationGroup.spec.js index 921a7294..0f6d2a69 100644 --- a/test/model/CampaignEvaluationGroup.spec.js +++ b/test/model/CampaignEvaluationGroup.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property evaluationScope (base name: "evaluationScope")', function() { + // uncomment below and update the code to test the property evaluationScope + //var instane = new TalonOne.CampaignEvaluationGroup(); + //expect(instance).to.be(); + }); + it('should have the property locked (base name: "locked")', function() { // uncomment below and update the code to test the property locked //var instane = new TalonOne.CampaignEvaluationGroup(); diff --git a/test/model/CampaignForNotification.spec.js b/test/model/CampaignForNotification.spec.js new file mode 100644 index 00000000..01f9cd74 --- /dev/null +++ b/test/model/CampaignForNotification.spec.js @@ -0,0 +1,305 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CampaignForNotification(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CampaignForNotification', function() { + it('should create an instance of CampaignForNotification', function() { + // uncomment below and update the code to test CampaignForNotification + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be.a(TalonOne.CampaignForNotification); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property applicationId (base name: "applicationId")', function() { + // uncomment below and update the code to test the property applicationId + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property userId (base name: "userId")', function() { + // uncomment below and update the code to test the property userId + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property startTime (base name: "startTime")', function() { + // uncomment below and update the code to test the property startTime + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property endTime (base name: "endTime")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property state (base name: "state")', function() { + // uncomment below and update the code to test the property state + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property activeRulesetId (base name: "activeRulesetId")', function() { + // uncomment below and update the code to test the property activeRulesetId + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property tags (base name: "tags")', function() { + // uncomment below and update the code to test the property tags + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property features (base name: "features")', function() { + // uncomment below and update the code to test the property features + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponSettings (base name: "couponSettings")', function() { + // uncomment below and update the code to test the property couponSettings + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralSettings (base name: "referralSettings")', function() { + // uncomment below and update the code to test the property referralSettings + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property limits (base name: "limits")', function() { + // uncomment below and update the code to test the property limits + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property campaignGroups (base name: "campaignGroups")', function() { + // uncomment below and update the code to test the property campaignGroups + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property budgets (base name: "budgets")', function() { + // uncomment below and update the code to test the property budgets + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponRedemptionCount (base name: "couponRedemptionCount")', function() { + // uncomment below and update the code to test the property couponRedemptionCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralRedemptionCount (base name: "referralRedemptionCount")', function() { + // uncomment below and update the code to test the property referralRedemptionCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property discountCount (base name: "discountCount")', function() { + // uncomment below and update the code to test the property discountCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property discountEffectCount (base name: "discountEffectCount")', function() { + // uncomment below and update the code to test the property discountEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponCreationCount (base name: "couponCreationCount")', function() { + // uncomment below and update the code to test the property couponCreationCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property customEffectCount (base name: "customEffectCount")', function() { + // uncomment below and update the code to test the property customEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralCreationCount (base name: "referralCreationCount")', function() { + // uncomment below and update the code to test the property referralCreationCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property addFreeItemEffectCount (base name: "addFreeItemEffectCount")', function() { + // uncomment below and update the code to test the property addFreeItemEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property awardedGiveawaysCount (base name: "awardedGiveawaysCount")', function() { + // uncomment below and update the code to test the property awardedGiveawaysCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsCount (base name: "createdLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsEffectCount (base name: "createdLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsCount (base name: "redeemedLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsEffectCount (base name: "redeemedLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property callApiEffectCount (base name: "callApiEffectCount")', function() { + // uncomment below and update the code to test the property callApiEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property reservecouponEffectCount (base name: "reservecouponEffectCount")', function() { + // uncomment below and update the code to test the property reservecouponEffectCount + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property lastActivity (base name: "lastActivity")', function() { + // uncomment below and update the code to test the property lastActivity + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property updated (base name: "updated")', function() { + // uncomment below and update the code to test the property updated + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdBy (base name: "createdBy")', function() { + // uncomment below and update the code to test the property createdBy + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property updatedBy (base name: "updatedBy")', function() { + // uncomment below and update the code to test the property updatedBy + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + it('should have the property templateId (base name: "templateId")', function() { + // uncomment below and update the code to test the property templateId + //var instane = new TalonOne.CampaignForNotification(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CampaignNotificationPolicy.spec.js b/test/model/CampaignNotificationPolicy.spec.js new file mode 100644 index 00000000..b95d5204 --- /dev/null +++ b/test/model/CampaignNotificationPolicy.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CampaignNotificationPolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CampaignNotificationPolicy', function() { + it('should create an instance of CampaignNotificationPolicy', function() { + // uncomment below and update the code to test CampaignNotificationPolicy + //var instane = new TalonOne.CampaignNotificationPolicy(); + //expect(instance).to.be.a(TalonOne.CampaignNotificationPolicy); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.CampaignNotificationPolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CampaignSetBranchNode.spec.js b/test/model/CampaignSetBranchNode.spec.js index ede2521e..4eb06223 100644 --- a/test/model/CampaignSetBranchNode.spec.js +++ b/test/model/CampaignSetBranchNode.spec.js @@ -102,6 +102,12 @@ //expect(instance).to.be(); }); + it('should have the property evaluationScope (base name: "evaluationScope")', function() { + // uncomment below and update the code to test the property evaluationScope + //var instane = new TalonOne.CampaignSetBranchNode(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/CampaignStateNotification.spec.js b/test/model/CampaignStateNotification.spec.js new file mode 100644 index 00000000..7c786ccc --- /dev/null +++ b/test/model/CampaignStateNotification.spec.js @@ -0,0 +1,311 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CampaignStateNotification(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CampaignStateNotification', function() { + it('should create an instance of CampaignStateNotification', function() { + // uncomment below and update the code to test CampaignStateNotification + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be.a(TalonOne.CampaignStateNotification); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property applicationId (base name: "applicationId")', function() { + // uncomment below and update the code to test the property applicationId + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property userId (base name: "userId")', function() { + // uncomment below and update the code to test the property userId + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property startTime (base name: "startTime")', function() { + // uncomment below and update the code to test the property startTime + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property endTime (base name: "endTime")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property state (base name: "state")', function() { + // uncomment below and update the code to test the property state + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property activeRulesetId (base name: "activeRulesetId")', function() { + // uncomment below and update the code to test the property activeRulesetId + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property tags (base name: "tags")', function() { + // uncomment below and update the code to test the property tags + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property features (base name: "features")', function() { + // uncomment below and update the code to test the property features + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponSettings (base name: "couponSettings")', function() { + // uncomment below and update the code to test the property couponSettings + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralSettings (base name: "referralSettings")', function() { + // uncomment below and update the code to test the property referralSettings + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property limits (base name: "limits")', function() { + // uncomment below and update the code to test the property limits + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property campaignGroups (base name: "campaignGroups")', function() { + // uncomment below and update the code to test the property campaignGroups + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property budgets (base name: "budgets")', function() { + // uncomment below and update the code to test the property budgets + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponRedemptionCount (base name: "couponRedemptionCount")', function() { + // uncomment below and update the code to test the property couponRedemptionCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralRedemptionCount (base name: "referralRedemptionCount")', function() { + // uncomment below and update the code to test the property referralRedemptionCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property discountCount (base name: "discountCount")', function() { + // uncomment below and update the code to test the property discountCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property discountEffectCount (base name: "discountEffectCount")', function() { + // uncomment below and update the code to test the property discountEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property couponCreationCount (base name: "couponCreationCount")', function() { + // uncomment below and update the code to test the property couponCreationCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property customEffectCount (base name: "customEffectCount")', function() { + // uncomment below and update the code to test the property customEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property referralCreationCount (base name: "referralCreationCount")', function() { + // uncomment below and update the code to test the property referralCreationCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property addFreeItemEffectCount (base name: "addFreeItemEffectCount")', function() { + // uncomment below and update the code to test the property addFreeItemEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property awardedGiveawaysCount (base name: "awardedGiveawaysCount")', function() { + // uncomment below and update the code to test the property awardedGiveawaysCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsCount (base name: "createdLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsEffectCount (base name: "createdLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsCount (base name: "redeemedLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsEffectCount (base name: "redeemedLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property callApiEffectCount (base name: "callApiEffectCount")', function() { + // uncomment below and update the code to test the property callApiEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property reservecouponEffectCount (base name: "reservecouponEffectCount")', function() { + // uncomment below and update the code to test the property reservecouponEffectCount + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property lastActivity (base name: "lastActivity")', function() { + // uncomment below and update the code to test the property lastActivity + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property updated (base name: "updated")', function() { + // uncomment below and update the code to test the property updated + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property createdBy (base name: "createdBy")', function() { + // uncomment below and update the code to test the property createdBy + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property updatedBy (base name: "updatedBy")', function() { + // uncomment below and update the code to test the property updatedBy + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property templateId (base name: "templateId")', function() { + // uncomment below and update the code to test the property templateId + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + it('should have the property frontendState (base name: "frontendState")', function() { + // uncomment below and update the code to test the property frontendState + //var instane = new TalonOne.CampaignStateNotification(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CampaignTemplate.spec.js b/test/model/CampaignTemplate.spec.js index f1997e90..3330dae1 100644 --- a/test/model/CampaignTemplate.spec.js +++ b/test/model/CampaignTemplate.spec.js @@ -174,6 +174,12 @@ //expect(instance).to.be(); }); + it('should have the property campaignType (base name: "campaignType")', function() { + // uncomment below and update the code to test the property campaignType + //var instane = new TalonOne.CampaignTemplate(); + //expect(instance).to.be(); + }); + it('should have the property updated (base name: "updated")', function() { // uncomment below and update the code to test the property updated //var instane = new TalonOne.CampaignTemplate(); diff --git a/test/model/CardLedgerPointsEntryIntegrationAPI.spec.js b/test/model/CardLedgerPointsEntryIntegrationAPI.spec.js new file mode 100644 index 00000000..cb6d6575 --- /dev/null +++ b/test/model/CardLedgerPointsEntryIntegrationAPI.spec.js @@ -0,0 +1,119 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CardLedgerPointsEntryIntegrationAPI', function() { + it('should create an instance of CardLedgerPointsEntryIntegrationAPI', function() { + // uncomment below and update the code to test CardLedgerPointsEntryIntegrationAPI + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be.a(TalonOne.CardLedgerPointsEntryIntegrationAPI); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property programId (base name: "programId")', function() { + // uncomment below and update the code to test the property programId + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property customerProfileID (base name: "customerProfileID")', function() { + // uncomment below and update the code to test the property customerProfileID + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property customerSessionId (base name: "customerSessionId")', function() { + // uncomment below and update the code to test the property customerSessionId + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property startDate (base name: "startDate")', function() { + // uncomment below and update the code to test the property startDate + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property expiryDate (base name: "expiryDate")', function() { + // uncomment below and update the code to test the property expiryDate + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property subledgerId (base name: "subledgerId")', function() { + // uncomment below and update the code to test the property subledgerId + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property amount (base name: "amount")', function() { + // uncomment below and update the code to test the property amount + //var instane = new TalonOne.CardLedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/ChangeLoyaltyTierLevelEffectProps.spec.js b/test/model/ChangeLoyaltyTierLevelEffectProps.spec.js new file mode 100644 index 00000000..38dca838 --- /dev/null +++ b/test/model/ChangeLoyaltyTierLevelEffectProps.spec.js @@ -0,0 +1,95 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('ChangeLoyaltyTierLevelEffectProps', function() { + it('should create an instance of ChangeLoyaltyTierLevelEffectProps', function() { + // uncomment below and update the code to test ChangeLoyaltyTierLevelEffectProps + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be.a(TalonOne.ChangeLoyaltyTierLevelEffectProps); + }); + + it('should have the property ruleTitle (base name: "ruleTitle")', function() { + // uncomment below and update the code to test the property ruleTitle + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property programId (base name: "programId")', function() { + // uncomment below and update the code to test the property programId + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property subLedgerId (base name: "subLedgerId")', function() { + // uncomment below and update the code to test the property subLedgerId + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property previousTierName (base name: "previousTierName")', function() { + // uncomment below and update the code to test the property previousTierName + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property newTierName (base name: "newTierName")', function() { + // uncomment below and update the code to test the property newTierName + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property expiryDate (base name: "expiryDate")', function() { + // uncomment below and update the code to test the property expiryDate + //var instane = new TalonOne.ChangeLoyaltyTierLevelEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/Coupon.spec.js b/test/model/Coupon.spec.js index 5f7864a4..56cd62a5 100644 --- a/test/model/Coupon.spec.js +++ b/test/model/Coupon.spec.js @@ -180,6 +180,12 @@ //expect(instance).to.be(); }); + it('should have the property implicitlyReserved (base name: "implicitlyReserved")', function() { + // uncomment below and update the code to test the property implicitlyReserved + //var instane = new TalonOne.Coupon(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/CreateAchievement.spec.js b/test/model/CreateAchievement.spec.js new file mode 100644 index 00000000..49788c25 --- /dev/null +++ b/test/model/CreateAchievement.spec.js @@ -0,0 +1,95 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CreateAchievement(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CreateAchievement', function() { + it('should create an instance of CreateAchievement', function() { + // uncomment below and update the code to test CreateAchievement + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be.a(TalonOne.CreateAchievement); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property title (base name: "title")', function() { + // uncomment below and update the code to test the property title + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property target (base name: "target")', function() { + // uncomment below and update the code to test the property target + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property period (base name: "period")', function() { + // uncomment below and update the code to test the property period + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property periodEndOverride (base name: "periodEndOverride")', function() { + // uncomment below and update the code to test the property periodEndOverride + //var instane = new TalonOne.CreateAchievement(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CreateTemplateCampaign.spec.js b/test/model/CreateTemplateCampaign.spec.js index 28392c72..377bddfd 100644 --- a/test/model/CreateTemplateCampaign.spec.js +++ b/test/model/CreateTemplateCampaign.spec.js @@ -108,6 +108,12 @@ //expect(instance).to.be(); }); + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.CreateTemplateCampaign(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/CustomerProfileIntegrationResponseV2.spec.js b/test/model/CustomerProfileIntegrationResponseV2.spec.js new file mode 100644 index 00000000..8943d41f --- /dev/null +++ b/test/model/CustomerProfileIntegrationResponseV2.spec.js @@ -0,0 +1,113 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.CustomerProfileIntegrationResponseV2(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('CustomerProfileIntegrationResponseV2', function() { + it('should create an instance of CustomerProfileIntegrationResponseV2', function() { + // uncomment below and update the code to test CustomerProfileIntegrationResponseV2 + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be.a(TalonOne.CustomerProfileIntegrationResponseV2); + }); + + it('should have the property customerProfile (base name: "customerProfile")', function() { + // uncomment below and update the code to test the property customerProfile + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property event (base name: "event")', function() { + // uncomment below and update the code to test the property event + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property loyalty (base name: "loyalty")', function() { + // uncomment below and update the code to test the property loyalty + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property triggeredCampaigns (base name: "triggeredCampaigns")', function() { + // uncomment below and update the code to test the property triggeredCampaigns + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property ruleFailureReasons (base name: "ruleFailureReasons")', function() { + // uncomment below and update the code to test the property ruleFailureReasons + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property awardedGiveaways (base name: "awardedGiveaways")', function() { + // uncomment below and update the code to test the property awardedGiveaways + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property effects (base name: "effects")', function() { + // uncomment below and update the code to test the property effects + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property createdCoupons (base name: "createdCoupons")', function() { + // uncomment below and update the code to test the property createdCoupons + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + it('should have the property createdReferrals (base name: "createdReferrals")', function() { + // uncomment below and update the code to test the property createdReferrals + //var instane = new TalonOne.CustomerProfileIntegrationResponseV2(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/CustomerSessionV2.spec.js b/test/model/CustomerSessionV2.spec.js index 5d501a9b..9b987714 100644 --- a/test/model/CustomerSessionV2.spec.js +++ b/test/model/CustomerSessionV2.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.CustomerSessionV2(); + //expect(instance).to.be(); + }); + it('should have the property evaluableCampaignIds (base name: "evaluableCampaignIds")', function() { // uncomment below and update the code to test the property evaluableCampaignIds //var instane = new TalonOne.CustomerSessionV2(); diff --git a/test/model/Effect.spec.js b/test/model/Effect.spec.js index 3e1e1441..09fb97c2 100644 --- a/test/model/Effect.spec.js +++ b/test/model/Effect.spec.js @@ -96,6 +96,12 @@ //expect(instance).to.be(); }); + it('should have the property conditionIndex (base name: "conditionIndex")', function() { + // uncomment below and update the code to test the property conditionIndex + //var instane = new TalonOne.Effect(); + //expect(instance).to.be(); + }); + it('should have the property props (base name: "props")', function() { // uncomment below and update the code to test the property props //var instane = new TalonOne.Effect(); diff --git a/test/model/EffectEntity.spec.js b/test/model/EffectEntity.spec.js index 284bd0ce..343160e0 100644 --- a/test/model/EffectEntity.spec.js +++ b/test/model/EffectEntity.spec.js @@ -96,6 +96,12 @@ //expect(instance).to.be(); }); + it('should have the property conditionIndex (base name: "conditionIndex")', function() { + // uncomment below and update the code to test the property conditionIndex + //var instane = new TalonOne.EffectEntity(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Event.spec.js b/test/model/Event.spec.js index 5f52170b..68db3b3b 100644 --- a/test/model/Event.spec.js +++ b/test/model/Event.spec.js @@ -78,6 +78,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.Event(); + //expect(instance).to.be(); + }); + it('should have the property type (base name: "type")', function() { // uncomment below and update the code to test the property type //var instane = new TalonOne.Event(); diff --git a/test/model/EventV2.spec.js b/test/model/EventV2.spec.js index eba35b43..13c28eba 100644 --- a/test/model/EventV2.spec.js +++ b/test/model/EventV2.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.EventV2(); + //expect(instance).to.be(); + }); + it('should have the property evaluableCampaignIds (base name: "evaluableCampaignIds")', function() { // uncomment below and update the code to test the property evaluableCampaignIds //var instane = new TalonOne.EventV2(); diff --git a/test/model/ExpiringPointsNotificationPolicy.spec.js b/test/model/ExpiringPointsNotificationPolicy.spec.js index 5471415a..b005d0c6 100644 --- a/test/model/ExpiringPointsNotificationPolicy.spec.js +++ b/test/model/ExpiringPointsNotificationPolicy.spec.js @@ -66,6 +66,12 @@ //expect(instance).to.be(); }); + it('should have the property batchingEnabled (base name: "batchingEnabled")', function() { + // uncomment below and update the code to test the property batchingEnabled + //var instane = new TalonOne.ExpiringPointsNotificationPolicy(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/InlineResponse20011.spec.js b/test/model/InlineResponse20011.spec.js index 6dcf1a76..0987af9c 100644 --- a/test/model/InlineResponse20011.spec.js +++ b/test/model/InlineResponse20011.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20011); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse20011(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20012.spec.js b/test/model/InlineResponse20012.spec.js index a053e192..e9d31879 100644 --- a/test/model/InlineResponse20012.spec.js +++ b/test/model/InlineResponse20012.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20012); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20012(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20015.spec.js b/test/model/InlineResponse20015.spec.js index 0f7220d6..e12d96b3 100644 --- a/test/model/InlineResponse20015.spec.js +++ b/test/model/InlineResponse20015.spec.js @@ -60,12 +60,6 @@ //expect(instance).to.be(); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize - //var instane = new TalonOne.InlineResponse20015(); - //expect(instance).to.be(); - }); - it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20015(); diff --git a/test/model/InlineResponse20016.spec.js b/test/model/InlineResponse20016.spec.js index 34cc9531..675d0e6b 100644 --- a/test/model/InlineResponse20016.spec.js +++ b/test/model/InlineResponse20016.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize + //var instane = new TalonOne.InlineResponse20016(); + //expect(instance).to.be(); + }); + it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20016(); diff --git a/test/model/InlineResponse20017.spec.js b/test/model/InlineResponse20017.spec.js index 00135e9f..939f88aa 100644 --- a/test/model/InlineResponse20017.spec.js +++ b/test/model/InlineResponse20017.spec.js @@ -60,12 +60,6 @@ //expect(instance).to.be(); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize - //var instane = new TalonOne.InlineResponse20017(); - //expect(instance).to.be(); - }); - it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20017(); diff --git a/test/model/InlineResponse20018.spec.js b/test/model/InlineResponse20018.spec.js index 4aeba139..73c146d9 100644 --- a/test/model/InlineResponse20018.spec.js +++ b/test/model/InlineResponse20018.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize + //var instane = new TalonOne.InlineResponse20018(); + //expect(instance).to.be(); + }); + it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20018(); diff --git a/test/model/InlineResponse20019.spec.js b/test/model/InlineResponse20019.spec.js index dcf9503d..1cd2d9ea 100644 --- a/test/model/InlineResponse20019.spec.js +++ b/test/model/InlineResponse20019.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20019); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse20019(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20021.spec.js b/test/model/InlineResponse20021.spec.js index e7659ba0..9542916f 100644 --- a/test/model/InlineResponse20021.spec.js +++ b/test/model/InlineResponse20021.spec.js @@ -60,12 +60,6 @@ //expect(instance).to.be(); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore - //var instane = new TalonOne.InlineResponse20021(); - //expect(instance).to.be(); - }); - it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20021(); diff --git a/test/model/InlineResponse20022.spec.js b/test/model/InlineResponse20022.spec.js index 0858bc0d..98eab1af 100644 --- a/test/model/InlineResponse20022.spec.js +++ b/test/model/InlineResponse20022.spec.js @@ -54,14 +54,14 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20022); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20022(); //expect(instance).to.be(); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse20022(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20024.spec.js b/test/model/InlineResponse20024.spec.js index 52095770..ed553e6f 100644 --- a/test/model/InlineResponse20024.spec.js +++ b/test/model/InlineResponse20024.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize + //var instane = new TalonOne.InlineResponse20024(); + //expect(instance).to.be(); + }); + it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20024(); diff --git a/test/model/InlineResponse20028.spec.js b/test/model/InlineResponse20028.spec.js index dda7870c..2f763e47 100644 --- a/test/model/InlineResponse20028.spec.js +++ b/test/model/InlineResponse20028.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20028); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse20028(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20029.spec.js b/test/model/InlineResponse20029.spec.js index d9b3ede7..a506ae99 100644 --- a/test/model/InlineResponse20029.spec.js +++ b/test/model/InlineResponse20029.spec.js @@ -54,12 +54,6 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20029); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore - //var instane = new TalonOne.InlineResponse20029(); - //expect(instance).to.be(); - }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20029(); diff --git a/test/model/InlineResponse2003.spec.js b/test/model/InlineResponse2003.spec.js index d5b6d10b..6f370102 100644 --- a/test/model/InlineResponse2003.spec.js +++ b/test/model/InlineResponse2003.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse2003); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse2003(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20031.spec.js b/test/model/InlineResponse20031.spec.js index 400e18e7..26f22dd2 100644 --- a/test/model/InlineResponse20031.spec.js +++ b/test/model/InlineResponse20031.spec.js @@ -54,6 +54,12 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20031); }); + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore + //var instane = new TalonOne.InlineResponse20031(); + //expect(instance).to.be(); + }); + it('should have the property totalResultSize (base name: "totalResultSize")', function() { // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20031(); diff --git a/test/model/InlineResponse20032.spec.js b/test/model/InlineResponse20032.spec.js index bc8e8a3d..2bad1c1a 100644 --- a/test/model/InlineResponse20032.spec.js +++ b/test/model/InlineResponse20032.spec.js @@ -54,12 +54,6 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20032); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore - //var instane = new TalonOne.InlineResponse20032(); - //expect(instance).to.be(); - }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20032(); diff --git a/test/model/InlineResponse20033.spec.js b/test/model/InlineResponse20033.spec.js index 6f5e2fd4..aec0f32d 100644 --- a/test/model/InlineResponse20033.spec.js +++ b/test/model/InlineResponse20033.spec.js @@ -54,6 +54,12 @@ //expect(instance).to.be.a(TalonOne.InlineResponse20033); }); + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore + //var instane = new TalonOne.InlineResponse20033(); + //expect(instance).to.be(); + }); + it('should have the property totalResultSize (base name: "totalResultSize")', function() { // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse20033(); diff --git a/test/model/InlineResponse20039.spec.js b/test/model/InlineResponse20039.spec.js index 5c02cb73..1398bbb2 100644 --- a/test/model/InlineResponse20039.spec.js +++ b/test/model/InlineResponse20039.spec.js @@ -60,12 +60,6 @@ //expect(instance).to.be(); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore - //var instane = new TalonOne.InlineResponse20039(); - //expect(instance).to.be(); - }); - it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20039(); diff --git a/test/model/InlineResponse2004.spec.js b/test/model/InlineResponse2004.spec.js index e7a3e066..bad9c39e 100644 --- a/test/model/InlineResponse2004.spec.js +++ b/test/model/InlineResponse2004.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse2004); }); - it('should have the property totalResultSize (base name: "totalResultSize")', function() { - // uncomment below and update the code to test the property totalResultSize + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore //var instane = new TalonOne.InlineResponse2004(); //expect(instance).to.be(); }); diff --git a/test/model/InlineResponse20040.spec.js b/test/model/InlineResponse20040.spec.js index 0a4098a4..65792b47 100644 --- a/test/model/InlineResponse20040.spec.js +++ b/test/model/InlineResponse20040.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore + //var instane = new TalonOne.InlineResponse20040(); + //expect(instance).to.be(); + }); + it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20040(); diff --git a/test/model/InlineResponse20042.spec.js b/test/model/InlineResponse20042.spec.js new file mode 100644 index 00000000..ea0c1960 --- /dev/null +++ b/test/model/InlineResponse20042.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.InlineResponse20042(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('InlineResponse20042', function() { + it('should create an instance of InlineResponse20042', function() { + // uncomment below and update the code to test InlineResponse20042 + //var instane = new TalonOne.InlineResponse20042(); + //expect(instance).to.be.a(TalonOne.InlineResponse20042); + }); + + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize + //var instane = new TalonOne.InlineResponse20042(); + //expect(instance).to.be(); + }); + + it('should have the property data (base name: "data")', function() { + // uncomment below and update the code to test the property data + //var instane = new TalonOne.InlineResponse20042(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/InlineResponse20043.spec.js b/test/model/InlineResponse20043.spec.js new file mode 100644 index 00000000..0407a94f --- /dev/null +++ b/test/model/InlineResponse20043.spec.js @@ -0,0 +1,77 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.InlineResponse20043(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('InlineResponse20043', function() { + it('should create an instance of InlineResponse20043', function() { + // uncomment below and update the code to test InlineResponse20043 + //var instane = new TalonOne.InlineResponse20043(); + //expect(instance).to.be.a(TalonOne.InlineResponse20043); + }); + + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore + //var instane = new TalonOne.InlineResponse20043(); + //expect(instance).to.be(); + }); + + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize + //var instane = new TalonOne.InlineResponse20043(); + //expect(instance).to.be(); + }); + + it('should have the property data (base name: "data")', function() { + // uncomment below and update the code to test the property data + //var instane = new TalonOne.InlineResponse20043(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/InlineResponse2008.spec.js b/test/model/InlineResponse2008.spec.js index c757f79c..89977440 100644 --- a/test/model/InlineResponse2008.spec.js +++ b/test/model/InlineResponse2008.spec.js @@ -54,8 +54,8 @@ //expect(instance).to.be.a(TalonOne.InlineResponse2008); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore + it('should have the property totalResultSize (base name: "totalResultSize")', function() { + // uncomment below and update the code to test the property totalResultSize //var instane = new TalonOne.InlineResponse2008(); //expect(instance).to.be(); }); diff --git a/test/model/IntegrationCoupon.spec.js b/test/model/IntegrationCoupon.spec.js index 51df06e5..b65d5429 100644 --- a/test/model/IntegrationCoupon.spec.js +++ b/test/model/IntegrationCoupon.spec.js @@ -180,6 +180,12 @@ //expect(instance).to.be(); }); + it('should have the property implicitlyReserved (base name: "implicitlyReserved")', function() { + // uncomment below and update the code to test the property implicitlyReserved + //var instane = new TalonOne.IntegrationCoupon(); + //expect(instance).to.be(); + }); + it('should have the property profileRedemptionCount (base name: "profileRedemptionCount")', function() { // uncomment below and update the code to test the property profileRedemptionCount //var instane = new TalonOne.IntegrationCoupon(); diff --git a/test/model/IntegrationEvent.spec.js b/test/model/IntegrationEvent.spec.js index 974efe28..d219b537 100644 --- a/test/model/IntegrationEvent.spec.js +++ b/test/model/IntegrationEvent.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.IntegrationEvent(); + //expect(instance).to.be(); + }); + it('should have the property type (base name: "type")', function() { // uncomment below and update the code to test the property type //var instane = new TalonOne.IntegrationEvent(); diff --git a/test/model/IntegrationEventV2Request.spec.js b/test/model/IntegrationEventV2Request.spec.js index 962d90fb..c00eb4cb 100644 --- a/test/model/IntegrationEventV2Request.spec.js +++ b/test/model/IntegrationEventV2Request.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.IntegrationEventV2Request(); + //expect(instance).to.be(); + }); + it('should have the property evaluableCampaignIds (base name: "evaluableCampaignIds")', function() { // uncomment below and update the code to test the property evaluableCampaignIds //var instane = new TalonOne.IntegrationEventV2Request(); diff --git a/test/model/IntegrationStoreEntity.spec.js b/test/model/IntegrationStoreEntity.spec.js new file mode 100644 index 00000000..1873d352 --- /dev/null +++ b/test/model/IntegrationStoreEntity.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.IntegrationStoreEntity(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('IntegrationStoreEntity', function() { + it('should create an instance of IntegrationStoreEntity', function() { + // uncomment below and update the code to test IntegrationStoreEntity + //var instane = new TalonOne.IntegrationStoreEntity(); + //expect(instance).to.be.a(TalonOne.IntegrationStoreEntity); + }); + + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.IntegrationStoreEntity(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/InventoryCoupon.spec.js b/test/model/InventoryCoupon.spec.js index 96b8e136..53c76085 100644 --- a/test/model/InventoryCoupon.spec.js +++ b/test/model/InventoryCoupon.spec.js @@ -180,6 +180,12 @@ //expect(instance).to.be(); }); + it('should have the property implicitlyReserved (base name: "implicitlyReserved")', function() { + // uncomment below and update the code to test the property implicitlyReserved + //var instane = new TalonOne.InventoryCoupon(); + //expect(instance).to.be(); + }); + it('should have the property profileRedemptionCount (base name: "profileRedemptionCount")', function() { // uncomment below and update the code to test the property profileRedemptionCount //var instane = new TalonOne.InventoryCoupon(); diff --git a/test/model/LedgerPointsEntryIntegrationAPI.spec.js b/test/model/LedgerPointsEntryIntegrationAPI.spec.js new file mode 100644 index 00000000..99760460 --- /dev/null +++ b/test/model/LedgerPointsEntryIntegrationAPI.spec.js @@ -0,0 +1,113 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.LedgerPointsEntryIntegrationAPI(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('LedgerPointsEntryIntegrationAPI', function() { + it('should create an instance of LedgerPointsEntryIntegrationAPI', function() { + // uncomment below and update the code to test LedgerPointsEntryIntegrationAPI + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be.a(TalonOne.LedgerPointsEntryIntegrationAPI); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property programId (base name: "programId")', function() { + // uncomment below and update the code to test the property programId + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property customerSessionId (base name: "customerSessionId")', function() { + // uncomment below and update the code to test the property customerSessionId + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property startDate (base name: "startDate")', function() { + // uncomment below and update the code to test the property startDate + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property expiryDate (base name: "expiryDate")', function() { + // uncomment below and update the code to test the property expiryDate + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property subledgerId (base name: "subledgerId")', function() { + // uncomment below and update the code to test the property subledgerId + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + it('should have the property amount (base name: "amount")', function() { + // uncomment below and update the code to test the property amount + //var instane = new TalonOne.LedgerPointsEntryIntegrationAPI(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/NewBaseNotification.spec.js b/test/model/NewBaseNotification.spec.js index b0372c76..4c5f10ea 100644 --- a/test/model/NewBaseNotification.spec.js +++ b/test/model/NewBaseNotification.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.NewBaseNotification(); + //expect(instance).to.be(); + }); + it('should have the property webhook (base name: "webhook")', function() { // uncomment below and update the code to test the property webhook //var instane = new TalonOne.NewBaseNotification(); diff --git a/test/model/NewCampaign.spec.js b/test/model/NewCampaign.spec.js index 87fbe983..329ab4d0 100644 --- a/test/model/NewCampaign.spec.js +++ b/test/model/NewCampaign.spec.js @@ -138,6 +138,18 @@ //expect(instance).to.be(); }); + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.NewCampaign(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.NewCampaign(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/NewCampaignEvaluationGroup.spec.js b/test/model/NewCampaignEvaluationGroup.spec.js index 7463a430..d1c6af62 100644 --- a/test/model/NewCampaignEvaluationGroup.spec.js +++ b/test/model/NewCampaignEvaluationGroup.spec.js @@ -78,6 +78,12 @@ //expect(instance).to.be(); }); + it('should have the property evaluationScope (base name: "evaluationScope")', function() { + // uncomment below and update the code to test the property evaluationScope + //var instane = new TalonOne.NewCampaignEvaluationGroup(); + //expect(instance).to.be(); + }); + it('should have the property locked (base name: "locked")', function() { // uncomment below and update the code to test the property locked //var instane = new TalonOne.NewCampaignEvaluationGroup(); diff --git a/test/model/NewCampaignTemplate.spec.js b/test/model/NewCampaignTemplate.spec.js index 3958a7aa..d42d61aa 100644 --- a/test/model/NewCampaignTemplate.spec.js +++ b/test/model/NewCampaignTemplate.spec.js @@ -138,6 +138,12 @@ //expect(instance).to.be(); }); + it('should have the property campaignType (base name: "campaignType")', function() { + // uncomment below and update the code to test the property campaignType + //var instane = new TalonOne.NewCampaignTemplate(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/NewCoupons.spec.js b/test/model/NewCoupons.spec.js index adbe9b1e..fe79abeb 100644 --- a/test/model/NewCoupons.spec.js +++ b/test/model/NewCoupons.spec.js @@ -132,6 +132,12 @@ //expect(instance).to.be(); }); + it('should have the property implicitlyReserved (base name: "implicitlyReserved")', function() { + // uncomment below and update the code to test the property implicitlyReserved + //var instane = new TalonOne.NewCoupons(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/NewCustomerSessionV2.spec.js b/test/model/NewCustomerSessionV2.spec.js index ff067837..8e442b5c 100644 --- a/test/model/NewCustomerSessionV2.spec.js +++ b/test/model/NewCustomerSessionV2.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.NewCustomerSessionV2(); + //expect(instance).to.be(); + }); + it('should have the property evaluableCampaignIds (base name: "evaluableCampaignIds")', function() { // uncomment below and update the code to test the property evaluableCampaignIds //var instane = new TalonOne.NewCustomerSessionV2(); diff --git a/test/model/NewEvent.spec.js b/test/model/NewEvent.spec.js index 82fcf2f1..b94f9335 100644 --- a/test/model/NewEvent.spec.js +++ b/test/model/NewEvent.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property storeIntegrationId (base name: "storeIntegrationId")', function() { + // uncomment below and update the code to test the property storeIntegrationId + //var instane = new TalonOne.NewEvent(); + //expect(instance).to.be(); + }); + it('should have the property type (base name: "type")', function() { // uncomment below and update the code to test the property type //var instane = new TalonOne.NewEvent(); diff --git a/test/model/NewInvitation.spec.js b/test/model/NewInvitation.spec.js index eb1b3587..177a0000 100644 --- a/test/model/NewInvitation.spec.js +++ b/test/model/NewInvitation.spec.js @@ -72,6 +72,12 @@ //expect(instance).to.be(); }); + it('should have the property isAdmin (base name: "isAdmin")', function() { + // uncomment below and update the code to test the property isAdmin + //var instane = new TalonOne.NewInvitation(); + //expect(instance).to.be(); + }); + it('should have the property roles (base name: "roles")', function() { // uncomment below and update the code to test the property roles //var instane = new TalonOne.NewInvitation(); diff --git a/test/model/NewNotificationTest.spec.js b/test/model/NewNotificationTest.spec.js new file mode 100644 index 00000000..e8fafea9 --- /dev/null +++ b/test/model/NewNotificationTest.spec.js @@ -0,0 +1,95 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.NewNotificationTest(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('NewNotificationTest', function() { + it('should create an instance of NewNotificationTest', function() { + // uncomment below and update the code to test NewNotificationTest + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be.a(TalonOne.NewNotificationTest); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property queryParams (base name: "queryParams")', function() { + // uncomment below and update the code to test the property queryParams + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property headers (base name: "headers")', function() { + // uncomment below and update the code to test the property headers + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property verb (base name: "verb")', function() { + // uncomment below and update the code to test the property verb + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property url (base name: "url")', function() { + // uncomment below and update the code to test the property url + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property payload (base name: "payload")', function() { + // uncomment below and update the code to test the property payload + //var instane = new TalonOne.NewNotificationTest(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/NewNotificationWebhook.spec.js b/test/model/NewNotificationWebhook.spec.js index bf8e1aa7..93a99b71 100644 --- a/test/model/NewNotificationWebhook.spec.js +++ b/test/model/NewNotificationWebhook.spec.js @@ -66,6 +66,12 @@ //expect(instance).to.be(); }); + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.NewNotificationWebhook(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/NewRoleV2.spec.js b/test/model/NewRoleV2.spec.js index beb665ef..7dab2340 100644 --- a/test/model/NewRoleV2.spec.js +++ b/test/model/NewRoleV2.spec.js @@ -66,12 +66,6 @@ //expect(instance).to.be(); }); - it('should have the property isAdmin (base name: "isAdmin")', function() { - // uncomment below and update the code to test the property isAdmin - //var instane = new TalonOne.NewRoleV2(); - //expect(instance).to.be(); - }); - it('should have the property permissions (base name: "permissions")', function() { // uncomment below and update the code to test the property permissions //var instane = new TalonOne.NewRoleV2(); diff --git a/test/model/NewStore.spec.js b/test/model/NewStore.spec.js new file mode 100644 index 00000000..eaf132ec --- /dev/null +++ b/test/model/NewStore.spec.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.NewStore(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('NewStore', function() { + it('should create an instance of NewStore', function() { + // uncomment below and update the code to test NewStore + //var instane = new TalonOne.NewStore(); + //expect(instance).to.be.a(TalonOne.NewStore); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.NewStore(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.NewStore(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.NewStore(); + //expect(instance).to.be(); + }); + + it('should have the property integrationId (base name: "integrationId")', function() { + // uncomment below and update the code to test the property integrationId + //var instane = new TalonOne.NewStore(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/NotificationActivation.spec.js b/test/model/NotificationActivation.spec.js new file mode 100644 index 00000000..7057ddff --- /dev/null +++ b/test/model/NotificationActivation.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.NotificationActivation(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('NotificationActivation', function() { + it('should create an instance of NotificationActivation', function() { + // uncomment below and update the code to test NotificationActivation + //var instane = new TalonOne.NotificationActivation(); + //expect(instance).to.be.a(TalonOne.NotificationActivation); + }); + + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.NotificationActivation(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/NotificationTest.spec.js b/test/model/NotificationTest.spec.js new file mode 100644 index 00000000..60762c41 --- /dev/null +++ b/test/model/NotificationTest.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.NotificationTest(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('NotificationTest', function() { + it('should create an instance of NotificationTest', function() { + // uncomment below and update the code to test NotificationTest + //var instane = new TalonOne.NotificationTest(); + //expect(instance).to.be.a(TalonOne.NotificationTest); + }); + + it('should have the property httpResponse (base name: "httpResponse")', function() { + // uncomment below and update the code to test the property httpResponse + //var instane = new TalonOne.NotificationTest(); + //expect(instance).to.be(); + }); + + it('should have the property httpStatus (base name: "httpStatus")', function() { + // uncomment below and update the code to test the property httpStatus + //var instane = new TalonOne.NotificationTest(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/OneTimeCode.spec.js b/test/model/OneTimeCode.spec.js new file mode 100644 index 00000000..570688b6 --- /dev/null +++ b/test/model/OneTimeCode.spec.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.OneTimeCode(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('OneTimeCode', function() { + it('should create an instance of OneTimeCode', function() { + // uncomment below and update the code to test OneTimeCode + //var instane = new TalonOne.OneTimeCode(); + //expect(instance).to.be.a(TalonOne.OneTimeCode); + }); + + it('should have the property userId (base name: "userId")', function() { + // uncomment below and update the code to test the property userId + //var instane = new TalonOne.OneTimeCode(); + //expect(instance).to.be(); + }); + + it('should have the property accountId (base name: "accountId")', function() { + // uncomment below and update the code to test the property accountId + //var instane = new TalonOne.OneTimeCode(); + //expect(instance).to.be(); + }); + + it('should have the property token (base name: "token")', function() { + // uncomment below and update the code to test the property token + //var instane = new TalonOne.OneTimeCode(); + //expect(instance).to.be(); + }); + + it('should have the property code (base name: "code")', function() { + // uncomment below and update the code to test the property code + //var instane = new TalonOne.OneTimeCode(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/OutgoingIntegrationCleverTapPolicy.spec.js b/test/model/OutgoingIntegrationCleverTapPolicy.spec.js new file mode 100644 index 00000000..09fe022c --- /dev/null +++ b/test/model/OutgoingIntegrationCleverTapPolicy.spec.js @@ -0,0 +1,77 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.OutgoingIntegrationCleverTapPolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('OutgoingIntegrationCleverTapPolicy', function() { + it('should create an instance of OutgoingIntegrationCleverTapPolicy', function() { + // uncomment below and update the code to test OutgoingIntegrationCleverTapPolicy + //var instane = new TalonOne.OutgoingIntegrationCleverTapPolicy(); + //expect(instance).to.be.a(TalonOne.OutgoingIntegrationCleverTapPolicy); + }); + + it('should have the property baseUrl (base name: "baseUrl")', function() { + // uncomment below and update the code to test the property baseUrl + //var instane = new TalonOne.OutgoingIntegrationCleverTapPolicy(); + //expect(instance).to.be(); + }); + + it('should have the property accountId (base name: "accountId")', function() { + // uncomment below and update the code to test the property accountId + //var instane = new TalonOne.OutgoingIntegrationCleverTapPolicy(); + //expect(instance).to.be(); + }); + + it('should have the property passcode (base name: "passcode")', function() { + // uncomment below and update the code to test the property passcode + //var instane = new TalonOne.OutgoingIntegrationCleverTapPolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/OutgoingIntegrationIterablePolicy.spec.js b/test/model/OutgoingIntegrationIterablePolicy.spec.js new file mode 100644 index 00000000..691f9cfc --- /dev/null +++ b/test/model/OutgoingIntegrationIterablePolicy.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.OutgoingIntegrationIterablePolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('OutgoingIntegrationIterablePolicy', function() { + it('should create an instance of OutgoingIntegrationIterablePolicy', function() { + // uncomment below and update the code to test OutgoingIntegrationIterablePolicy + //var instane = new TalonOne.OutgoingIntegrationIterablePolicy(); + //expect(instance).to.be.a(TalonOne.OutgoingIntegrationIterablePolicy); + }); + + it('should have the property baseUrl (base name: "baseUrl")', function() { + // uncomment below and update the code to test the property baseUrl + //var instane = new TalonOne.OutgoingIntegrationIterablePolicy(); + //expect(instance).to.be(); + }); + + it('should have the property apiKey (base name: "apiKey")', function() { + // uncomment below and update the code to test the property apiKey + //var instane = new TalonOne.OutgoingIntegrationIterablePolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/OutgoingIntegrationMoEngagePolicy.spec.js b/test/model/OutgoingIntegrationMoEngagePolicy.spec.js new file mode 100644 index 00000000..d2838bee --- /dev/null +++ b/test/model/OutgoingIntegrationMoEngagePolicy.spec.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('OutgoingIntegrationMoEngagePolicy', function() { + it('should create an instance of OutgoingIntegrationMoEngagePolicy', function() { + // uncomment below and update the code to test OutgoingIntegrationMoEngagePolicy + //var instane = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + //expect(instance).to.be.a(TalonOne.OutgoingIntegrationMoEngagePolicy); + }); + + it('should have the property baseUrl (base name: "baseUrl")', function() { + // uncomment below and update the code to test the property baseUrl + //var instane = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + //expect(instance).to.be(); + }); + + it('should have the property appId (base name: "appId")', function() { + // uncomment below and update the code to test the property appId + //var instane = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + //expect(instance).to.be(); + }); + + it('should have the property dataApiId (base name: "dataApiId")', function() { + // uncomment below and update the code to test the property dataApiId + //var instane = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + //expect(instance).to.be(); + }); + + it('should have the property dataApiKey (base name: "dataApiKey")', function() { + // uncomment below and update the code to test the property dataApiKey + //var instane = new TalonOne.OutgoingIntegrationMoEngagePolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RemoveFromAudienceEffectProps.spec.js b/test/model/RemoveFromAudienceEffectProps.spec.js new file mode 100644 index 00000000..2e78aad5 --- /dev/null +++ b/test/model/RemoveFromAudienceEffectProps.spec.js @@ -0,0 +1,83 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.RemoveFromAudienceEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('RemoveFromAudienceEffectProps', function() { + it('should create an instance of RemoveFromAudienceEffectProps', function() { + // uncomment below and update the code to test RemoveFromAudienceEffectProps + //var instane = new TalonOne.RemoveFromAudienceEffectProps(); + //expect(instance).to.be.a(TalonOne.RemoveFromAudienceEffectProps); + }); + + it('should have the property audienceId (base name: "audienceId")', function() { + // uncomment below and update the code to test the property audienceId + //var instane = new TalonOne.RemoveFromAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property audienceName (base name: "audienceName")', function() { + // uncomment below and update the code to test the property audienceName + //var instane = new TalonOne.RemoveFromAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property profileIntegrationId (base name: "profileIntegrationId")', function() { + // uncomment below and update the code to test the property profileIntegrationId + //var instane = new TalonOne.RemoveFromAudienceEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property profileId (base name: "profileId")', function() { + // uncomment below and update the code to test the property profileId + //var instane = new TalonOne.RemoveFromAudienceEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RoleV2.spec.js b/test/model/RoleV2.spec.js index db368397..be0d0ab3 100644 --- a/test/model/RoleV2.spec.js +++ b/test/model/RoleV2.spec.js @@ -90,12 +90,6 @@ //expect(instance).to.be(); }); - it('should have the property isAdmin (base name: "isAdmin")', function() { - // uncomment below and update the code to test the property isAdmin - //var instane = new TalonOne.RoleV2(); - //expect(instance).to.be(); - }); - it('should have the property permissions (base name: "permissions")', function() { // uncomment below and update the code to test the property permissions //var instane = new TalonOne.RoleV2(); diff --git a/test/model/RoleV2ApplicationDetails.spec.js b/test/model/RoleV2ApplicationDetails.spec.js index a43e3082..92cf9907 100644 --- a/test/model/RoleV2ApplicationDetails.spec.js +++ b/test/model/RoleV2ApplicationDetails.spec.js @@ -72,6 +72,12 @@ //expect(instance).to.be(); }); + it('should have the property tools (base name: "tools")', function() { + // uncomment below and update the code to test the property tools + //var instane = new TalonOne.RoleV2ApplicationDetails(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/RoleV2Base.spec.js b/test/model/RoleV2Base.spec.js index 24075f05..52172d52 100644 --- a/test/model/RoleV2Base.spec.js +++ b/test/model/RoleV2Base.spec.js @@ -66,12 +66,6 @@ //expect(instance).to.be(); }); - it('should have the property isAdmin (base name: "isAdmin")', function() { - // uncomment below and update the code to test the property isAdmin - //var instane = new TalonOne.RoleV2Base(); - //expect(instance).to.be(); - }); - it('should have the property permissions (base name: "permissions")', function() { // uncomment below and update the code to test the property permissions //var instane = new TalonOne.RoleV2Base(); diff --git a/test/model/SSOConfig.spec.js b/test/model/SSOConfig.spec.js new file mode 100644 index 00000000..485c23f8 --- /dev/null +++ b/test/model/SSOConfig.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.SSOConfig(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('SSOConfig', function() { + it('should create an instance of SSOConfig', function() { + // uncomment below and update the code to test SSOConfig + //var instane = new TalonOne.SSOConfig(); + //expect(instance).to.be.a(TalonOne.SSOConfig); + }); + + it('should have the property enforced (base name: "enforced")', function() { + // uncomment below and update the code to test the property enforced + //var instane = new TalonOne.SSOConfig(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/SamlLoginEndpoint.spec.js b/test/model/SamlLoginEndpoint.spec.js index c41e389f..502c8790 100644 --- a/test/model/SamlLoginEndpoint.spec.js +++ b/test/model/SamlLoginEndpoint.spec.js @@ -54,6 +54,12 @@ //expect(instance).to.be.a(TalonOne.SamlLoginEndpoint); }); + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.SamlLoginEndpoint(); + //expect(instance).to.be(); + }); + it('should have the property name (base name: "name")', function() { // uncomment below and update the code to test the property name //var instane = new TalonOne.SamlLoginEndpoint(); diff --git a/test/model/SetDiscountPerItemEffectProps.spec.js b/test/model/SetDiscountPerItemEffectProps.spec.js index 5b8ea1b1..24075072 100644 --- a/test/model/SetDiscountPerItemEffectProps.spec.js +++ b/test/model/SetDiscountPerItemEffectProps.spec.js @@ -114,6 +114,18 @@ //expect(instance).to.be(); }); + it('should have the property targetedItemPosition (base name: "targetedItemPosition")', function() { + // uncomment below and update the code to test the property targetedItemPosition + //var instane = new TalonOne.SetDiscountPerItemEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property targetedItemSubPosition (base name: "targetedItemSubPosition")', function() { + // uncomment below and update the code to test the property targetedItemSubPosition + //var instane = new TalonOne.SetDiscountPerItemEffectProps(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Store.spec.js b/test/model/Store.spec.js new file mode 100644 index 00000000..fad7a8ba --- /dev/null +++ b/test/model/Store.spec.js @@ -0,0 +1,113 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.Store(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('Store', function() { + it('should create an instance of Store', function() { + // uncomment below and update the code to test Store + //var instane = new TalonOne.Store(); + //expect(instance).to.be.a(TalonOne.Store); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property created (base name: "created")', function() { + // uncomment below and update the code to test the property created + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property integrationId (base name: "integrationId")', function() { + // uncomment below and update the code to test the property integrationId + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property applicationId (base name: "applicationId")', function() { + // uncomment below and update the code to test the property applicationId + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property updated (base name: "updated")', function() { + // uncomment below and update the code to test the property updated + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + it('should have the property linkedCampaignIds (base name: "linkedCampaignIds")', function() { + // uncomment below and update the code to test the property linkedCampaignIds + //var instane = new TalonOne.Store(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TierDowngradeNotificationPolicy.spec.js b/test/model/TierDowngradeNotificationPolicy.spec.js new file mode 100644 index 00000000..75686599 --- /dev/null +++ b/test/model/TierDowngradeNotificationPolicy.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TierDowngradeNotificationPolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TierDowngradeNotificationPolicy', function() { + it('should create an instance of TierDowngradeNotificationPolicy', function() { + // uncomment below and update the code to test TierDowngradeNotificationPolicy + //var instane = new TalonOne.TierDowngradeNotificationPolicy(); + //expect(instance).to.be.a(TalonOne.TierDowngradeNotificationPolicy); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.TierDowngradeNotificationPolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TierUpgradeNotificationPolicy.spec.js b/test/model/TierUpgradeNotificationPolicy.spec.js new file mode 100644 index 00000000..d7bd03e3 --- /dev/null +++ b/test/model/TierUpgradeNotificationPolicy.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TierUpgradeNotificationPolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TierUpgradeNotificationPolicy', function() { + it('should create an instance of TierUpgradeNotificationPolicy', function() { + // uncomment below and update the code to test TierUpgradeNotificationPolicy + //var instane = new TalonOne.TierUpgradeNotificationPolicy(); + //expect(instance).to.be.a(TalonOne.TierUpgradeNotificationPolicy); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.TierUpgradeNotificationPolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TierWillDowngradeNotificationPolicy.spec.js b/test/model/TierWillDowngradeNotificationPolicy.spec.js new file mode 100644 index 00000000..12a78fca --- /dev/null +++ b/test/model/TierWillDowngradeNotificationPolicy.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TierWillDowngradeNotificationPolicy(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TierWillDowngradeNotificationPolicy', function() { + it('should create an instance of TierWillDowngradeNotificationPolicy', function() { + // uncomment below and update the code to test TierWillDowngradeNotificationPolicy + //var instane = new TalonOne.TierWillDowngradeNotificationPolicy(); + //expect(instance).to.be.a(TalonOne.TierWillDowngradeNotificationPolicy); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.TierWillDowngradeNotificationPolicy(); + //expect(instance).to.be(); + }); + + it('should have the property triggers (base name: "triggers")', function() { + // uncomment below and update the code to test the property triggers + //var instane = new TalonOne.TierWillDowngradeNotificationPolicy(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TierWillDowngradeNotificationTrigger.spec.js b/test/model/TierWillDowngradeNotificationTrigger.spec.js new file mode 100644 index 00000000..50c1b51c --- /dev/null +++ b/test/model/TierWillDowngradeNotificationTrigger.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TierWillDowngradeNotificationTrigger(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TierWillDowngradeNotificationTrigger', function() { + it('should create an instance of TierWillDowngradeNotificationTrigger', function() { + // uncomment below and update the code to test TierWillDowngradeNotificationTrigger + //var instane = new TalonOne.TierWillDowngradeNotificationTrigger(); + //expect(instance).to.be.a(TalonOne.TierWillDowngradeNotificationTrigger); + }); + + it('should have the property amount (base name: "amount")', function() { + // uncomment below and update the code to test the property amount + //var instane = new TalonOne.TierWillDowngradeNotificationTrigger(); + //expect(instance).to.be(); + }); + + it('should have the property period (base name: "period")', function() { + // uncomment below and update the code to test the property period + //var instane = new TalonOne.TierWillDowngradeNotificationTrigger(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TimePoint.spec.js b/test/model/TimePoint.spec.js new file mode 100644 index 00000000..dbf710db --- /dev/null +++ b/test/model/TimePoint.spec.js @@ -0,0 +1,95 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TimePoint(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TimePoint', function() { + it('should create an instance of TimePoint', function() { + // uncomment below and update the code to test TimePoint + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be.a(TalonOne.TimePoint); + }); + + it('should have the property month (base name: "month")', function() { + // uncomment below and update the code to test the property month + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + it('should have the property dayOfMonth (base name: "dayOfMonth")', function() { + // uncomment below and update the code to test the property dayOfMonth + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + it('should have the property dayOfWeek (base name: "dayOfWeek")', function() { + // uncomment below and update the code to test the property dayOfWeek + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + it('should have the property hour (base name: "hour")', function() { + // uncomment below and update the code to test the property hour + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + it('should have the property minute (base name: "minute")', function() { + // uncomment below and update the code to test the property minute + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + it('should have the property second (base name: "second")', function() { + // uncomment below and update the code to test the property second + //var instane = new TalonOne.TimePoint(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TrackEventV2Response.spec.js b/test/model/TrackEventV2Response.spec.js new file mode 100644 index 00000000..58988ded --- /dev/null +++ b/test/model/TrackEventV2Response.spec.js @@ -0,0 +1,113 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TrackEventV2Response(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TrackEventV2Response', function() { + it('should create an instance of TrackEventV2Response', function() { + // uncomment below and update the code to test TrackEventV2Response + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be.a(TalonOne.TrackEventV2Response); + }); + + it('should have the property customerProfile (base name: "customerProfile")', function() { + // uncomment below and update the code to test the property customerProfile + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property event (base name: "event")', function() { + // uncomment below and update the code to test the property event + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property loyalty (base name: "loyalty")', function() { + // uncomment below and update the code to test the property loyalty + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property triggeredCampaigns (base name: "triggeredCampaigns")', function() { + // uncomment below and update the code to test the property triggeredCampaigns + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property ruleFailureReasons (base name: "ruleFailureReasons")', function() { + // uncomment below and update the code to test the property ruleFailureReasons + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property awardedGiveaways (base name: "awardedGiveaways")', function() { + // uncomment below and update the code to test the property awardedGiveaways + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property effects (base name: "effects")', function() { + // uncomment below and update the code to test the property effects + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property createdCoupons (base name: "createdCoupons")', function() { + // uncomment below and update the code to test the property createdCoupons + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + it('should have the property createdReferrals (base name: "createdReferrals")', function() { + // uncomment below and update the code to test the property createdReferrals + //var instane = new TalonOne.TrackEventV2Response(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/TwoFAConfig.spec.js b/test/model/TwoFAConfig.spec.js new file mode 100644 index 00000000..e009ac78 --- /dev/null +++ b/test/model/TwoFAConfig.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.TwoFAConfig(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('TwoFAConfig', function() { + it('should create an instance of TwoFAConfig', function() { + // uncomment below and update the code to test TwoFAConfig + //var instane = new TalonOne.TwoFAConfig(); + //expect(instance).to.be.a(TalonOne.TwoFAConfig); + }); + + it('should have the property enabled (base name: "enabled")', function() { + // uncomment below and update the code to test the property enabled + //var instane = new TalonOne.TwoFAConfig(); + //expect(instance).to.be(); + }); + + it('should have the property requireEverySignIn (base name: "requireEverySignIn")', function() { + // uncomment below and update the code to test the property requireEverySignIn + //var instane = new TalonOne.TwoFAConfig(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/UpdateAchievement.spec.js b/test/model/UpdateAchievement.spec.js new file mode 100644 index 00000000..f2277c7f --- /dev/null +++ b/test/model/UpdateAchievement.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.UpdateAchievement(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('UpdateAchievement', function() { + it('should create an instance of UpdateAchievement', function() { + // uncomment below and update the code to test UpdateAchievement + //var instane = new TalonOne.UpdateAchievement(); + //expect(instance).to.be.a(TalonOne.UpdateAchievement); + }); + + it('should have the property title (base name: "title")', function() { + // uncomment below and update the code to test the property title + //var instane = new TalonOne.UpdateAchievement(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.UpdateAchievement(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/UpdateCampaign.spec.js b/test/model/UpdateCampaign.spec.js index f347f3f4..c2ce7973 100644 --- a/test/model/UpdateCampaign.spec.js +++ b/test/model/UpdateCampaign.spec.js @@ -132,6 +132,24 @@ //expect(instance).to.be(); }); + it('should have the property evaluationGroupId (base name: "evaluationGroupId")', function() { + // uncomment below and update the code to test the property evaluationGroupId + //var instane = new TalonOne.UpdateCampaign(); + //expect(instance).to.be(); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.UpdateCampaign(); + //expect(instance).to.be(); + }); + + it('should have the property linkedStoreIds (base name: "linkedStoreIds")', function() { + // uncomment below and update the code to test the property linkedStoreIds + //var instane = new TalonOne.UpdateCampaign(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/UpdateCampaignEvaluationGroup.spec.js b/test/model/UpdateCampaignEvaluationGroup.spec.js index 4fa4e3c4..2f1db148 100644 --- a/test/model/UpdateCampaignEvaluationGroup.spec.js +++ b/test/model/UpdateCampaignEvaluationGroup.spec.js @@ -78,6 +78,12 @@ //expect(instance).to.be(); }); + it('should have the property evaluationScope (base name: "evaluationScope")', function() { + // uncomment below and update the code to test the property evaluationScope + //var instane = new TalonOne.UpdateCampaignEvaluationGroup(); + //expect(instance).to.be(); + }); + it('should have the property locked (base name: "locked")', function() { // uncomment below and update the code to test the property locked //var instane = new TalonOne.UpdateCampaignEvaluationGroup(); diff --git a/test/model/UpdateCampaignTemplate.spec.js b/test/model/UpdateCampaignTemplate.spec.js index 90d76f15..e164c0dd 100644 --- a/test/model/UpdateCampaignTemplate.spec.js +++ b/test/model/UpdateCampaignTemplate.spec.js @@ -150,6 +150,12 @@ //expect(instance).to.be(); }); + it('should have the property campaignType (base name: "campaignType")', function() { + // uncomment below and update the code to test the property campaignType + //var instane = new TalonOne.UpdateCampaignTemplate(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/UpdateCoupon.spec.js b/test/model/UpdateCoupon.spec.js index b017faba..aacef8a1 100644 --- a/test/model/UpdateCoupon.spec.js +++ b/test/model/UpdateCoupon.spec.js @@ -108,6 +108,12 @@ //expect(instance).to.be(); }); + it('should have the property implicitlyReserved (base name: "implicitlyReserved")', function() { + // uncomment below and update the code to test the property implicitlyReserved + //var instane = new TalonOne.UpdateCoupon(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/UpdateStore.spec.js b/test/model/UpdateStore.spec.js new file mode 100644 index 00000000..383c0557 --- /dev/null +++ b/test/model/UpdateStore.spec.js @@ -0,0 +1,77 @@ +/** + * Talon.One API + * 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}` + * + * The version of the OpenAPI document: + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.UpdateStore(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('UpdateStore', function() { + it('should create an instance of UpdateStore', function() { + // uncomment below and update the code to test UpdateStore + //var instane = new TalonOne.UpdateStore(); + //expect(instance).to.be.a(TalonOne.UpdateStore); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new TalonOne.UpdateStore(); + //expect(instance).to.be(); + }); + + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new TalonOne.UpdateStore(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.UpdateStore(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/UpdateUser.spec.js b/test/model/UpdateUser.spec.js index 508b5c47..8eb5e878 100644 --- a/test/model/UpdateUser.spec.js +++ b/test/model/UpdateUser.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property isAdmin (base name: "isAdmin")', function() { + // uncomment below and update the code to test the property isAdmin + //var instane = new TalonOne.UpdateUser(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/User.spec.js b/test/model/User.spec.js index 51d83f61..c9a13d74 100644 --- a/test/model/User.spec.js +++ b/test/model/User.spec.js @@ -132,6 +132,24 @@ //expect(instance).to.be(); }); + it('should have the property isAdmin (base name: "isAdmin")', function() { + // uncomment below and update the code to test the property isAdmin + //var instane = new TalonOne.User(); + //expect(instance).to.be(); + }); + + it('should have the property lastSignedIn (base name: "lastSignedIn")', function() { + // uncomment below and update the code to test the property lastSignedIn + //var instane = new TalonOne.User(); + //expect(instance).to.be(); + }); + + it('should have the property lastAccessed (base name: "lastAccessed")', function() { + // uncomment below and update the code to test the property lastAccessed + //var instane = new TalonOne.User(); + //expect(instance).to.be(); + }); + }); }));