From 65c1e38f37246fc795efb8efc1c55ad5e15598c4 Mon Sep 17 00:00:00 2001 From: Thomas Date: Tue, 5 Nov 2024 15:02:37 +0100 Subject: [PATCH] add cardIdentifier to defintion of LoyaltyCardIdentifier (#50) * add cardIdentifier to defintion of LoyaltyCardIdentifier * version 9.1.0, add cardIdentifier to generate loyalty card * new files * revert ex in readme * bring back checksum-maven-plugin in pom --- README.md | 19 +- api/openapi.yaml | 2322 +++++++++-------- build.gradle | 2 +- build.sbt | 2 +- docs/Account.md | 1 - docs/AccountAdditionalCost.md | 1 - docs/Achievement.md | 23 +- docs/AdditionalCampaignProperties.md | 3 +- docs/Application.md | 1 - docs/ApplicationAPIKey.md | 1 - docs/ApplicationCIF.md | 1 - docs/ApplicationCIFExpression.md | 1 - docs/ApplicationCampaignAnalytics.md | 1 + docs/ApplicationCampaignStats.md | 1 + docs/ApplicationCustomer.md | 9 +- docs/ApplicationEvent.md | 1 - docs/ApplicationReferee.md | 1 - docs/ApplicationSession.md | 3 +- docs/AsyncCouponDeletionJobResponse.md | 1 - docs/Attribute.md | 1 - docs/Audience.md | 1 - docs/AudienceCustomer.md | 3 +- docs/BaseLoyaltyProgram.md | 10 + docs/BaseNotification.md | 1 - docs/BaseNotificationWebhook.md | 1 - docs/BulkOperationOnCampaigns.md | 2 + docs/Campaign.md | 14 +- docs/CampaignAnalytics.md | 1 - docs/CampaignCollection.md | 1 - docs/CampaignCollectionWithoutPayload.md | 1 - docs/CampaignEvaluationGroup.md | 1 - docs/CampaignGroup.md | 1 - docs/CampaignSet.md | 1 - docs/CampaignStoreBudget.md | 1 - docs/CampaignTemplate.md | 2 +- ...mpaignTemplateCouponReservationSettings.md | 13 + docs/CampaignVersions.md | 10 + docs/Catalog.md | 1 - docs/CatalogItem.md | 1 - docs/Change.md | 1 - docs/Collection.md | 1 - docs/CollectionItem.md | 1 - docs/CollectionWithoutPayload.md | 1 - docs/Coupon.md | 1 - docs/CouponCreationJob.md | 1 - docs/CouponDeletionJob.md | 1 - docs/CreateAchievement.md | 22 + docs/CustomEffect.md | 1 - docs/CustomerProfile.md | 3 +- docs/CustomerProfileIntegrationRequestV2.md | 2 +- docs/CustomerSession.md | 1 - docs/CustomerSessionV2.md | 6 +- docs/DeactivateUserRequest.md | 1 - docs/Effect.md | 2 +- docs/Environment.md | 1 - docs/Event.md | 1 - docs/EventType.md | 1 - docs/EventV2.md | 1 - docs/Export.md | 1 - docs/FeaturesFeed.md | 1 - docs/GenerateLoyaltyCard.md | 1 + docs/Giveaway.md | 1 - docs/IntegrationApi.md | 12 +- docs/IntegrationCoupon.md | 1 - docs/IntegrationEvent.md | 1 - docs/IntegrationEventV2Request.md | 1 - docs/InventoryCoupon.md | 1 - docs/InventoryReferral.md | 1 - docs/ItemAttribute.md | 1 - docs/LedgerEntry.md | 2 +- docs/LedgerInfo.md | 2 +- docs/LibraryAttribute.md | 1 - docs/LimitConfig.md | 1 + docs/LimitCounter.md | 1 - docs/ListCampaignStoreBudgets.md | 15 + docs/ListCampaignStoreBudgetsStore.md | 14 + docs/LoginParams.md | 1 - docs/LoyaltyBalanceWithTier.md | 2 +- docs/LoyaltyCard.md | 1 - docs/LoyaltyCardBalances.md | 2 +- docs/LoyaltyCardBatch.md | 2 +- docs/LoyaltyProgram.md | 14 +- docs/LoyaltyTier.md | 6 +- docs/ManagementApi.md | 116 +- docs/ManagementKey.md | 1 - docs/MessageLogEntry.md | 7 +- docs/ModelImport.md | 1 - docs/ModelReturn.md | 1 - docs/MultipleAudiencesItem.md | 1 - ...leCustomerProfileIntegrationRequestItem.md | 2 +- docs/NewAccountSignUp.md | 1 - docs/NewAdditionalCost.md | 1 - docs/NewApplicationAPIKey.md | 1 - docs/NewAttribute.md | 1 - docs/NewAudience.md | 1 - docs/NewBaseNotification.md | 1 - docs/NewCampaign.md | 1 - docs/NewCampaignCollection.md | 1 - docs/NewCampaignSet.md | 1 - docs/NewCampaignStoreBudget.md | 33 + docs/NewCampaignStoreBudgetStoreLimit.md | 13 + docs/NewCampaignTemplate.md | 1 + docs/NewCatalog.md | 1 - docs/NewCollection.md | 1 - docs/NewCouponCreationJob.md | 1 - docs/NewCoupons.md | 1 - docs/NewCouponsForMultipleRecipients.md | 1 - docs/NewCustomEffect.md | 1 - docs/NewCustomerSession.md | 1 - docs/NewCustomerSessionV2.md | 2 +- docs/NewEvent.md | 1 - docs/NewEventType.md | 1 - docs/NewLoyaltyProgram.md | 12 +- docs/NewLoyaltyTier.md | 4 +- docs/NewManagementKey.md | 1 - docs/NewMultipleAudiencesItem.md | 1 - docs/NewReferral.md | 1 - docs/NewReferralsForMultipleAdvocates.md | 1 - docs/NewRole.md | 1 - docs/NewRoleV2.md | 1 - docs/NewSamlConnection.md | 2 +- docs/NewStore.md | 1 - docs/NewUser.md | 1 - docs/NewWebhook.md | 1 - ...grationTemplateWithConfigurationDetails.md | 1 - docs/Picklist.md | 1 - docs/Referral.md | 1 - docs/Revision.md | 1 - docs/RevisionVersion.md | 1 - docs/Role.md | 1 - docs/RoleAssign.md | 1 - docs/RoleV2.md | 1 - docs/Ruleset.md | 1 - docs/SamlConnection.md | 2 +- docs/ScimNewUser.md | 2 +- docs/ScimServiceProviderConfigResponse.md | 1 + docs/ScimServiceProviderConfigResponseSort.md | 13 + docs/ScimUser.md | 2 +- docs/Store.md | 3 +- docs/SummaryCampaignStoreBudget.md | 48 + docs/TalangAttribute.md | 1 - docs/TemplateArgDef.md | 1 - docs/TemplateDef.md | 1 - docs/TemplateLimitConfig.md | 2 +- docs/UpdateAchievement.md | 22 + docs/UpdateCampaignEvaluationGroup.md | 1 - docs/UpdateCampaignGroup.md | 1 - docs/UpdateCampaignTemplate.md | 1 + docs/UpdateCoupon.md | 1 - docs/UpdateCouponBatch.md | 1 - docs/UpdateLoyaltyProgram.md | 12 +- docs/UpdateLoyaltyProgramTier.md | 15 + docs/UpdatePicklist.md | 1 - docs/User.md | 1 - docs/Webhook.md | 3 +- docs/WebhookLogEntry.md | 2 +- docs/WebhookWithOutgoingIntegrationDetails.md | 3 +- pom.xml | 2 +- src/main/java/one/talon/ApiClient.java | 2 +- .../java/one/talon/api/IntegrationApi.java | 32 +- .../java/one/talon/api/ManagementApi.java | 238 +- src/main/java/one/talon/model/Account.java | 3 +- .../talon/model/AccountAdditionalCost.java | 3 +- .../one/talon/model/AccountAnalytics.java | 2 +- .../java/one/talon/model/Achievement.java | 215 +- .../model/AdditionalCampaignProperties.java | 10 +- .../java/one/talon/model/Application.java | 3 +- .../one/talon/model/ApplicationAPIKey.java | 3 +- .../java/one/talon/model/ApplicationCIF.java | 3 +- .../talon/model/ApplicationCIFExpression.java | 3 +- .../model/ApplicationCampaignAnalytics.java | 4 +- .../talon/model/ApplicationCampaignStats.java | 30 +- .../one/talon/model/ApplicationCustomer.java | 19 +- .../one/talon/model/ApplicationEvent.java | 3 +- .../one/talon/model/ApplicationReferee.java | 3 +- .../one/talon/model/ApplicationSession.java | 7 +- .../model/AsyncCouponDeletionJobResponse.java | 3 +- src/main/java/one/talon/model/Attribute.java | 3 +- src/main/java/one/talon/model/Audience.java | 3 +- .../one/talon/model/AudienceCustomer.java | 7 +- .../one/talon/model/BaseLoyaltyProgram.java | 80 +- .../one/talon/model/BaseNotification.java | 3 +- .../talon/model/BaseNotificationWebhook.java | 3 +- .../talon/model/BulkOperationOnCampaigns.java | 38 +- src/main/java/one/talon/model/Campaign.java | 91 +- .../one/talon/model/CampaignAnalytics.java | 3 +- .../one/talon/model/CampaignCollection.java | 3 +- .../CampaignCollectionWithoutPayload.java | 3 +- .../talon/model/CampaignEvaluationGroup.java | 3 +- .../java/one/talon/model/CampaignGroup.java | 3 +- .../java/one/talon/model/CampaignSet.java | 3 +- .../one/talon/model/CampaignStoreBudget.java | 3 +- .../one/talon/model/CampaignTemplate.java | 37 +- ...aignTemplateCouponReservationSettings.java | 130 + .../one/talon/model/CampaignVersions.java | 80 +- src/main/java/one/talon/model/Catalog.java | 3 +- .../java/one/talon/model/CatalogItem.java | 3 +- src/main/java/one/talon/model/Change.java | 3 +- src/main/java/one/talon/model/Collection.java | 3 +- .../java/one/talon/model/CollectionItem.java | 3 +- .../talon/model/CollectionWithoutPayload.java | 3 +- src/main/java/one/talon/model/Coupon.java | 3 +- .../one/talon/model/CouponCreationJob.java | 3 +- .../talon/model/CouponDeletionFilters.java | 2 +- .../one/talon/model/CouponDeletionJob.java | 3 +- .../one/talon/model/CreateAchievement.java | 215 +- .../java/one/talon/model/CustomEffect.java | 3 +- .../java/one/talon/model/CustomerProfile.java | 7 +- .../java/one/talon/model/CustomerSession.java | 5 +- .../one/talon/model/CustomerSessionV2.java | 12 +- .../talon/model/DeactivateUserRequest.java | 3 +- src/main/java/one/talon/model/Effect.java | 4 +- .../java/one/talon/model/Environment.java | 3 +- src/main/java/one/talon/model/Event.java | 3 +- src/main/java/one/talon/model/EventType.java | 3 +- src/main/java/one/talon/model/EventV2.java | 3 +- src/main/java/one/talon/model/Export.java | 3 +- .../java/one/talon/model/FeatureFlag.java | 2 +- .../java/one/talon/model/FeaturesFeed.java | 3 +- .../one/talon/model/GenerateLoyaltyCard.java | 33 +- src/main/java/one/talon/model/Giveaway.java | 3 +- .../one/talon/model/IntegrationCoupon.java | 3 +- .../one/talon/model/IntegrationEvent.java | 3 +- .../java/one/talon/model/InventoryCoupon.java | 3 +- .../one/talon/model/InventoryReferral.java | 3 +- .../java/one/talon/model/ItemAttribute.java | 3 +- .../java/one/talon/model/LedgerEntry.java | 4 +- src/main/java/one/talon/model/LedgerInfo.java | 4 +- .../one/talon/model/LibraryAttribute.java | 3 +- .../java/one/talon/model/LimitConfig.java | 4 +- .../java/one/talon/model/LimitCounter.java | 3 +- .../talon/model/ListCampaignStoreBudgets.java | 184 ++ .../model/ListCampaignStoreBudgetsStore.java | 154 ++ .../java/one/talon/model/LoginParams.java | 3 +- .../talon/model/LoyaltyBalanceWithTier.java | 4 +- .../java/one/talon/model/LoyaltyCard.java | 3 +- .../one/talon/model/LoyaltyCardBalances.java | 4 +- .../one/talon/model/LoyaltyCardBatch.java | 37 +- .../one/talon/model/LoyaltyMembership.java | 2 +- .../java/one/talon/model/LoyaltyProgram.java | 86 +- .../java/one/talon/model/LoyaltyTier.java | 12 +- .../java/one/talon/model/ManagementKey.java | 3 +- .../java/one/talon/model/MessageLogEntry.java | 132 +- .../java/one/talon/model/ModelImport.java | 3 +- .../java/one/talon/model/ModelReturn.java | 3 +- .../talon/model/MultipleAudiencesItem.java | 3 +- .../one/talon/model/NewAccountSignUp.java | 3 +- .../one/talon/model/NewAdditionalCost.java | 3 +- .../one/talon/model/NewApplicationAPIKey.java | 3 +- .../java/one/talon/model/NewAttribute.java | 3 +- .../java/one/talon/model/NewAudience.java | 3 +- .../one/talon/model/NewBaseNotification.java | 3 +- .../java/one/talon/model/NewCampaign.java | 3 +- .../talon/model/NewCampaignCollection.java | 3 +- .../java/one/talon/model/NewCampaignSet.java | 3 +- .../talon/model/NewCampaignStoreBudget.java | 259 ++ .../NewCampaignStoreBudgetStoreLimit.java | 127 + .../one/talon/model/NewCampaignTemplate.java | 32 +- src/main/java/one/talon/model/NewCatalog.java | 3 +- .../java/one/talon/model/NewCollection.java | 3 +- .../one/talon/model/NewCouponCreationJob.java | 3 +- src/main/java/one/talon/model/NewCoupons.java | 3 +- .../NewCouponsForMultipleRecipients.java | 3 +- .../java/one/talon/model/NewCustomEffect.java | 3 +- .../java/one/talon/model/NewEventType.java | 3 +- .../one/talon/model/NewLoyaltyProgram.java | 82 +- .../java/one/talon/model/NewLoyaltyTier.java | 8 +- .../one/talon/model/NewManagementKey.java | 3 +- .../talon/model/NewMultipleAudiencesItem.java | 3 +- .../java/one/talon/model/NewReferral.java | 3 +- src/main/java/one/talon/model/NewRole.java | 3 +- src/main/java/one/talon/model/NewRoleV2.java | 3 +- .../one/talon/model/NewSamlConnection.java | 4 +- src/main/java/one/talon/model/NewStore.java | 3 +- src/main/java/one/talon/model/NewUser.java | 3 +- src/main/java/one/talon/model/NewWebhook.java | 3 +- ...ationTemplateWithConfigurationDetails.java | 3 +- src/main/java/one/talon/model/Picklist.java | 3 +- src/main/java/one/talon/model/Referral.java | 3 +- src/main/java/one/talon/model/Revision.java | 3 +- .../java/one/talon/model/RevisionVersion.java | 3 +- src/main/java/one/talon/model/Role.java | 3 +- src/main/java/one/talon/model/RoleAssign.java | 3 +- src/main/java/one/talon/model/RoleV2.java | 3 +- src/main/java/one/talon/model/Ruleset.java | 3 +- .../java/one/talon/model/SamlConnection.java | 4 +- .../java/one/talon/model/ScimNewUser.java | 3 +- .../ScimServiceProviderConfigResponse.java | 34 +- ...ScimServiceProviderConfigResponseSort.java | 100 + src/main/java/one/talon/model/ScimUser.java | 3 +- src/main/java/one/talon/model/Store.java | 7 +- .../model/SummaryCampaignStoreBudget.java | 281 ++ .../java/one/talon/model/TalangAttribute.java | 3 +- .../java/one/talon/model/TemplateArgDef.java | 3 +- .../java/one/talon/model/TemplateDef.java | 3 +- .../one/talon/model/TemplateLimitConfig.java | 7 +- .../one/talon/model/UpdateAchievement.java | 215 +- .../model/UpdateCampaignEvaluationGroup.java | 3 +- .../one/talon/model/UpdateCampaignGroup.java | 3 +- .../talon/model/UpdateCampaignTemplate.java | 32 +- .../java/one/talon/model/UpdateCoupon.java | 3 +- .../one/talon/model/UpdateCouponBatch.java | 3 +- .../one/talon/model/UpdateLoyaltyProgram.java | 82 +- .../talon/model/UpdateLoyaltyProgramTier.java | 160 ++ .../java/one/talon/model/UpdatePicklist.java | 3 +- src/main/java/one/talon/model/User.java | 3 +- src/main/java/one/talon/model/Webhook.java | 7 +- .../java/one/talon/model/WebhookLogEntry.java | 4 +- ...WebhookWithOutgoingIntegrationDetails.java | 7 +- .../one/talon/api/IntegrationApiTest.java | 6 +- .../java/one/talon/api/ManagementApiTest.java | 11 +- .../java/one/talon/model/AchievementTest.java | 32 + .../model/ApplicationCampaignStatsTest.java | 8 + .../talon/model/BaseLoyaltyProgramTest.java | 8 + .../model/BulkOperationOnCampaignsTest.java | 9 + ...TemplateCouponReservationSettingsTest.java | 59 + .../one/talon/model/CampaignTemplateTest.java | 9 + .../java/one/talon/model/CampaignTest.java | 8 + .../one/talon/model/CampaignVersionsTest.java | 8 + .../talon/model/CreateAchievementTest.java | 33 + .../talon/model/GenerateLoyaltyCardTest.java | 8 + .../ListCampaignStoreBudgetsStoreTest.java | 67 + .../model/ListCampaignStoreBudgetsTest.java | 76 + .../one/talon/model/LoyaltyCardBatchTest.java | 9 + .../one/talon/model/LoyaltyProgramTest.java | 8 + .../one/talon/model/MessageLogEntryTest.java | 32 + .../NewCampaignStoreBudgetStoreLimitTest.java | 60 + .../model/NewCampaignStoreBudgetTest.java | 70 + .../talon/model/NewCampaignTemplateTest.java | 9 + .../talon/model/NewLoyaltyProgramTest.java | 8 + ...ServiceProviderConfigResponseSortTest.java | 51 + ...ScimServiceProviderConfigResponseTest.java | 9 + .../model/SummaryCampaignStoreBudgetTest.java | 67 + .../talon/model/UpdateAchievementTest.java | 33 + .../model/UpdateCampaignTemplateTest.java | 9 + .../talon/model/UpdateLoyaltyProgramTest.java | 8 + .../model/UpdateLoyaltyProgramTierTest.java | 68 + 337 files changed, 5678 insertions(+), 1741 deletions(-) create mode 100644 docs/CampaignTemplateCouponReservationSettings.md create mode 100644 docs/ListCampaignStoreBudgets.md create mode 100644 docs/ListCampaignStoreBudgetsStore.md create mode 100644 docs/NewCampaignStoreBudget.md create mode 100644 docs/NewCampaignStoreBudgetStoreLimit.md create mode 100644 docs/ScimServiceProviderConfigResponseSort.md create mode 100644 docs/SummaryCampaignStoreBudget.md create mode 100644 docs/UpdateLoyaltyProgramTier.md create mode 100644 src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java create mode 100644 src/main/java/one/talon/model/ListCampaignStoreBudgets.java create mode 100644 src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java create mode 100644 src/main/java/one/talon/model/NewCampaignStoreBudget.java create mode 100644 src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java create mode 100644 src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java create mode 100644 src/main/java/one/talon/model/SummaryCampaignStoreBudget.java create mode 100644 src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java create mode 100644 src/test/java/one/talon/model/CampaignTemplateCouponReservationSettingsTest.java create mode 100644 src/test/java/one/talon/model/ListCampaignStoreBudgetsStoreTest.java create mode 100644 src/test/java/one/talon/model/ListCampaignStoreBudgetsTest.java create mode 100644 src/test/java/one/talon/model/NewCampaignStoreBudgetStoreLimitTest.java create mode 100644 src/test/java/one/talon/model/NewCampaignStoreBudgetTest.java create mode 100644 src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java create mode 100644 src/test/java/one/talon/model/SummaryCampaignStoreBudgetTest.java create mode 100644 src/test/java/one/talon/model/UpdateLoyaltyProgramTierTest.java diff --git a/README.md b/README.md index e81c2949..9cd8b2f8 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Add this dependency to your project's POM: one.talon talon-one-client - 9.0.2 + 9.1.0 compile ``` @@ -63,7 +63,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "one.talon:talon-one-client:9.0.2" +compile "one.talon:talon-one-client:9.1.0" ``` ### Others @@ -76,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/talon-one-client-9.0.2.jar` +* `target/talon-one-client-9.1.0.jar` * `target/lib/*.jar` ## Getting Started @@ -219,7 +219,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**generateLoyaltyCard**](docs/IntegrationApi.md#generateLoyaltyCard) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card *IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data *IntegrationApi* | [**getCustomerSession**](docs/IntegrationApi.md#getCustomerSession) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session -*IntegrationApi* | [**getLoyaltyBalances**](docs/IntegrationApi.md#getLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points +*IntegrationApi* | [**getLoyaltyBalances**](docs/IntegrationApi.md#getLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances *IntegrationApi* | [**getLoyaltyCardBalances**](docs/IntegrationApi.md#getLoyaltyCardBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances *IntegrationApi* | [**getLoyaltyCardPoints**](docs/IntegrationApi.md#getLoyaltyCardPoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points *IntegrationApi* | [**getLoyaltyCardTransactions**](docs/IntegrationApi.md#getLoyaltyCardTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions @@ -425,7 +425,6 @@ Class | Method | HTTP request | Description - [Achievement](docs/Achievement.md) - [AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md) - [AchievementProgress](docs/AchievementProgress.md) - - [ActivateUserRequest](docs/ActivateUserRequest.md) - [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) - [AddItemCatalogAction](docs/AddItemCatalogAction.md) - [AddLoyaltyPoints](docs/AddLoyaltyPoints.md) @@ -506,6 +505,7 @@ Class | Method | HTTP request | Description - [CampaignStoreBudget](docs/CampaignStoreBudget.md) - [CampaignTemplate](docs/CampaignTemplate.md) - [CampaignTemplateCollection](docs/CampaignTemplateCollection.md) + - [CampaignTemplateCouponReservationSettings](docs/CampaignTemplateCouponReservationSettings.md) - [CampaignTemplateParams](docs/CampaignTemplateParams.md) - [CampaignVersions](docs/CampaignVersions.md) - [CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md) @@ -562,7 +562,6 @@ Class | Method | HTTP request | Description - [DeactivateUserRequest](docs/DeactivateUserRequest.md) - [DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md) - [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md) - - [DeleteUserRequest](docs/DeleteUserRequest.md) - [Effect](docs/Effect.md) - [EffectEntity](docs/EffectEntity.md) - [EmailEntity](docs/EmailEntity.md) @@ -668,6 +667,8 @@ Class | Method | HTTP request | Description - [LibraryAttribute](docs/LibraryAttribute.md) - [LimitConfig](docs/LimitConfig.md) - [LimitCounter](docs/LimitCounter.md) + - [ListCampaignStoreBudgets](docs/ListCampaignStoreBudgets.md) + - [ListCampaignStoreBudgetsStore](docs/ListCampaignStoreBudgetsStore.md) - [LoginParams](docs/LoginParams.md) - [Loyalty](docs/Loyalty.md) - [LoyaltyBalance](docs/LoyaltyBalance.md) @@ -728,6 +729,8 @@ Class | Method | HTTP request | Description - [NewCampaignEvaluationGroup](docs/NewCampaignEvaluationGroup.md) - [NewCampaignGroup](docs/NewCampaignGroup.md) - [NewCampaignSet](docs/NewCampaignSet.md) + - [NewCampaignStoreBudget](docs/NewCampaignStoreBudget.md) + - [NewCampaignStoreBudgetStoreLimit](docs/NewCampaignStoreBudgetStoreLimit.md) - [NewCampaignTemplate](docs/NewCampaignTemplate.md) - [NewCatalog](docs/NewCatalog.md) - [NewCollection](docs/NewCollection.md) @@ -848,6 +851,7 @@ Class | Method | HTTP request | Description - [ScimServiceProviderConfigResponseChangePassword](docs/ScimServiceProviderConfigResponseChangePassword.md) - [ScimServiceProviderConfigResponseFilter](docs/ScimServiceProviderConfigResponseFilter.md) - [ScimServiceProviderConfigResponsePatch](docs/ScimServiceProviderConfigResponsePatch.md) + - [ScimServiceProviderConfigResponseSort](docs/ScimServiceProviderConfigResponseSort.md) - [ScimUser](docs/ScimUser.md) - [ScimUsersListResponse](docs/ScimUsersListResponse.md) - [Session](docs/Session.md) @@ -865,6 +869,7 @@ Class | Method | HTTP request | Description - [StrikethroughLabelingNotification](docs/StrikethroughLabelingNotification.md) - [StrikethroughSetDiscountPerItemEffectProps](docs/StrikethroughSetDiscountPerItemEffectProps.md) - [StrikethroughTrigger](docs/StrikethroughTrigger.md) + - [SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.md) - [TalangAttribute](docs/TalangAttribute.md) - [TalangAttributeVisibility](docs/TalangAttributeVisibility.md) - [TemplateArgDef](docs/TemplateArgDef.md) @@ -896,9 +901,9 @@ Class | Method | HTTP request | Description - [UpdateCollection](docs/UpdateCollection.md) - [UpdateCoupon](docs/UpdateCoupon.md) - [UpdateCouponBatch](docs/UpdateCouponBatch.md) - - [UpdateCustomEffect](docs/UpdateCustomEffect.md) - [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md) - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) + - [UpdateLoyaltyProgramTier](docs/UpdateLoyaltyProgramTier.md) - [UpdatePicklist](docs/UpdatePicklist.md) - [UpdateReferral](docs/UpdateReferral.md) - [UpdateReferralBatch](docs/UpdateReferralBatch.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index b4d35a26..57f0bc62 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -23,15 +23,6 @@ security: - manager_auth: [] - management_key: [] tags: -- description: | - Endpoints used for communication between Talon.One and the AI assistant. - name: AI assistant -- description: | - Represents the API used to send [Integration API](https://docs.talon.one/docs/dev/integration-api/overview) requests to a given Application. - name: API keys -- description: | - Operations regarding account statistics. - name: Account statistics - description: | Operations for updating account information such as billing email addresses, inviting users, etc. name: Accounts and users @@ -95,20 +86,12 @@ tags: See the [docs](https://docs.talon.one/docs/product/campaigns/managing-collections). name: Collections -- description: | - Represents a configuration for the Campaign Manager. - name: Config - description: | Coupons are unique codes belonging to a particular campaign. They don't define any behavior on their own. Instead the campaign ruleset can include rules that validate coupons and carry out particular effects. See the [docs](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). name: Coupons -- description: | - Represents the custom effects that users can create. - - See the [docs](https://docs.talon.one/docs/product/account/dev-tools/managing-custom-effects). - name: Custom effects - description: | Represents the data of a customer, including sessions and events used for reporting and debugging in the Campaign Manager. name: Customer data @@ -123,9 +106,6 @@ tags: Sessions are a key concept of Talon.One. We strongly recommend you read the [documentation about customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). name: Customer sessions -- description: | - Represents internal database-related operations. - name: Database - description: | Represents a single occurrence of a specific customer action, for example, updating the cart or signing up for a newsletter. @@ -133,20 +113,11 @@ tags: - **Built-in events:** They are triggered by various endpoints, such as the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. [Learn more](https://docs.talon.one/docs/dev/concepts/entities/events). - **Custom events:** They are triggered by the [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. name: Events -- description: | - How we enable features in accounts. - name: Feature flags - description: | Represents a program that rewards customers with giveaways, such as free gift cards. See the [docs](https://docs.talon.one/docs/product/giveaways/overview). name: Giveaways -- description: | - Represents internal notification operations. Not to be confused with the [notifications relying on webhooks](#tag/Notifications). - name: Internal notifications -- description: Represents endpoints used internally by other endpoints. Do not use - them. - name: Internal routing - description: | Operations to query the Talon.One logs. They contain all incoming and outgoing requests. name: Logs @@ -163,23 +134,9 @@ tags: [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow your customers to collect and spend loyalty points within a card-based loyalty program. name: Loyalty cards -- description: | - Represents a key to access specified endpoints of the Management API programmatically. - name: Management keys - description: | Represents the notifications that customers can create about various events. See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). name: Notifications -- description: | - Represents various Integration API endpoints used internally for authentication. Do not use them. - name: Other -- description: | - Represents the outgoing integrations that we currently support. - - An outgoing integration may be, for example, a customer data platform or customer engagement platform. - name: Outgoing integrations -- description: | - Represents the picklist that users can create for a custom effect. - name: Picklists - description: | A referral is a code shared between a customer and a prospect. @@ -195,27 +152,13 @@ tags: See the [docs](https://docs.talon.one/docs/product/account/account-settings/managing-roles). name: Roles -- description: | - Represents the endpoints related to the SAML configuration used for single sign-on (SSO). - name: SAML - description: | Represents a session used for authentication purposes. Create one with the [Create session](#operation/createSession) endpoint. name: Sessions -- description: | - Represents [single sign-on](https://docs.talon.one/docs/product/account/account-settings/setting-up-sso) (SSO) configuration-related endpoints. - - Single sign-on is a way to allow users to access many service providers using a single username and password by relying on a single identity provider. - name: Single sign-on - description: | Represents physical or digital stores, branches, and franchises. name: Stores -- description: | - Talang template operations. - name: Talang templates -- description: | - Represents [two-factor authentication](https://docs.talon.one/docs/product/account/account-settings/setting-up-2fa) (2FA) that requires users of an organization to enter a one-time security code sent to their email address when signing in to their Talon.One account. - name: Two-factor authentication - description: | A way to send information from Talon.One to the URI of your choice. @@ -1195,7 +1138,12 @@ paths: description: | Delete all attributes on the customer profile and on entities that reference this customer profile. - **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. + **Important:** + - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) + that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, + customer data will be deleted from all sandbox Applications. This is because customer data is shared + between Applications from the same environment. + - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. operationId: deleteCustomerData parameters: - description: | @@ -1495,7 +1443,7 @@ paths: format: date-time type: string - description: Filter results by one or more subledger IDs. Must be exact match. - explode: false + explode: true in: query name: subledgerId schema: @@ -1538,7 +1486,7 @@ paths: get: description: | Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. - You can filter balances by date and subledger ID. + You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. @@ -1597,7 +1545,7 @@ paths: - description: | Indicates whether the customer's projected tier information is included in the response. - When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. + When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. in: query @@ -1632,7 +1580,7 @@ paths: description: Not found security: - api_key_v1: [] - summary: Get customer's loyalty points + summary: Get customer's loyalty balances tags: - integration x-accepts: application/json @@ -1661,7 +1609,7 @@ paths: maxLength: 108 type: string - description: Filter results by one or more subledger IDs. Must be exact match. - explode: false + explode: true in: query name: subledgerId schema: @@ -1907,7 +1855,7 @@ paths: - expired type: string - description: Filter results by one or more subledger IDs. Must be exact match. - explode: false + explode: true in: query name: subledgerId schema: @@ -2164,6 +2112,7 @@ paths: - scheduled - running - expired + - staged type: string - description: Filter results performing case-insensitive matching against the name of the campaign. @@ -2199,7 +2148,7 @@ paths: name: campaignGroupId schema: type: integer - - description: The ID of the Campaign Template this Campaign was created from. + - description: The ID of the campaign template this campaign was created from. in: query name: templateId schema: @@ -2605,6 +2554,7 @@ paths: - scheduled - running - expired + - staged type: string requestBody: content: @@ -2825,7 +2775,7 @@ paths: schema: type: integer - description: | - Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. in: query name: recipientIntegrationId schema: @@ -3182,8 +3132,8 @@ paths: name: referralId schema: type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field + - description: Filter results by match with a profile ID specified in the coupon's + RecipientIntegrationId field. in: query name: recipientIntegrationId schema: @@ -3194,7 +3144,7 @@ paths: schema: type: string - description: Filter results to an exact case-insensitive matching against - the coupon code + the coupon code. in: query name: exactMatch schema: @@ -3435,14 +3385,14 @@ paths: name: referralId schema: type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field + - description: Filter results by match with a profile ID specified in the coupon's + RecipientIntegrationId field. in: query name: recipientIntegrationId schema: type: string - description: Filter results to an exact case-insensitive matching against - the coupon code + the coupon code. in: query name: exactMatch schema: @@ -3562,8 +3512,8 @@ paths: name: referralId schema: type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field + - description: Filter results by match with a profile ID specified in the coupon's + RecipientIntegrationId field. in: query name: recipientIntegrationId schema: @@ -3574,7 +3524,7 @@ paths: schema: type: string - description: Filter results to an exact case-insensitive matching against - the coupon code + the coupon code. in: query name: exactMatch schema: @@ -3598,6 +3548,7 @@ paths: - scheduled - running - expired + - staged type: string requestBody: content: @@ -3779,8 +3730,8 @@ paths: - "true" - "false" type: string - - description: Filter results by match with a profile id specified in the referral's - AdvocateProfileIntegrationId field + - description: Filter results by match with a profile ID specified in the referral's + AdvocateProfileIntegrationId field. in: query name: advocate schema: @@ -4381,10 +4332,6 @@ paths: "200": content: application/csv: - example: | - customerprofileid,customersessionid,rulesetid,rulename,programid,type,name,subledgerid,startdate,expirydate,id,created,amount,archived,campaignid - 8NHOS78H,06b0fafb-ccbf-42c7-b44b-d858e8b525022,1691,test,37,subtraction,10% of current total,,immediate,unlimited,60803,2022-11-29 16:16:10,100.00,false,5 - EB780RDN,06b0fafb-ccbf-42c7-b44b-d858e8b525022,1691,test,37,addition,Reimbursed loyalty points,,immediate,unlimited,60804,2022-11-29 16:16:23,100.00,false,5 schema: format: csv type: string @@ -4441,10 +4388,6 @@ paths: "200": content: application/csv: - example: | - programid,subledgerid,customerprofileid,tiername,startdate,expirydate - 1,SUB1,Dinesh,Golden,2023-08-02T15:04:05Z07:00,2024-08-02T15:04:05Z07:00 - 1,SUB2,Gilfoyle,Silver,2023-03-21T03:45:12Z05:00,2026-03-21T03:45:12Z05:00 schema: format: csv type: string @@ -4523,10 +4466,6 @@ paths: "200": content: application/csv: - example: | - loyaltyProgramID,loyaltySubledger,profileIntegrationID,currentBalance,pendingBalance,expiredBalance,spentBalance,currentTier - 40,,8786NTHSAO8,10.00,0.00,0.00,0.00,First - 40,,2735HATHOH8,20.00,0.00,0.00,0.00,First schema: format: csv type: string @@ -4868,9 +4807,6 @@ paths: "200": content: application/csv: - example: | - loyaltyProgramID,loyaltySubledger,cardIdentifier,cardState,currentBalance,pendingBalance,expiredBalance,spentBalance - 40,,111,active,10,0,0,0,5 schema: format: csv type: string @@ -5051,13 +4987,18 @@ paths: name: batchId schema: type: string + - description: Determines the format of dates in the export document. + in: query + name: dateFormat + schema: + enum: + - excel + - ISO8601 + type: string responses: "200": content: application/csv: - example: | - identifier,created,status,userpercardlimit,customerprofileids,blockreason,generated,batchid - CARD-1234,2020-06-10T09:05:27.993483Z,active,3,['profile1'],card limit reached,false,gwedcbfp schema: format: csv type: string @@ -5688,9 +5629,6 @@ paths: "200": content: application/csv: - example: | - id,poolid,code,startdate,enddate,attributes,used,importid,created,profileintegrationid,profileid - 1,7,af18bc3839799451fb6d6b6467cf4c25e,2023-04-11T12:47:47Z,2024-04-11T12:47:47Z,"{""attribute"": ""value""}",true,2,2023-04-11T12:47:47Z,R195412,35 schema: format: csv type: string @@ -6433,11 +6371,6 @@ paths: "200": content: application/csv: - example: | - item - SKU1 - SKU2 - SKU3 schema: format: csv type: string @@ -6491,11 +6424,6 @@ paths: "200": content: application/csv: - example: | - item - SKU1 - SKU2 - SKU3 schema: format: csv type: string @@ -6924,7 +6852,7 @@ paths: name: skip schema: type: integer - - description: Indicates whether you are pointing to a sandbox or Live customer. + - description: Indicates whether you are pointing to a sandbox or live customer. in: query name: sandbox schema: @@ -7004,7 +6932,7 @@ paths: name: skip schema: type: integer - - description: Indicates whether you are pointing to a sandbox or Live customer. + - description: Indicates whether you are pointing to a sandbox or live customer. in: query name: sandbox schema: @@ -7113,7 +7041,7 @@ paths: required: true schema: type: integer - - description: Only return reports matching the customer name + - description: Only return reports matching the customer name. in: query name: name schema: @@ -7124,12 +7052,12 @@ paths: name: integrationId schema: type: string - - description: Only return reports matching the campaignName + - description: Only return reports matching the campaign name. in: query name: campaignName schema: type: string - - description: Only return reports matching the current customer referrer name + - description: Only return reports matching the current customer referrer name. in: query name: advocateName schema: @@ -7335,7 +7263,7 @@ paths: name: referral schema: type: string - - description: Filter by sessions with this integrationId. Must be exact match. + - description: Filter by sessions with this integration ID. Must be exact match. in: query name: integrationId schema: @@ -7778,10 +7706,6 @@ paths: "200": content: application/csv: - example: | - profileintegrationid - URNGV8294NV - BZGGC2454PA schema: format: csv type: string @@ -8695,7 +8619,7 @@ paths: name: integrationRequestUuid schema: type: string - - description: Filter results by Webhook. + - description: Filter results by webhook id. in: query name: webhookId schema: @@ -8705,7 +8629,7 @@ paths: name: applicationId schema: type: number - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -8770,7 +8694,7 @@ paths: - success - error type: string - - description: Filter results by Webhook. + - description: Filter results by webhook id. in: query name: webhookId schema: @@ -8780,7 +8704,7 @@ paths: name: applicationId schema: type: number - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -8959,7 +8883,7 @@ paths: - `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. + - `created`: The creation date in RFC3339 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. @@ -8987,7 +8911,7 @@ paths: required: true schema: type: integer - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -9092,6 +9016,7 @@ paths: - scheduled - running - expired + - staged type: string - description: Filter results to only return the coupon codes (`value` column) without the associated coupon data. @@ -9104,9 +9029,6 @@ paths: "200": content: application/csv: - example: | - id,created,campaignid,value,expirydate,startdate,attributes,applicationid,deleted,deleted_changelogid,accountid,referralid,recipientintegrationid,importid,batchid,reservation,limits,limitval,counter,discount_counter,discount_limitval - 20191301,2022-04-26T11:02:38Z,3882,COUP1,2022-04-27T10:56:47Z,2022-04-26T10:56:47Z,"{""test"": ""premium""}",270,,0,1,,cust123,671,axghjfdy,,"[]",1,0,0,1.5 schema: format: csv type: string @@ -9139,7 +9061,7 @@ paths: required: true schema: type: integer - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -9199,9 +9121,6 @@ paths: "200": content: application/csv: - example: | - id,created,campaignid,advocateprofileintegrationid,friendprofileintegrationid,startdate,expirydate,code,importid,attributes,batchid,counter,limitval - 687,2021-09-10 09:21:06,3882,UGAV4628K,,,,3LFC-4BPC,,"{}",pimcxobg,0,9999 schema: format: csv type: string @@ -9244,7 +9163,7 @@ paths: required: true schema: type: integer - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -9277,10 +9196,6 @@ paths: "200": content: application/csv: - example: | - created,name,applicationid,campaignid,rulesetid,ruleindex,sessionintegrationid,profileintegrationid,sessionid,profileid,eventid,event_type,total_revenue,props,couponid,store_id,store_integration_id - 2021-06-02T21:14:16Z,rejectCoupon,270,0,0,0,newsession1,,9168,0,95797,talon_session_created,265.00,"{""value"": ""XMAS20"", ""rejectionReason"": ""CouponNotFound""}",,115,STORE-001 - 2021-09-01T13:04:04Z,setDiscountPerItem,270,3882,13599,0,test_flattening_2,integid_4,9707,4800,98806,talon_session_updated,405.00,"{""name"": ""10% off per item#1"", ""value"": 11.0, ""position"": 1}",,116,STORE-002 schema: format: csv type: string @@ -9369,9 +9284,6 @@ paths: "200": content: application/csv: - example: | - id,firstsession,integrationid,applicationid,profileid,profileintegrationid,created,state,cartitems,discounts,total,attributes,closedat,cancelledat,referral,identifiers,additional_costs,updated,store_integration_id,coupons - 12328,true,62791173fbf323ee5cfd96f3,270,6111,dxclwds,2022-05-09T13:05:31Z,open,"[{""sku"": ""B00004TKVY"", ""name"": ""Gravel bike - \""Aisle of Man\"""", ""price"": 1800, ""weight"": 6, ""category"": ""gravelbikes"", ""position"": 0, ""quantity"": 1, ""attributes"": {""color"": [""black,white""], ""material"": ""titanium""}, ""returnedQuantity"": 0, ""remainingQuantity"": 1}]","{}",1850.00,"{""ShippingCost"": 50, ""PaymentMethod"": ""creditcard"", ""ShippingMethod"": ""Standard""}",0001-01-01T00:00:00Z,0001-01-01T00:00:00Z,,"null","{""ShippingCost"": {""price"": 50}}",2022-05-09T13:13:28Z,"STORE-001","[""SORRY5QMUJRWA""]" schema: format: csv type: string @@ -10337,7 +10249,7 @@ paths: name: withTotalResultSize schema: type: boolean - - description: Filter results by campaign. + - description: Filter results by campaign ID. in: query name: campaignId schema: @@ -10563,11 +10475,6 @@ paths: "200": content: application/csv: - example: | - store_integration_id - STORE-001 - STORE-002 - STORE-003 schema: format: csv type: string @@ -11012,10 +10919,6 @@ paths: "200": content: application/csv: - example: | - profileIntegrationID,title,target,progress,status,startDate,endDate,completionDate - user1231,CoffeeFree10Orders,10.00,5,inprogress,2023-12-10T11:42:25+01:00,2024-01-10T11:42:25+01:00, - user341,CoffeeFree10Orders,10.00,10,completed,2023-12-10T11:42:25+01:00,2024-01-10T11:42:25+01:00,2023-12-20T10:24:34+01:00 schema: format: csv type: string @@ -11169,6 +11072,7 @@ components: type: string modified: description: The time this entity was last modified. + example: 2021-09-25T10:34:12.956203Z format: date-time type: string required: @@ -11513,6 +11417,7 @@ components: example: SUMMER-####-#### maxLength: 100 minLength: 3 + pattern: ^[A-Za-z0-9_#-]*$ type: string required: - couponPattern @@ -11569,7 +11474,6 @@ components: - userId type: object LoginParams: - description: "" example: password: admin123456 email: john.doe@example.com @@ -11809,7 +11713,6 @@ components: - timezone type: object Application: - description: "" example: enableFlattenedCartItems: true created: 2020-06-10T09:05:27.993483Z @@ -11899,10 +11802,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -11980,10 +11884,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -12173,7 +12078,6 @@ components: - name type: object CampaignGroup: - description: "" example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z @@ -12246,7 +12150,6 @@ components: - name type: object UpdateCampaignGroup: - description: "" properties: name: description: The name of the campaign access group. @@ -12281,7 +12184,6 @@ components: - name type: object NewCampaign: - description: "" properties: name: description: A user-facing name for this campaign. @@ -12409,6 +12311,13 @@ components: type: object CampaignVersions: properties: + revisionFrontendState: + description: The campaign revision state displayed in the Campaign Manager. + enum: + - revised + - pending + example: revised + type: string activeRevisionId: description: | ID of the revision that was last activated on this campaign. @@ -12801,21 +12710,14 @@ components: - tags type: object Campaign: - description: "" example: - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -12857,22 +12759,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -12880,7 +12768,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -12888,12 +12775,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -12902,10 +12783,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -12948,9 +12859,7 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 properties: id: description: Unique ID for this entity. @@ -13203,13 +13112,14 @@ components: example: 3 type: integer frontendState: - description: A campaign state described exactly as in the Campaign Manager. + description: The campaign state displayed in the Campaign Manager. enum: - expired - scheduled - running - disabled - archived + - staged example: running type: string storesImported: @@ -13217,6 +13127,13 @@ components: file. example: true type: boolean + revisionFrontendState: + description: The campaign revision state displayed in the Campaign Manager. + enum: + - revised + - pending + example: revised + type: string activeRevisionId: description: | ID of the revision that was last activated on this campaign. @@ -13265,7 +13182,6 @@ components: - userId type: object Revision: - description: "" properties: id: description: Unique ID for this entity. Not to be confused with the Integration @@ -13308,7 +13224,6 @@ components: type: string type: object RevisionVersion: - description: "" properties: id: description: Unique ID for this entity. Not to be confused with the Integration @@ -13623,13 +13538,14 @@ components: example: 3 type: integer frontendState: - description: A campaign state described exactly as in the Campaign Manager. + description: The campaign state displayed in the Campaign Manager. enum: - expired - scheduled - running - disabled - archived + - staged example: running type: string storesImported: @@ -13677,7 +13593,6 @@ components: - rules type: object Ruleset: - description: "" example: rbVersion: v2 created: 2020-06-10T09:05:27.993483Z @@ -13907,7 +13822,6 @@ components: description: A Talang expression that will be evaluated and its result attached to the name of the binding. items: - properties: {} type: object type: array valueType: @@ -13990,7 +13904,6 @@ components: - and - - couponValid items: - properties: {} type: object minItems: 1 type: array @@ -14019,7 +13932,6 @@ components: - title type: object TemplateLimitConfig: - description: "" example: period: yearly entities: @@ -14060,6 +13972,7 @@ components: - Referral - Profile - Identifier + - Store type: string type: array required: @@ -14108,6 +14021,7 @@ components: - Referral - Profile - Identifier + - Store type: string type: array required: @@ -14116,7 +14030,6 @@ components: - limit type: object CampaignSet: - description: "" properties: applicationId: description: The ID of the application that owns this entity. @@ -14224,7 +14137,6 @@ components: - type type: object NewCampaignSet: - description: "" properties: applicationId: description: The ID of the application that owns this entity. @@ -14287,7 +14199,6 @@ components: - parentId type: object UpdateCampaignEvaluationGroup: - description: "" properties: name: description: The name of the campaign evaluation group. @@ -14332,7 +14243,6 @@ components: - parentId type: object CampaignEvaluationGroup: - description: "" properties: applicationId: description: The ID of the application that owns this entity. @@ -14447,7 +14357,6 @@ components: - batchID type: object NewReferral: - description: "" example: expiryDate: 2021-11-10T23:00:00Z friendProfileIntegrationId: BZGGC2454PA @@ -14514,7 +14423,6 @@ components: type: integer type: object Referral: - description: "" example: code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -14655,7 +14563,6 @@ components: type: object type: object NewReferralsForMultipleAdvocates: - description: "" example: expiryDate: 2021-11-10T23:00:00Z advocateProfileIntegrationIds: @@ -14786,7 +14693,6 @@ components: - usageLimit type: object InventoryReferral: - description: "" example: code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -14990,7 +14896,6 @@ components: - applicationIds type: object NewCoupons: - description: "" example: recipientIntegrationId: URNGV8294NV uniquePrefix: "" @@ -15125,7 +15030,6 @@ components: - usageLimit type: object NewCouponsForMultipleRecipients: - description: "" example: expiryDate: 2023-08-24T14:15:22Z couponPattern: SUMMER-##### @@ -15261,7 +15165,6 @@ components: - usageLimit type: object UpdateCoupon: - description: "" example: expiryDate: 2023-08-24T14:15:22Z recipientIntegrationId: URNGV8294NV @@ -15351,7 +15254,6 @@ components: type: boolean type: object UpdateCouponBatch: - description: "" example: expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 @@ -15408,7 +15310,6 @@ components: type: string type: object Coupon: - description: "" example: recipientIntegrationId: URNGV8294NV implicitlyReserved: false @@ -15585,7 +15486,6 @@ components: - value type: object IntegrationCoupon: - description: "" example: recipientIntegrationId: URNGV8294NV implicitlyReserved: false @@ -15789,7 +15689,6 @@ components: - limit type: object InventoryCoupon: - description: "" example: recipientIntegrationId: URNGV8294NV implicitlyReserved: false @@ -15988,7 +15887,6 @@ components: - value type: object CampaignAnalytics: - description: "" example: date: 2021-10-12T10:12:42Z couponRolledbackRedemptions: 2 @@ -16340,7 +16238,7 @@ components: example: 12 type: integer url: - description: Target url of request + description: The target URL of the request. example: www.my-company.com/my-endpoint-name type: string request: @@ -16418,6 +16316,14 @@ components: description: The name of the notification. example: My campaign notification type: string + webhookId: + description: ID of the webhook. + example: 101 + type: integer + webhookName: + description: The name of the webhook. + example: My webhook + type: string request: $ref: '#/components/schemas/MessageLogRequest' response: @@ -16429,12 +16335,17 @@ components: type: string entityType: description: | - The entity type the notification is related to. + The entity type the log is related to. enum: - application - loyalty_program + - webhook example: loyalty_program type: string + url: + description: The target URL of the request. + example: www.my-company.com/my-endpoint-name + type: string applicationId: description: Identifier of the Application. example: 5 @@ -16445,8 +16356,14 @@ components: example: 2 minimum: 1 type: integer + campaignId: + description: Identifier of the campaign. + example: 2 + minimum: 1 + type: integer required: - createdAt + - entityType - id - service type: object @@ -16526,7 +16443,6 @@ components: - webhookId type: object User: - description: "" example: created: 2020-06-10T09:05:27.993483Z roles: @@ -16647,7 +16563,6 @@ components: - state type: object DeactivateUserRequest: - description: "" example: email: john.doe@example.com properties: @@ -16660,31 +16575,9 @@ components: - email type: object ActivateUserRequest: - description: "" - example: - email: john.doe@example.com - properties: - email: - description: The email address associated with the user profile. - example: john.doe@example.com - format: email - type: string - required: - - email - type: object + $ref: '#/components/schemas/DeactivateUserRequest' DeleteUserRequest: - description: "" - example: - email: john.doe@example.com - properties: - email: - description: The email address associated with the user profile. - example: john.doe@example.com - format: email - type: string - required: - - email - type: object + $ref: '#/components/schemas/DeactivateUserRequest' OktaEventTarget: description: Target of the specific Okta event. properties: @@ -16781,6 +16674,8 @@ components: type: string name: $ref: '#/components/schemas/ScimBaseUser_name' + required: + - userName type: object ScimUser: description: Schema definition for users that have been provisioned using the @@ -16813,6 +16708,7 @@ components: type: string required: - id + - userName type: object ScimResource: description: Resource definition for the SCIM provisioning protocol. @@ -16981,6 +16877,8 @@ components: supported: true schemas: - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig + x-sort: + supported: false properties: bulk: $ref: '#/components/schemas/ScimServiceProviderConfigResponse_bulk' @@ -17000,6 +16898,8 @@ components: items: type: string type: array + sort: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse_sort' type: object ScimSchemasListResponse: description: List of resource schemas supported by the SCIM provisioning protocol. @@ -17115,7 +17015,6 @@ components: - email type: object Change: - description: "" example: new: applicationId": 359 @@ -17317,7 +17216,7 @@ components: - points type: object LoyaltyProgram: - description: "" + description: A Loyalty Program example: cardBased: true tiers: @@ -17387,10 +17286,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -17402,7 +17302,8 @@ components: name: my_program properties: id: - description: The ID of loyalty program. Internal ID of this entity. + description: The ID of loyalty program. + example: 139 type: integer created: description: The time this entity was created. @@ -17526,6 +17427,15 @@ components: type: string cardCodeSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + returnPolicy: + description: | + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). + - `only_pending`: Only pending points can be rolled back. + - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + enum: + - only_pending + - within_balance + type: string accountID: description: The ID of the Talon.One account that owns this program. example: 1 @@ -17612,8 +17522,13 @@ components: - timezone - title type: object + LoyaltyTiers: + description: A list of the loyalty program's tiers. + items: + $ref: '#/components/schemas/LoyaltyTier' + type: array LoyaltyTier: - description: "" + description: A tier in a loyalty program. properties: id: description: Internal ID of this entity. @@ -17629,12 +17544,11 @@ components: example: 125 type: integer name: - description: The name of the tier + description: The name of the tier. example: Gold type: string minPoints: - description: The minimum amount of points required to be eligible for the - tier. + description: The minimum amount of points required to enter the tier. example: 300.0 exclusiveMaximum: false maximum: 999999999999.99 @@ -17651,12 +17565,11 @@ components: description: A tier in a loyalty program. properties: name: - description: The name of the tier + description: The name of the tier. example: Gold type: string minPoints: - description: The minimum amount of points required to be eligible for the - tier. + description: The minimum amount of points required to enter the tier. example: 300.0 exclusiveMaximum: false maximum: 999999999999.99 @@ -17785,9 +17698,18 @@ components: type: string cardCodeSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + returnPolicy: + description: | + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). + - `only_pending`: Only pending points can be rolled back. + - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + enum: + - only_pending + - within_balance + type: string type: object NewLoyaltyProgram: - description: "" + description: A new loyalty program properties: title: description: The display title for the Loyalty Program. @@ -17906,6 +17828,15 @@ components: type: string cardCodeSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + returnPolicy: + description: | + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). + - `only_pending`: Only pending points can be rolled back. + - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + enum: + - only_pending + - within_balance + type: string name: description: The internal name for the Loyalty Program. This is an immutable value. @@ -17939,7 +17870,7 @@ components: - title type: object UpdateLoyaltyProgram: - description: "" + description: An updated loyalty program. properties: title: description: The display title for the Loyalty Program. @@ -18058,12 +17989,47 @@ components: type: string cardCodeSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + returnPolicy: + description: | + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). + - `only_pending`: Only pending points can be rolled back. + - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + enum: + - only_pending + - within_balance + type: string tiers: description: The tiers in this loyalty program. items: $ref: '#/components/schemas/NewLoyaltyTier' type: array type: object + UpdateLoyaltyProgramTier: + description: Update a tier in a specified loyalty program. + properties: + id: + description: The internal ID of the tier. + example: 6 + type: integer + name: + description: The name of the tier. + example: Gold + type: string + minPoints: + description: The minimum amount of points required to enter the tier. + example: 300.0 + exclusiveMaximum: false + maximum: 999999999999.99 + minimum: 0 + type: number + required: + - id + type: object + UpdateLoyaltyProgramTiers: + description: List of tiers that are updated by the request. + items: + $ref: '#/components/schemas/UpdateLoyaltyProgramTier' + type: array LoyaltyLedgerTransactions: description: List of loyalty ledger transactions. properties: @@ -18163,7 +18129,7 @@ components: - type type: object LoyaltyCardBalances: - description: "" + description: List of customer profiles linked to the loyalty card. example: balance: activePoints: 286.0 @@ -18251,7 +18217,7 @@ components: type: number type: object LoyaltyBalanceWithTier: - description: "" + description: Point balance of a ledger in the Loyalty Program. example: projectedTier: projectedActivePoints: 198.0 @@ -18964,7 +18930,7 @@ components: - title type: object LedgerInfo: - description: "" + description: The balance in a Loyalty Program for some Customer. example: pendingBalance: 10.0 currentBalance: 100.0 @@ -19156,6 +19122,7 @@ components: customerProfileIds: - R195412 - G244519 + cardIdentifier: summer-loyalty-card-0543 properties: status: default: active @@ -19173,9 +19140,15 @@ components: items: type: string type: array + cardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ + type: string type: object LoyaltyCard: - description: "" example: ledger: pendingBalance: 10.0 @@ -19251,6 +19224,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string usersPerCardLimit: description: | @@ -19281,12 +19255,14 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string newCardIdentifier: description: | The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string batchId: description: The ID of the batch in which the loyalty card was created. @@ -19305,6 +19281,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string CardLedgerTransactionLogEntry: description: Log entry for a given loyalty card transaction. @@ -19336,6 +19313,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string applicationId: description: The ID of the Application that owns this entity. @@ -19437,6 +19415,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string customerSessionId: description: ID of the customer session where the transaction occurred. @@ -19826,6 +19805,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string subledgerId: description: ID of the subledger. @@ -19882,6 +19862,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string blockReason: description: | @@ -20037,11 +20018,10 @@ components: type: array type: object CustomerProfile: - description: "" example: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -20051,9 +20031,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -20066,8 +20046,8 @@ components: example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string integrationId: @@ -20277,7 +20257,7 @@ components: profile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -20287,9 +20267,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -20471,8 +20451,46 @@ components: type: array type: object LoyaltyCardBatch: - description: "" example: + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" numberOfCards: 5000 batchId: hwernpjz status: active @@ -20496,6 +20514,8 @@ components: - inactive example: active type: string + cardCodeSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' required: - numberOfCards type: object @@ -20517,7 +20537,6 @@ components: - numberOfCardsGenerated type: object NewCustomerSession: - description: "" properties: profileId: description: | @@ -20599,7 +20618,7 @@ components: storeIntegrationId: STORE-001 profileId: URNGV8294NV identifiers: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea evaluableCampaignIds: - 10 - 12 @@ -20765,8 +20784,9 @@ components: - 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). + - We recommend passing an anonymized (hashed) version of the identifier value. example: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea items: type: string maxItems: 5 @@ -20901,10 +20921,10 @@ components: - totalOrdersNoCoupon type: object CustomerSession: - description: "" properties: integrationId: description: The integration ID set by your integration layer. + example: URNGV8294NV format: string maxLength: 1000 type: string @@ -21018,13 +21038,13 @@ components: - updated type: object CustomerSessionV2: - description: "" + description: The representation of the customer session. example: couponCodes: - XMAS-20-2021 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z identifiers: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea integrationId: URNGV8294NV total: 119.99 loyaltyCards: @@ -21096,8 +21116,8 @@ components: example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string integrationId: @@ -21224,8 +21244,9 @@ components: - 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). + - We recommend passing an anonymized (hashed) version of the identifier value. example: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea items: type: string maxItems: 5 @@ -21406,7 +21427,6 @@ components: - quantity - sku type: object - x-attributable: true NewApplicationCIF: properties: name: @@ -21462,7 +21482,6 @@ components: type: string type: object ApplicationCIF: - description: "" properties: id: description: Internal ID of this entity. @@ -21538,12 +21557,10 @@ components: - Category - Kitchen items: - properties: {} type: object type: array type: object ApplicationCIFExpression: - description: "" properties: id: description: Internal ID of this entity. @@ -21580,7 +21597,6 @@ components: - Category - Kitchen items: - properties: {} type: object type: array applicationId: @@ -21602,7 +21618,6 @@ components: - price type: object IntegrationEvent: - description: "" properties: profileId: description: | @@ -21636,7 +21651,6 @@ components: - type type: object NewEvent: - description: "" properties: profileId: description: | @@ -21676,7 +21690,6 @@ components: - type type: object Event: - description: "" example: effects: - '{}' @@ -21819,7 +21832,7 @@ components: customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -21829,9 +21842,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -22128,19 +22141,13 @@ components: id: 6 startDate: 2020-11-10T23:00:00Z triggeredCampaigns: - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -22182,22 +22189,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -22205,7 +22198,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -22213,12 +22205,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -22227,10 +22213,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -22273,22 +22289,14 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -22330,22 +22338,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -22353,7 +22347,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -22361,12 +22354,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -22375,10 +22362,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -22421,9 +22438,7 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 coupons: - recipientIntegrationId: URNGV8294NV implicitlyReserved: false @@ -22494,9 +22509,9 @@ components: customerSession: couponCodes: - XMAS-20-2021 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z identifiers: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea integrationId: URNGV8294NV total: 119.99 loyaltyCards: @@ -22768,19 +22783,13 @@ components: ruleName: Give 20% discount triggeredByCoupon: 4928 triggeredCampaigns: - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -22822,22 +22831,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -22845,7 +22840,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -22853,12 +22847,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -22867,10 +22855,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -22913,22 +22931,14 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -22970,22 +22980,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -22993,7 +22989,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -23001,12 +22996,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -23015,10 +23004,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -23061,13 +23080,11 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -23077,9 +23094,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -23475,19 +23492,13 @@ components: ruleName: Give 20% discount triggeredByCoupon: 4928 triggeredCampaigns: - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -23529,22 +23540,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -23552,7 +23549,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -23560,12 +23556,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -23574,10 +23564,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -23620,22 +23640,14 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -23677,22 +23689,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -23700,7 +23698,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -23708,12 +23705,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -23722,10 +23713,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -23768,13 +23789,11 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -23784,9 +23803,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -24198,7 +24217,7 @@ components: customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -24208,9 +24227,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -24255,9 +24274,9 @@ components: customerSession: couponCodes: - XMAS-20-2021 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z identifiers: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea integrationId: URNGV8294NV total: 119.99 loyaltyCards: @@ -24332,23 +24351,22 @@ components: type: array type: object ApplicationCustomer: - description: "" example: - accountId: 6 + accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false - integrationId: integrationId + integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 0 + id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: @@ -24358,16 +24376,17 @@ components: id: 2 properties: id: - description: Internal ID of this entity. Internal ID of this entity. + description: Internal ID of this entity. + example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. The time this entity was created. The time this entity was created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string integrationId: - description: The integration ID set by your integration layer. The integration - ID set by your integration layer. + description: The integration ID set by your integration layer. + example: URNGV8294NV format: string maxLength: 1000 type: string @@ -24379,8 +24398,9 @@ components: properties: {} type: object accountId: - description: The ID of the Talon.One account that owns this profile. The - ID of the Talon.One account that owns this profile. + description: The ID of the Talon.One account that owns this profile. + example: 31 + title: Profile belongs to Account type: integer closedSessions: description: The total amount of closed sessions by a customer. A closed @@ -24445,15 +24465,14 @@ components: - totalSales type: object AudienceCustomer: - description: "" properties: id: description: Internal ID of this entity. example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string integrationId: @@ -24552,7 +24571,6 @@ components: - totalSales type: object ApplicationReferee: - description: "" example: friendIntegrationId: friendIntegrationId code: code @@ -24595,10 +24613,9 @@ components: - sessionId type: object ApplicationSession: - description: "" example: coupon: BKDB946 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalDiscounts: 100.0 integrationId: URNGV8294NV profileintegrationid: 382370BKDB946 @@ -24661,8 +24678,8 @@ components: example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string integrationId: @@ -24756,7 +24773,6 @@ components: - totalDiscounts type: object ApplicationEvent: - description: "" example: effects: - rulesetId: 73 @@ -24896,7 +24912,7 @@ components: example: liveActiveCampaigns: 10 expiredCoupons: 200 - lastUpdatedAt: 2000-01-23T04:56:07.000+00:00 + lastUpdatedAt: 2022-12-12T12:12:12Z roles: 10 activeCampaigns: 15 activeCoupons: 650 @@ -24993,6 +25009,7 @@ components: type: integer lastUpdatedAt: description: The point in time when the analytics numbers were updated last. + example: 2022-12-12T12:12:12Z format: date-time type: string required: @@ -25101,7 +25118,6 @@ components: - companyName type: object Account: - description: "" example: applicationCount: 5 planExpires: 2000-01-23T04:56:07.000+00:00 @@ -25203,7 +25219,6 @@ components: - userCount type: object NewAccountSignUp: - description: "" properties: email: description: The email address associated with the user profile. @@ -25223,7 +25238,6 @@ components: - password type: object NewUser: - description: "" properties: email: description: The email address associated with the user profile. @@ -25358,7 +25372,6 @@ components: - resetToken type: object Environment: - description: "" properties: id: description: Internal ID of this entity. @@ -25490,7 +25503,6 @@ components: - type type: object TemplateArgDef: - description: "" properties: type: description: The type of value this argument expects. @@ -25590,6 +25602,26 @@ components: - name - type type: object + CampaignTemplateCouponReservationSettings: + example: + reservationLimit: 45 + isReservationMandatory: false + properties: + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer + isReservationMandatory: + default: false + description: An indication of whether the code can be redeemed only if it + has been reserved first. + example: false + title: Is reservation mandatory + type: boolean + type: object NewCampaignTemplate: properties: name: @@ -25645,6 +25677,8 @@ components: type: array couponSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + couponReservationSettings: + $ref: '#/components/schemas/CampaignTemplateCouponReservationSettings' referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: @@ -25750,6 +25784,8 @@ components: type: array couponSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + couponReservationSettings: + $ref: '#/components/schemas/CampaignTemplateCouponReservationSettings' referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: @@ -25819,38 +25855,23 @@ components: - name type: object CampaignTemplate: - description: "" example: - activeRulesetId: 5 instructions: Use this template for discount campaigns. Set the campaign properties according to the campaign goals, and don't forget to set an end date. - campaignAttributes: '{}' - applicationsIds: - - 0 - - 0 - campaignType: advanced - updatedBy: Jane Doe campaignCollections: - name: My collection description: My collection of SKUs - name: My collection description: My collection of SKUs - created: 2020-06-10T09:05:27.993483Z defaultCampaignGroupId: 42 description: This is a template for a discount campaign. - userId: 388 - tags: - - discount - accountId: 3886 features: - coupons - coupons - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false + couponSettings: couponPattern: SUMMER-####-#### validCharacters: - A @@ -25889,7 +25910,51 @@ components: - "7" - "8" - "9" - couponSettings: + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 5 + campaignAttributes: '{}' + applicationsIds: + - 1 + - 2 + - 3 + - 1 + - 2 + - 3 + campaignType: advanced + updatedBy: Jane Doe + created: 2020-06-10T09:05:27.993483Z + userId: 388 + tags: + - discount + accountId: 3886 + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: couponPattern: SUMMER-####-#### validCharacters: - A @@ -25928,30 +25993,7 @@ components: - "7" - "8" - "9" - templateParams: - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - id: 6 - couponAttributes: '{}' - state: draft updated: 2022-08-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon properties: id: description: Internal ID of this entity. @@ -26033,6 +26075,8 @@ components: type: array couponSettings: $ref: '#/components/schemas/CodeGeneratorSettings' + couponReservationSettings: + $ref: '#/components/schemas/CampaignTemplateCouponReservationSettings' referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: @@ -26048,8 +26092,14 @@ components: applicationsIds: description: A list of IDs of the Applications that are subscribed to this campaign template. + example: + - 1 + - 2 + - 3 + - 1 + - 2 + - 3 items: - description: "" type: integer type: array campaignCollections: @@ -26401,19 +26451,13 @@ components: templateId: 3 userId: 388 campaign: - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -26455,22 +26499,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -26478,7 +26508,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -26486,12 +26515,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -26500,10 +26523,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -26546,9 +26599,7 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 properties: campaign: $ref: '#/components/schemas/Campaign' @@ -26584,7 +26635,6 @@ components: description: A Talang expression that contains variable bindings referring to args. items: - properties: {} type: object type: array args: @@ -26603,7 +26653,6 @@ components: - title type: object TemplateDef: - description: "" properties: id: description: Internal ID of this entity. @@ -26638,7 +26687,6 @@ components: description: A Talang expression that contains variable bindings referring to args. items: - properties: {} type: object type: array args: @@ -26667,7 +26715,6 @@ components: - title type: object NewAttribute: - description: "" example: editable: true subscribedApplicationsIds: @@ -26817,7 +26864,6 @@ components: - type type: object Attribute: - description: "" example: created: 2020-06-10T09:05:27.993483Z editable: true @@ -26990,7 +27036,6 @@ components: - type type: object NewAdditionalCost: - description: "" example: name: shippingFee subscribedApplicationsIds: @@ -27044,7 +27089,6 @@ components: - title type: object AccountAdditionalCost: - description: "" example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z @@ -27117,7 +27161,6 @@ components: - title type: object NewEventType: - description: "" properties: title: description: The human-friendly name for this event type. @@ -27140,7 +27183,6 @@ components: - title type: object EventType: - description: "" example: created: 2020-06-10T09:05:27.993483Z name: surveyCompleted @@ -27180,7 +27222,6 @@ components: - title type: object NewWebhook: - description: "" properties: applicationIds: description: The IDs of the Applications that are related to this entity. @@ -27245,7 +27286,6 @@ components: - verb type: object Webhook: - description: "" example: headers: - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' @@ -27280,9 +27320,7 @@ components: type: string applicationIds: description: The IDs of the Applications that are related to this entity. - The IDs of the Applications that are related to this entity. items: - description: "" type: integer minItems: 1 type: array @@ -27346,7 +27384,6 @@ components: - verb type: object WebhookWithOutgoingIntegrationDetails: - description: "" example: headers: - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' @@ -27384,9 +27421,7 @@ components: type: string applicationIds: description: The IDs of the Applications that are related to this entity. - The IDs of the Applications that are related to this entity. items: - description: "" type: integer minItems: 1 type: array @@ -27494,7 +27529,6 @@ components: type: string type: object NewMultipleAudiencesItem: - description: "" properties: name: description: The human-friendly display name for this audience. @@ -27511,7 +27545,6 @@ components: - name type: object MultipleAudiencesItem: - description: "" properties: id: description: Internal ID of this entity. @@ -27568,7 +27601,6 @@ components: - name type: object NewAudience: - description: "" example: lastUpdate: 2022-04-26T11:02:38Z name: Travel audience @@ -27634,7 +27666,6 @@ components: - name type: object Audience: - description: "" example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z @@ -27729,7 +27760,6 @@ components: - schemaVersion type: object Export: - description: "" example: filter: '{}' accountId: 3886 @@ -27780,7 +27810,6 @@ components: - userId type: object Import: - description: "" example: accountId: 3886 amount: 10 @@ -27825,7 +27854,6 @@ components: - userId type: object FeaturesFeed: - description: "" properties: title: type: string @@ -27833,7 +27861,6 @@ components: type: string type: object LibraryAttribute: - description: "" properties: entity: description: The name of the entity that can have this attribute. When creating @@ -27892,7 +27919,6 @@ components: - type type: object TalangAttribute: - description: "" properties: entity: description: The name of the entity of the attribute. @@ -27970,7 +27996,6 @@ components: type: array type: object Role: - description: "" properties: id: description: Internal ID of this entity. @@ -28030,7 +28055,6 @@ components: - name type: object NewRole: - description: "" properties: name: description: Name of the role. @@ -28087,7 +28111,6 @@ components: type: array type: object RoleAssign: - description: "" properties: users: description: An array of user IDs. @@ -28112,7 +28135,6 @@ components: - users type: object NewRoleV2: - description: "" properties: name: description: Name of the role. @@ -28140,7 +28162,6 @@ components: UpdateRoleV2: $ref: '#/components/schemas/RoleV2Base' RoleV2: - description: "" example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z @@ -28520,7 +28541,7 @@ components: - integrationIDs type: object LedgerEntry: - description: "" + description: Entry in the point ledger. example: expiryDate: 2022-04-26T11:02:38Z accountId: 0 @@ -28589,11 +28610,12 @@ components: type: object LoyaltyMembership: example: - joined: 2000-01-23T04:56:07.000+00:00 + joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 properties: joined: description: The moment in which the loyalty program was joined. + example: 2012-03-20T14:15:22Z format: date-time title: Loyalty program joined at type: string @@ -28708,7 +28730,6 @@ components: - referralId type: object ApplicationAPIKey: - description: "" properties: title: description: Title of the API key. @@ -28783,7 +28804,6 @@ components: - title type: object NewApplicationAPIKey: - description: "" properties: title: description: Title of the API key. @@ -28953,7 +28973,6 @@ components: - name type: object ManagementKey: - description: "" properties: name: description: Name for management key. @@ -29007,7 +29026,6 @@ components: - name type: object NewManagementKey: - description: "" properties: name: description: Name for management key. @@ -29125,7 +29143,7 @@ components: $ref: '#/components/schemas/NotificationListItem' type: array SamlConnection: - description: "" + description: A SAML 2.0 connection. properties: assertionConsumerServiceURL: description: The location where the SAML assertion is sent with a HTTP POST. @@ -29181,7 +29199,7 @@ components: - signOnURL type: object NewSamlConnection: - description: "" + description: A new SAML 2.0 connection. properties: x509certificate: description: X.509 Certificate. @@ -29352,7 +29370,8 @@ components: - enforced type: object Effect: - description: "" + description: A generic effect that is fired by a triggered campaign. The props + property will contain information specific to the specific effect type. example: rulesetId: 73 ruleIndex: 2 @@ -29861,6 +29880,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string bundleIndex: description: The position of the bundle in a list of item bundles created @@ -29909,6 +29929,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string required: - name @@ -30099,6 +30120,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string required: - programId @@ -30144,6 +30166,7 @@ components: The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 maxLength: 108 + pattern: ^[A-Za-z0-9_-]*$ type: string required: - programId @@ -30417,7 +30440,7 @@ components: storeIntegrationId: STORE-001 profileId: URNGV8294NV identifiers: - - 91.11.156.141 + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea evaluableCampaignIds: - 10 - 12 @@ -30540,7 +30563,9 @@ components: - return type: object CustomerProfileIntegrationRequestV2: - description: "" + description: The body of a V2 integration API request (customer profile update). + Next to the customer profile details, this contains an optional listing of + extra properties that should be returned in the response. example: evaluableCampaignIds: - 10 @@ -30663,7 +30688,9 @@ components: type: array type: object MultipleCustomerProfileIntegrationRequestItem: - description: "" + description: | + The body of a V2 integration API request (customer profile update). + Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. example: integrationId: R195412 attributes: @@ -30695,7 +30722,7 @@ components: - customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -30705,9 +30732,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -30717,7 +30744,7 @@ components: - customerProfile: accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -30727,9 +30754,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -30798,6 +30825,9 @@ components: disabled: description: Number of disabled campaigns. type: integer + staged: + description: Number of staged campaigns. + type: integer scheduled: description: Number of scheduled campaigns. type: integer @@ -30816,6 +30846,7 @@ components: - expired - running - scheduled + - staged type: object RuleFailureReason: description: Details about why a rule failed. @@ -30894,7 +30925,6 @@ components: - rulesetID type: object Giveaway: - description: "" example: profileIntegrationId: R195412 code: GIVEAWAY1 @@ -31048,7 +31078,6 @@ components: - sandbox type: object NewCustomEffect: - description: "" properties: applicationIds: description: The IDs of the Applications that are related to this entity. @@ -31116,7 +31145,6 @@ components: - values type: object Picklist: - description: "" properties: id: description: Internal ID of this entity. @@ -31172,7 +31200,6 @@ components: - values type: object UpdatePicklist: - description: "" properties: type: description: The type of allowed values in the picklist. If the type `time` @@ -31199,49 +31226,8 @@ components: - values type: object UpdateCustomEffect: - description: "" - properties: - applicationIds: - description: The IDs of the Applications that are related to this entity. - items: - type: integer - minItems: 1 - type: array - isPerItem: - description: Indicates if this effect is per item or not. - type: boolean - x-fieldType: bool - name: - description: The name of this effect. - pattern: ^[A-Za-z](\w|\s)*$ - type: string - title: - description: The title of this effect. - pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ - type: string - payload: - description: The JSON payload of this effect. - type: string - description: - description: The description of this effect. - type: string - enabled: - description: Determines if this effect is active. - type: boolean - params: - description: Array of template argument definitions. - items: - $ref: '#/components/schemas/TemplateArgDef' - type: array - required: - - applicationIds - - enabled - - name - - payload - - title - type: object + $ref: '#/components/schemas/NewCustomEffect' CustomEffect: - description: "" properties: id: description: Internal ID of this entity. @@ -31323,7 +31309,6 @@ components: type: string type: object NewCampaignCollection: - description: "" example: name: My collection description: My collection of SKUs @@ -31342,7 +31327,6 @@ components: - name type: object CampaignCollectionWithoutPayload: - description: "" properties: id: description: Internal ID of this entity. @@ -31397,7 +31381,6 @@ components: - name type: object CampaignCollection: - description: "" properties: id: description: Internal ID of this entity. @@ -31484,7 +31467,6 @@ components: type: array type: object NewCollection: - description: "" example: subscribedApplicationsIds: - 1 @@ -31517,7 +31499,6 @@ components: - name type: object CollectionWithoutPayload: - description: "" example: accountId: 3886 createdBy: 134 @@ -31597,7 +31578,6 @@ components: - name type: object Collection: - description: "" example: accountId: 3886 createdBy: 134 @@ -31689,7 +31669,6 @@ components: - name type: object CollectionItem: - description: "" example: item: item properties: @@ -31699,7 +31678,6 @@ components: - item type: object NewCouponCreationJob: - description: "" example: expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 @@ -31798,7 +31776,6 @@ components: - usageLimit type: object CouponCreationJob: - description: "" properties: id: description: Internal ID of this entity. @@ -31969,7 +31946,7 @@ components: expiresAfter: 2000-01-23T04:56:07.000+00:00 expiresBefore: 2000-01-23T04:56:07.000+00:00 createdBefore: 2000-01-23T04:56:07.000+00:00 - value: "false" + value: value startsBefore: 2000-01-23T04:56:07.000+00:00 properties: filters: @@ -32003,7 +31980,7 @@ components: expiresAfter: 2000-01-23T04:56:07.000+00:00 expiresBefore: 2000-01-23T04:56:07.000+00:00 createdBefore: 2000-01-23T04:56:07.000+00:00 - value: "false" + value: value startsBefore: 2000-01-23T04:56:07.000+00:00 properties: createdBefore: @@ -32063,7 +32040,6 @@ components: the coupon code type: boolean value: - default: "false" description: Filter results by the coupon code type: string batchId: @@ -32087,7 +32063,6 @@ components: type: string type: object CouponDeletionJob: - description: "" properties: id: description: Internal ID of this entity. @@ -32166,7 +32141,6 @@ components: - status type: object AsyncCouponDeletionJobResponse: - description: "" example: id: 6 properties: @@ -32179,7 +32153,6 @@ components: - id type: object LimitCounter: - description: "" properties: campaignId: description: The ID of the campaign that owns this entity. @@ -32605,7 +32578,6 @@ components: - payload type: object NewBaseNotification: - description: "" example: webhook: headers: @@ -32949,7 +32921,6 @@ components: type: array type: object BaseNotification: - description: "" example: webhook: headers: @@ -33003,7 +32974,6 @@ components: - webhook type: object BaseNotificationWebhook: - description: "" example: headers: - 'content-type: application/json' @@ -33382,7 +33352,6 @@ components: - title type: object OutgoingIntegrationTemplateWithConfigurationDetails: - description: "" properties: id: description: Unique ID for this entity. @@ -33484,7 +33453,6 @@ components: type: array type: object Return: - description: "" example: returnedCartItems: - quantity: 1 @@ -33603,7 +33571,6 @@ components: - position type: object EventV2: - description: "" properties: profileId: description: | @@ -33650,7 +33617,6 @@ components: - type type: object IntegrationEventV2Request: - description: "" example: storeIntegrationId: STORE-001 profileId: URNGV8294NV @@ -33760,7 +33726,6 @@ components: type: array type: object NewCatalog: - description: "" properties: name: description: The cart item catalog name. @@ -33785,7 +33750,6 @@ components: - name type: object Catalog: - description: "" example: accountId: 3886 createdBy: 6 @@ -34037,7 +34001,6 @@ components: type: array type: object CatalogItem: - description: "" example: product: name: sample_product @@ -34110,7 +34073,6 @@ components: - name type: object ItemAttribute: - description: "" example: attributeid: 6 name: name @@ -34276,7 +34238,6 @@ components: - name type: object NewStore: - description: "" example: name: South US store description: This is the description of the store in south US. @@ -34318,13 +34279,12 @@ components: - name type: object Store: - description: "" example: linkedCampaignIds: - 4 - 6 - 8 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. integrationId: STORE-001 @@ -34340,8 +34300,8 @@ components: example: 6 type: integer created: - description: The time this entity was created. The time this entity was - created. + description: The time this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string name: @@ -34399,8 +34359,45 @@ components: - name - updated type: object + NewCampaignStoreBudgetStoreLimit: + properties: + storeId: + description: | + The ID of the store. + You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + example: 17 + type: integer + limit: + description: The value to set for the limit. + example: 1000.0 + type: number + required: + - limit + - storeId + type: object + NewCampaignStoreBudget: + properties: + action: + enum: + - setDiscount + type: string + storeLimits: + description: The set of budget limits for stores linked to the campaign. + items: + $ref: '#/components/schemas/NewCampaignStoreBudgetStoreLimit' + type: array + period: + enum: + - daily + - weekly + - monthly + - yearly + type: string + required: + - action + - storeLimits + type: object CampaignStoreBudget: - description: "" properties: id: description: Internal ID of this entity. @@ -34430,6 +34427,68 @@ components: - limits - storeId type: object + ListCampaignStoreBudgetsStore: + properties: + id: + type: integer + integrationId: + type: string + name: + type: string + required: + - id + - integrationId + - name + type: object + ListCampaignStoreBudgets: + properties: + store: + $ref: '#/components/schemas/ListCampaignStoreBudgetsStore' + limit: + type: integer + action: + type: string + period: + type: string + required: + - action + - limit + - store + type: object + SummaryCampaignStoreBudget: + properties: + action: + enum: + - redeemCoupon + - redeemReferral + - setDiscount + - setDiscountEffect + - createCoupon + - createReferral + - createLoyaltyPoints + - redeemLoyaltyPoints + - customEffect + - createLoyaltyPointsEffect + - redeemLoyaltyPointsEffect + - callApi + - awardGiveaway + - addFreeItemEffect + - reserveCoupon + type: string + period: + enum: + - overall + - daily + - weekly + - monthly + - yearly + type: string + storeCount: + type: integer + required: + - action + - storeCount + type: object BulkOperationOnCampaigns: properties: operation: @@ -34438,6 +34497,7 @@ components: enum: - disable - delete + - activate_revision type: string campaignIds: description: The list of campaign IDs on which the operation will be performed. @@ -34449,13 +34509,22 @@ components: type: integer maxItems: 50 type: array + activateAt: + description: | + Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string required: - campaignIds - operation type: object CreateAchievement: example: + fixedStartDate: 2000-01-23T04:56:07.000+00:00 period: 1Y + endDate: 2000-01-23T04:56:07.000+00:00 name: Order50Discount periodEndOverride: month: 11 @@ -34464,8 +34533,10 @@ components: minute: 59 second: 59 description: 50% off for every 50th purchase in a year. + activationPolicy: fixed_schedule title: 50% off on 50th purchase. target: 50.0 + recurrencePolicy: no_recurrence properties: name: description: | @@ -34522,6 +34593,40 @@ components: type: string periodEndOverride: $ref: '#/components/schemas/TimePoint' + recurrencePolicy: + description: | + The policy that determines if and how the achievement recurs. + - `no_recurrence`: The achievement can be completed only once. + - `on_expiration`: The achievement resets after it expires and becomes available again. + enum: + - no_recurrence + - on_expiration + example: no_recurrence + type: string + activationPolicy: + description: | + The policy that determines how the achievement starts, ends, or resets. + - `user_action`: The achievement ends or resets relative to when the customer started the achievement. + - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + enum: + - user_action + - fixed_schedule + example: fixed_schedule + type: string + fixedStartDate: + description: | + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string + endDate: + description: | + The achievement's end date. If defined, customers cannot participate in the achievement after this date. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string required: - description - name @@ -34555,12 +34660,19 @@ components: - userId type: object Achievement: - description: "" example: period: 1Y - createdBy: John Doe + endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z campaignId: 1 + description: 50% off for every 50th purchase in a year. + activationPolicy: fixed_schedule + title: 50% off on 50th purchase. + userId: 1234 + hasProgress: true + target: 50.0 + fixedStartDate: 2000-01-23T04:56:07.000+00:00 + createdBy: John Doe name: Order50Discount periodEndOverride: month: 11 @@ -34568,12 +34680,8 @@ components: hour: 23 minute: 59 second: 59 - description: 50% off for every 50th purchase in a year. id: 6 - title: 50% off on 50th purchase. - userId: 1234 - hasProgress: true - target: 50.0 + recurrencePolicy: no_recurrence properties: id: description: Internal ID of this entity. @@ -34639,6 +34747,40 @@ components: type: string periodEndOverride: $ref: '#/components/schemas/TimePoint' + recurrencePolicy: + description: | + The policy that determines if and how the achievement recurs. + - `no_recurrence`: The achievement can be completed only once. + - `on_expiration`: The achievement resets after it expires and becomes available again. + enum: + - no_recurrence + - on_expiration + example: no_recurrence + type: string + activationPolicy: + description: | + The policy that determines how the achievement starts, ends, or resets. + - `user_action`: The achievement ends or resets relative to when the customer started the achievement. + - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + enum: + - user_action + - fixed_schedule + example: fixed_schedule + type: string + fixedStartDate: + description: | + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string + endDate: + description: | + The achievement's end date. If defined, customers cannot participate in the achievement after this date. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string campaignId: description: ID of the campaign, to which the achievement belongs to example: 1 @@ -34671,7 +34813,9 @@ components: type: object UpdateAchievement: example: + fixedStartDate: 2000-01-23T04:56:07.000+00:00 period: 1Y + endDate: 2000-01-23T04:56:07.000+00:00 name: Order50Discount periodEndOverride: month: 11 @@ -34680,8 +34824,10 @@ components: minute: 59 second: 59 description: 50% off for every 50th purchase in a year. + activationPolicy: fixed_schedule title: 50% off on 50th purchase. target: 50.0 + recurrencePolicy: no_recurrence properties: name: description: | @@ -34712,6 +34858,40 @@ components: type: string periodEndOverride: $ref: '#/components/schemas/TimePoint' + recurrencePolicy: + description: | + The policy that determines if and how the achievement recurs. + - `no_recurrence`: The achievement can be completed only once. + - `on_expiration`: The achievement resets after it expires and becomes available again. + enum: + - no_recurrence + - on_expiration + example: no_recurrence + type: string + activationPolicy: + description: | + The policy that determines how the achievement starts, ends, or resets. + - `user_action`: The achievement ends or resets relative to when the customer started the achievement. + - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + enum: + - user_action + - fixed_schedule + example: fixed_schedule + type: string + fixedStartDate: + description: | + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string + endDate: + description: | + The achievement's end date. If defined, customers cannot participate in the achievement after this date. + + **Note:** It must be an RFC3339 timestamp string. + format: date-time + type: string type: object AchievementProgress: example: @@ -34866,6 +35046,7 @@ components: - running - disabled - archived + - staged example: running type: string totalRevenue: @@ -35049,7 +35230,7 @@ components: data: - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -35059,9 +35240,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -35070,7 +35251,7 @@ components: id: 2 - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -35080,9 +35261,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -35340,10 +35521,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -35421,10 +35603,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -35541,10 +35724,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -35622,10 +35806,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -35669,19 +35854,13 @@ components: inline_response_200_6: example: data: - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -35723,22 +35902,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -35746,7 +35911,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -35754,12 +35918,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -35768,10 +35926,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -35814,22 +36002,14 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 - - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced + - type: advanced templateId: 3 - activeRevisionVersionId: 6 customEffectCount: 0 activeRevisionId: 6 features: - coupons - referrals - currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 storesImported: true couponSettings: @@ -35871,22 +36051,8 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z id: 4 state: enabled - currentRevisionId: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 reservecouponEffectCount: 9 updatedBy: Jane Doe frontendState: running @@ -35894,7 +36060,6 @@ components: referralCreationCount: 8 stageRevision: false couponRedemptionCount: 163 - userId: 388 couponCreationCount: 16 version: 6 campaignGroups: @@ -35902,12 +36067,6 @@ components: - 3 tags: - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 discountEffectCount: 343 budgets: - limit: 1000.0 @@ -35916,10 +36075,40 @@ components: - limit: 1000.0 action: createCoupon counter: 42.0 - createdBy: John Doe redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 name: Summer promotions + applicationId: 322 + updated: 2000-01-23T04:56:07.000+00:00 + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + revisionFrontendState: revised + description: Campaign for all summer 2021 promotions + activeRevisionVersionId: 6 + currentRevisionVersionId: 6 + startTime: 2021-07-20T22:00:00Z + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + userId: 388 + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + createdBy: John Doe + addFreeItemEffectCount: 0 referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -35962,9 +36151,7 @@ components: attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z - applicationId: 322 referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 totalResultSize: 1 properties: totalResultSize: @@ -36519,207 +36706,22 @@ components: inline_response_200_12: example: data: - - activeRulesetId: 5 - instructions: Use this template for discount campaigns. Set the campaign + - instructions: Use this template for discount campaigns. Set the campaign properties according to the campaign goals, and don't forget to set an end date. - campaignAttributes: '{}' - applicationsIds: - - 0 - - 0 - campaignType: advanced - updatedBy: Jane Doe campaignCollections: - name: My collection description: My collection of SKUs - name: My collection description: My collection of SKUs - created: 2020-06-10T09:05:27.993483Z defaultCampaignGroupId: 42 description: This is a template for a discount campaign. - userId: 388 - tags: - - discount - accountId: 3886 features: - coupons - coupons - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: - couponPattern: SUMMER-####-#### - validCharacters: - - A - - B - - C - - D - - E - - F - - G - - H - - I - - J - - K - - L - - M - - "N" - - O - - P - - Q - - R - - S - - T - - U - - V - - W - - X - - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" - couponSettings: - couponPattern: SUMMER-####-#### - validCharacters: - - A - - B - - C - - D - - E - - F - - G - - H - - I - - J - - K - - L - - M - - "N" - - O - - P - - Q - - R - - S - - T - - U - - V - - W - - X - - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" - templateParams: - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - id: 6 - couponAttributes: '{}' - state: draft - updated: 2022-08-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - activeRulesetId: 5 - instructions: Use this template for discount campaigns. Set the campaign - properties according to the campaign goals, and don't forget to set an - end date. - campaignAttributes: '{}' - applicationsIds: - - 0 - - 0 - campaignType: advanced - updatedBy: Jane Doe - campaignCollections: - - name: My collection - description: My collection of SKUs - - name: My collection - description: My collection of SKUs - created: 2020-06-10T09:05:27.993483Z - defaultCampaignGroupId: 42 - description: This is a template for a discount campaign. - userId: 388 - tags: - - discount - accountId: 3886 - features: - - coupons - - coupons - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: - couponPattern: SUMMER-####-#### - validCharacters: - - A - - B - - C - - D - - E - - F - - G - - H - - I - - J - - K - - L - - M - - "N" - - O - - P - - Q - - R - - S - - T - - U - - V - - W - - X - - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -36771,7 +36773,145 @@ components: id: 6 couponAttributes: '{}' state: draft + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 5 + campaignAttributes: '{}' + applicationsIds: + - 1 + - 2 + - 3 + - 1 + - 2 + - 3 + campaignType: advanced + updatedBy: Jane Doe + created: 2020-06-10T09:05:27.993483Z + userId: 388 + tags: + - discount + accountId: 3886 + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" updated: 2022-08-24T14:15:22Z + - instructions: Use this template for discount campaigns. Set the campaign + properties according to the campaign goals, and don't forget to set an + end date. + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + defaultCampaignGroupId: 42 + description: This is a template for a discount campaign. + features: + - coupons + - coupons + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft limits: - period: yearly entities: @@ -36783,6 +36923,67 @@ components: - Coupon limit: 1000.0 action: createCoupon + activeRulesetId: 5 + campaignAttributes: '{}' + applicationsIds: + - 1 + - 2 + - 3 + - 1 + - 2 + - 3 + campaignType: advanced + updatedBy: Jane Doe + created: 2020-06-10T09:05:27.993483Z + userId: 388 + tags: + - discount + accountId: 3886 + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + updated: 2022-08-24T14:15:22Z hasMore: true properties: hasMore: @@ -36866,10 +37067,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -36947,10 +37149,11 @@ components: - "7" - "8" - "9" - id: 0 + id: 139 canUpgradeToAdvancedTiers: true created: 2020-06-10T09:05:27.993483Z sandbox: true + returnPolicy: only_pending subscribedApplications: - 132 - 97 @@ -37381,21 +37584,21 @@ components: inline_response_200_22: example: data: - - accountId: 6 + - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false - integrationId: integrationId + integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 0 + id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: @@ -37403,21 +37606,21 @@ components: id: 2 - name: Travel audience id: 2 - - accountId: 6 + - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false - integrationId: integrationId + integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 0 + id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: @@ -37442,21 +37645,21 @@ components: inline_response_200_23: example: data: - - accountId: 6 + - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false - integrationId: integrationId + integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 0 + id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: @@ -37464,21 +37667,21 @@ components: id: 2 - name: Travel audience id: 2 - - accountId: 6 + - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false - integrationId: integrationId + integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 0 + id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: @@ -37504,7 +37707,7 @@ components: data: - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -37514,9 +37717,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -37525,7 +37728,7 @@ components: id: 2 - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -37535,9 +37738,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -37562,7 +37765,7 @@ components: data: - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -37572,9 +37775,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -37583,7 +37786,7 @@ components: id: 2 - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -37593,9 +37796,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -37657,7 +37860,7 @@ components: example: data: - coupon: BKDB946 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalDiscounts: 100.0 integrationId: URNGV8294NV profileintegrationid: 382370BKDB946 @@ -37715,7 +37918,7 @@ components: category: shoes height: 0.8008281904610115 - coupon: BKDB946 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalDiscounts: 100.0 integrationId: URNGV8294NV profileintegrationid: 382370BKDB946 @@ -38002,7 +38205,7 @@ components: data: - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -38012,9 +38215,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -38023,7 +38226,7 @@ components: id: 2 - accountId: 31 closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z sandbox: false integrationId: URNGV8294NV attributes: @@ -38033,9 +38236,9 @@ components: lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - - joined: 2000-01-23T04:56:07.000+00:00 + - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - name: Travel audience @@ -38625,7 +38828,7 @@ components: - 4 - 6 - 8 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. integrationId: STORE-001 @@ -38639,7 +38842,7 @@ components: - 4 - 6 - 8 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. integrationId: STORE-001 @@ -38667,9 +38870,17 @@ components: example: data: - period: 1Y - createdBy: John Doe + endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z campaignId: 1 + description: 50% off for every 50th purchase in a year. + activationPolicy: fixed_schedule + title: 50% off on 50th purchase. + userId: 1234 + hasProgress: true + target: 50.0 + fixedStartDate: 2000-01-23T04:56:07.000+00:00 + createdBy: John Doe name: Order50Discount periodEndOverride: month: 11 @@ -38677,16 +38888,20 @@ components: hour: 23 minute: 59 second: 59 - description: 50% off for every 50th purchase in a year. id: 6 + recurrencePolicy: no_recurrence + - period: 1Y + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + campaignId: 1 + description: 50% off for every 50th purchase in a year. + activationPolicy: fixed_schedule title: 50% off on 50th purchase. userId: 1234 hasProgress: true target: 50.0 - - period: 1Y + fixedStartDate: 2000-01-23T04:56:07.000+00:00 createdBy: John Doe - created: 2020-06-10T09:05:27.993483Z - campaignId: 1 name: Order50Discount periodEndOverride: month: 11 @@ -38694,12 +38909,8 @@ components: hour: 23 minute: 59 second: 59 - description: 50% off for every 50th purchase in a year. id: 6 - title: 50% off on 50th purchase. - userId: 1234 - hasProgress: true - target: 50.0 + recurrencePolicy: no_recurrence hasMore: true properties: hasMore: @@ -38799,6 +39010,14 @@ components: description: Indicates whether the service provider supports patch operations for modifying resources. type: boolean + ScimServiceProviderConfigResponse_sort: + description: Configuration settings related to sorting SCIM resources in query + responses. + properties: + supported: + description: Indicates whether the service provider supports sorting operations + for ordered query results. + type: boolean GenerateRuleTitle_rule: properties: effects: @@ -38827,7 +39046,6 @@ components: - and - - couponValid items: - properties: {} type: object minItems: 1 type: array diff --git a/build.gradle b/build.gradle index 301bb45f..b4d4c515 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'one.talon' -version = '9.0.2' +version = '9.1.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index ec4bb49c..8fe4e41c 100644 --- a/build.sbt +++ b/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "one.talon", name := "talon-one-client", - version := "9.0.2", + version := "9.1.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/Account.md b/docs/Account.md index 051925d8..e6a37d79 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -2,7 +2,6 @@ # Account - ## Properties Name | Type | Description | Notes diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md index 25f66df0..45a50c49 100644 --- a/docs/AccountAdditionalCost.md +++ b/docs/AccountAdditionalCost.md @@ -2,7 +2,6 @@ # AccountAdditionalCost - ## Properties Name | Type | Description | Notes diff --git a/docs/Achievement.md b/docs/Achievement.md index 4475727b..c95289db 100644 --- a/docs/Achievement.md +++ b/docs/Achievement.md @@ -2,7 +2,6 @@ # Achievement - ## Properties Name | Type | Description | Notes @@ -15,6 +14,10 @@ Name | Type | Description | Notes **target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | **periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] **campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to | **userId** | **Integer** | 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. | @@ -22,3 +25,21 @@ Name | Type | Description | Notes +## Enum: RecurrencePolicyEnum + +Name | Value +---- | ----- +NO_RECURRENCE | "no_recurrence" +ON_EXPIRATION | "on_expiration" + + + +## Enum: ActivationPolicyEnum + +Name | Value +---- | ----- +USER_ACTION | "user_action" +FIXED_SCHEDULE | "fixed_schedule" + + + diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md index dbfcf5e5..b7498473 100644 --- a/docs/AdditionalCampaignProperties.md +++ b/docs/AdditionalCampaignProperties.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes **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** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional] -**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. | +**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | The campaign state displayed in the Campaign Manager. | **storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | @@ -41,6 +41,7 @@ SCHEDULED | "scheduled" RUNNING | "running" DISABLED | "disabled" ARCHIVED | "archived" +STAGED | "staged" diff --git a/docs/Application.md b/docs/Application.md index 73805e47..9676c6d2 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -2,7 +2,6 @@ # Application - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md index d0fff825..e2f8881e 100644 --- a/docs/ApplicationAPIKey.md +++ b/docs/ApplicationAPIKey.md @@ -2,7 +2,6 @@ # ApplicationAPIKey - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md index b9ea4a2e..bea541a0 100644 --- a/docs/ApplicationCIF.md +++ b/docs/ApplicationCIF.md @@ -2,7 +2,6 @@ # ApplicationCIF - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md index 7f3a533a..7d03812a 100644 --- a/docs/ApplicationCIFExpression.md +++ b/docs/ApplicationCIFExpression.md @@ -2,7 +2,6 @@ # ApplicationCIFExpression - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md index c195a439..b7cdda8d 100644 --- a/docs/ApplicationCampaignAnalytics.md +++ b/docs/ApplicationCampaignAnalytics.md @@ -30,6 +30,7 @@ SCHEDULED | "scheduled" RUNNING | "running" DISABLED | "disabled" ARCHIVED | "archived" +STAGED | "staged" diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md index 289dae94..6427b729 100644 --- a/docs/ApplicationCampaignStats.md +++ b/docs/ApplicationCampaignStats.md @@ -8,6 +8,7 @@ Provides statistics regarding an application's campaigns. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **disabled** | **Integer** | Number of disabled campaigns. | +**staged** | **Integer** | Number of staged campaigns. | **scheduled** | **Integer** | Number of scheduled campaigns. | **running** | **Integer** | Number of running campaigns. | **expired** | **Integer** | Number of expired campaigns. | diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index fb152708..fff19a34 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -2,16 +2,15 @@ # ApplicationCustomer - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Internal ID of this entity. Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. | -**integrationId** | **String** | The integration ID set by your integration layer. The integration ID set by your integration layer. | +**id** | **Integer** | Internal ID of this entity. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | +**integrationId** | **String** | The integration ID set by your integration layer. | **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | -**accountId** | **Integer** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | +**accountId** | **Integer** | The ID of the Talon.One account that owns this profile. | **closedSessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | **totalSales** | [**BigDecimal**](BigDecimal.md) | 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** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index 001955f2..339dedc1 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -2,7 +2,6 @@ # ApplicationEvent - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md index 9c6c653f..eb59521a 100644 --- a/docs/ApplicationReferee.md +++ b/docs/ApplicationReferee.md @@ -2,7 +2,6 @@ # ApplicationReferee - ## Properties Name | Type | Description | Notes diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index c74917ff..4c06c5f5 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -2,13 +2,12 @@ # ApplicationSession - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | 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** | **Integer** | The ID of the application that owns this entity. | diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md index 5ff17ed6..440aad48 100644 --- a/docs/AsyncCouponDeletionJobResponse.md +++ b/docs/AsyncCouponDeletionJobResponse.md @@ -2,7 +2,6 @@ # AsyncCouponDeletionJobResponse - ## Properties Name | Type | Description | Notes diff --git a/docs/Attribute.md b/docs/Attribute.md index 3ca828f3..cd831648 100644 --- a/docs/Attribute.md +++ b/docs/Attribute.md @@ -2,7 +2,6 @@ # Attribute - ## Properties Name | Type | Description | Notes diff --git a/docs/Audience.md b/docs/Audience.md index b0dd785d..d7047c3e 100644 --- a/docs/Audience.md +++ b/docs/Audience.md @@ -2,7 +2,6 @@ # Audience - ## Properties Name | Type | Description | Notes diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md index c256d527..c2d7f477 100644 --- a/docs/AudienceCustomer.md +++ b/docs/AudienceCustomer.md @@ -2,13 +2,12 @@ # AudienceCustomer - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **integrationId** | **String** | The integration ID set by your integration layer. | **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | **accountId** | **Integer** | The ID of the Talon.One account that owns this profile. | diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md index 0fa099f4..65180dc3 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated. 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** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**returnPolicy** | [**ReturnPolicyEnum**](#ReturnPolicyEnum) | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] @@ -53,3 +54,12 @@ BALANCE_BASED | "balance_based" +## Enum: ReturnPolicyEnum + +Name | Value +---- | ----- +ONLY_PENDING | "only_pending" +WITHIN_BALANCE | "within_balance" + + + diff --git a/docs/BaseNotification.md b/docs/BaseNotification.md index 175e15c9..fda2712b 100644 --- a/docs/BaseNotification.md +++ b/docs/BaseNotification.md @@ -2,7 +2,6 @@ # BaseNotification - ## Properties Name | Type | Description | Notes diff --git a/docs/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md index fb23b7c1..bc0fcbfb 100644 --- a/docs/BaseNotificationWebhook.md +++ b/docs/BaseNotificationWebhook.md @@ -2,7 +2,6 @@ # BaseNotificationWebhook - ## Properties Name | Type | Description | Notes diff --git a/docs/BulkOperationOnCampaigns.md b/docs/BulkOperationOnCampaigns.md index ca0ace69..7eb0ecb7 100644 --- a/docs/BulkOperationOnCampaigns.md +++ b/docs/BulkOperationOnCampaigns.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**OperationEnum**](#OperationEnum) | The operation to perform on the specified campaign IDs. | **campaignIds** | **List<Integer>** | The list of campaign IDs on which the operation will be performed. | +**activateAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. | [optional] @@ -17,6 +18,7 @@ Name | Value ---- | ----- DISABLE | "disable" DELETE | "delete" +ACTIVATE_REVISION | "activate_revision" diff --git a/docs/Campaign.md b/docs/Campaign.md index 25c1f15e..84caa11f 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -2,7 +2,6 @@ # Campaign - ## Properties Name | Type | Description | Notes @@ -47,8 +46,9 @@ Name | Type | Description | Notes **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** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional] -**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. | +**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | The campaign state displayed in the Campaign Manager. | **storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | +**revisionFrontendState** | [**RevisionFrontendStateEnum**](#RevisionFrontendStateEnum) | The campaign revision state displayed in the Campaign Manager. | [optional] **activeRevisionId** | **Integer** | ID of the revision that was last activated on this campaign. | [optional] **activeRevisionVersionId** | **Integer** | ID of the revision version that is active on the campaign. | [optional] **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] @@ -99,6 +99,16 @@ SCHEDULED | "scheduled" RUNNING | "running" DISABLED | "disabled" ARCHIVED | "archived" +STAGED | "staged" + + + +## Enum: RevisionFrontendStateEnum + +Name | Value +---- | ----- +REVISED | "revised" +PENDING | "pending" diff --git a/docs/CampaignAnalytics.md b/docs/CampaignAnalytics.md index 541dad18..6db38b31 100644 --- a/docs/CampaignAnalytics.md +++ b/docs/CampaignAnalytics.md @@ -2,7 +2,6 @@ # CampaignAnalytics - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md index c4b07460..e950df5e 100644 --- a/docs/CampaignCollection.md +++ b/docs/CampaignCollection.md @@ -2,7 +2,6 @@ # CampaignCollection - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md index e8645410..e8105ad0 100644 --- a/docs/CampaignCollectionWithoutPayload.md +++ b/docs/CampaignCollectionWithoutPayload.md @@ -2,7 +2,6 @@ # CampaignCollectionWithoutPayload - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignEvaluationGroup.md b/docs/CampaignEvaluationGroup.md index 85e9baa7..5ee79975 100644 --- a/docs/CampaignEvaluationGroup.md +++ b/docs/CampaignEvaluationGroup.md @@ -2,7 +2,6 @@ # CampaignEvaluationGroup - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md index 9dc3750b..2f6a7c78 100644 --- a/docs/CampaignGroup.md +++ b/docs/CampaignGroup.md @@ -2,7 +2,6 @@ # CampaignGroup - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md index 988ae499..5e13190b 100644 --- a/docs/CampaignSet.md +++ b/docs/CampaignSet.md @@ -2,7 +2,6 @@ # CampaignSet - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignStoreBudget.md b/docs/CampaignStoreBudget.md index 568b48bd..e36e45aa 100644 --- a/docs/CampaignStoreBudget.md +++ b/docs/CampaignStoreBudget.md @@ -2,7 +2,6 @@ # CampaignStoreBudget - ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignTemplate.md b/docs/CampaignTemplate.md index 0eff1cf5..f1d246f9 100644 --- a/docs/CampaignTemplate.md +++ b/docs/CampaignTemplate.md @@ -2,7 +2,6 @@ # CampaignTemplate - ## Properties Name | Type | Description | Notes @@ -21,6 +20,7 @@ Name | Type | Description | Notes **tags** | **List<String>** | A list of tags for the campaign template. | [optional] **features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign template. | [optional] **couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**couponReservationSettings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**List<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] **templateParams** | [**List<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/CampaignTemplateCouponReservationSettings.md b/docs/CampaignTemplateCouponReservationSettings.md new file mode 100644 index 00000000..d04b8952 --- /dev/null +++ b/docs/CampaignTemplateCouponReservationSettings.md @@ -0,0 +1,13 @@ + + +# CampaignTemplateCouponReservationSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reservationLimit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional] +**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] + + + diff --git a/docs/CampaignVersions.md b/docs/CampaignVersions.md index f8254a91..cb06e69a 100644 --- a/docs/CampaignVersions.md +++ b/docs/CampaignVersions.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**revisionFrontendState** | [**RevisionFrontendStateEnum**](#RevisionFrontendStateEnum) | The campaign revision state displayed in the Campaign Manager. | [optional] **activeRevisionId** | **Integer** | ID of the revision that was last activated on this campaign. | [optional] **activeRevisionVersionId** | **Integer** | ID of the revision version that is active on the campaign. | [optional] **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] @@ -15,3 +16,12 @@ Name | Type | Description | Notes +## Enum: RevisionFrontendStateEnum + +Name | Value +---- | ----- +REVISED | "revised" +PENDING | "pending" + + + diff --git a/docs/Catalog.md b/docs/Catalog.md index ed525df6..a962c3fc 100644 --- a/docs/Catalog.md +++ b/docs/Catalog.md @@ -2,7 +2,6 @@ # Catalog - ## Properties Name | Type | Description | Notes diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index 20a8ffcb..7128d57b 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -2,7 +2,6 @@ # CatalogItem - ## Properties Name | Type | Description | Notes diff --git a/docs/Change.md b/docs/Change.md index 410c4952..23ff1f8f 100644 --- a/docs/Change.md +++ b/docs/Change.md @@ -2,7 +2,6 @@ # Change - ## Properties Name | Type | Description | Notes diff --git a/docs/Collection.md b/docs/Collection.md index 9112b767..f0dc07df 100644 --- a/docs/Collection.md +++ b/docs/Collection.md @@ -2,7 +2,6 @@ # Collection - ## Properties Name | Type | Description | Notes diff --git a/docs/CollectionItem.md b/docs/CollectionItem.md index d87b3372..6c5c67d9 100644 --- a/docs/CollectionItem.md +++ b/docs/CollectionItem.md @@ -2,7 +2,6 @@ # CollectionItem - ## Properties Name | Type | Description | Notes diff --git a/docs/CollectionWithoutPayload.md b/docs/CollectionWithoutPayload.md index ab274d65..c237d873 100644 --- a/docs/CollectionWithoutPayload.md +++ b/docs/CollectionWithoutPayload.md @@ -2,7 +2,6 @@ # CollectionWithoutPayload - ## Properties Name | Type | Description | Notes diff --git a/docs/Coupon.md b/docs/Coupon.md index 8987398c..9c34c308 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -2,7 +2,6 @@ # Coupon - ## Properties Name | Type | Description | Notes diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index 8a63bb2d..b406ddaf 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -2,7 +2,6 @@ # CouponCreationJob - ## Properties Name | Type | Description | Notes diff --git a/docs/CouponDeletionJob.md b/docs/CouponDeletionJob.md index 569a451e..e0616222 100644 --- a/docs/CouponDeletionJob.md +++ b/docs/CouponDeletionJob.md @@ -2,7 +2,6 @@ # CouponDeletionJob - ## Properties Name | Type | Description | Notes diff --git a/docs/CreateAchievement.md b/docs/CreateAchievement.md index 732e59cc..e3d58d73 100644 --- a/docs/CreateAchievement.md +++ b/docs/CreateAchievement.md @@ -12,6 +12,28 @@ Name | Type | Description | Notes **target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | **periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] + + + +## Enum: RecurrencePolicyEnum + +Name | Value +---- | ----- +NO_RECURRENCE | "no_recurrence" +ON_EXPIRATION | "on_expiration" + + + +## Enum: ActivationPolicyEnum + +Name | Value +---- | ----- +USER_ACTION | "user_action" +FIXED_SCHEDULE | "fixed_schedule" diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md index 9d1c154f..70e5cb4b 100644 --- a/docs/CustomEffect.md +++ b/docs/CustomEffect.md @@ -2,7 +2,6 @@ # CustomEffect - ## Properties Name | Type | Description | Notes diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index 1499e664..89a41f14 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -2,13 +2,12 @@ # CustomerProfile - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **integrationId** | **String** | The integration ID set by your integration layer. | **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | **accountId** | **Integer** | The ID of the Talon.One account that owns this profile. | diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md index 5d3025ee..8ce26dcd 100644 --- a/docs/CustomerProfileIntegrationRequestV2.md +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -2,7 +2,7 @@ # CustomerProfileIntegrationRequestV2 - +The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. ## Properties Name | Type | Description | Notes diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index cab0871e..de7f53c3 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -2,7 +2,6 @@ # CustomerSession - ## Properties Name | Type | Description | Notes diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index 8135ae7c..6ddc178f 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -2,13 +2,13 @@ # CustomerSessionV2 - +The representation of the customer session. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **integrationId** | **String** | The integration ID set by your integration layer. | **applicationId** | **Integer** | 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`. | @@ -20,7 +20,7 @@ Name | Type | Description | Notes **state** | [**StateEnum**](#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). | **cartItems** | [**List<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** | [**Map<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** | **List<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] +**identifiers** | **List<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). - We recommend passing an anonymized (hashed) version of the identifier value. | [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** | [**BigDecimal**](BigDecimal.md) | The total value of cart items and additional costs in the session, before any discounts are applied. | diff --git a/docs/DeactivateUserRequest.md b/docs/DeactivateUserRequest.md index 909210bb..3ba27b13 100644 --- a/docs/DeactivateUserRequest.md +++ b/docs/DeactivateUserRequest.md @@ -2,7 +2,6 @@ # DeactivateUserRequest - ## Properties Name | Type | Description | Notes diff --git a/docs/Effect.md b/docs/Effect.md index d1cddde0..b00f2e90 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -2,7 +2,7 @@ # Effect - +A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type. ## Properties Name | Type | Description | Notes diff --git a/docs/Environment.md b/docs/Environment.md index 6c3384d0..2d174f12 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -2,7 +2,6 @@ # Environment - ## Properties Name | Type | Description | Notes diff --git a/docs/Event.md b/docs/Event.md index 61c067b2..f3a83852 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -2,7 +2,6 @@ # Event - ## Properties Name | Type | Description | Notes diff --git a/docs/EventType.md b/docs/EventType.md index 4b39462c..8cc7274e 100644 --- a/docs/EventType.md +++ b/docs/EventType.md @@ -2,7 +2,6 @@ # EventType - ## Properties Name | Type | Description | Notes diff --git a/docs/EventV2.md b/docs/EventV2.md index 8448c2a1..2a692493 100644 --- a/docs/EventV2.md +++ b/docs/EventV2.md @@ -2,7 +2,6 @@ # EventV2 - ## Properties Name | Type | Description | Notes diff --git a/docs/Export.md b/docs/Export.md index f5a7082a..cb8a4038 100644 --- a/docs/Export.md +++ b/docs/Export.md @@ -2,7 +2,6 @@ # Export - ## Properties Name | Type | Description | Notes diff --git a/docs/FeaturesFeed.md b/docs/FeaturesFeed.md index f5606559..6b7dce67 100644 --- a/docs/FeaturesFeed.md +++ b/docs/FeaturesFeed.md @@ -2,7 +2,6 @@ # FeaturesFeed - ## Properties Name | Type | Description | Notes diff --git a/docs/GenerateLoyaltyCard.md b/docs/GenerateLoyaltyCard.md index 75a9ebdb..7d961a50 100644 --- a/docs/GenerateLoyaltyCard.md +++ b/docs/GenerateLoyaltyCard.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | [**StatusEnum**](#StatusEnum) | Status of the loyalty card. | [optional] **customerProfileIds** | **List<String>** | Integration IDs of the customer profiles linked to the card. | [optional] +**cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional] diff --git a/docs/Giveaway.md b/docs/Giveaway.md index 43fade3e..b712417c 100644 --- a/docs/Giveaway.md +++ b/docs/Giveaway.md @@ -2,7 +2,6 @@ # Giveaway - ## Properties Name | Type | Description | Notes diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index 4aaf20f9..46d5e8b7 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description [**generateLoyaltyCard**](IntegrationApi.md#generateLoyaltyCard) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card [**getCustomerInventory**](IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data [**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 +[**getLoyaltyBalances**](IntegrationApi.md#getLoyaltyBalances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances [**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 @@ -546,7 +546,7 @@ null (empty response body) Delete customer's personal data -Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. +Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. ### Example ```java @@ -841,9 +841,9 @@ Name | Type | Description | Notes # **getLoyaltyBalances** > LoyaltyBalancesWithTiers getLoyaltyBalances(loyaltyProgramId, integrationId, endDate, subledgerId, includeTiers, includeProjectedTier) -Get customer's loyalty points +Get customer's loyalty balances -Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. 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) +Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. 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 ```java @@ -872,7 +872,7 @@ public class Example { OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data. Boolean includeTiers = false; // Boolean | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. - Boolean includeProjectedTier = false; // Boolean | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. + Boolean includeProjectedTier = false; // Boolean | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. try { LoyaltyBalancesWithTiers result = apiInstance.getLoyaltyBalances(loyaltyProgramId, integrationId, endDate, subledgerId, includeTiers, includeProjectedTier); System.out.println(result); @@ -896,7 +896,7 @@ Name | Type | Description | Notes **endDate** | **OffsetDateTime**| 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] **includeTiers** | **Boolean**| Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. | [optional] [default to false] - **includeProjectedTier** | **Boolean**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to false] + **includeProjectedTier** | **Boolean**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to false] ### Return type diff --git a/docs/IntegrationCoupon.md b/docs/IntegrationCoupon.md index b1a5c21d..e0559d57 100644 --- a/docs/IntegrationCoupon.md +++ b/docs/IntegrationCoupon.md @@ -2,7 +2,6 @@ # IntegrationCoupon - ## Properties Name | Type | Description | Notes diff --git a/docs/IntegrationEvent.md b/docs/IntegrationEvent.md index d26fde60..518f0bbe 100644 --- a/docs/IntegrationEvent.md +++ b/docs/IntegrationEvent.md @@ -2,7 +2,6 @@ # IntegrationEvent - ## Properties Name | Type | Description | Notes diff --git a/docs/IntegrationEventV2Request.md b/docs/IntegrationEventV2Request.md index c14b0a15..7c31c893 100644 --- a/docs/IntegrationEventV2Request.md +++ b/docs/IntegrationEventV2Request.md @@ -2,7 +2,6 @@ # IntegrationEventV2Request - ## Properties Name | Type | Description | Notes diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index 829b3ff8..01d42dee 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -2,7 +2,6 @@ # InventoryCoupon - ## Properties Name | Type | Description | Notes diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md index 17d53eda..994276b5 100644 --- a/docs/InventoryReferral.md +++ b/docs/InventoryReferral.md @@ -2,7 +2,6 @@ # InventoryReferral - ## Properties Name | Type | Description | Notes diff --git a/docs/ItemAttribute.md b/docs/ItemAttribute.md index c7d6a6d3..c9f4b3c6 100644 --- a/docs/ItemAttribute.md +++ b/docs/ItemAttribute.md @@ -2,7 +2,6 @@ # ItemAttribute - ## Properties Name | Type | Description | Notes diff --git a/docs/LedgerEntry.md b/docs/LedgerEntry.md index 2df43ac0..4e9ad59e 100644 --- a/docs/LedgerEntry.md +++ b/docs/LedgerEntry.md @@ -2,7 +2,7 @@ # LedgerEntry - +Entry in the point ledger. ## Properties Name | Type | Description | Notes diff --git a/docs/LedgerInfo.md b/docs/LedgerInfo.md index 8b475a47..e3fe11e6 100644 --- a/docs/LedgerInfo.md +++ b/docs/LedgerInfo.md @@ -2,7 +2,7 @@ # LedgerInfo - +The balance in a Loyalty Program for some Customer. ## Properties Name | Type | Description | Notes diff --git a/docs/LibraryAttribute.md b/docs/LibraryAttribute.md index 3a45af5f..fd90365a 100644 --- a/docs/LibraryAttribute.md +++ b/docs/LibraryAttribute.md @@ -2,7 +2,6 @@ # LibraryAttribute - ## Properties Name | Type | Description | Notes diff --git a/docs/LimitConfig.md b/docs/LimitConfig.md index 3a8445b4..01339b73 100644 --- a/docs/LimitConfig.md +++ b/docs/LimitConfig.md @@ -32,6 +32,7 @@ COUPON | "Coupon" REFERRAL | "Referral" PROFILE | "Profile" IDENTIFIER | "Identifier" +STORE | "Store" diff --git a/docs/LimitCounter.md b/docs/LimitCounter.md index 63f2ed0e..024f107c 100644 --- a/docs/LimitCounter.md +++ b/docs/LimitCounter.md @@ -2,7 +2,6 @@ # LimitCounter - ## Properties Name | Type | Description | Notes diff --git a/docs/ListCampaignStoreBudgets.md b/docs/ListCampaignStoreBudgets.md new file mode 100644 index 00000000..810396ca --- /dev/null +++ b/docs/ListCampaignStoreBudgets.md @@ -0,0 +1,15 @@ + + +# ListCampaignStoreBudgets + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**store** | [**ListCampaignStoreBudgetsStore**](ListCampaignStoreBudgetsStore.md) | | +**limit** | **Integer** | | +**action** | **String** | | +**period** | **String** | | [optional] + + + diff --git a/docs/ListCampaignStoreBudgetsStore.md b/docs/ListCampaignStoreBudgetsStore.md new file mode 100644 index 00000000..2c9718e6 --- /dev/null +++ b/docs/ListCampaignStoreBudgetsStore.md @@ -0,0 +1,14 @@ + + +# ListCampaignStoreBudgetsStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Integer** | | +**integrationId** | **String** | | +**name** | **String** | | + + + diff --git a/docs/LoginParams.md b/docs/LoginParams.md index 2730c9c5..40d5f9ce 100644 --- a/docs/LoginParams.md +++ b/docs/LoginParams.md @@ -2,7 +2,6 @@ # LoginParams - ## Properties Name | Type | Description | Notes diff --git a/docs/LoyaltyBalanceWithTier.md b/docs/LoyaltyBalanceWithTier.md index 04539325..d504f4a6 100644 --- a/docs/LoyaltyBalanceWithTier.md +++ b/docs/LoyaltyBalanceWithTier.md @@ -2,7 +2,7 @@ # LoyaltyBalanceWithTier - +Point balance of a ledger in the Loyalty Program. ## Properties Name | Type | Description | Notes diff --git a/docs/LoyaltyCard.md b/docs/LoyaltyCard.md index 6c1455af..6a5458eb 100644 --- a/docs/LoyaltyCard.md +++ b/docs/LoyaltyCard.md @@ -2,7 +2,6 @@ # LoyaltyCard - ## Properties Name | Type | Description | Notes diff --git a/docs/LoyaltyCardBalances.md b/docs/LoyaltyCardBalances.md index 3e9a273e..c847a59e 100644 --- a/docs/LoyaltyCardBalances.md +++ b/docs/LoyaltyCardBalances.md @@ -2,7 +2,7 @@ # LoyaltyCardBalances - +List of customer profiles linked to the loyalty card. ## Properties Name | Type | Description | Notes diff --git a/docs/LoyaltyCardBatch.md b/docs/LoyaltyCardBatch.md index 1468a899..832edd26 100644 --- a/docs/LoyaltyCardBatch.md +++ b/docs/LoyaltyCardBatch.md @@ -2,7 +2,6 @@ # LoyaltyCardBatch - ## Properties Name | Type | Description | Notes @@ -10,6 +9,7 @@ Name | Type | Description | Notes **numberOfCards** | **Integer** | Number of loyalty cards in the batch. | **batchId** | **String** | ID of the loyalty card batch. | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the loyalty cards in the batch. | [optional] +**cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md index 906d484d..ea862b06 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -2,12 +2,12 @@ # LoyaltyProgram - +A Loyalty Program ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | The ID of loyalty program. Internal ID of this entity. | +**id** | **Integer** | The ID of loyalty program. | **created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **title** | **String** | The display title for the Loyalty Program. | **description** | **String** | Description of our Loyalty Program. | @@ -23,6 +23,7 @@ Name | Type | Description | Notes **tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated. 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** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**returnPolicy** | [**ReturnPolicyEnum**](#ReturnPolicyEnum) | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **accountID** | **Integer** | 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** | [**List<LoyaltyTier>**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] @@ -66,3 +67,12 @@ BALANCE_BASED | "balance_based" +## Enum: ReturnPolicyEnum + +Name | Value +---- | ----- +ONLY_PENDING | "only_pending" +WITHIN_BALANCE | "within_balance" + + + diff --git a/docs/LoyaltyTier.md b/docs/LoyaltyTier.md index a16a3aa7..910ccd35 100644 --- a/docs/LoyaltyTier.md +++ b/docs/LoyaltyTier.md @@ -2,7 +2,7 @@ # LoyaltyTier - +A tier in a loyalty program. ## Properties Name | Type | Description | Notes @@ -10,8 +10,8 @@ Name | Type | Description | Notes **id** | **Integer** | Internal ID of this entity. | **created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **programID** | **Integer** | The ID of the loyalty program that owns this entity. | -**name** | **String** | The name of the tier | -**minPoints** | [**BigDecimal**](BigDecimal.md) | The minimum amount of points required to be eligible for the tier. | +**name** | **String** | The name of the tier. | +**minPoints** | [**BigDecimal**](BigDecimal.md) | The minimum amount of points required to enter the tier. | diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index 69fe2e50..02c0d847 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -208,7 +208,7 @@ public class Example { //manager_auth.setApiKeyPrefix("Token"); ManagementApi apiInstance = new ManagementApi(defaultClient); - ActivateUserRequest body = new ActivateUserRequest(); // ActivateUserRequest | body + DeactivateUserRequest body = new DeactivateUserRequest(); // DeactivateUserRequest | body try { apiInstance.activateUserByEmail(body); } catch (ApiException e) { @@ -226,7 +226,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ActivateUserRequest**](ActivateUserRequest.md)| body | + **body** | **DeactivateUserRequest**| body | ### Return type @@ -2326,7 +2326,7 @@ public class Example { String batchId = "batchId_example"; // String | Filter results by batches of coupons String usable = "usable_example"; // String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code try { apiInstance.deleteCoupons(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch); @@ -2358,7 +2358,7 @@ Name | Type | Description | Notes **batchId** | **String**| Filter results by batches of coupons | [optional] **usable** | **String**| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | [optional] [enum: true, false] **referralId** | **Integer**| 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] **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false] ### Return type @@ -2722,7 +2722,7 @@ public class Example { //manager_auth.setApiKeyPrefix("Token"); ManagementApi apiInstance = new ManagementApi(defaultClient); - DeleteUserRequest body = new DeleteUserRequest(); // DeleteUserRequest | body + DeactivateUserRequest body = new DeactivateUserRequest(); // DeactivateUserRequest | body try { apiInstance.deleteUserByEmail(body); } catch (ApiException e) { @@ -2740,7 +2740,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body | + **body** | **DeactivateUserRequest**| body | ### Return type @@ -3313,7 +3313,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 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 ```java @@ -3344,7 +3344,7 @@ public class Example { ManagementApi apiInstance = new ManagementApi(defaultClient); Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. String 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. String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -3377,7 +3377,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaignId** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [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] **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional] **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -3389,7 +3389,7 @@ Name | Type | Description | Notes **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] **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] - **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired] + **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired, staged] **valuesOnly** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false] ### Return type @@ -3611,7 +3611,7 @@ public class Example { ManagementApi apiInstance = new ManagementApi(defaultClient); Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document. @@ -3634,7 +3634,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaignId** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [optional] **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] @@ -3981,7 +3981,7 @@ Name | Type | Description | Notes # **exportLoyaltyCards** -> String exportLoyaltyCards(loyaltyProgramId, batchId) +> String exportLoyaltyCards(loyaltyProgramId, batchId, dateFormat) Export loyalty cards @@ -4017,8 +4017,9 @@ public class Example { ManagementApi apiInstance = new ManagementApi(defaultClient); Integer loyaltyProgramId = 56; // Integer | 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. String batchId = "batchId_example"; // String | Filter results by loyalty card batch ID. + String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document. try { - String result = apiInstance.exportLoyaltyCards(loyaltyProgramId, batchId); + String result = apiInstance.exportLoyaltyCards(loyaltyProgramId, batchId, dateFormat); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ManagementApi#exportLoyaltyCards"); @@ -4037,6 +4038,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltyProgramId** | **Integer**| 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. | **batchId** | **String**| Filter results by loyalty card batch ID. | [optional] + **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] ### Return type @@ -4258,7 +4260,7 @@ public class Example { ManagementApi apiInstance = new ManagementApi(defaultClient); Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. String valid = "valid_example"; // String | - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. @@ -4284,7 +4286,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaignId** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [optional] **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **valid** | **String**| - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture] @@ -5736,7 +5738,7 @@ public class Example { OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. String coupon = "coupon_example"; // String | Filter by sessions with this coupon. Must be exact match. String referral = "referral_example"; // String | Filter by sessions with this referral. Must be exact match. - String integrationId = "integrationId_example"; // String | Filter by sessions with this integrationId. Must be exact match. + String integrationId = "integrationId_example"; // String | Filter by sessions with this integration ID. Must be exact match. String storeIntegrationId = "storeIntegrationId_example"; // String | The integration ID of the store. You choose this ID when you create a store. try { InlineResponse20027 result = apiInstance.getApplicationSessions(applicationId, pageSize, skip, sort, profile, state, createdBefore, createdAfter, coupon, referral, integrationId, storeIntegrationId); @@ -5766,7 +5768,7 @@ Name | Type | Description | Notes **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional] **referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional] - **integrationId** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional] + **integrationId** | **String**| Filter by sessions with this integration ID. Must be exact match. | [optional] **storeIntegrationId** | **String**| The integration ID of the store. You choose this ID when you create a store. | [optional] ### Return type @@ -6489,7 +6491,7 @@ Name | Type | Description | Notes **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000] **skip** | **Integer**| 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] - **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired] + **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired, staged] ### Return type @@ -6796,7 +6798,7 @@ public class Example { OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. Integer campaignGroupId = 56; // Integer | Filter results to campaigns owned by the specified campaign access group ID. - Integer templateId = 56; // Integer | The ID of the Campaign Template this Campaign was created from. + Integer templateId = 56; // Integer | The ID of the campaign template this campaign was created from. Integer storeId = 56; // Integer | Filter results to campaigns linked to the specified store ID. try { InlineResponse2006 result = apiInstance.getCampaigns(applicationId, pageSize, skip, sort, campaignState, name, tags, createdBefore, createdAfter, campaignGroupId, templateId, storeId); @@ -6820,13 +6822,13 @@ Name | Type | Description | Notes **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000] **skip** | **Integer**| 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] - **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired] + **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired, staged] **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional] **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** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **campaignGroupId** | **Integer**| Filter results to campaigns owned by the specified campaign access group ID. | [optional] - **templateId** | **Integer**| The ID of the Campaign Template this Campaign was created from. | [optional] + **templateId** | **Integer**| The ID of the campaign template this campaign was created from. | [optional] **storeId** | **Integer**| Filter results to campaigns linked to the specified store ID. | [optional] ### Return type @@ -7151,9 +7153,9 @@ public class Example { String 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`. String redeemed = "redeemed_example"; // String | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. String batchId = "batchId_example"; // String | Filter results by batches of coupons - Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code + Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code. OffsetDateTime expiresBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime expiresAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime startsBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -7189,9 +7191,9 @@ Name | Type | Description | Notes **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] [enum: true, false] **redeemed** | **String**| - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | [optional] [enum: true, false] **referralId** | **Integer**| 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] **expiresBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **expiresAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **startsBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -7343,10 +7345,10 @@ public class Example { Integer pageSize = 1000; // Integer | The number of items in the response. Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. String 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. - String name = "name_example"; // String | Only return reports matching the customer name + String name = "name_example"; // String | Only return reports matching the customer name. String integrationId = "integrationId_example"; // String | Filter results performing an exact matching against the profile integration identifier. - String campaignName = "campaignName_example"; // String | Only return reports matching the campaignName - String advocateName = "advocateName_example"; // String | Only return reports matching the current customer referrer name + String campaignName = "campaignName_example"; // String | Only return reports matching the campaign name. + String advocateName = "advocateName_example"; // String | Only return reports matching the current customer referrer name. try { InlineResponse20026 result = apiInstance.getCustomerActivityReportsWithoutTotalCount(rangeStart, rangeEnd, applicationId, pageSize, skip, sort, name, integrationId, campaignName, advocateName); System.out.println(result); @@ -7371,10 +7373,10 @@ Name | Type | Description | Notes **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000] **skip** | **Integer**| 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] - **name** | **String**| Only return reports matching the customer name | [optional] + **name** | **String**| Only return reports matching the customer name. | [optional] **integrationId** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional] - **campaignName** | **String**| Only return reports matching the campaignName | [optional] - **advocateName** | **String**| Only return reports matching the current customer referrer name | [optional] + **campaignName** | **String**| Only return reports matching the campaign name. | [optional] + **advocateName** | **String**| Only return reports matching the current customer referrer name. | [optional] ### Return type @@ -7677,7 +7679,7 @@ public class Example { ManagementApi apiInstance = new ManagementApi(defaultClient); Integer pageSize = 1000; // Integer | The number of items in the response. Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. - Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or Live customer. + Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or live customer. try { InlineResponse20025 result = apiInstance.getCustomerProfiles(pageSize, skip, sandbox); System.out.println(result); @@ -7698,7 +7700,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000] **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional] - **sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to false] + **sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to false] ### Return type @@ -7757,7 +7759,7 @@ public class Example { CustomerProfileSearchQuery body = new CustomerProfileSearchQuery(); // CustomerProfileSearchQuery | body Integer pageSize = 1000; // Integer | The number of items in the response. Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. - Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or Live customer. + Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or live customer. try { InlineResponse20024 result = apiInstance.getCustomersByAttributes(body, pageSize, skip, sandbox); System.out.println(result); @@ -7779,7 +7781,7 @@ Name | Type | Description | Notes **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body | **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000] **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional] - **sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to false] + **sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to false] ### Return type @@ -8657,7 +8659,7 @@ public class Example { OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. String valid = "valid_example"; // String | 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. String usable = "usable_example"; // String | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. - String advocate = "advocate_example"; // String | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field + String advocate = "advocate_example"; // String | Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. try { InlineResponse20010 result = apiInstance.getReferralsWithoutTotalCount(applicationId, campaignId, pageSize, skip, sort, code, createdBefore, createdAfter, valid, usable, advocate); System.out.println(result); @@ -8686,7 +8688,7 @@ Name | Type | Description | Notes **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **valid** | **String**| 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. | [optional] [enum: expired, validNow, validFuture] **usable** | **String**| Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | [optional] [enum: true, false] - **advocate** | **String**| Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | [optional] + **advocate** | **String**| Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. | [optional] ### Return type @@ -9290,9 +9292,9 @@ public class Example { Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. String 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. String integrationRequestUuid = "integrationRequestUuid_example"; // String | Filter results by integration request UUID. - BigDecimal webhookId = new BigDecimal(); // BigDecimal | Filter results by Webhook. + BigDecimal webhookId = new BigDecimal(); // BigDecimal | Filter results by webhook id. BigDecimal applicationId = new BigDecimal(); // BigDecimal | Filter results by Application ID. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. try { @@ -9317,9 +9319,9 @@ Name | Type | Description | Notes **skip** | **Integer**| 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] **integrationRequestUuid** | **String**| Filter results by integration request UUID. | [optional] - **webhookId** | **BigDecimal**| Filter results by Webhook. | [optional] + **webhookId** | **BigDecimal**| Filter results by webhook id. | [optional] **applicationId** | **BigDecimal**| Filter results by Application ID. | [optional] - **campaignId** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [optional] **createdBefore** | **OffsetDateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -9381,9 +9383,9 @@ public class Example { Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. String 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. String status = "status_example"; // String | Filter results by HTTP status codes. - BigDecimal webhookId = new BigDecimal(); // BigDecimal | Filter results by Webhook. + BigDecimal webhookId = new BigDecimal(); // BigDecimal | Filter results by webhook id. BigDecimal applicationId = new BigDecimal(); // BigDecimal | Filter results by Application ID. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. String requestUuid = "requestUuid_example"; // String | Filter results by request UUID. OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -9409,9 +9411,9 @@ Name | Type | Description | Notes **skip** | **Integer**| 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] **status** | **String**| Filter results by HTTP status codes. | [optional] [enum: success, error] - **webhookId** | **BigDecimal**| Filter results by Webhook. | [optional] + **webhookId** | **BigDecimal**| Filter results by webhook id. | [optional] **applicationId** | **BigDecimal**| Filter results by Application ID. | [optional] - **campaignId** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [optional] **requestUuid** | **String**| Filter results by request UUID. | [optional] **createdBefore** | **OffsetDateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **createdAfter** | **OffsetDateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -11013,7 +11015,7 @@ public class Example { Integer skip = 56; // Integer | The number of items to skip when paging through large result sets. String 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. Boolean 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. - BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign. + BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign ID. String name = "name_example"; // String | The name of the store. String integrationId = "integrationId_example"; // String | The integration ID of the store. String query = "query_example"; // String | Filter results by `name` or `integrationId`. @@ -11040,7 +11042,7 @@ Name | Type | Description | Notes **skip** | **Integer**| 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** | **BigDecimal**| Filter results by campaign. | [optional] + **campaignId** | **BigDecimal**| Filter results by campaign ID. | [optional] **name** | **String**| The name of the store. | [optional] **integrationId** | **String**| The integration ID of the store. | [optional] **query** | **String**| Filter results by `name` or `integrationId`. | [optional] @@ -12314,9 +12316,9 @@ public class Example { String 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. String 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`. Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. String batchId = "batchId_example"; // String | Filter results by batches of coupons - Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code + Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code. String 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. try { InlineResponse2009 result = apiInstance.searchCouponsAdvancedApplicationWideWithoutTotalCount(applicationId, body, pageSize, skip, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, batchId, exactMatch, campaignState); @@ -12347,10 +12349,10 @@ 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] [enum: expired, validNow, validFuture] **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] [enum: true, false] **referralId** | **Integer**| 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] - **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired] + **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false] + **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. | [optional] [enum: enabled, disabled, archived, scheduled, running, expired, staged] ### Return type @@ -12418,8 +12420,8 @@ public class Example { String 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. String 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`. Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field - Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code + String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. + Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code. String batchId = "batchId_example"; // String | Filter results by batches of coupons try { InlineResponse2009 result = apiInstance.searchCouponsAdvancedWithoutTotalCount(applicationId, campaignId, body, pageSize, skip, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, exactMatch, batchId); @@ -12451,8 +12453,8 @@ 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] [enum: expired, validNow, validFuture] **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] [enum: true, false] **referralId** | **Integer**| 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] - **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false] + **recipientIntegrationId** | **String**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional] + **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false] **batchId** | **String**| Filter results by batches of coupons | [optional] ### Return type diff --git a/docs/ManagementKey.md b/docs/ManagementKey.md index 5599a296..aee8cd6c 100644 --- a/docs/ManagementKey.md +++ b/docs/ManagementKey.md @@ -2,7 +2,6 @@ # ManagementKey - ## Properties Name | Type | Description | Notes diff --git a/docs/MessageLogEntry.md b/docs/MessageLogEntry.md index a2279e02..d237317e 100644 --- a/docs/MessageLogEntry.md +++ b/docs/MessageLogEntry.md @@ -12,12 +12,16 @@ Name | Type | Description | Notes **changeType** | **String** | Type of change that triggered the notification. | [optional] **notificationId** | **Integer** | ID of the notification. | [optional] **notificationName** | **String** | The name of the notification. | [optional] +**webhookId** | **Integer** | ID of the webhook. | [optional] +**webhookName** | **String** | The name of the webhook. | [optional] **request** | [**MessageLogRequest**](MessageLogRequest.md) | | [optional] **response** | [**MessageLogResponse**](MessageLogResponse.md) | | [optional] **createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the log entry was created. | -**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | The entity type the notification is related to. | [optional] +**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | The entity type the log is related to. | +**url** | **String** | The target URL of the request. | [optional] **applicationId** | **Integer** | Identifier of the Application. | [optional] **loyaltyProgramId** | **Integer** | Identifier of the loyalty program. | [optional] +**campaignId** | **Integer** | Identifier of the campaign. | [optional] @@ -27,6 +31,7 @@ Name | Value ---- | ----- APPLICATION | "application" LOYALTY_PROGRAM | "loyalty_program" +WEBHOOK | "webhook" diff --git a/docs/ModelImport.md b/docs/ModelImport.md index fa99acb7..e316234b 100644 --- a/docs/ModelImport.md +++ b/docs/ModelImport.md @@ -2,7 +2,6 @@ # ModelImport - ## Properties Name | Type | Description | Notes diff --git a/docs/ModelReturn.md b/docs/ModelReturn.md index 3e4a9cd6..38e72a2b 100644 --- a/docs/ModelReturn.md +++ b/docs/ModelReturn.md @@ -2,7 +2,6 @@ # ModelReturn - ## Properties Name | Type | Description | Notes diff --git a/docs/MultipleAudiencesItem.md b/docs/MultipleAudiencesItem.md index c08e7d37..c5b4366a 100644 --- a/docs/MultipleAudiencesItem.md +++ b/docs/MultipleAudiencesItem.md @@ -2,7 +2,6 @@ # MultipleAudiencesItem - ## Properties Name | Type | Description | Notes diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md index b6dbc6cc..a6a32c18 100644 --- a/docs/MultipleCustomerProfileIntegrationRequestItem.md +++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md @@ -2,7 +2,7 @@ # MultipleCustomerProfileIntegrationRequestItem - +The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. ## Properties Name | Type | Description | Notes diff --git a/docs/NewAccountSignUp.md b/docs/NewAccountSignUp.md index 0164cbda..2b33e083 100644 --- a/docs/NewAccountSignUp.md +++ b/docs/NewAccountSignUp.md @@ -2,7 +2,6 @@ # NewAccountSignUp - ## Properties Name | Type | Description | Notes diff --git a/docs/NewAdditionalCost.md b/docs/NewAdditionalCost.md index d7265429..c0d41330 100644 --- a/docs/NewAdditionalCost.md +++ b/docs/NewAdditionalCost.md @@ -2,7 +2,6 @@ # NewAdditionalCost - ## Properties Name | Type | Description | Notes diff --git a/docs/NewApplicationAPIKey.md b/docs/NewApplicationAPIKey.md index 561bebaf..b36b97de 100644 --- a/docs/NewApplicationAPIKey.md +++ b/docs/NewApplicationAPIKey.md @@ -2,7 +2,6 @@ # NewApplicationAPIKey - ## Properties Name | Type | Description | Notes diff --git a/docs/NewAttribute.md b/docs/NewAttribute.md index 12ba99b2..62dfb616 100644 --- a/docs/NewAttribute.md +++ b/docs/NewAttribute.md @@ -2,7 +2,6 @@ # NewAttribute - ## Properties Name | Type | Description | Notes diff --git a/docs/NewAudience.md b/docs/NewAudience.md index 2c67cb61..059644c2 100644 --- a/docs/NewAudience.md +++ b/docs/NewAudience.md @@ -2,7 +2,6 @@ # NewAudience - ## Properties Name | Type | Description | Notes diff --git a/docs/NewBaseNotification.md b/docs/NewBaseNotification.md index 36bb5e9f..39c6ec8c 100644 --- a/docs/NewBaseNotification.md +++ b/docs/NewBaseNotification.md @@ -2,7 +2,6 @@ # NewBaseNotification - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md index bbe30a93..5b727c5d 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -2,7 +2,6 @@ # NewCampaign - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCampaignCollection.md b/docs/NewCampaignCollection.md index 561e67cf..5188b472 100644 --- a/docs/NewCampaignCollection.md +++ b/docs/NewCampaignCollection.md @@ -2,7 +2,6 @@ # NewCampaignCollection - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCampaignSet.md b/docs/NewCampaignSet.md index e4db93c6..5b50750f 100644 --- a/docs/NewCampaignSet.md +++ b/docs/NewCampaignSet.md @@ -2,7 +2,6 @@ # NewCampaignSet - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCampaignStoreBudget.md b/docs/NewCampaignStoreBudget.md new file mode 100644 index 00000000..8897d851 --- /dev/null +++ b/docs/NewCampaignStoreBudget.md @@ -0,0 +1,33 @@ + + +# NewCampaignStoreBudget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**ActionEnum**](#ActionEnum) | | +**storeLimits** | [**List<NewCampaignStoreBudgetStoreLimit>**](NewCampaignStoreBudgetStoreLimit.md) | The set of budget limits for stores linked to the campaign. | +**period** | [**PeriodEnum**](#PeriodEnum) | | [optional] + + + +## Enum: ActionEnum + +Name | Value +---- | ----- +SETDISCOUNT | "setDiscount" + + + +## Enum: PeriodEnum + +Name | Value +---- | ----- +DAILY | "daily" +WEEKLY | "weekly" +MONTHLY | "monthly" +YEARLY | "yearly" + + + diff --git a/docs/NewCampaignStoreBudgetStoreLimit.md b/docs/NewCampaignStoreBudgetStoreLimit.md new file mode 100644 index 00000000..a0730b27 --- /dev/null +++ b/docs/NewCampaignStoreBudgetStoreLimit.md @@ -0,0 +1,13 @@ + + +# NewCampaignStoreBudgetStoreLimit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**storeId** | **Integer** | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. | +**limit** | [**BigDecimal**](BigDecimal.md) | The value to set for the limit. | + + + diff --git a/docs/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md index 763fa515..6df18fae 100644 --- a/docs/NewCampaignTemplate.md +++ b/docs/NewCampaignTemplate.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **tags** | **List<String>** | A list of tags for the campaign template. | [optional] **features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign template. | [optional] **couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**couponReservationSettings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**List<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional] **templateParams** | [**List<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/NewCatalog.md b/docs/NewCatalog.md index 7852f717..7eca3499 100644 --- a/docs/NewCatalog.md +++ b/docs/NewCatalog.md @@ -2,7 +2,6 @@ # NewCatalog - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCollection.md b/docs/NewCollection.md index 879d642d..5b503b99 100644 --- a/docs/NewCollection.md +++ b/docs/NewCollection.md @@ -2,7 +2,6 @@ # NewCollection - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index 2786c78c..b9802385 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -2,7 +2,6 @@ # NewCouponCreationJob - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index 7714956a..d6a69d2d 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -2,7 +2,6 @@ # NewCoupons - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index 278bcde2..3434ce93 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -2,7 +2,6 @@ # NewCouponsForMultipleRecipients - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCustomEffect.md b/docs/NewCustomEffect.md index 6df05a66..649cb13d 100644 --- a/docs/NewCustomEffect.md +++ b/docs/NewCustomEffect.md @@ -2,7 +2,6 @@ # NewCustomEffect - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index c3ab392d..0e000914 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -2,7 +2,6 @@ # NewCustomerSession - ## Properties Name | Type | Description | Notes diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md index 3232b431..b162bb3c 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **state** | [**StateEnum**](#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). | [optional] **cartItems** | [**List<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** | [**Map<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** | **List<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] +**identifiers** | **List<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). - We recommend passing an anonymized (hashed) version of the identifier value. | [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 fd353649..daa4173c 100644 --- a/docs/NewEvent.md +++ b/docs/NewEvent.md @@ -2,7 +2,6 @@ # NewEvent - ## Properties Name | Type | Description | Notes diff --git a/docs/NewEventType.md b/docs/NewEventType.md index 4267ddc7..ab73be59 100644 --- a/docs/NewEventType.md +++ b/docs/NewEventType.md @@ -2,7 +2,6 @@ # NewEventType - ## Properties Name | Type | Description | Notes diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index a9d4ce51..662c52e4 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -2,7 +2,7 @@ # NewLoyaltyProgram - +A new loyalty program ## Properties Name | Type | Description | Notes @@ -21,6 +21,7 @@ Name | Type | Description | Notes **tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated. 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** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**returnPolicy** | [**ReturnPolicyEnum**](#ReturnPolicyEnum) | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | **tiers** | [**List<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] **timezone** | **String** | A string containing an IANA timezone descriptor. | @@ -58,3 +59,12 @@ BALANCE_BASED | "balance_based" +## Enum: ReturnPolicyEnum + +Name | Value +---- | ----- +ONLY_PENDING | "only_pending" +WITHIN_BALANCE | "within_balance" + + + diff --git a/docs/NewLoyaltyTier.md b/docs/NewLoyaltyTier.md index f04098de..e8580d89 100644 --- a/docs/NewLoyaltyTier.md +++ b/docs/NewLoyaltyTier.md @@ -7,8 +7,8 @@ A tier in a loyalty program. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The name of the tier | -**minPoints** | [**BigDecimal**](BigDecimal.md) | The minimum amount of points required to be eligible for the tier. | +**name** | **String** | The name of the tier. | +**minPoints** | [**BigDecimal**](BigDecimal.md) | The minimum amount of points required to enter the tier. | diff --git a/docs/NewManagementKey.md b/docs/NewManagementKey.md index 71e8f4f6..01ac5a61 100644 --- a/docs/NewManagementKey.md +++ b/docs/NewManagementKey.md @@ -2,7 +2,6 @@ # NewManagementKey - ## Properties Name | Type | Description | Notes diff --git a/docs/NewMultipleAudiencesItem.md b/docs/NewMultipleAudiencesItem.md index 3e26401d..2906b597 100644 --- a/docs/NewMultipleAudiencesItem.md +++ b/docs/NewMultipleAudiencesItem.md @@ -2,7 +2,6 @@ # NewMultipleAudiencesItem - ## Properties Name | Type | Description | Notes diff --git a/docs/NewReferral.md b/docs/NewReferral.md index 1f1ab305..89539a34 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -2,7 +2,6 @@ # NewReferral - ## Properties Name | Type | Description | Notes diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index f1b85d42..f81457bf 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -2,7 +2,6 @@ # NewReferralsForMultipleAdvocates - ## Properties Name | Type | Description | Notes diff --git a/docs/NewRole.md b/docs/NewRole.md index fa5f7b0f..18efda13 100644 --- a/docs/NewRole.md +++ b/docs/NewRole.md @@ -2,7 +2,6 @@ # NewRole - ## Properties Name | Type | Description | Notes diff --git a/docs/NewRoleV2.md b/docs/NewRoleV2.md index b2351704..0b14d352 100644 --- a/docs/NewRoleV2.md +++ b/docs/NewRoleV2.md @@ -2,7 +2,6 @@ # NewRoleV2 - ## Properties Name | Type | Description | Notes diff --git a/docs/NewSamlConnection.md b/docs/NewSamlConnection.md index 0e7b7042..fc26b121 100644 --- a/docs/NewSamlConnection.md +++ b/docs/NewSamlConnection.md @@ -2,7 +2,7 @@ # NewSamlConnection - +A new SAML 2.0 connection. ## Properties Name | Type | Description | Notes diff --git a/docs/NewStore.md b/docs/NewStore.md index 13fd2b77..85750b9a 100644 --- a/docs/NewStore.md +++ b/docs/NewStore.md @@ -2,7 +2,6 @@ # NewStore - ## Properties Name | Type | Description | Notes diff --git a/docs/NewUser.md b/docs/NewUser.md index 89f9eacc..8fcce27c 100644 --- a/docs/NewUser.md +++ b/docs/NewUser.md @@ -2,7 +2,6 @@ # NewUser - ## Properties Name | Type | Description | Notes diff --git a/docs/NewWebhook.md b/docs/NewWebhook.md index 72d93f71..48ca5aa2 100644 --- a/docs/NewWebhook.md +++ b/docs/NewWebhook.md @@ -2,7 +2,6 @@ # NewWebhook - ## Properties Name | Type | Description | Notes diff --git a/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md b/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md index 1891f60a..e938523d 100644 --- a/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +++ b/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md @@ -2,7 +2,6 @@ # OutgoingIntegrationTemplateWithConfigurationDetails - ## Properties Name | Type | Description | Notes diff --git a/docs/Picklist.md b/docs/Picklist.md index a045b744..15ea9dbc 100644 --- a/docs/Picklist.md +++ b/docs/Picklist.md @@ -2,7 +2,6 @@ # Picklist - ## Properties Name | Type | Description | Notes diff --git a/docs/Referral.md b/docs/Referral.md index 7eae5458..37b7b891 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -2,7 +2,6 @@ # Referral - ## Properties Name | Type | Description | Notes diff --git a/docs/Revision.md b/docs/Revision.md index 04de5055..c0c9b496 100644 --- a/docs/Revision.md +++ b/docs/Revision.md @@ -2,7 +2,6 @@ # Revision - ## Properties Name | Type | Description | Notes diff --git a/docs/RevisionVersion.md b/docs/RevisionVersion.md index 7b1f95fe..d4f0d085 100644 --- a/docs/RevisionVersion.md +++ b/docs/RevisionVersion.md @@ -2,7 +2,6 @@ # RevisionVersion - ## Properties Name | Type | Description | Notes diff --git a/docs/Role.md b/docs/Role.md index d279055b..cd357581 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -2,7 +2,6 @@ # Role - ## Properties Name | Type | Description | Notes diff --git a/docs/RoleAssign.md b/docs/RoleAssign.md index bfd7f232..a91a102a 100644 --- a/docs/RoleAssign.md +++ b/docs/RoleAssign.md @@ -2,7 +2,6 @@ # RoleAssign - ## Properties Name | Type | Description | Notes diff --git a/docs/RoleV2.md b/docs/RoleV2.md index bfcd0b68..6ef2bfae 100644 --- a/docs/RoleV2.md +++ b/docs/RoleV2.md @@ -2,7 +2,6 @@ # RoleV2 - ## Properties Name | Type | Description | Notes diff --git a/docs/Ruleset.md b/docs/Ruleset.md index fc7c2b1f..9c2e2240 100644 --- a/docs/Ruleset.md +++ b/docs/Ruleset.md @@ -2,7 +2,6 @@ # Ruleset - ## Properties Name | Type | Description | Notes diff --git a/docs/SamlConnection.md b/docs/SamlConnection.md index 5acf3cc3..7f81a5ba 100644 --- a/docs/SamlConnection.md +++ b/docs/SamlConnection.md @@ -2,7 +2,7 @@ # SamlConnection - +A SAML 2.0 connection. ## Properties Name | Type | Description | Notes diff --git a/docs/ScimNewUser.md b/docs/ScimNewUser.md index 44bfdf27..3f4208f1 100644 --- a/docs/ScimNewUser.md +++ b/docs/ScimNewUser.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **active** | **Boolean** | Status of the user. | [optional] **displayName** | **String** | Display name of the user. | [optional] -**userName** | **String** | Unique identifier of the user. This is usually an email address. | [optional] +**userName** | **String** | Unique identifier of the user. This is usually an email address. | **name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional] diff --git a/docs/ScimServiceProviderConfigResponse.md b/docs/ScimServiceProviderConfigResponse.md index a5ec1d8a..54a0a6f3 100644 --- a/docs/ScimServiceProviderConfigResponse.md +++ b/docs/ScimServiceProviderConfigResponse.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **filter** | [**ScimServiceProviderConfigResponseFilter**](ScimServiceProviderConfigResponseFilter.md) | | [optional] **patch** | [**ScimServiceProviderConfigResponsePatch**](ScimServiceProviderConfigResponsePatch.md) | | [optional] **schemas** | **List<String>** | A list of SCIM schemas that define the structure and data types supported by the service provider. | [optional] +**sort** | [**ScimServiceProviderConfigResponseSort**](ScimServiceProviderConfigResponseSort.md) | | [optional] diff --git a/docs/ScimServiceProviderConfigResponseSort.md b/docs/ScimServiceProviderConfigResponseSort.md new file mode 100644 index 00000000..5957856b --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseSort.md @@ -0,0 +1,13 @@ + + +# ScimServiceProviderConfigResponseSort + +Configuration settings related to sorting SCIM resources in query responses. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**supported** | **Boolean** | Indicates whether the service provider supports sorting operations for ordered query results. | [optional] + + + diff --git a/docs/ScimUser.md b/docs/ScimUser.md index 58ba527e..1f7e4dc0 100644 --- a/docs/ScimUser.md +++ b/docs/ScimUser.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **active** | **Boolean** | Status of the user. | [optional] **displayName** | **String** | Display name of the user. | [optional] -**userName** | **String** | Unique identifier of the user. This is usually an email address. | [optional] +**userName** | **String** | Unique identifier of the user. This is usually an email address. | **name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional] **id** | **String** | ID of the user. | diff --git a/docs/Store.md b/docs/Store.md index 5cddd021..477670c6 100644 --- a/docs/Store.md +++ b/docs/Store.md @@ -2,13 +2,12 @@ # Store - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Internal ID of this entity. | -**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. The time this entity was created. | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | 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] diff --git a/docs/SummaryCampaignStoreBudget.md b/docs/SummaryCampaignStoreBudget.md new file mode 100644 index 00000000..21c80920 --- /dev/null +++ b/docs/SummaryCampaignStoreBudget.md @@ -0,0 +1,48 @@ + + +# SummaryCampaignStoreBudget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**ActionEnum**](#ActionEnum) | | +**period** | [**PeriodEnum**](#PeriodEnum) | | [optional] +**storeCount** | **Integer** | | + + + +## Enum: ActionEnum + +Name | Value +---- | ----- +REDEEMCOUPON | "redeemCoupon" +REDEEMREFERRAL | "redeemReferral" +SETDISCOUNT | "setDiscount" +SETDISCOUNTEFFECT | "setDiscountEffect" +CREATECOUPON | "createCoupon" +CREATEREFERRAL | "createReferral" +CREATELOYALTYPOINTS | "createLoyaltyPoints" +REDEEMLOYALTYPOINTS | "redeemLoyaltyPoints" +CUSTOMEFFECT | "customEffect" +CREATELOYALTYPOINTSEFFECT | "createLoyaltyPointsEffect" +REDEEMLOYALTYPOINTSEFFECT | "redeemLoyaltyPointsEffect" +CALLAPI | "callApi" +AWARDGIVEAWAY | "awardGiveaway" +ADDFREEITEMEFFECT | "addFreeItemEffect" +RESERVECOUPON | "reserveCoupon" + + + +## Enum: PeriodEnum + +Name | Value +---- | ----- +OVERALL | "overall" +DAILY | "daily" +WEEKLY | "weekly" +MONTHLY | "monthly" +YEARLY | "yearly" + + + diff --git a/docs/TalangAttribute.md b/docs/TalangAttribute.md index 9135ab0c..f39315e0 100644 --- a/docs/TalangAttribute.md +++ b/docs/TalangAttribute.md @@ -2,7 +2,6 @@ # TalangAttribute - ## Properties Name | Type | Description | Notes diff --git a/docs/TemplateArgDef.md b/docs/TemplateArgDef.md index cda5288d..4dce5cbc 100644 --- a/docs/TemplateArgDef.md +++ b/docs/TemplateArgDef.md @@ -2,7 +2,6 @@ # TemplateArgDef - ## Properties Name | Type | Description | Notes diff --git a/docs/TemplateDef.md b/docs/TemplateDef.md index 36a07ab3..679a749e 100644 --- a/docs/TemplateDef.md +++ b/docs/TemplateDef.md @@ -2,7 +2,6 @@ # TemplateDef - ## Properties Name | Type | Description | Notes diff --git a/docs/TemplateLimitConfig.md b/docs/TemplateLimitConfig.md index a2bdd084..7bcc3210 100644 --- a/docs/TemplateLimitConfig.md +++ b/docs/TemplateLimitConfig.md @@ -2,7 +2,6 @@ # TemplateLimitConfig - ## Properties Name | Type | Description | Notes @@ -33,6 +32,7 @@ COUPON | "Coupon" REFERRAL | "Referral" PROFILE | "Profile" IDENTIFIER | "Identifier" +STORE | "Store" diff --git a/docs/UpdateAchievement.md b/docs/UpdateAchievement.md index a4f88953..6c7d7f1f 100644 --- a/docs/UpdateAchievement.md +++ b/docs/UpdateAchievement.md @@ -12,6 +12,28 @@ Name | Type | Description | Notes **target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional] **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. | [optional] **periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] + + + +## Enum: RecurrencePolicyEnum + +Name | Value +---- | ----- +NO_RECURRENCE | "no_recurrence" +ON_EXPIRATION | "on_expiration" + + + +## Enum: ActivationPolicyEnum + +Name | Value +---- | ----- +USER_ACTION | "user_action" +FIXED_SCHEDULE | "fixed_schedule" diff --git a/docs/UpdateCampaignEvaluationGroup.md b/docs/UpdateCampaignEvaluationGroup.md index 0b6e3bbd..0408d666 100644 --- a/docs/UpdateCampaignEvaluationGroup.md +++ b/docs/UpdateCampaignEvaluationGroup.md @@ -2,7 +2,6 @@ # UpdateCampaignEvaluationGroup - ## Properties Name | Type | Description | Notes diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md index da80f1e2..f1d2b0ad 100644 --- a/docs/UpdateCampaignGroup.md +++ b/docs/UpdateCampaignGroup.md @@ -2,7 +2,6 @@ # UpdateCampaignGroup - ## Properties Name | Type | Description | Notes diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md index 29628490..08dcd55f 100644 --- a/docs/UpdateCampaignTemplate.md +++ b/docs/UpdateCampaignTemplate.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **tags** | **List<String>** | A list of tags for the campaign template. | [optional] **features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign template. | [optional] **couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**couponReservationSettings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**List<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] **templateParams** | [**List<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index 45f55467..301154ae 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -2,7 +2,6 @@ # UpdateCoupon - ## Properties Name | Type | Description | Notes diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 6ede7fc6..5a8078ae 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -2,7 +2,6 @@ # UpdateCouponBatch - ## Properties Name | Type | Description | Notes diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 009e91bd..567f9786 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -2,7 +2,7 @@ # UpdateLoyaltyProgram - +An updated loyalty program. ## Properties Name | Type | Description | Notes @@ -21,6 +21,7 @@ Name | Type | Description | Notes **tiersExpireIn** | **String** | The amount of time after which the tier expires and is reevaluated. 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** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **cardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**returnPolicy** | [**ReturnPolicyEnum**](#ReturnPolicyEnum) | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **tiers** | [**List<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] @@ -55,3 +56,12 @@ BALANCE_BASED | "balance_based" +## Enum: ReturnPolicyEnum + +Name | Value +---- | ----- +ONLY_PENDING | "only_pending" +WITHIN_BALANCE | "within_balance" + + + diff --git a/docs/UpdateLoyaltyProgramTier.md b/docs/UpdateLoyaltyProgramTier.md new file mode 100644 index 00000000..2e1bb290 --- /dev/null +++ b/docs/UpdateLoyaltyProgramTier.md @@ -0,0 +1,15 @@ + + +# UpdateLoyaltyProgramTier + +Update a tier in a specified loyalty program. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Integer** | The internal ID of the tier. | +**name** | **String** | The name of the tier. | [optional] +**minPoints** | [**BigDecimal**](BigDecimal.md) | The minimum amount of points required to enter the tier. | [optional] + + + diff --git a/docs/UpdatePicklist.md b/docs/UpdatePicklist.md index 27dfe554..ddd601f9 100644 --- a/docs/UpdatePicklist.md +++ b/docs/UpdatePicklist.md @@ -2,7 +2,6 @@ # UpdatePicklist - ## Properties Name | Type | Description | Notes diff --git a/docs/User.md b/docs/User.md index 57e943e2..a91c6b7a 100644 --- a/docs/User.md +++ b/docs/User.md @@ -2,7 +2,6 @@ # User - ## Properties Name | Type | Description | Notes diff --git a/docs/Webhook.md b/docs/Webhook.md index ebce19b2..34392eeb 100644 --- a/docs/Webhook.md +++ b/docs/Webhook.md @@ -2,7 +2,6 @@ # Webhook - ## Properties Name | Type | Description | Notes @@ -10,7 +9,7 @@ Name | Type | Description | Notes **id** | **Integer** | Internal ID of this entity. | **created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. | -**applicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | +**applicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. | **title** | **String** | Name or title for this webhook. | **description** | **String** | A description of the webhook. | [optional] **verb** | [**VerbEnum**](#VerbEnum) | API method for this webhook. | diff --git a/docs/WebhookLogEntry.md b/docs/WebhookLogEntry.md index d9decd30..bac9be49 100644 --- a/docs/WebhookLogEntry.md +++ b/docs/WebhookLogEntry.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **integrationRequestUuid** | **String** | UUID reference of the integration request linked to this webhook request. | **webhookId** | **Integer** | ID of the webhook that triggered the request. | **applicationId** | **Integer** | ID of the application that triggered the webhook. | [optional] -**url** | **String** | Target url of request | +**url** | **String** | The target URL of the request. | **request** | **String** | Request message | **response** | **String** | Response message | [optional] **status** | **Integer** | HTTP status code of response. | [optional] diff --git a/docs/WebhookWithOutgoingIntegrationDetails.md b/docs/WebhookWithOutgoingIntegrationDetails.md index cf27133e..f003d85b 100644 --- a/docs/WebhookWithOutgoingIntegrationDetails.md +++ b/docs/WebhookWithOutgoingIntegrationDetails.md @@ -2,7 +2,6 @@ # WebhookWithOutgoingIntegrationDetails - ## Properties Name | Type | Description | Notes @@ -10,7 +9,7 @@ Name | Type | Description | Notes **id** | **Integer** | Internal ID of this entity. | **created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | **modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. | -**applicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | +**applicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. | **title** | **String** | Name or title for this webhook. | **description** | **String** | A description of the webhook. | [optional] **verb** | [**VerbEnum**](#VerbEnum) | API method for this webhook. | diff --git a/pom.xml b/pom.xml index 13f3f61b..971b0664 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ talon-one-client jar talon-one-client - 9.0.2 + 9.1.0 https://github.com/talon-one/maven-artefacts Talon.One unified JAVA SDK. It allows for programmatic access to the integration and management API with their respective authentication strategies diff --git a/src/main/java/one/talon/ApiClient.java b/src/main/java/one/talon/ApiClient.java index daff7bd1..da99c534 100644 --- a/src/main/java/one/talon/ApiClient.java +++ b/src/main/java/one/talon/ApiClient.java @@ -132,7 +132,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/9.0.2/java"); + setUserAgent("OpenAPI-Generator/9.1.0/java"); authentications = new HashMap(); } diff --git a/src/main/java/one/talon/api/IntegrationApi.java b/src/main/java/one/talon/api/IntegrationApi.java index 9013b192..69d00118 100644 --- a/src/main/java/one/talon/api/IntegrationApi.java +++ b/src/main/java/one/talon/api/IntegrationApi.java @@ -1014,7 +1014,7 @@ private okhttp3.Call deleteCustomerDataValidateBeforeCall(String integrationId, /** * Delete customer's personal data - * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. + * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1031,7 +1031,7 @@ public void deleteCustomerData(String integrationId) throws ApiException { /** * Delete customer's personal data - * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. + * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1050,7 +1050,7 @@ public ApiResponse deleteCustomerDataWithHttpInfo(String integrationId) th /** * Delete customer's personal data (asynchronously) - * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. + * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1490,7 +1490,7 @@ public okhttp3.Call getCustomerSessionAsync(String customerSessionId, final ApiC * @param 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) * @param subledgerId The ID of the subledger by which we filter the data. (optional) * @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false) - * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) + * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1570,14 +1570,14 @@ private okhttp3.Call getLoyaltyBalancesValidateBeforeCall(Integer loyaltyProgram } /** - * 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 and subledger ID. **Note**: 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. 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) + * Get customer's loyalty balances + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. 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 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. (required) * @param 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. (required) * @param 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) * @param subledgerId The ID of the subledger by which we filter the data. (optional) * @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false) - * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) + * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) * @return LoyaltyBalancesWithTiers * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1595,14 +1595,14 @@ public LoyaltyBalancesWithTiers getLoyaltyBalances(Integer loyaltyProgramId, Str } /** - * 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 and subledger ID. **Note**: 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. 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) + * Get customer's loyalty balances + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. 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 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. (required) * @param 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. (required) * @param 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) * @param subledgerId The ID of the subledger by which we filter the data. (optional) * @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false) - * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) + * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) * @return ApiResponse<LoyaltyBalancesWithTiers> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1621,14 +1621,14 @@ public ApiResponse getLoyaltyBalancesWithHttpInfo(Inte } /** - * Get customer's loyalty points (asynchronously) - * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. 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) + * Get customer's loyalty balances (asynchronously) + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. 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 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. (required) * @param 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. (required) * @param 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. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) * @param subledgerId The ID of the subledger by which we filter the data. (optional) * @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false) - * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) + * @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1681,7 +1681,7 @@ public okhttp3.Call getLoyaltyCardBalancesCall(Integer loyaltyProgramId, String } if (subledgerId != null) { - localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "subledgerId", subledgerId)); + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "subledgerId", subledgerId)); } Map localVarHeaderParams = new HashMap(); @@ -1832,7 +1832,7 @@ public okhttp3.Call getLoyaltyCardPointsCall(Integer loyaltyProgramId, String lo } if (subledgerId != null) { - localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "subledgerId", subledgerId)); + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "subledgerId", subledgerId)); } if (pageSize != null) { @@ -1995,7 +1995,7 @@ public okhttp3.Call getLoyaltyCardTransactionsCall(Integer loyaltyProgramId, Str List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (subledgerId != null) { - localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "subledgerId", subledgerId)); + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "subledgerId", subledgerId)); } if (loyaltyTransactionType != null) { diff --git a/src/main/java/one/talon/api/ManagementApi.java b/src/main/java/one/talon/api/ManagementApi.java index 31c5bb30..d922040d 100644 --- a/src/main/java/one/talon/api/ManagementApi.java +++ b/src/main/java/one/talon/api/ManagementApi.java @@ -31,7 +31,6 @@ import one.talon.model.AccountAdditionalCost; import one.talon.model.AccountAnalytics; import one.talon.model.Achievement; -import one.talon.model.ActivateUserRequest; import one.talon.model.AddLoyaltyPoints; import one.talon.model.Application; import one.talon.model.ApplicationApiHealth; @@ -57,7 +56,6 @@ import one.talon.model.CustomerProfileSearchQuery; import one.talon.model.DeactivateUserRequest; import one.talon.model.DeductLoyaltyPoints; -import one.talon.model.DeleteUserRequest; import one.talon.model.ErrorResponse; import one.talon.model.ErrorResponseWithStatus; import one.talon.model.InlineResponse20010; @@ -191,7 +189,7 @@ public void setApiClient(ApiClient apiClient) { 204 No Content - */ - public okhttp3.Call activateUserByEmailCall(ActivateUserRequest body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call activateUserByEmailCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { Object localVarPostBody = body; // create path and map variables @@ -221,7 +219,7 @@ public okhttp3.Call activateUserByEmailCall(ActivateUserRequest body, final ApiC } @SuppressWarnings("rawtypes") - private okhttp3.Call activateUserByEmailValidateBeforeCall(ActivateUserRequest body, final ApiCallback _callback) throws ApiException { + private okhttp3.Call activateUserByEmailValidateBeforeCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { // verify the required parameter 'body' is set if (body == null) { @@ -245,7 +243,7 @@ private okhttp3.Call activateUserByEmailValidateBeforeCall(ActivateUserRequest b 204 No Content - */ - public void activateUserByEmail(ActivateUserRequest body) throws ApiException { + public void activateUserByEmail(DeactivateUserRequest body) throws ApiException { activateUserByEmailWithHttpInfo(body); } @@ -261,7 +259,7 @@ public void activateUserByEmail(ActivateUserRequest body) throws ApiException { 204 No Content - */ - public ApiResponse activateUserByEmailWithHttpInfo(ActivateUserRequest body) throws ApiException { + public ApiResponse activateUserByEmailWithHttpInfo(DeactivateUserRequest body) throws ApiException { okhttp3.Call localVarCall = activateUserByEmailValidateBeforeCall(body, null); return localVarApiClient.execute(localVarCall); } @@ -279,7 +277,7 @@ public ApiResponse activateUserByEmailWithHttpInfo(ActivateUserRequest bod 204 No Content - */ - public okhttp3.Call activateUserByEmailAsync(ActivateUserRequest body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call activateUserByEmailAsync(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = activateUserByEmailValidateBeforeCall(body, _callback); localVarApiClient.executeAsync(localVarCall, _callback); @@ -3549,7 +3547,7 @@ public okhttp3.Call deleteCouponAsync(Integer applicationId, Integer campaignId, * @param batchId Filter results by batches of coupons (optional) * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3678,7 +3676,7 @@ private okhttp3.Call deleteCouponsValidateBeforeCall(Integer applicationId, Inte * @param batchId Filter results by batches of coupons (optional) * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3707,7 +3705,7 @@ public void deleteCoupons(Integer applicationId, Integer campaignId, String valu * @param batchId Filter results by batches of coupons (optional) * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -3738,7 +3736,7 @@ public ApiResponse deleteCouponsWithHttpInfo(Integer applicationId, Intege * @param batchId Filter results by batches of coupons (optional) * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -4247,7 +4245,7 @@ public okhttp3.Call deleteUserAsync(Integer userId, final ApiCallback _cal 204 No Content - */ - public okhttp3.Call deleteUserByEmailCall(DeleteUserRequest body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserByEmailCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { Object localVarPostBody = body; // create path and map variables @@ -4277,7 +4275,7 @@ public okhttp3.Call deleteUserByEmailCall(DeleteUserRequest body, final ApiCallb } @SuppressWarnings("rawtypes") - private okhttp3.Call deleteUserByEmailValidateBeforeCall(DeleteUserRequest body, final ApiCallback _callback) throws ApiException { + private okhttp3.Call deleteUserByEmailValidateBeforeCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { // verify the required parameter 'body' is set if (body == null) { @@ -4301,7 +4299,7 @@ private okhttp3.Call deleteUserByEmailValidateBeforeCall(DeleteUserRequest body, 204 No Content - */ - public void deleteUserByEmail(DeleteUserRequest body) throws ApiException { + public void deleteUserByEmail(DeactivateUserRequest body) throws ApiException { deleteUserByEmailWithHttpInfo(body); } @@ -4317,7 +4315,7 @@ public void deleteUserByEmail(DeleteUserRequest body) throws ApiException { 204 No Content - */ - public ApiResponse deleteUserByEmailWithHttpInfo(DeleteUserRequest body) throws ApiException { + public ApiResponse deleteUserByEmailWithHttpInfo(DeactivateUserRequest body) throws ApiException { okhttp3.Call localVarCall = deleteUserByEmailValidateBeforeCall(body, null); return localVarApiClient.execute(localVarCall); } @@ -4335,7 +4333,7 @@ public ApiResponse deleteUserByEmailWithHttpInfo(DeleteUserRequest body) t 204 No Content - */ - public okhttp3.Call deleteUserByEmailAsync(DeleteUserRequest body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserByEmailAsync(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = deleteUserByEmailValidateBeforeCall(body, _callback); localVarApiClient.executeAsync(localVarCall, _callback); @@ -5227,7 +5225,7 @@ public okhttp3.Call exportCollectionItemsAsync(Integer applicationId, Integer ca /** * Build call for exportCoupons * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param 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. (optional) * @param value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5352,9 +5350,9 @@ private okhttp3.Call exportCouponsValidateBeforeCall(Integer applicationId, BigD /** * 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 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param 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. (optional) * @param value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5383,9 +5381,9 @@ public String exportCoupons(Integer applicationId, BigDecimal campaignId, String /** * 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 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param 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. (optional) * @param value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5415,9 +5413,9 @@ public ApiResponse exportCouponsWithHttpInfo(Integer applicationId, BigD /** * Export coupons (asynchronously) - * 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param 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. (optional) * @param value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5728,7 +5726,7 @@ public okhttp3.Call exportCustomersTiersAsync(String loyaltyProgramId, List exportEffectsWithHttpInfo(Integer applicationId, BigD * Export triggered effects (asynchronously) * 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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param dateFormat Determines the format of dates in the export document. (optional) @@ -6425,6 +6423,7 @@ public okhttp3.Call exportLoyaltyCardLedgerAsync(Integer loyaltyProgramId, Strin * Build call for exportLoyaltyCards * @param 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. (required) * @param batchId Filter results by loyalty card batch ID. (optional) + * @param dateFormat Determines the format of dates in the export document. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -6436,7 +6435,7 @@ public okhttp3.Call exportLoyaltyCardLedgerAsync(Integer loyaltyProgramId, Strin 401 Unauthorized - */ - public okhttp3.Call exportLoyaltyCardsCall(Integer loyaltyProgramId, String batchId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call exportLoyaltyCardsCall(Integer loyaltyProgramId, String batchId, String dateFormat, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -6449,6 +6448,10 @@ public okhttp3.Call exportLoyaltyCardsCall(Integer loyaltyProgramId, String batc localVarQueryParams.addAll(localVarApiClient.parameterToPair("batchId", batchId)); } + if (dateFormat != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("dateFormat", dateFormat)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -6471,7 +6474,7 @@ public okhttp3.Call exportLoyaltyCardsCall(Integer loyaltyProgramId, String batc } @SuppressWarnings("rawtypes") - private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(Integer loyaltyProgramId, String batchId, final ApiCallback _callback) throws ApiException { + private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(Integer loyaltyProgramId, String batchId, String dateFormat, final ApiCallback _callback) throws ApiException { // verify the required parameter 'loyaltyProgramId' is set if (loyaltyProgramId == null) { @@ -6479,7 +6482,7 @@ private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(Integer loyaltyProgram } - okhttp3.Call localVarCall = exportLoyaltyCardsCall(loyaltyProgramId, batchId, _callback); + okhttp3.Call localVarCall = exportLoyaltyCardsCall(loyaltyProgramId, batchId, dateFormat, _callback); return localVarCall; } @@ -6489,6 +6492,7 @@ private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(Integer loyaltyProgram * Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. * @param 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. (required) * @param batchId Filter results by loyalty card batch ID. (optional) + * @param dateFormat Determines the format of dates in the export document. (optional) * @return String * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -6499,8 +6503,8 @@ private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(Integer loyaltyProgram 401 Unauthorized - */ - public String exportLoyaltyCards(Integer loyaltyProgramId, String batchId) throws ApiException { - ApiResponse localVarResp = exportLoyaltyCardsWithHttpInfo(loyaltyProgramId, batchId); + public String exportLoyaltyCards(Integer loyaltyProgramId, String batchId, String dateFormat) throws ApiException { + ApiResponse localVarResp = exportLoyaltyCardsWithHttpInfo(loyaltyProgramId, batchId, dateFormat); return localVarResp.getData(); } @@ -6509,6 +6513,7 @@ public String exportLoyaltyCards(Integer loyaltyProgramId, String batchId) throw * Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. * @param 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. (required) * @param batchId Filter results by loyalty card batch ID. (optional) + * @param dateFormat Determines the format of dates in the export document. (optional) * @return ApiResponse<String> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -6519,8 +6524,8 @@ public String exportLoyaltyCards(Integer loyaltyProgramId, String batchId) throw 401 Unauthorized - */ - public ApiResponse exportLoyaltyCardsWithHttpInfo(Integer loyaltyProgramId, String batchId) throws ApiException { - okhttp3.Call localVarCall = exportLoyaltyCardsValidateBeforeCall(loyaltyProgramId, batchId, null); + public ApiResponse exportLoyaltyCardsWithHttpInfo(Integer loyaltyProgramId, String batchId, String dateFormat) throws ApiException { + okhttp3.Call localVarCall = exportLoyaltyCardsValidateBeforeCall(loyaltyProgramId, batchId, dateFormat, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -6530,6 +6535,7 @@ public ApiResponse exportLoyaltyCardsWithHttpInfo(Integer loyaltyProgram * Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. * @param 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. (required) * @param batchId Filter results by loyalty card batch ID. (optional) + * @param dateFormat Determines the format of dates in the export document. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -6541,9 +6547,9 @@ public ApiResponse exportLoyaltyCardsWithHttpInfo(Integer loyaltyProgram 401 Unauthorized - */ - public okhttp3.Call exportLoyaltyCardsAsync(Integer loyaltyProgramId, String batchId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call exportLoyaltyCardsAsync(Integer loyaltyProgramId, String batchId, String dateFormat, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = exportLoyaltyCardsValidateBeforeCall(loyaltyProgramId, batchId, _callback); + okhttp3.Call localVarCall = exportLoyaltyCardsValidateBeforeCall(loyaltyProgramId, batchId, dateFormat, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -6837,7 +6843,7 @@ public okhttp3.Call exportPoolGiveawaysAsync(Integer poolId, OffsetDateTime crea /** * Build call for exportReferrals * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. (optional) @@ -6929,7 +6935,7 @@ private okhttp3.Call exportReferralsValidateBeforeCall(Integer applicationId, Bi * Export referrals * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. (optional) @@ -6953,7 +6959,7 @@ public String exportReferrals(Integer applicationId, BigDecimal campaignId, Offs * Export referrals * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. (optional) @@ -6978,7 +6984,7 @@ public ApiResponse exportReferralsWithHttpInfo(Integer applicationId, Bi * Export referrals (asynchronously) * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. (optional) @@ -9337,7 +9343,7 @@ public okhttp3.Call getApplicationSessionAsync(Integer applicationId, Integer se * @param createdAfter Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param coupon Filter by sessions with this coupon. Must be exact match. (optional) * @param referral Filter by sessions with this referral. Must be exact match. (optional) - * @param integrationId Filter by sessions with this integrationId. Must be exact match. (optional) + * @param integrationId Filter by sessions with this integration ID. Must be exact match. (optional) * @param storeIntegrationId The integration ID of the store. You choose this ID when you create a store. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -9449,7 +9455,7 @@ private okhttp3.Call getApplicationSessionsValidateBeforeCall(Integer applicatio * @param createdAfter Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param coupon Filter by sessions with this coupon. Must be exact match. (optional) * @param referral Filter by sessions with this referral. Must be exact match. (optional) - * @param integrationId Filter by sessions with this integrationId. Must be exact match. (optional) + * @param integrationId Filter by sessions with this integration ID. Must be exact match. (optional) * @param storeIntegrationId The integration ID of the store. You choose this ID when you create a store. (optional) * @return InlineResponse20027 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -9477,7 +9483,7 @@ public InlineResponse20027 getApplicationSessions(Integer applicationId, Integer * @param createdAfter Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param coupon Filter by sessions with this coupon. Must be exact match. (optional) * @param referral Filter by sessions with this referral. Must be exact match. (optional) - * @param integrationId Filter by sessions with this integrationId. Must be exact match. (optional) + * @param integrationId Filter by sessions with this integration ID. Must be exact match. (optional) * @param storeIntegrationId The integration ID of the store. You choose this ID when you create a store. (optional) * @return ApiResponse<InlineResponse20027> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -9506,7 +9512,7 @@ public ApiResponse getApplicationSessionsWithHttpInfo(Integ * @param createdAfter Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param coupon Filter by sessions with this coupon. Must be exact match. (optional) * @param referral Filter by sessions with this referral. Must be exact match. (optional) - * @param integrationId Filter by sessions with this integrationId. Must be exact match. (optional) + * @param integrationId Filter by sessions with this integration ID. Must be exact match. (optional) * @param storeIntegrationId The integration ID of the store. You choose this ID when you create a store. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -11128,7 +11134,7 @@ public okhttp3.Call getCampaignTemplatesAsync(Integer pageSize, Integer skip, St * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param campaignGroupId Filter results to campaigns owned by the specified campaign access group ID. (optional) - * @param templateId The ID of the Campaign Template this Campaign was created from. (optional) + * @param templateId The ID of the campaign template this campaign was created from. (optional) * @param storeId Filter results to campaigns linked to the specified store ID. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -11241,7 +11247,7 @@ private okhttp3.Call getCampaignsValidateBeforeCall(Integer applicationId, Integ * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param campaignGroupId Filter results to campaigns owned by the specified campaign access group ID. (optional) - * @param templateId The ID of the Campaign Template this Campaign was created from. (optional) + * @param templateId The ID of the campaign template this campaign was created from. (optional) * @param storeId Filter results to campaigns linked to the specified store ID. (optional) * @return InlineResponse2006 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -11270,7 +11276,7 @@ public InlineResponse2006 getCampaigns(Integer applicationId, Integer pageSize, * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param campaignGroupId Filter results to campaigns owned by the specified campaign access group ID. (optional) - * @param templateId The ID of the Campaign Template this Campaign was created from. (optional) + * @param templateId The ID of the campaign template this campaign was created from. (optional) * @param storeId Filter results to campaigns linked to the specified store ID. (optional) * @return ApiResponse<InlineResponse2006> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -11300,7 +11306,7 @@ public ApiResponse getCampaignsWithHttpInfo(Integer applicat * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param campaignGroupId Filter results to campaigns owned by the specified campaign access group ID. (optional) - * @param templateId The ID of the Campaign Template this Campaign was created from. (optional) + * @param templateId The ID of the campaign template this campaign was created from. (optional) * @param storeId Filter results to campaigns linked to the specified store ID. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -11788,9 +11794,9 @@ public okhttp3.Call getCollectionItemsAsync(Integer collectionId, Integer pageSi * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param redeemed - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -11942,9 +11948,9 @@ private okhttp3.Call getCouponsWithoutTotalCountValidateBeforeCall(Integer appli * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param redeemed - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -11978,9 +11984,9 @@ public InlineResponse2009 getCouponsWithoutTotalCount(Integer applicationId, Int * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param redeemed - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -12015,9 +12021,9 @@ public ApiResponse getCouponsWithoutTotalCountWithHttpInfo(I * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param redeemed - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -12210,10 +12216,10 @@ public okhttp3.Call getCustomerActivityReportAsync(OffsetDateTime rangeStart, Of * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) - * @param name Only return reports matching the customer name (optional) + * @param name Only return reports matching the customer name. (optional) * @param integrationId Filter results performing an exact matching against the profile integration identifier. (optional) - * @param campaignName Only return reports matching the campaignName (optional) - * @param advocateName Only return reports matching the current customer referrer name (optional) + * @param campaignName Only return reports matching the campaign name. (optional) + * @param advocateName Only return reports matching the current customer referrer name. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -12322,10 +12328,10 @@ private okhttp3.Call getCustomerActivityReportsWithoutTotalCountValidateBeforeCa * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) - * @param name Only return reports matching the customer name (optional) + * @param name Only return reports matching the customer name. (optional) * @param integrationId Filter results performing an exact matching against the profile integration identifier. (optional) - * @param campaignName Only return reports matching the campaignName (optional) - * @param advocateName Only return reports matching the current customer referrer name (optional) + * @param campaignName Only return reports matching the campaign name. (optional) + * @param advocateName Only return reports matching the current customer referrer name. (optional) * @return InlineResponse20026 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -12348,10 +12354,10 @@ public InlineResponse20026 getCustomerActivityReportsWithoutTotalCount(OffsetDat * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) - * @param name Only return reports matching the customer name (optional) + * @param name Only return reports matching the customer name. (optional) * @param integrationId Filter results performing an exact matching against the profile integration identifier. (optional) - * @param campaignName Only return reports matching the campaignName (optional) - * @param advocateName Only return reports matching the current customer referrer name (optional) + * @param campaignName Only return reports matching the campaign name. (optional) + * @param advocateName Only return reports matching the current customer referrer name. (optional) * @return ApiResponse<InlineResponse20026> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -12375,10 +12381,10 @@ public ApiResponse getCustomerActivityReportsWithoutTotalCo * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) - * @param name Only return reports matching the customer name (optional) + * @param name Only return reports matching the customer name. (optional) * @param integrationId Filter results performing an exact matching against the profile integration identifier. (optional) - * @param campaignName Only return reports matching the campaignName (optional) - * @param advocateName Only return reports matching the current customer referrer name (optional) + * @param campaignName Only return reports matching the campaign name. (optional) + * @param advocateName Only return reports matching the current customer referrer name. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -12816,7 +12822,7 @@ public okhttp3.Call getCustomerProfileAchievementProgressAsync(Integer applicati * Build call for getCustomerProfiles * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -12881,7 +12887,7 @@ private okhttp3.Call getCustomerProfilesValidateBeforeCall(Integer pageSize, Int * List all customer profiles. * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @return InlineResponse20025 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -12900,7 +12906,7 @@ public InlineResponse20025 getCustomerProfiles(Integer pageSize, Integer skip, B * List all customer profiles. * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @return ApiResponse<InlineResponse20025> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -12920,7 +12926,7 @@ public ApiResponse getCustomerProfilesWithHttpInfo(Integer * List all customer profiles. * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -12942,7 +12948,7 @@ public okhttp3.Call getCustomerProfilesAsync(Integer pageSize, Integer skip, Boo * @param body body (required) * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -13013,7 +13019,7 @@ private okhttp3.Call getCustomersByAttributesValidateBeforeCall(CustomerProfileS * @param body body (required) * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @return InlineResponse20024 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -13033,7 +13039,7 @@ public InlineResponse20024 getCustomersByAttributes(CustomerProfileSearchQuery b * @param body body (required) * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @return ApiResponse<InlineResponse20024> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -13054,7 +13060,7 @@ public ApiResponse getCustomersByAttributesWithHttpInfo(Cus * @param body body (required) * @param pageSize The number of items in the response. (optional, default to 1000) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param sandbox Indicates whether you are pointing to a sandbox or Live customer. (optional, default to false) + * @param sandbox Indicates whether you are pointing to a sandbox or live customer. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -14449,7 +14455,7 @@ public okhttp3.Call getLoyaltyStatisticsAsync(Integer loyaltyProgramId, final Ap * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) - * @param advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) + * @param advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -14558,7 +14564,7 @@ private okhttp3.Call getReferralsWithoutTotalCountValidateBeforeCall(Integer app * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) - * @param advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) + * @param advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) * @return InlineResponse20010 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -14585,7 +14591,7 @@ public InlineResponse20010 getReferralsWithoutTotalCount(Integer applicationId, * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) - * @param advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) + * @param advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) * @return ApiResponse<InlineResponse20010> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -14613,7 +14619,7 @@ public ApiResponse getReferralsWithoutTotalCountWithHttpInf * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) - * @param advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) + * @param advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -15495,9 +15501,9 @@ public okhttp3.Call getWebhookAsync(Integer webhookId, final ApiCallback getWebhookActivationLogsWithHttpInfo(Int * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param integrationRequestUuid Filter results by integration request UUID. (optional) - * @param webhookId Filter results by Webhook. (optional) + * @param webhookId Filter results by webhook id. (optional) * @param applicationId Filter results by Application ID. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param createdBefore Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param createdAfter Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) * @param _callback The callback to be executed when the API call finishes @@ -15668,9 +15674,9 @@ public okhttp3.Call getWebhookActivationLogsAsync(Integer pageSize, Integer skip * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param status Filter results by HTTP status codes. (optional) - * @param webhookId Filter results by Webhook. (optional) + * @param webhookId Filter results by webhook id. (optional) * @param applicationId Filter results by Application ID. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param requestUuid Filter results by request UUID. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) @@ -15768,9 +15774,9 @@ private okhttp3.Call getWebhookLogsValidateBeforeCall(Integer pageSize, Integer * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param status Filter results by HTTP status codes. (optional) - * @param webhookId Filter results by Webhook. (optional) + * @param webhookId Filter results by webhook id. (optional) * @param applicationId Filter results by Application ID. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param requestUuid Filter results by request UUID. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) @@ -15794,9 +15800,9 @@ public InlineResponse20039 getWebhookLogs(Integer pageSize, Integer skip, String * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param status Filter results by HTTP status codes. (optional) - * @param webhookId Filter results by Webhook. (optional) + * @param webhookId Filter results by webhook id. (optional) * @param applicationId Filter results by Application ID. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param requestUuid Filter results by request UUID. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) @@ -15821,9 +15827,9 @@ public ApiResponse getWebhookLogsWithHttpInfo(Integer pageS * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param status Filter results by HTTP status codes. (optional) - * @param webhookId Filter results by Webhook. (optional) + * @param webhookId Filter results by webhook id. (optional) * @param applicationId Filter results by Application ID. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param requestUuid Filter results by request UUID. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) * @param 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 time zone setting. Talon.One will convert to UTC internally. (optional) @@ -18426,7 +18432,7 @@ public okhttp3.Call listCollectionsInApplicationAsync(Integer applicationId, Int * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param 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. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param name The name of the store. (optional) * @param integrationId The integration ID of the store. (optional) * @param query Filter results by `name` or `integrationId`. (optional) @@ -18523,7 +18529,7 @@ private okhttp3.Call listStoresValidateBeforeCall(Integer applicationId, Integer * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param 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. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param name The name of the store. (optional) * @param integrationId The integration ID of the store. (optional) * @param query Filter results by `name` or `integrationId`. (optional) @@ -18548,7 +18554,7 @@ public InlineResponse20045 listStores(Integer applicationId, Integer pageSize, I * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param 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. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param name The name of the store. (optional) * @param integrationId The integration ID of the store. (optional) * @param query Filter results by `name` or `integrationId`. (optional) @@ -18574,7 +18580,7 @@ public ApiResponse listStoresWithHttpInfo(Integer applicati * @param skip The number of items to skip when paging through large result sets. (optional) * @param 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. (optional) * @param 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. (optional) - * @param campaignId Filter results by campaign. (optional) + * @param campaignId Filter results by campaign ID. (optional) * @param name The name of the store. (optional) * @param integrationId The integration ID of the store. (optional) * @param query Filter results by `name` or `integrationId`. (optional) @@ -20436,9 +20442,9 @@ public okhttp3.Call scimReplaceUserAttributesAsync(Integer userId, ScimNewUser b * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param 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. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -20564,9 +20570,9 @@ private okhttp3.Call searchCouponsAdvancedApplicationWideWithoutTotalCountValida * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param 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. (optional) * @return InlineResponse2009 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -20595,9 +20601,9 @@ public InlineResponse2009 searchCouponsAdvancedApplicationWideWithoutTotalCount( * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param 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. (optional) * @return ApiResponse<InlineResponse2009> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -20627,9 +20633,9 @@ public ApiResponse searchCouponsAdvancedApplicationWideWitho * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) * @param batchId Filter results by batches of coupons (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param 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. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -20661,8 +20667,8 @@ public okhttp3.Call searchCouponsAdvancedApplicationWideWithoutTotalCountAsync(I * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param batchId Filter results by batches of coupons (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -20791,8 +20797,8 @@ private okhttp3.Call searchCouponsAdvancedWithoutTotalCountValidateBeforeCall(In * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param batchId Filter results by batches of coupons (optional) * @return InlineResponse2009 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -20822,8 +20828,8 @@ public InlineResponse2009 searchCouponsAdvancedWithoutTotalCount(Integer applica * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param batchId Filter results by batches of coupons (optional) * @return ApiResponse<InlineResponse2009> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -20854,8 +20860,8 @@ public ApiResponse searchCouponsAdvancedWithoutTotalCountWit * @param 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. (optional) * @param usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) - * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) - * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false) + * @param recipientIntegrationId Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) + * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code. (optional, default to false) * @param batchId Filter results by batches of coupons (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/one/talon/model/Account.java b/src/main/java/one/talon/model/Account.java index ab049cc0..324dbcb4 100644 --- a/src/main/java/one/talon/model/Account.java +++ b/src/main/java/one/talon/model/Account.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Account */ -@ApiModel(description = "") public class Account { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/AccountAdditionalCost.java b/src/main/java/one/talon/model/AccountAdditionalCost.java index 911878a9..e486aa98 100644 --- a/src/main/java/one/talon/model/AccountAdditionalCost.java +++ b/src/main/java/one/talon/model/AccountAdditionalCost.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * AccountAdditionalCost */ -@ApiModel(description = "") public class AccountAdditionalCost { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/AccountAnalytics.java b/src/main/java/one/talon/model/AccountAnalytics.java index 9d0f48e1..88c7ee6d 100644 --- a/src/main/java/one/talon/model/AccountAnalytics.java +++ b/src/main/java/one/talon/model/AccountAnalytics.java @@ -539,7 +539,7 @@ public AccountAnalytics lastUpdatedAt(OffsetDateTime lastUpdatedAt) { * The point in time when the analytics numbers were updated last. * @return lastUpdatedAt **/ - @ApiModelProperty(required = true, value = "The point in time when the analytics numbers were updated last.") + @ApiModelProperty(example = "2022-12-12T12:12:12Z", required = true, value = "The point in time when the analytics numbers were updated last.") public OffsetDateTime getLastUpdatedAt() { return lastUpdatedAt; diff --git a/src/main/java/one/talon/model/Achievement.java b/src/main/java/one/talon/model/Achievement.java index 2621f80a..fe8ffbf0 100644 --- a/src/main/java/one/talon/model/Achievement.java +++ b/src/main/java/one/talon/model/Achievement.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Achievement */ -@ApiModel(description = "") public class Achievement { public static final String SERIALIZED_NAME_ID = "id"; @@ -65,6 +64,116 @@ public class Achievement { @SerializedName(SERIALIZED_NAME_PERIOD_END_OVERRIDE) private TimePoint periodEndOverride; + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + */ + @JsonAdapter(RecurrencePolicyEnum.Adapter.class) + public enum RecurrencePolicyEnum { + NO_RECURRENCE("no_recurrence"), + + ON_EXPIRATION("on_expiration"); + + private String value; + + RecurrencePolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RecurrencePolicyEnum fromValue(String value) { + for (RecurrencePolicyEnum b : RecurrencePolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RecurrencePolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RecurrencePolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RecurrencePolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RECURRENCE_POLICY = "recurrencePolicy"; + @SerializedName(SERIALIZED_NAME_RECURRENCE_POLICY) + private RecurrencePolicyEnum recurrencePolicy; + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + */ + @JsonAdapter(ActivationPolicyEnum.Adapter.class) + public enum ActivationPolicyEnum { + USER_ACTION("user_action"), + + FIXED_SCHEDULE("fixed_schedule"); + + private String value; + + ActivationPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActivationPolicyEnum fromValue(String value) { + for (ActivationPolicyEnum b : ActivationPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActivationPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActivationPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActivationPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ACTIVATION_POLICY = "activationPolicy"; + @SerializedName(SERIALIZED_NAME_ACTIVATION_POLICY) + private ActivationPolicyEnum activationPolicy; + + public static final String SERIALIZED_NAME_FIXED_START_DATE = "fixedStartDate"; + @SerializedName(SERIALIZED_NAME_FIXED_START_DATE) + private OffsetDateTime fixedStartDate; + + public static final String SERIALIZED_NAME_END_DATE = "endDate"; + @SerializedName(SERIALIZED_NAME_END_DATE) + private OffsetDateTime endDate; + public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) private Integer campaignId; @@ -259,6 +368,98 @@ public void setPeriodEndOverride(TimePoint periodEndOverride) { } + public Achievement recurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + + this.recurrencePolicy = recurrencePolicy; + return this; + } + + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + * @return recurrencePolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "no_recurrence", value = "The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. ") + + public RecurrencePolicyEnum getRecurrencePolicy() { + return recurrencePolicy; + } + + + public void setRecurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + this.recurrencePolicy = recurrencePolicy; + } + + + public Achievement activationPolicy(ActivationPolicyEnum activationPolicy) { + + this.activationPolicy = activationPolicy; + return this; + } + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + * @return activationPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "fixed_schedule", value = "The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. ") + + public ActivationPolicyEnum getActivationPolicy() { + return activationPolicy; + } + + + public void setActivationPolicy(ActivationPolicyEnum activationPolicy) { + this.activationPolicy = activationPolicy; + } + + + public Achievement fixedStartDate(OffsetDateTime fixedStartDate) { + + this.fixedStartDate = fixedStartDate; + return this; + } + + /** + * The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. + * @return fixedStartDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getFixedStartDate() { + return fixedStartDate; + } + + + public void setFixedStartDate(OffsetDateTime fixedStartDate) { + this.fixedStartDate = fixedStartDate; + } + + + public Achievement endDate(OffsetDateTime endDate) { + + this.endDate = endDate; + return this; + } + + /** + * The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. + * @return endDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getEndDate() { + return endDate; + } + + + public void setEndDate(OffsetDateTime endDate) { + this.endDate = endDate; + } + + public Achievement campaignId(Integer campaignId) { this.campaignId = campaignId; @@ -365,6 +566,10 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.target, achievement.target) && Objects.equals(this.period, achievement.period) && Objects.equals(this.periodEndOverride, achievement.periodEndOverride) && + Objects.equals(this.recurrencePolicy, achievement.recurrencePolicy) && + Objects.equals(this.activationPolicy, achievement.activationPolicy) && + Objects.equals(this.fixedStartDate, achievement.fixedStartDate) && + Objects.equals(this.endDate, achievement.endDate) && Objects.equals(this.campaignId, achievement.campaignId) && Objects.equals(this.userId, achievement.userId) && Objects.equals(this.createdBy, achievement.createdBy) && @@ -373,7 +578,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, created, name, title, description, target, period, periodEndOverride, campaignId, userId, createdBy, hasProgress); + return Objects.hash(id, created, name, title, description, target, period, periodEndOverride, recurrencePolicy, activationPolicy, fixedStartDate, endDate, campaignId, userId, createdBy, hasProgress); } @@ -389,6 +594,10 @@ public String toString() { sb.append(" target: ").append(toIndentedString(target)).append("\n"); sb.append(" period: ").append(toIndentedString(period)).append("\n"); sb.append(" periodEndOverride: ").append(toIndentedString(periodEndOverride)).append("\n"); + sb.append(" recurrencePolicy: ").append(toIndentedString(recurrencePolicy)).append("\n"); + sb.append(" activationPolicy: ").append(toIndentedString(activationPolicy)).append("\n"); + sb.append(" fixedStartDate: ").append(toIndentedString(fixedStartDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); sb.append(" campaignId: ").append(toIndentedString(campaignId)).append("\n"); sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n"); diff --git a/src/main/java/one/talon/model/AdditionalCampaignProperties.java b/src/main/java/one/talon/model/AdditionalCampaignProperties.java index 4c3e4339..a4829528 100644 --- a/src/main/java/one/talon/model/AdditionalCampaignProperties.java +++ b/src/main/java/one/talon/model/AdditionalCampaignProperties.java @@ -119,7 +119,7 @@ public class AdditionalCampaignProperties { private Integer templateId; /** - * A campaign state described exactly as in the Campaign Manager. + * The campaign state displayed in the Campaign Manager. */ @JsonAdapter(FrontendStateEnum.Adapter.class) public enum FrontendStateEnum { @@ -131,7 +131,9 @@ public enum FrontendStateEnum { DISABLED("disabled"), - ARCHIVED("archived"); + ARCHIVED("archived"), + + STAGED("staged"); private String value; @@ -674,10 +676,10 @@ public AdditionalCampaignProperties frontendState(FrontendStateEnum frontendStat } /** - * A campaign state described exactly as in the Campaign Manager. + * The campaign state displayed in the Campaign Manager. * @return frontendState **/ - @ApiModelProperty(example = "running", required = true, value = "A campaign state described exactly as in the Campaign Manager.") + @ApiModelProperty(example = "running", required = true, value = "The campaign state displayed in the Campaign Manager.") public FrontendStateEnum getFrontendState() { return frontendState; diff --git a/src/main/java/one/talon/model/Application.java b/src/main/java/one/talon/model/Application.java index 0ebd743b..fb437030 100644 --- a/src/main/java/one/talon/model/Application.java +++ b/src/main/java/one/talon/model/Application.java @@ -31,9 +31,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Application */ -@ApiModel(description = "") public class Application { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ApplicationAPIKey.java b/src/main/java/one/talon/model/ApplicationAPIKey.java index f29ff3f4..6ee16a38 100644 --- a/src/main/java/one/talon/model/ApplicationAPIKey.java +++ b/src/main/java/one/talon/model/ApplicationAPIKey.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationAPIKey */ -@ApiModel(description = "") public class ApplicationAPIKey { public static final String SERIALIZED_NAME_TITLE = "title"; diff --git a/src/main/java/one/talon/model/ApplicationCIF.java b/src/main/java/one/talon/model/ApplicationCIF.java index 447e3346..1ac2f03c 100644 --- a/src/main/java/one/talon/model/ApplicationCIF.java +++ b/src/main/java/one/talon/model/ApplicationCIF.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationCIF */ -@ApiModel(description = "") public class ApplicationCIF { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ApplicationCIFExpression.java b/src/main/java/one/talon/model/ApplicationCIFExpression.java index c1478c6f..84c101d1 100644 --- a/src/main/java/one/talon/model/ApplicationCIFExpression.java +++ b/src/main/java/one/talon/model/ApplicationCIFExpression.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationCIFExpression */ -@ApiModel(description = "") public class ApplicationCIFExpression { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java index ed19ab9c..ed5d019a 100644 --- a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java +++ b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java @@ -68,7 +68,9 @@ public enum CampaignStateEnum { DISABLED("disabled"), - ARCHIVED("archived"); + ARCHIVED("archived"), + + STAGED("staged"); private String value; diff --git a/src/main/java/one/talon/model/ApplicationCampaignStats.java b/src/main/java/one/talon/model/ApplicationCampaignStats.java index b4424917..99f3fcde 100644 --- a/src/main/java/one/talon/model/ApplicationCampaignStats.java +++ b/src/main/java/one/talon/model/ApplicationCampaignStats.java @@ -34,6 +34,10 @@ public class ApplicationCampaignStats { @SerializedName(SERIALIZED_NAME_DISABLED) private Integer disabled; + public static final String SERIALIZED_NAME_STAGED = "staged"; + @SerializedName(SERIALIZED_NAME_STAGED) + private Integer staged; + public static final String SERIALIZED_NAME_SCHEDULED = "scheduled"; @SerializedName(SERIALIZED_NAME_SCHEDULED) private Integer scheduled; @@ -73,6 +77,28 @@ public void setDisabled(Integer disabled) { } + public ApplicationCampaignStats staged(Integer staged) { + + this.staged = staged; + return this; + } + + /** + * Number of staged campaigns. + * @return staged + **/ + @ApiModelProperty(required = true, value = "Number of staged campaigns.") + + public Integer getStaged() { + return staged; + } + + + public void setStaged(Integer staged) { + this.staged = staged; + } + + public ApplicationCampaignStats scheduled(Integer scheduled) { this.scheduled = scheduled; @@ -171,6 +197,7 @@ public boolean equals(java.lang.Object o) { } ApplicationCampaignStats applicationCampaignStats = (ApplicationCampaignStats) o; return Objects.equals(this.disabled, applicationCampaignStats.disabled) && + Objects.equals(this.staged, applicationCampaignStats.staged) && Objects.equals(this.scheduled, applicationCampaignStats.scheduled) && Objects.equals(this.running, applicationCampaignStats.running) && Objects.equals(this.expired, applicationCampaignStats.expired) && @@ -179,7 +206,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(disabled, scheduled, running, expired, archived); + return Objects.hash(disabled, staged, scheduled, running, expired, archived); } @@ -188,6 +215,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApplicationCampaignStats {\n"); sb.append(" disabled: ").append(toIndentedString(disabled)).append("\n"); + sb.append(" staged: ").append(toIndentedString(staged)).append("\n"); sb.append(" scheduled: ").append(toIndentedString(scheduled)).append("\n"); sb.append(" running: ").append(toIndentedString(running)).append("\n"); sb.append(" expired: ").append(toIndentedString(expired)).append("\n"); diff --git a/src/main/java/one/talon/model/ApplicationCustomer.java b/src/main/java/one/talon/model/ApplicationCustomer.java index 669a4ab2..7c44e8a9 100644 --- a/src/main/java/one/talon/model/ApplicationCustomer.java +++ b/src/main/java/one/talon/model/ApplicationCustomer.java @@ -31,9 +31,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationCustomer */ -@ApiModel(description = "") public class ApplicationCustomer { public static final String SERIALIZED_NAME_ID = "id"; @@ -92,10 +91,10 @@ public ApplicationCustomer id(Integer id) { } /** - * Internal ID of this entity. Internal ID of this entity. + * Internal ID of this entity. * @return id **/ - @ApiModelProperty(required = true, value = "Internal ID of this entity. Internal ID of this entity.") + @ApiModelProperty(example = "6", required = true, value = "Internal ID of this entity.") public Integer getId() { return id; @@ -114,10 +113,10 @@ public ApplicationCustomer created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; @@ -136,10 +135,10 @@ public ApplicationCustomer integrationId(String integrationId) { } /** - * The integration ID set by your integration layer. The integration ID set by your integration layer. + * The integration ID set by your integration layer. * @return integrationId **/ - @ApiModelProperty(required = true, value = "The integration ID set by your integration layer. The integration ID set by your integration layer.") + @ApiModelProperty(example = "URNGV8294NV", required = true, value = "The integration ID set by your integration layer.") public String getIntegrationId() { return integrationId; @@ -180,10 +179,10 @@ public ApplicationCustomer accountId(Integer accountId) { } /** - * The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. + * The ID of the Talon.One account that owns this profile. * @return accountId **/ - @ApiModelProperty(required = true, value = "The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile.") + @ApiModelProperty(example = "31", required = true, value = "The ID of the Talon.One account that owns this profile.") public Integer getAccountId() { return accountId; diff --git a/src/main/java/one/talon/model/ApplicationEvent.java b/src/main/java/one/talon/model/ApplicationEvent.java index 58d785e5..3845b876 100644 --- a/src/main/java/one/talon/model/ApplicationEvent.java +++ b/src/main/java/one/talon/model/ApplicationEvent.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationEvent */ -@ApiModel(description = "") public class ApplicationEvent { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ApplicationReferee.java b/src/main/java/one/talon/model/ApplicationReferee.java index 86dcde2a..09070784 100644 --- a/src/main/java/one/talon/model/ApplicationReferee.java +++ b/src/main/java/one/talon/model/ApplicationReferee.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationReferee */ -@ApiModel(description = "") public class ApplicationReferee { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; diff --git a/src/main/java/one/talon/model/ApplicationSession.java b/src/main/java/one/talon/model/ApplicationSession.java index b53f7560..d6152fd5 100644 --- a/src/main/java/one/talon/model/ApplicationSession.java +++ b/src/main/java/one/talon/model/ApplicationSession.java @@ -32,9 +32,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ApplicationSession */ -@ApiModel(description = "") public class ApplicationSession { public static final String SERIALIZED_NAME_ID = "id"; @@ -178,10 +177,10 @@ public ApplicationSession created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; diff --git a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java index ea2d8006..33712558 100644 --- a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java +++ b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * AsyncCouponDeletionJobResponse */ -@ApiModel(description = "") public class AsyncCouponDeletionJobResponse { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Attribute.java b/src/main/java/one/talon/model/Attribute.java index b50c7bcd..69a2a65e 100644 --- a/src/main/java/one/talon/model/Attribute.java +++ b/src/main/java/one/talon/model/Attribute.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Attribute */ -@ApiModel(description = "") public class Attribute { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Audience.java b/src/main/java/one/talon/model/Audience.java index f255a0a8..668c903b 100644 --- a/src/main/java/one/talon/model/Audience.java +++ b/src/main/java/one/talon/model/Audience.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Audience */ -@ApiModel(description = "") public class Audience { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; diff --git a/src/main/java/one/talon/model/AudienceCustomer.java b/src/main/java/one/talon/model/AudienceCustomer.java index 0ae391f9..6bcea89a 100644 --- a/src/main/java/one/talon/model/AudienceCustomer.java +++ b/src/main/java/one/talon/model/AudienceCustomer.java @@ -31,9 +31,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * AudienceCustomer */ -@ApiModel(description = "") public class AudienceCustomer { public static final String SERIALIZED_NAME_ID = "id"; @@ -118,10 +117,10 @@ public AudienceCustomer created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; diff --git a/src/main/java/one/talon/model/BaseLoyaltyProgram.java b/src/main/java/one/talon/model/BaseLoyaltyProgram.java index 988fe4c8..a0ceaf41 100644 --- a/src/main/java/one/talon/model/BaseLoyaltyProgram.java +++ b/src/main/java/one/talon/model/BaseLoyaltyProgram.java @@ -236,6 +236,57 @@ public TiersDowngradePolicyEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName(SERIALIZED_NAME_CARD_CODE_SETTINGS) private CodeGeneratorSettings cardCodeSettings; + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + */ + @JsonAdapter(ReturnPolicyEnum.Adapter.class) + public enum ReturnPolicyEnum { + ONLY_PENDING("only_pending"), + + WITHIN_BALANCE("within_balance"); + + private String value; + + ReturnPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReturnPolicyEnum fromValue(String value) { + for (ReturnPolicyEnum b : ReturnPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReturnPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReturnPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReturnPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RETURN_POLICY = "returnPolicy"; + @SerializedName(SERIALIZED_NAME_RETURN_POLICY) + private ReturnPolicyEnum returnPolicy; + public BaseLoyaltyProgram title(String title) { @@ -568,6 +619,29 @@ public void setCardCodeSettings(CodeGeneratorSettings cardCodeSettings) { } + public BaseLoyaltyProgram returnPolicy(ReturnPolicyEnum returnPolicy) { + + this.returnPolicy = returnPolicy; + return this; + } + + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + * @return returnPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. ") + + public ReturnPolicyEnum getReturnPolicy() { + return returnPolicy; + } + + + public void setReturnPolicy(ReturnPolicyEnum returnPolicy) { + this.returnPolicy = returnPolicy; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -590,12 +664,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tierCycleStartDate, baseLoyaltyProgram.tierCycleStartDate) && Objects.equals(this.tiersExpireIn, baseLoyaltyProgram.tiersExpireIn) && Objects.equals(this.tiersDowngradePolicy, baseLoyaltyProgram.tiersDowngradePolicy) && - Objects.equals(this.cardCodeSettings, baseLoyaltyProgram.cardCodeSettings); + Objects.equals(this.cardCodeSettings, baseLoyaltyProgram.cardCodeSettings) && + Objects.equals(this.returnPolicy, baseLoyaltyProgram.returnPolicy); } @Override public int hashCode() { - return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings); + return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, returnPolicy); } @@ -617,6 +692,7 @@ public String toString() { sb.append(" tiersExpireIn: ").append(toIndentedString(tiersExpireIn)).append("\n"); sb.append(" tiersDowngradePolicy: ").append(toIndentedString(tiersDowngradePolicy)).append("\n"); sb.append(" cardCodeSettings: ").append(toIndentedString(cardCodeSettings)).append("\n"); + sb.append(" returnPolicy: ").append(toIndentedString(returnPolicy)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/BaseNotification.java b/src/main/java/one/talon/model/BaseNotification.java index deea1b0f..15bf0038 100644 --- a/src/main/java/one/talon/model/BaseNotification.java +++ b/src/main/java/one/talon/model/BaseNotification.java @@ -26,9 +26,8 @@ import one.talon.model.BaseNotificationWebhook; /** - * + * BaseNotification */ -@ApiModel(description = "") public class BaseNotification { public static final String SERIALIZED_NAME_POLICY = "policy"; diff --git a/src/main/java/one/talon/model/BaseNotificationWebhook.java b/src/main/java/one/talon/model/BaseNotificationWebhook.java index a50001aa..1c1ef0c1 100644 --- a/src/main/java/one/talon/model/BaseNotificationWebhook.java +++ b/src/main/java/one/talon/model/BaseNotificationWebhook.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * BaseNotificationWebhook */ -@ApiModel(description = "") public class BaseNotificationWebhook { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java index 4fb8664f..e30c830c 100644 --- a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java +++ b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java @@ -25,6 +25,7 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; +import org.threeten.bp.OffsetDateTime; /** * BulkOperationOnCampaigns @@ -38,7 +39,9 @@ public class BulkOperationOnCampaigns { public enum OperationEnum { DISABLE("disable"), - DELETE("delete"); + DELETE("delete"), + + ACTIVATE_REVISION("activate_revision"); private String value; @@ -86,6 +89,10 @@ public OperationEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_CAMPAIGN_IDS) private List campaignIds = new ArrayList(); + public static final String SERIALIZED_NAME_ACTIVATE_AT = "activateAt"; + @SerializedName(SERIALIZED_NAME_ACTIVATE_AT) + private OffsetDateTime activateAt; + public BulkOperationOnCampaigns operation(OperationEnum operation) { @@ -136,6 +143,29 @@ public void setCampaignIds(List campaignIds) { } + public BulkOperationOnCampaigns activateAt(OffsetDateTime activateAt) { + + this.activateAt = activateAt; + return this; + } + + /** + * Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. + * @return activateAt + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getActivateAt() { + return activateAt; + } + + + public void setActivateAt(OffsetDateTime activateAt) { + this.activateAt = activateAt; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -146,12 +176,13 @@ public boolean equals(java.lang.Object o) { } BulkOperationOnCampaigns bulkOperationOnCampaigns = (BulkOperationOnCampaigns) o; return Objects.equals(this.operation, bulkOperationOnCampaigns.operation) && - Objects.equals(this.campaignIds, bulkOperationOnCampaigns.campaignIds); + Objects.equals(this.campaignIds, bulkOperationOnCampaigns.campaignIds) && + Objects.equals(this.activateAt, bulkOperationOnCampaigns.activateAt); } @Override public int hashCode() { - return Objects.hash(operation, campaignIds); + return Objects.hash(operation, campaignIds, activateAt); } @@ -161,6 +192,7 @@ public String toString() { sb.append("class BulkOperationOnCampaigns {\n"); sb.append(" operation: ").append(toIndentedString(operation)).append("\n"); sb.append(" campaignIds: ").append(toIndentedString(campaignIds)).append("\n"); + sb.append(" activateAt: ").append(toIndentedString(activateAt)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/Campaign.java b/src/main/java/one/talon/model/Campaign.java index ed5327f2..a33d9620 100644 --- a/src/main/java/one/talon/model/Campaign.java +++ b/src/main/java/one/talon/model/Campaign.java @@ -32,9 +32,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Campaign */ -@ApiModel(description = "") public class Campaign { public static final String SERIALIZED_NAME_ID = "id"; @@ -349,7 +348,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private Integer templateId; /** - * A campaign state described exactly as in the Campaign Manager. + * The campaign state displayed in the Campaign Manager. */ @JsonAdapter(FrontendStateEnum.Adapter.class) public enum FrontendStateEnum { @@ -361,7 +360,9 @@ public enum FrontendStateEnum { DISABLED("disabled"), - ARCHIVED("archived"); + ARCHIVED("archived"), + + STAGED("staged"); private String value; @@ -409,6 +410,57 @@ public FrontendStateEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_STORES_IMPORTED) private Boolean storesImported; + /** + * The campaign revision state displayed in the Campaign Manager. + */ + @JsonAdapter(RevisionFrontendStateEnum.Adapter.class) + public enum RevisionFrontendStateEnum { + REVISED("revised"), + + PENDING("pending"); + + private String value; + + RevisionFrontendStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RevisionFrontendStateEnum fromValue(String value) { + for (RevisionFrontendStateEnum b : RevisionFrontendStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RevisionFrontendStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RevisionFrontendStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RevisionFrontendStateEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_REVISION_FRONTEND_STATE = "revisionFrontendState"; + @SerializedName(SERIALIZED_NAME_REVISION_FRONTEND_STATE) + private RevisionFrontendStateEnum revisionFrontendState; + public static final String SERIALIZED_NAME_ACTIVE_REVISION_ID = "activeRevisionId"; @SerializedName(SERIALIZED_NAME_ACTIVE_REVISION_ID) private Integer activeRevisionId; @@ -1385,10 +1437,10 @@ public Campaign frontendState(FrontendStateEnum frontendState) { } /** - * A campaign state described exactly as in the Campaign Manager. + * The campaign state displayed in the Campaign Manager. * @return frontendState **/ - @ApiModelProperty(example = "running", required = true, value = "A campaign state described exactly as in the Campaign Manager.") + @ApiModelProperty(example = "running", required = true, value = "The campaign state displayed in the Campaign Manager.") public FrontendStateEnum getFrontendState() { return frontendState; @@ -1422,6 +1474,29 @@ public void setStoresImported(Boolean storesImported) { } + public Campaign revisionFrontendState(RevisionFrontendStateEnum revisionFrontendState) { + + this.revisionFrontendState = revisionFrontendState; + return this; + } + + /** + * The campaign revision state displayed in the Campaign Manager. + * @return revisionFrontendState + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "revised", value = "The campaign revision state displayed in the Campaign Manager.") + + public RevisionFrontendStateEnum getRevisionFrontendState() { + return revisionFrontendState; + } + + + public void setRevisionFrontendState(RevisionFrontendStateEnum revisionFrontendState) { + this.revisionFrontendState = revisionFrontendState; + } + + public Campaign activeRevisionId(Integer activeRevisionId) { this.activeRevisionId = activeRevisionId; @@ -1611,6 +1686,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.templateId, campaign.templateId) && Objects.equals(this.frontendState, campaign.frontendState) && Objects.equals(this.storesImported, campaign.storesImported) && + Objects.equals(this.revisionFrontendState, campaign.revisionFrontendState) && Objects.equals(this.activeRevisionId, campaign.activeRevisionId) && Objects.equals(this.activeRevisionVersionId, campaign.activeRevisionVersionId) && Objects.equals(this.version, campaign.version) && @@ -1621,7 +1697,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, created, applicationId, userId, name, description, startTime, endTime, attributes, state, activeRulesetId, tags, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds, budgets, couponRedemptionCount, referralRedemptionCount, discountCount, discountEffectCount, couponCreationCount, customEffectCount, referralCreationCount, addFreeItemEffectCount, awardedGiveawaysCount, createdLoyaltyPointsCount, createdLoyaltyPointsEffectCount, redeemedLoyaltyPointsCount, redeemedLoyaltyPointsEffectCount, callApiEffectCount, reservecouponEffectCount, lastActivity, updated, createdBy, updatedBy, templateId, frontendState, storesImported, activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision); + return Objects.hash(id, created, applicationId, userId, name, description, startTime, endTime, attributes, state, activeRulesetId, tags, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds, budgets, couponRedemptionCount, referralRedemptionCount, discountCount, discountEffectCount, couponCreationCount, customEffectCount, referralCreationCount, addFreeItemEffectCount, awardedGiveawaysCount, createdLoyaltyPointsCount, createdLoyaltyPointsEffectCount, redeemedLoyaltyPointsCount, redeemedLoyaltyPointsEffectCount, callApiEffectCount, reservecouponEffectCount, lastActivity, updated, createdBy, updatedBy, templateId, frontendState, storesImported, revisionFrontendState, activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision); } @@ -1671,6 +1747,7 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" frontendState: ").append(toIndentedString(frontendState)).append("\n"); sb.append(" storesImported: ").append(toIndentedString(storesImported)).append("\n"); + sb.append(" revisionFrontendState: ").append(toIndentedString(revisionFrontendState)).append("\n"); sb.append(" activeRevisionId: ").append(toIndentedString(activeRevisionId)).append("\n"); sb.append(" activeRevisionVersionId: ").append(toIndentedString(activeRevisionVersionId)).append("\n"); sb.append(" version: ").append(toIndentedString(version)).append("\n"); diff --git a/src/main/java/one/talon/model/CampaignAnalytics.java b/src/main/java/one/talon/model/CampaignAnalytics.java index 2e5c93d9..bce7f06f 100644 --- a/src/main/java/one/talon/model/CampaignAnalytics.java +++ b/src/main/java/one/talon/model/CampaignAnalytics.java @@ -27,9 +27,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CampaignAnalytics */ -@ApiModel(description = "") public class CampaignAnalytics { public static final String SERIALIZED_NAME_DATE = "date"; diff --git a/src/main/java/one/talon/model/CampaignCollection.java b/src/main/java/one/talon/model/CampaignCollection.java index bc9649d3..80cdce71 100644 --- a/src/main/java/one/talon/model/CampaignCollection.java +++ b/src/main/java/one/talon/model/CampaignCollection.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CampaignCollection */ -@ApiModel(description = "") public class CampaignCollection { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java index 76a6ac6d..b27607c7 100644 --- a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java +++ b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CampaignCollectionWithoutPayload */ -@ApiModel(description = "") public class CampaignCollectionWithoutPayload { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CampaignEvaluationGroup.java b/src/main/java/one/talon/model/CampaignEvaluationGroup.java index 40e2ab24..9e3be7a5 100644 --- a/src/main/java/one/talon/model/CampaignEvaluationGroup.java +++ b/src/main/java/one/talon/model/CampaignEvaluationGroup.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * CampaignEvaluationGroup */ -@ApiModel(description = "") public class CampaignEvaluationGroup { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; diff --git a/src/main/java/one/talon/model/CampaignGroup.java b/src/main/java/one/talon/model/CampaignGroup.java index f0e30985..c0465148 100644 --- a/src/main/java/one/talon/model/CampaignGroup.java +++ b/src/main/java/one/talon/model/CampaignGroup.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CampaignGroup */ -@ApiModel(description = "") public class CampaignGroup { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CampaignSet.java b/src/main/java/one/talon/model/CampaignSet.java index ce40b5f1..b58456f3 100644 --- a/src/main/java/one/talon/model/CampaignSet.java +++ b/src/main/java/one/talon/model/CampaignSet.java @@ -26,9 +26,8 @@ import one.talon.model.CampaignSetBranchNode; /** - * + * CampaignSet */ -@ApiModel(description = "") public class CampaignSet { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; diff --git a/src/main/java/one/talon/model/CampaignStoreBudget.java b/src/main/java/one/talon/model/CampaignStoreBudget.java index 8c70e305..8133a2af 100644 --- a/src/main/java/one/talon/model/CampaignStoreBudget.java +++ b/src/main/java/one/talon/model/CampaignStoreBudget.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CampaignStoreBudget */ -@ApiModel(description = "") public class CampaignStoreBudget { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CampaignTemplate.java b/src/main/java/one/talon/model/CampaignTemplate.java index bef04472..a3c94cbd 100644 --- a/src/main/java/one/talon/model/CampaignTemplate.java +++ b/src/main/java/one/talon/model/CampaignTemplate.java @@ -26,15 +26,15 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; import org.threeten.bp.OffsetDateTime; /** - * + * CampaignTemplate */ -@ApiModel(description = "") public class CampaignTemplate { public static final String SERIALIZED_NAME_ID = "id"; @@ -197,6 +197,10 @@ public FeaturesEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_COUPON_SETTINGS) private CodeGeneratorSettings couponSettings; + public static final String SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS = "couponReservationSettings"; + @SerializedName(SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS) + private CampaignTemplateCouponReservationSettings couponReservationSettings; + public static final String SERIALIZED_NAME_REFERRAL_SETTINGS = "referralSettings"; @SerializedName(SERIALIZED_NAME_REFERRAL_SETTINGS) private CodeGeneratorSettings referralSettings; @@ -615,6 +619,29 @@ public void setCouponSettings(CodeGeneratorSettings couponSettings) { } + public CampaignTemplate couponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + + this.couponReservationSettings = couponReservationSettings; + return this; + } + + /** + * Get couponReservationSettings + * @return couponReservationSettings + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public CampaignTemplateCouponReservationSettings getCouponReservationSettings() { + return couponReservationSettings; + } + + + public void setCouponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + this.couponReservationSettings = couponReservationSettings; + } + + public CampaignTemplate referralSettings(CodeGeneratorSettings referralSettings) { this.referralSettings = referralSettings; @@ -715,7 +742,7 @@ public CampaignTemplate addApplicationsIdsItem(Integer applicationsIdsItem) { * A list of IDs of the Applications that are subscribed to this campaign template. * @return applicationsIds **/ - @ApiModelProperty(required = true, value = "A list of IDs of the Applications that are subscribed to this campaign template.") + @ApiModelProperty(example = "[1, 2, 3, 1, 2, 3]", required = true, value = "A list of IDs of the Applications that are subscribed to this campaign template.") public List getApplicationsIds() { return applicationsIds; @@ -899,6 +926,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tags, campaignTemplate.tags) && Objects.equals(this.features, campaignTemplate.features) && Objects.equals(this.couponSettings, campaignTemplate.couponSettings) && + Objects.equals(this.couponReservationSettings, campaignTemplate.couponReservationSettings) && Objects.equals(this.referralSettings, campaignTemplate.referralSettings) && Objects.equals(this.limits, campaignTemplate.limits) && Objects.equals(this.templateParams, campaignTemplate.templateParams) && @@ -913,7 +941,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, created, accountId, userId, name, description, instructions, campaignAttributes, couponAttributes, state, activeRulesetId, tags, features, couponSettings, referralSettings, limits, templateParams, applicationsIds, campaignCollections, defaultCampaignGroupId, campaignType, updated, updatedBy, validApplicationIds); + return Objects.hash(id, created, accountId, userId, name, description, instructions, campaignAttributes, couponAttributes, state, activeRulesetId, tags, features, couponSettings, couponReservationSettings, referralSettings, limits, templateParams, applicationsIds, campaignCollections, defaultCampaignGroupId, campaignType, updated, updatedBy, validApplicationIds); } @@ -935,6 +963,7 @@ public String toString() { sb.append(" tags: ").append(toIndentedString(tags)).append("\n"); sb.append(" features: ").append(toIndentedString(features)).append("\n"); sb.append(" couponSettings: ").append(toIndentedString(couponSettings)).append("\n"); + sb.append(" couponReservationSettings: ").append(toIndentedString(couponReservationSettings)).append("\n"); sb.append(" referralSettings: ").append(toIndentedString(referralSettings)).append("\n"); sb.append(" limits: ").append(toIndentedString(limits)).append("\n"); sb.append(" templateParams: ").append(toIndentedString(templateParams)).append("\n"); diff --git a/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java new file mode 100644 index 00000000..3f1385d5 --- /dev/null +++ b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java @@ -0,0 +1,130 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * CampaignTemplateCouponReservationSettings + */ + +public class CampaignTemplateCouponReservationSettings { + public static final String SERIALIZED_NAME_RESERVATION_LIMIT = "reservationLimit"; + @SerializedName(SERIALIZED_NAME_RESERVATION_LIMIT) + private Integer reservationLimit; + + public static final String SERIALIZED_NAME_IS_RESERVATION_MANDATORY = "isReservationMandatory"; + @SerializedName(SERIALIZED_NAME_IS_RESERVATION_MANDATORY) + private Boolean isReservationMandatory = false; + + + public CampaignTemplateCouponReservationSettings reservationLimit(Integer reservationLimit) { + + this.reservationLimit = reservationLimit; + return this; + } + + /** + * The number of reservations that can be made with this coupon code. + * minimum: 0 + * maximum: 999999 + * @return reservationLimit + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "45", value = "The number of reservations that can be made with this coupon code. ") + + public Integer getReservationLimit() { + return reservationLimit; + } + + + public void setReservationLimit(Integer reservationLimit) { + this.reservationLimit = reservationLimit; + } + + + public CampaignTemplateCouponReservationSettings isReservationMandatory(Boolean isReservationMandatory) { + + this.isReservationMandatory = isReservationMandatory; + return this; + } + + /** + * An indication of whether the code can be redeemed only if it has been reserved first. + * @return isReservationMandatory + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "false", value = "An indication of whether the code can be redeemed only if it has been reserved first.") + + public Boolean getIsReservationMandatory() { + return isReservationMandatory; + } + + + public void setIsReservationMandatory(Boolean isReservationMandatory) { + this.isReservationMandatory = isReservationMandatory; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CampaignTemplateCouponReservationSettings campaignTemplateCouponReservationSettings = (CampaignTemplateCouponReservationSettings) o; + return Objects.equals(this.reservationLimit, campaignTemplateCouponReservationSettings.reservationLimit) && + Objects.equals(this.isReservationMandatory, campaignTemplateCouponReservationSettings.isReservationMandatory); + } + + @Override + public int hashCode() { + return Objects.hash(reservationLimit, isReservationMandatory); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CampaignTemplateCouponReservationSettings {\n"); + sb.append(" reservationLimit: ").append(toIndentedString(reservationLimit)).append("\n"); + sb.append(" isReservationMandatory: ").append(toIndentedString(isReservationMandatory)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/CampaignVersions.java b/src/main/java/one/talon/model/CampaignVersions.java index 5881b076..72929d62 100644 --- a/src/main/java/one/talon/model/CampaignVersions.java +++ b/src/main/java/one/talon/model/CampaignVersions.java @@ -29,6 +29,57 @@ */ public class CampaignVersions { + /** + * The campaign revision state displayed in the Campaign Manager. + */ + @JsonAdapter(RevisionFrontendStateEnum.Adapter.class) + public enum RevisionFrontendStateEnum { + REVISED("revised"), + + PENDING("pending"); + + private String value; + + RevisionFrontendStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RevisionFrontendStateEnum fromValue(String value) { + for (RevisionFrontendStateEnum b : RevisionFrontendStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RevisionFrontendStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RevisionFrontendStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RevisionFrontendStateEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_REVISION_FRONTEND_STATE = "revisionFrontendState"; + @SerializedName(SERIALIZED_NAME_REVISION_FRONTEND_STATE) + private RevisionFrontendStateEnum revisionFrontendState; + public static final String SERIALIZED_NAME_ACTIVE_REVISION_ID = "activeRevisionId"; @SerializedName(SERIALIZED_NAME_ACTIVE_REVISION_ID) private Integer activeRevisionId; @@ -54,6 +105,29 @@ public class CampaignVersions { private Boolean stageRevision = false; + public CampaignVersions revisionFrontendState(RevisionFrontendStateEnum revisionFrontendState) { + + this.revisionFrontendState = revisionFrontendState; + return this; + } + + /** + * The campaign revision state displayed in the Campaign Manager. + * @return revisionFrontendState + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "revised", value = "The campaign revision state displayed in the Campaign Manager.") + + public RevisionFrontendStateEnum getRevisionFrontendState() { + return revisionFrontendState; + } + + + public void setRevisionFrontendState(RevisionFrontendStateEnum revisionFrontendState) { + this.revisionFrontendState = revisionFrontendState; + } + + public CampaignVersions activeRevisionId(Integer activeRevisionId) { this.activeRevisionId = activeRevisionId; @@ -201,7 +275,8 @@ public boolean equals(java.lang.Object o) { return false; } CampaignVersions campaignVersions = (CampaignVersions) o; - return Objects.equals(this.activeRevisionId, campaignVersions.activeRevisionId) && + return Objects.equals(this.revisionFrontendState, campaignVersions.revisionFrontendState) && + Objects.equals(this.activeRevisionId, campaignVersions.activeRevisionId) && Objects.equals(this.activeRevisionVersionId, campaignVersions.activeRevisionVersionId) && Objects.equals(this.version, campaignVersions.version) && Objects.equals(this.currentRevisionId, campaignVersions.currentRevisionId) && @@ -211,7 +286,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision); + return Objects.hash(revisionFrontendState, activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision); } @@ -219,6 +294,7 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class CampaignVersions {\n"); + sb.append(" revisionFrontendState: ").append(toIndentedString(revisionFrontendState)).append("\n"); sb.append(" activeRevisionId: ").append(toIndentedString(activeRevisionId)).append("\n"); sb.append(" activeRevisionVersionId: ").append(toIndentedString(activeRevisionVersionId)).append("\n"); sb.append(" version: ").append(toIndentedString(version)).append("\n"); diff --git a/src/main/java/one/talon/model/Catalog.java b/src/main/java/one/talon/model/Catalog.java index 613e2794..474e619d 100644 --- a/src/main/java/one/talon/model/Catalog.java +++ b/src/main/java/one/talon/model/Catalog.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Catalog */ -@ApiModel(description = "") public class Catalog { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CatalogItem.java b/src/main/java/one/talon/model/CatalogItem.java index b144663a..9e069c3a 100644 --- a/src/main/java/one/talon/model/CatalogItem.java +++ b/src/main/java/one/talon/model/CatalogItem.java @@ -31,9 +31,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CatalogItem */ -@ApiModel(description = "") public class CatalogItem { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Change.java b/src/main/java/one/talon/model/Change.java index 13b608ae..9633c9ac 100644 --- a/src/main/java/one/talon/model/Change.java +++ b/src/main/java/one/talon/model/Change.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Change */ -@ApiModel(description = "") public class Change { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Collection.java b/src/main/java/one/talon/model/Collection.java index d5cbe53c..43ee20af 100644 --- a/src/main/java/one/talon/model/Collection.java +++ b/src/main/java/one/talon/model/Collection.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Collection */ -@ApiModel(description = "") public class Collection { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CollectionItem.java b/src/main/java/one/talon/model/CollectionItem.java index 752a3169..84762805 100644 --- a/src/main/java/one/talon/model/CollectionItem.java +++ b/src/main/java/one/talon/model/CollectionItem.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * CollectionItem */ -@ApiModel(description = "") public class CollectionItem { public static final String SERIALIZED_NAME_ITEM = "item"; diff --git a/src/main/java/one/talon/model/CollectionWithoutPayload.java b/src/main/java/one/talon/model/CollectionWithoutPayload.java index 392499b9..dd6e4fe8 100644 --- a/src/main/java/one/talon/model/CollectionWithoutPayload.java +++ b/src/main/java/one/talon/model/CollectionWithoutPayload.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CollectionWithoutPayload */ -@ApiModel(description = "") public class CollectionWithoutPayload { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Coupon.java b/src/main/java/one/talon/model/Coupon.java index ffbe9ea5..ab4a482c 100644 --- a/src/main/java/one/talon/model/Coupon.java +++ b/src/main/java/one/talon/model/Coupon.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Coupon */ -@ApiModel(description = "") public class Coupon { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CouponCreationJob.java b/src/main/java/one/talon/model/CouponCreationJob.java index 7b0e4677..1158d91c 100644 --- a/src/main/java/one/talon/model/CouponCreationJob.java +++ b/src/main/java/one/talon/model/CouponCreationJob.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CouponCreationJob */ -@ApiModel(description = "") public class CouponCreationJob { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CouponDeletionFilters.java b/src/main/java/one/talon/model/CouponDeletionFilters.java index 60dcc848..bc016897 100644 --- a/src/main/java/one/talon/model/CouponDeletionFilters.java +++ b/src/main/java/one/talon/model/CouponDeletionFilters.java @@ -117,7 +117,7 @@ public ValidEnum read(final JsonReader jsonReader) throws IOException { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - private String value = "false"; + private String value; public static final String SERIALIZED_NAME_BATCH_ID = "batchId"; @SerializedName(SERIALIZED_NAME_BATCH_ID) diff --git a/src/main/java/one/talon/model/CouponDeletionJob.java b/src/main/java/one/talon/model/CouponDeletionJob.java index b606c7c3..d4df12b0 100644 --- a/src/main/java/one/talon/model/CouponDeletionJob.java +++ b/src/main/java/one/talon/model/CouponDeletionJob.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CouponDeletionJob */ -@ApiModel(description = "") public class CouponDeletionJob { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CreateAchievement.java b/src/main/java/one/talon/model/CreateAchievement.java index 6f130fa5..801c3652 100644 --- a/src/main/java/one/talon/model/CreateAchievement.java +++ b/src/main/java/one/talon/model/CreateAchievement.java @@ -25,6 +25,7 @@ import java.io.IOException; import java.math.BigDecimal; import one.talon.model.TimePoint; +import org.threeten.bp.OffsetDateTime; /** * CreateAchievement @@ -55,6 +56,116 @@ public class CreateAchievement { @SerializedName(SERIALIZED_NAME_PERIOD_END_OVERRIDE) private TimePoint periodEndOverride; + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + */ + @JsonAdapter(RecurrencePolicyEnum.Adapter.class) + public enum RecurrencePolicyEnum { + NO_RECURRENCE("no_recurrence"), + + ON_EXPIRATION("on_expiration"); + + private String value; + + RecurrencePolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RecurrencePolicyEnum fromValue(String value) { + for (RecurrencePolicyEnum b : RecurrencePolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RecurrencePolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RecurrencePolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RecurrencePolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RECURRENCE_POLICY = "recurrencePolicy"; + @SerializedName(SERIALIZED_NAME_RECURRENCE_POLICY) + private RecurrencePolicyEnum recurrencePolicy; + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + */ + @JsonAdapter(ActivationPolicyEnum.Adapter.class) + public enum ActivationPolicyEnum { + USER_ACTION("user_action"), + + FIXED_SCHEDULE("fixed_schedule"); + + private String value; + + ActivationPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActivationPolicyEnum fromValue(String value) { + for (ActivationPolicyEnum b : ActivationPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActivationPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActivationPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActivationPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ACTIVATION_POLICY = "activationPolicy"; + @SerializedName(SERIALIZED_NAME_ACTIVATION_POLICY) + private ActivationPolicyEnum activationPolicy; + + public static final String SERIALIZED_NAME_FIXED_START_DATE = "fixedStartDate"; + @SerializedName(SERIALIZED_NAME_FIXED_START_DATE) + private OffsetDateTime fixedStartDate; + + public static final String SERIALIZED_NAME_END_DATE = "endDate"; + @SerializedName(SERIALIZED_NAME_END_DATE) + private OffsetDateTime endDate; + public CreateAchievement name(String name) { @@ -189,6 +300,98 @@ public void setPeriodEndOverride(TimePoint periodEndOverride) { } + public CreateAchievement recurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + + this.recurrencePolicy = recurrencePolicy; + return this; + } + + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + * @return recurrencePolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "no_recurrence", value = "The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. ") + + public RecurrencePolicyEnum getRecurrencePolicy() { + return recurrencePolicy; + } + + + public void setRecurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + this.recurrencePolicy = recurrencePolicy; + } + + + public CreateAchievement activationPolicy(ActivationPolicyEnum activationPolicy) { + + this.activationPolicy = activationPolicy; + return this; + } + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + * @return activationPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "fixed_schedule", value = "The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. ") + + public ActivationPolicyEnum getActivationPolicy() { + return activationPolicy; + } + + + public void setActivationPolicy(ActivationPolicyEnum activationPolicy) { + this.activationPolicy = activationPolicy; + } + + + public CreateAchievement fixedStartDate(OffsetDateTime fixedStartDate) { + + this.fixedStartDate = fixedStartDate; + return this; + } + + /** + * The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. + * @return fixedStartDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getFixedStartDate() { + return fixedStartDate; + } + + + public void setFixedStartDate(OffsetDateTime fixedStartDate) { + this.fixedStartDate = fixedStartDate; + } + + + public CreateAchievement endDate(OffsetDateTime endDate) { + + this.endDate = endDate; + return this; + } + + /** + * The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. + * @return endDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getEndDate() { + return endDate; + } + + + public void setEndDate(OffsetDateTime endDate) { + this.endDate = endDate; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -203,12 +406,16 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.description, createAchievement.description) && Objects.equals(this.target, createAchievement.target) && Objects.equals(this.period, createAchievement.period) && - Objects.equals(this.periodEndOverride, createAchievement.periodEndOverride); + Objects.equals(this.periodEndOverride, createAchievement.periodEndOverride) && + Objects.equals(this.recurrencePolicy, createAchievement.recurrencePolicy) && + Objects.equals(this.activationPolicy, createAchievement.activationPolicy) && + Objects.equals(this.fixedStartDate, createAchievement.fixedStartDate) && + Objects.equals(this.endDate, createAchievement.endDate); } @Override public int hashCode() { - return Objects.hash(name, title, description, target, period, periodEndOverride); + return Objects.hash(name, title, description, target, period, periodEndOverride, recurrencePolicy, activationPolicy, fixedStartDate, endDate); } @@ -222,6 +429,10 @@ public String toString() { sb.append(" target: ").append(toIndentedString(target)).append("\n"); sb.append(" period: ").append(toIndentedString(period)).append("\n"); sb.append(" periodEndOverride: ").append(toIndentedString(periodEndOverride)).append("\n"); + sb.append(" recurrencePolicy: ").append(toIndentedString(recurrencePolicy)).append("\n"); + sb.append(" activationPolicy: ").append(toIndentedString(activationPolicy)).append("\n"); + sb.append(" fixedStartDate: ").append(toIndentedString(fixedStartDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/CustomEffect.java b/src/main/java/one/talon/model/CustomEffect.java index baefed64..c125f2ae 100644 --- a/src/main/java/one/talon/model/CustomEffect.java +++ b/src/main/java/one/talon/model/CustomEffect.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CustomEffect */ -@ApiModel(description = "") public class CustomEffect { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/CustomerProfile.java b/src/main/java/one/talon/model/CustomerProfile.java index 2c2cffb5..d76f8daa 100644 --- a/src/main/java/one/talon/model/CustomerProfile.java +++ b/src/main/java/one/talon/model/CustomerProfile.java @@ -31,9 +31,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CustomerProfile */ -@ApiModel(description = "") public class CustomerProfile { public static final String SERIALIZED_NAME_ID = "id"; @@ -110,10 +109,10 @@ public CustomerProfile created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; diff --git a/src/main/java/one/talon/model/CustomerSession.java b/src/main/java/one/talon/model/CustomerSession.java index b5a034b8..602ada55 100644 --- a/src/main/java/one/talon/model/CustomerSession.java +++ b/src/main/java/one/talon/model/CustomerSession.java @@ -32,9 +32,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * CustomerSession */ -@ApiModel(description = "") public class CustomerSession { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @@ -155,7 +154,7 @@ public CustomerSession integrationId(String integrationId) { * The integration ID set by your integration layer. * @return integrationId **/ - @ApiModelProperty(required = true, value = "The integration ID set by your integration layer.") + @ApiModelProperty(example = "URNGV8294NV", required = true, value = "The integration ID set by your integration layer.") public String getIntegrationId() { return integrationId; diff --git a/src/main/java/one/talon/model/CustomerSessionV2.java b/src/main/java/one/talon/model/CustomerSessionV2.java index 623934a9..bcbcc047 100644 --- a/src/main/java/one/talon/model/CustomerSessionV2.java +++ b/src/main/java/one/talon/model/CustomerSessionV2.java @@ -33,9 +33,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * The representation of the customer session. */ -@ApiModel(description = "") +@ApiModel(description = "The representation of the customer session.") public class CustomerSessionV2 { public static final String SERIALIZED_NAME_ID = "id"; @@ -199,10 +199,10 @@ public CustomerSessionV2 created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; @@ -514,11 +514,11 @@ public CustomerSessionV2 addIdentifiersItem(String identifiersItem) { } /** - * 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). + * 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). - We recommend passing an anonymized (hashed) version of the identifier value. * @return identifiers **/ @javax.annotation.Nullable - @ApiModelProperty(example = "[91.11.156.141]", value = "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). ") + @ApiModelProperty(example = "[d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea]", value = "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). - We recommend passing an anonymized (hashed) version of the identifier value. ") public List getIdentifiers() { return identifiers; diff --git a/src/main/java/one/talon/model/DeactivateUserRequest.java b/src/main/java/one/talon/model/DeactivateUserRequest.java index 9b7c1397..d8de1ac7 100644 --- a/src/main/java/one/talon/model/DeactivateUserRequest.java +++ b/src/main/java/one/talon/model/DeactivateUserRequest.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * DeactivateUserRequest */ -@ApiModel(description = "") public class DeactivateUserRequest { public static final String SERIALIZED_NAME_EMAIL = "email"; diff --git a/src/main/java/one/talon/model/Effect.java b/src/main/java/one/talon/model/Effect.java index 501a04c7..00b1a918 100644 --- a/src/main/java/one/talon/model/Effect.java +++ b/src/main/java/one/talon/model/Effect.java @@ -25,9 +25,9 @@ import java.io.IOException; /** - * + * A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type. */ -@ApiModel(description = "") +@ApiModel(description = "A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type.") public class Effect { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; diff --git a/src/main/java/one/talon/model/Environment.java b/src/main/java/one/talon/model/Environment.java index ec61c9b4..280b33ec 100644 --- a/src/main/java/one/talon/model/Environment.java +++ b/src/main/java/one/talon/model/Environment.java @@ -39,9 +39,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Environment */ -@ApiModel(description = "") public class Environment { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Event.java b/src/main/java/one/talon/model/Event.java index ab28e5ce..d0d47cf7 100644 --- a/src/main/java/one/talon/model/Event.java +++ b/src/main/java/one/talon/model/Event.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Event */ -@ApiModel(description = "") public class Event { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/EventType.java b/src/main/java/one/talon/model/EventType.java index 8c0c9cc2..819c73b7 100644 --- a/src/main/java/one/talon/model/EventType.java +++ b/src/main/java/one/talon/model/EventType.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * EventType */ -@ApiModel(description = "") public class EventType { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/EventV2.java b/src/main/java/one/talon/model/EventV2.java index 4e73867d..f4659912 100644 --- a/src/main/java/one/talon/model/EventV2.java +++ b/src/main/java/one/talon/model/EventV2.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * EventV2 */ -@ApiModel(description = "") public class EventV2 { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; diff --git a/src/main/java/one/talon/model/Export.java b/src/main/java/one/talon/model/Export.java index 52a3c3bf..f094e39c 100644 --- a/src/main/java/one/talon/model/Export.java +++ b/src/main/java/one/talon/model/Export.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Export */ -@ApiModel(description = "") public class Export { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/FeatureFlag.java b/src/main/java/one/talon/model/FeatureFlag.java index 17ccc0cc..568cf39e 100644 --- a/src/main/java/one/talon/model/FeatureFlag.java +++ b/src/main/java/one/talon/model/FeatureFlag.java @@ -125,7 +125,7 @@ public FeatureFlag modified(OffsetDateTime modified) { * @return modified **/ @javax.annotation.Nullable - @ApiModelProperty(value = "The time this entity was last modified.") + @ApiModelProperty(example = "2021-09-25T10:34:12.956203Z", value = "The time this entity was last modified.") public OffsetDateTime getModified() { return modified; diff --git a/src/main/java/one/talon/model/FeaturesFeed.java b/src/main/java/one/talon/model/FeaturesFeed.java index 2361de24..f2588f12 100644 --- a/src/main/java/one/talon/model/FeaturesFeed.java +++ b/src/main/java/one/talon/model/FeaturesFeed.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * FeaturesFeed */ -@ApiModel(description = "") public class FeaturesFeed { public static final String SERIALIZED_NAME_TITLE = "title"; diff --git a/src/main/java/one/talon/model/GenerateLoyaltyCard.java b/src/main/java/one/talon/model/GenerateLoyaltyCard.java index 87bd2a19..5da6561b 100644 --- a/src/main/java/one/talon/model/GenerateLoyaltyCard.java +++ b/src/main/java/one/talon/model/GenerateLoyaltyCard.java @@ -87,6 +87,10 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE_IDS) private List customerProfileIds = null; + public static final String SERIALIZED_NAME_CARD_IDENTIFIER = "cardIdentifier"; + @SerializedName(SERIALIZED_NAME_CARD_IDENTIFIER) + private String cardIdentifier; + public GenerateLoyaltyCard status(StatusEnum status) { @@ -142,6 +146,29 @@ public void setCustomerProfileIds(List customerProfileIds) { } + public GenerateLoyaltyCard cardIdentifier(String cardIdentifier) { + + this.cardIdentifier = cardIdentifier; + return this; + } + + /** + * The alphanumeric identifier of the loyalty card. + * @return cardIdentifier + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "summer-loyalty-card-0543", value = "The alphanumeric identifier of the loyalty card. ") + + public String getCardIdentifier() { + return cardIdentifier; + } + + + public void setCardIdentifier(String cardIdentifier) { + this.cardIdentifier = cardIdentifier; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -152,12 +179,13 @@ public boolean equals(java.lang.Object o) { } GenerateLoyaltyCard generateLoyaltyCard = (GenerateLoyaltyCard) o; return Objects.equals(this.status, generateLoyaltyCard.status) && - Objects.equals(this.customerProfileIds, generateLoyaltyCard.customerProfileIds); + Objects.equals(this.customerProfileIds, generateLoyaltyCard.customerProfileIds) && + Objects.equals(this.cardIdentifier, generateLoyaltyCard.cardIdentifier); } @Override public int hashCode() { - return Objects.hash(status, customerProfileIds); + return Objects.hash(status, customerProfileIds, cardIdentifier); } @@ -167,6 +195,7 @@ public String toString() { sb.append("class GenerateLoyaltyCard {\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" customerProfileIds: ").append(toIndentedString(customerProfileIds)).append("\n"); + sb.append(" cardIdentifier: ").append(toIndentedString(cardIdentifier)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/Giveaway.java b/src/main/java/one/talon/model/Giveaway.java index f62103f0..7cbc1414 100644 --- a/src/main/java/one/talon/model/Giveaway.java +++ b/src/main/java/one/talon/model/Giveaway.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Giveaway */ -@ApiModel(description = "") public class Giveaway { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/IntegrationCoupon.java b/src/main/java/one/talon/model/IntegrationCoupon.java index 5d4e4de7..5ba8e5c4 100644 --- a/src/main/java/one/talon/model/IntegrationCoupon.java +++ b/src/main/java/one/talon/model/IntegrationCoupon.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * IntegrationCoupon */ -@ApiModel(description = "") public class IntegrationCoupon { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/IntegrationEvent.java b/src/main/java/one/talon/model/IntegrationEvent.java index 1ef174af..7589112a 100644 --- a/src/main/java/one/talon/model/IntegrationEvent.java +++ b/src/main/java/one/talon/model/IntegrationEvent.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * IntegrationEvent */ -@ApiModel(description = "") public class IntegrationEvent { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; diff --git a/src/main/java/one/talon/model/InventoryCoupon.java b/src/main/java/one/talon/model/InventoryCoupon.java index 5fd507f3..2fae67f5 100644 --- a/src/main/java/one/talon/model/InventoryCoupon.java +++ b/src/main/java/one/talon/model/InventoryCoupon.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * InventoryCoupon */ -@ApiModel(description = "") public class InventoryCoupon { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/InventoryReferral.java b/src/main/java/one/talon/model/InventoryReferral.java index e1a77fd8..9d6810cf 100644 --- a/src/main/java/one/talon/model/InventoryReferral.java +++ b/src/main/java/one/talon/model/InventoryReferral.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * InventoryReferral */ -@ApiModel(description = "") public class InventoryReferral { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ItemAttribute.java b/src/main/java/one/talon/model/ItemAttribute.java index 1861be3e..34a4a365 100644 --- a/src/main/java/one/talon/model/ItemAttribute.java +++ b/src/main/java/one/talon/model/ItemAttribute.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * ItemAttribute */ -@ApiModel(description = "") public class ItemAttribute { public static final String SERIALIZED_NAME_ATTRIBUTEID = "attributeid"; diff --git a/src/main/java/one/talon/model/LedgerEntry.java b/src/main/java/one/talon/model/LedgerEntry.java index 6350fa12..1edddddd 100644 --- a/src/main/java/one/talon/model/LedgerEntry.java +++ b/src/main/java/one/talon/model/LedgerEntry.java @@ -26,9 +26,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Entry in the point ledger. */ -@ApiModel(description = "") +@ApiModel(description = "Entry in the point ledger.") public class LedgerEntry { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/LedgerInfo.java b/src/main/java/one/talon/model/LedgerInfo.java index ab37b228..c1280259 100644 --- a/src/main/java/one/talon/model/LedgerInfo.java +++ b/src/main/java/one/talon/model/LedgerInfo.java @@ -27,9 +27,9 @@ import one.talon.model.Tier; /** - * + * The balance in a Loyalty Program for some Customer. */ -@ApiModel(description = "") +@ApiModel(description = "The balance in a Loyalty Program for some Customer.") public class LedgerInfo { public static final String SERIALIZED_NAME_CURRENT_BALANCE = "currentBalance"; diff --git a/src/main/java/one/talon/model/LibraryAttribute.java b/src/main/java/one/talon/model/LibraryAttribute.java index 0606c562..a797621a 100644 --- a/src/main/java/one/talon/model/LibraryAttribute.java +++ b/src/main/java/one/talon/model/LibraryAttribute.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * LibraryAttribute */ -@ApiModel(description = "") public class LibraryAttribute { /** diff --git a/src/main/java/one/talon/model/LimitConfig.java b/src/main/java/one/talon/model/LimitConfig.java index 2627aae2..8da3d28e 100644 --- a/src/main/java/one/talon/model/LimitConfig.java +++ b/src/main/java/one/talon/model/LimitConfig.java @@ -106,7 +106,9 @@ public enum EntitiesEnum { PROFILE("Profile"), - IDENTIFIER("Identifier"); + IDENTIFIER("Identifier"), + + STORE("Store"); private String value; diff --git a/src/main/java/one/talon/model/LimitCounter.java b/src/main/java/one/talon/model/LimitCounter.java index 51fc3add..a9dc934d 100644 --- a/src/main/java/one/talon/model/LimitCounter.java +++ b/src/main/java/one/talon/model/LimitCounter.java @@ -26,9 +26,8 @@ import java.math.BigDecimal; /** - * + * LimitCounter */ -@ApiModel(description = "") public class LimitCounter { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; diff --git a/src/main/java/one/talon/model/ListCampaignStoreBudgets.java b/src/main/java/one/talon/model/ListCampaignStoreBudgets.java new file mode 100644 index 00000000..af82bff9 --- /dev/null +++ b/src/main/java/one/talon/model/ListCampaignStoreBudgets.java @@ -0,0 +1,184 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import one.talon.model.ListCampaignStoreBudgetsStore; + +/** + * ListCampaignStoreBudgets + */ + +public class ListCampaignStoreBudgets { + public static final String SERIALIZED_NAME_STORE = "store"; + @SerializedName(SERIALIZED_NAME_STORE) + private ListCampaignStoreBudgetsStore store; + + public static final String SERIALIZED_NAME_LIMIT = "limit"; + @SerializedName(SERIALIZED_NAME_LIMIT) + private Integer limit; + + public static final String SERIALIZED_NAME_ACTION = "action"; + @SerializedName(SERIALIZED_NAME_ACTION) + private String action; + + public static final String SERIALIZED_NAME_PERIOD = "period"; + @SerializedName(SERIALIZED_NAME_PERIOD) + private String period; + + + public ListCampaignStoreBudgets store(ListCampaignStoreBudgetsStore store) { + + this.store = store; + return this; + } + + /** + * Get store + * @return store + **/ + @ApiModelProperty(required = true, value = "") + + public ListCampaignStoreBudgetsStore getStore() { + return store; + } + + + public void setStore(ListCampaignStoreBudgetsStore store) { + this.store = store; + } + + + public ListCampaignStoreBudgets limit(Integer limit) { + + this.limit = limit; + return this; + } + + /** + * Get limit + * @return limit + **/ + @ApiModelProperty(required = true, value = "") + + public Integer getLimit() { + return limit; + } + + + public void setLimit(Integer limit) { + this.limit = limit; + } + + + public ListCampaignStoreBudgets action(String action) { + + this.action = action; + return this; + } + + /** + * Get action + * @return action + **/ + @ApiModelProperty(required = true, value = "") + + public String getAction() { + return action; + } + + + public void setAction(String action) { + this.action = action; + } + + + public ListCampaignStoreBudgets period(String period) { + + this.period = period; + return this; + } + + /** + * Get period + * @return period + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public String getPeriod() { + return period; + } + + + public void setPeriod(String period) { + this.period = period; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ListCampaignStoreBudgets listCampaignStoreBudgets = (ListCampaignStoreBudgets) o; + return Objects.equals(this.store, listCampaignStoreBudgets.store) && + Objects.equals(this.limit, listCampaignStoreBudgets.limit) && + Objects.equals(this.action, listCampaignStoreBudgets.action) && + Objects.equals(this.period, listCampaignStoreBudgets.period); + } + + @Override + public int hashCode() { + return Objects.hash(store, limit, action, period); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ListCampaignStoreBudgets {\n"); + sb.append(" store: ").append(toIndentedString(store)).append("\n"); + sb.append(" limit: ").append(toIndentedString(limit)).append("\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append(" period: ").append(toIndentedString(period)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java b/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java new file mode 100644 index 00000000..a402aa05 --- /dev/null +++ b/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java @@ -0,0 +1,154 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ListCampaignStoreBudgetsStore + */ + +public class ListCampaignStoreBudgetsStore { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private Integer id; + + public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; + @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) + private String integrationId; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + + public ListCampaignStoreBudgetsStore id(Integer id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @ApiModelProperty(required = true, value = "") + + public Integer getId() { + return id; + } + + + public void setId(Integer id) { + this.id = id; + } + + + public ListCampaignStoreBudgetsStore integrationId(String integrationId) { + + this.integrationId = integrationId; + return this; + } + + /** + * Get integrationId + * @return integrationId + **/ + @ApiModelProperty(required = true, value = "") + + public String getIntegrationId() { + return integrationId; + } + + + public void setIntegrationId(String integrationId) { + this.integrationId = integrationId; + } + + + public ListCampaignStoreBudgetsStore name(String name) { + + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @ApiModelProperty(required = true, value = "") + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ListCampaignStoreBudgetsStore listCampaignStoreBudgetsStore = (ListCampaignStoreBudgetsStore) o; + return Objects.equals(this.id, listCampaignStoreBudgetsStore.id) && + Objects.equals(this.integrationId, listCampaignStoreBudgetsStore.integrationId) && + Objects.equals(this.name, listCampaignStoreBudgetsStore.name); + } + + @Override + public int hashCode() { + return Objects.hash(id, integrationId, name); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ListCampaignStoreBudgetsStore {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" integrationId: ").append(toIndentedString(integrationId)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/LoginParams.java b/src/main/java/one/talon/model/LoginParams.java index 3f785f6f..c09cbbc2 100644 --- a/src/main/java/one/talon/model/LoginParams.java +++ b/src/main/java/one/talon/model/LoginParams.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * LoginParams */ -@ApiModel(description = "") public class LoginParams { public static final String SERIALIZED_NAME_EMAIL = "email"; diff --git a/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java b/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java index 8cb9f589..cea8eadc 100644 --- a/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java +++ b/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java @@ -28,9 +28,9 @@ import one.talon.model.Tier; /** - * + * Point balance of a ledger in the Loyalty Program. */ -@ApiModel(description = "") +@ApiModel(description = "Point balance of a ledger in the Loyalty Program.") public class LoyaltyBalanceWithTier { public static final String SERIALIZED_NAME_ACTIVE_POINTS = "activePoints"; diff --git a/src/main/java/one/talon/model/LoyaltyCard.java b/src/main/java/one/talon/model/LoyaltyCard.java index b8d3421f..c38fd6db 100644 --- a/src/main/java/one/talon/model/LoyaltyCard.java +++ b/src/main/java/one/talon/model/LoyaltyCard.java @@ -32,9 +32,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * LoyaltyCard */ -@ApiModel(description = "") public class LoyaltyCard { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/LoyaltyCardBalances.java b/src/main/java/one/talon/model/LoyaltyCardBalances.java index f40209e3..ec2f2847 100644 --- a/src/main/java/one/talon/model/LoyaltyCardBalances.java +++ b/src/main/java/one/talon/model/LoyaltyCardBalances.java @@ -31,9 +31,9 @@ import one.talon.model.LoyaltyCardProfileRegistration; /** - * + * List of customer profiles linked to the loyalty card. */ -@ApiModel(description = "") +@ApiModel(description = "List of customer profiles linked to the loyalty card.") public class LoyaltyCardBalances { public static final String SERIALIZED_NAME_BALANCE = "balance"; diff --git a/src/main/java/one/talon/model/LoyaltyCardBatch.java b/src/main/java/one/talon/model/LoyaltyCardBatch.java index 538ac6f6..a5bb9eb6 100644 --- a/src/main/java/one/talon/model/LoyaltyCardBatch.java +++ b/src/main/java/one/talon/model/LoyaltyCardBatch.java @@ -23,11 +23,11 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import one.talon.model.CodeGeneratorSettings; /** - * + * LoyaltyCardBatch */ -@ApiModel(description = "") public class LoyaltyCardBatch { public static final String SERIALIZED_NAME_NUMBER_OF_CARDS = "numberOfCards"; @@ -89,6 +89,10 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_STATUS) private StatusEnum status = StatusEnum.ACTIVE; + public static final String SERIALIZED_NAME_CARD_CODE_SETTINGS = "cardCodeSettings"; + @SerializedName(SERIALIZED_NAME_CARD_CODE_SETTINGS) + private CodeGeneratorSettings cardCodeSettings; + public LoyaltyCardBatch numberOfCards(Integer numberOfCards) { @@ -158,6 +162,29 @@ public void setStatus(StatusEnum status) { } + public LoyaltyCardBatch cardCodeSettings(CodeGeneratorSettings cardCodeSettings) { + + this.cardCodeSettings = cardCodeSettings; + return this; + } + + /** + * Get cardCodeSettings + * @return cardCodeSettings + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public CodeGeneratorSettings getCardCodeSettings() { + return cardCodeSettings; + } + + + public void setCardCodeSettings(CodeGeneratorSettings cardCodeSettings) { + this.cardCodeSettings = cardCodeSettings; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -169,12 +196,13 @@ public boolean equals(java.lang.Object o) { LoyaltyCardBatch loyaltyCardBatch = (LoyaltyCardBatch) o; return Objects.equals(this.numberOfCards, loyaltyCardBatch.numberOfCards) && Objects.equals(this.batchId, loyaltyCardBatch.batchId) && - Objects.equals(this.status, loyaltyCardBatch.status); + Objects.equals(this.status, loyaltyCardBatch.status) && + Objects.equals(this.cardCodeSettings, loyaltyCardBatch.cardCodeSettings); } @Override public int hashCode() { - return Objects.hash(numberOfCards, batchId, status); + return Objects.hash(numberOfCards, batchId, status, cardCodeSettings); } @@ -185,6 +213,7 @@ public String toString() { sb.append(" numberOfCards: ").append(toIndentedString(numberOfCards)).append("\n"); sb.append(" batchId: ").append(toIndentedString(batchId)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" cardCodeSettings: ").append(toIndentedString(cardCodeSettings)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/LoyaltyMembership.java b/src/main/java/one/talon/model/LoyaltyMembership.java index bd231bd8..40e1ab44 100644 --- a/src/main/java/one/talon/model/LoyaltyMembership.java +++ b/src/main/java/one/talon/model/LoyaltyMembership.java @@ -50,7 +50,7 @@ public LoyaltyMembership joined(OffsetDateTime joined) { * @return joined **/ @javax.annotation.Nullable - @ApiModelProperty(value = "The moment in which the loyalty program was joined.") + @ApiModelProperty(example = "2012-03-20T14:15:22Z", value = "The moment in which the loyalty program was joined.") public OffsetDateTime getJoined() { return joined; diff --git a/src/main/java/one/talon/model/LoyaltyProgram.java b/src/main/java/one/talon/model/LoyaltyProgram.java index 79f30c64..91bc2a26 100644 --- a/src/main/java/one/talon/model/LoyaltyProgram.java +++ b/src/main/java/one/talon/model/LoyaltyProgram.java @@ -30,9 +30,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * A Loyalty Program */ -@ApiModel(description = "") +@ApiModel(description = "A Loyalty Program") public class LoyaltyProgram { public static final String SERIALIZED_NAME_ID = "id"; @@ -246,6 +246,57 @@ public TiersDowngradePolicyEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName(SERIALIZED_NAME_CARD_CODE_SETTINGS) private CodeGeneratorSettings cardCodeSettings; + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + */ + @JsonAdapter(ReturnPolicyEnum.Adapter.class) + public enum ReturnPolicyEnum { + ONLY_PENDING("only_pending"), + + WITHIN_BALANCE("within_balance"); + + private String value; + + ReturnPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReturnPolicyEnum fromValue(String value) { + for (ReturnPolicyEnum b : ReturnPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReturnPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReturnPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReturnPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RETURN_POLICY = "returnPolicy"; + @SerializedName(SERIALIZED_NAME_RETURN_POLICY) + private ReturnPolicyEnum returnPolicy; + public static final String SERIALIZED_NAME_ACCOUNT_I_D = "accountID"; @SerializedName(SERIALIZED_NAME_ACCOUNT_I_D) private Integer accountID; @@ -294,10 +345,10 @@ public LoyaltyProgram id(Integer id) { } /** - * The ID of loyalty program. Internal ID of this entity. + * The ID of loyalty program. * @return id **/ - @ApiModelProperty(required = true, value = "The ID of loyalty program. Internal ID of this entity.") + @ApiModelProperty(example = "139", required = true, value = "The ID of loyalty program.") public Integer getId() { return id; @@ -652,6 +703,29 @@ public void setCardCodeSettings(CodeGeneratorSettings cardCodeSettings) { } + public LoyaltyProgram returnPolicy(ReturnPolicyEnum returnPolicy) { + + this.returnPolicy = returnPolicy; + return this; + } + + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + * @return returnPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. ") + + public ReturnPolicyEnum getReturnPolicy() { + return returnPolicy; + } + + + public void setReturnPolicy(ReturnPolicyEnum returnPolicy) { + this.returnPolicy = returnPolicy; + } + + public LoyaltyProgram accountID(Integer accountID) { this.accountID = accountID; @@ -911,6 +985,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tiersExpireIn, loyaltyProgram.tiersExpireIn) && Objects.equals(this.tiersDowngradePolicy, loyaltyProgram.tiersDowngradePolicy) && Objects.equals(this.cardCodeSettings, loyaltyProgram.cardCodeSettings) && + Objects.equals(this.returnPolicy, loyaltyProgram.returnPolicy) && Objects.equals(this.accountID, loyaltyProgram.accountID) && Objects.equals(this.name, loyaltyProgram.name) && Objects.equals(this.tiers, loyaltyProgram.tiers) && @@ -925,7 +1000,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, created, title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, accountID, name, tiers, timezone, cardBased, canUpdateTiers, canUpdateJoinPolicy, canUpdateTierExpirationPolicy, canUpgradeToAdvancedTiers, canUpdateSubledgers); + return Objects.hash(id, created, title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, returnPolicy, accountID, name, tiers, timezone, cardBased, canUpdateTiers, canUpdateJoinPolicy, canUpdateTierExpirationPolicy, canUpgradeToAdvancedTiers, canUpdateSubledgers); } @@ -949,6 +1024,7 @@ public String toString() { sb.append(" tiersExpireIn: ").append(toIndentedString(tiersExpireIn)).append("\n"); sb.append(" tiersDowngradePolicy: ").append(toIndentedString(tiersDowngradePolicy)).append("\n"); sb.append(" cardCodeSettings: ").append(toIndentedString(cardCodeSettings)).append("\n"); + sb.append(" returnPolicy: ").append(toIndentedString(returnPolicy)).append("\n"); sb.append(" accountID: ").append(toIndentedString(accountID)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" tiers: ").append(toIndentedString(tiers)).append("\n"); diff --git a/src/main/java/one/talon/model/LoyaltyTier.java b/src/main/java/one/talon/model/LoyaltyTier.java index 2b9ab016..d99c6c84 100644 --- a/src/main/java/one/talon/model/LoyaltyTier.java +++ b/src/main/java/one/talon/model/LoyaltyTier.java @@ -27,9 +27,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * A tier in a loyalty program. */ -@ApiModel(description = "") +@ApiModel(description = "A tier in a loyalty program.") public class LoyaltyTier { public static final String SERIALIZED_NAME_ID = "id"; @@ -126,10 +126,10 @@ public LoyaltyTier name(String name) { } /** - * The name of the tier + * The name of the tier. * @return name **/ - @ApiModelProperty(example = "Gold", required = true, value = "The name of the tier") + @ApiModelProperty(example = "Gold", required = true, value = "The name of the tier.") public String getName() { return name; @@ -148,12 +148,12 @@ public LoyaltyTier minPoints(BigDecimal minPoints) { } /** - * The minimum amount of points required to be eligible for the tier. + * The minimum amount of points required to enter the tier. * minimum: 0 * maximum: 999999999999.99 * @return minPoints **/ - @ApiModelProperty(example = "300.0", required = true, value = "The minimum amount of points required to be eligible for the tier.") + @ApiModelProperty(example = "300.0", required = true, value = "The minimum amount of points required to enter the tier.") public BigDecimal getMinPoints() { return minPoints; diff --git a/src/main/java/one/talon/model/ManagementKey.java b/src/main/java/one/talon/model/ManagementKey.java index 51201eb3..e37d3fad 100644 --- a/src/main/java/one/talon/model/ManagementKey.java +++ b/src/main/java/one/talon/model/ManagementKey.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ManagementKey */ -@ApiModel(description = "") public class ManagementKey { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/MessageLogEntry.java b/src/main/java/one/talon/model/MessageLogEntry.java index b9cf1b1f..3aadc98b 100644 --- a/src/main/java/one/talon/model/MessageLogEntry.java +++ b/src/main/java/one/talon/model/MessageLogEntry.java @@ -53,6 +53,14 @@ public class MessageLogEntry { @SerializedName(SERIALIZED_NAME_NOTIFICATION_NAME) private String notificationName; + public static final String SERIALIZED_NAME_WEBHOOK_ID = "webhookId"; + @SerializedName(SERIALIZED_NAME_WEBHOOK_ID) + private Integer webhookId; + + public static final String SERIALIZED_NAME_WEBHOOK_NAME = "webhookName"; + @SerializedName(SERIALIZED_NAME_WEBHOOK_NAME) + private String webhookName; + public static final String SERIALIZED_NAME_REQUEST = "request"; @SerializedName(SERIALIZED_NAME_REQUEST) private MessageLogRequest request; @@ -66,13 +74,15 @@ public class MessageLogEntry { private OffsetDateTime createdAt; /** - * The entity type the notification is related to. + * The entity type the log is related to. */ @JsonAdapter(EntityTypeEnum.Adapter.class) public enum EntityTypeEnum { APPLICATION("application"), - LOYALTY_PROGRAM("loyalty_program"); + LOYALTY_PROGRAM("loyalty_program"), + + WEBHOOK("webhook"); private String value; @@ -116,6 +126,10 @@ public EntityTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_ENTITY_TYPE) private EntityTypeEnum entityType; + public static final String SERIALIZED_NAME_URL = "url"; + @SerializedName(SERIALIZED_NAME_URL) + private String url; + public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) private Integer applicationId; @@ -124,6 +138,10 @@ public EntityTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_ID) private Integer loyaltyProgramId; + public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; + @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) + private Integer campaignId; + public MessageLogEntry id(String id) { @@ -238,6 +256,52 @@ public void setNotificationName(String notificationName) { } + public MessageLogEntry webhookId(Integer webhookId) { + + this.webhookId = webhookId; + return this; + } + + /** + * ID of the webhook. + * @return webhookId + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "101", value = "ID of the webhook.") + + public Integer getWebhookId() { + return webhookId; + } + + + public void setWebhookId(Integer webhookId) { + this.webhookId = webhookId; + } + + + public MessageLogEntry webhookName(String webhookName) { + + this.webhookName = webhookName; + return this; + } + + /** + * The name of the webhook. + * @return webhookName + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "My webhook", value = "The name of the webhook.") + + public String getWebhookName() { + return webhookName; + } + + + public void setWebhookName(String webhookName) { + this.webhookName = webhookName; + } + + public MessageLogEntry request(MessageLogRequest request) { this.request = request; @@ -313,11 +377,10 @@ public MessageLogEntry entityType(EntityTypeEnum entityType) { } /** - * The entity type the notification is related to. + * The entity type the log is related to. * @return entityType **/ - @javax.annotation.Nullable - @ApiModelProperty(example = "loyalty_program", value = "The entity type the notification is related to. ") + @ApiModelProperty(example = "loyalty_program", required = true, value = "The entity type the log is related to. ") public EntityTypeEnum getEntityType() { return entityType; @@ -329,6 +392,29 @@ public void setEntityType(EntityTypeEnum entityType) { } + public MessageLogEntry url(String url) { + + this.url = url; + return this; + } + + /** + * The target URL of the request. + * @return url + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "www.my-company.com/my-endpoint-name", value = "The target URL of the request.") + + public String getUrl() { + return url; + } + + + public void setUrl(String url) { + this.url = url; + } + + public MessageLogEntry applicationId(Integer applicationId) { this.applicationId = applicationId; @@ -377,6 +463,30 @@ public void setLoyaltyProgramId(Integer loyaltyProgramId) { } + public MessageLogEntry campaignId(Integer campaignId) { + + this.campaignId = campaignId; + return this; + } + + /** + * Identifier of the campaign. + * minimum: 1 + * @return campaignId + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "2", value = "Identifier of the campaign.") + + public Integer getCampaignId() { + return campaignId; + } + + + public void setCampaignId(Integer campaignId) { + this.campaignId = campaignId; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -391,17 +501,21 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.changeType, messageLogEntry.changeType) && Objects.equals(this.notificationId, messageLogEntry.notificationId) && Objects.equals(this.notificationName, messageLogEntry.notificationName) && + Objects.equals(this.webhookId, messageLogEntry.webhookId) && + Objects.equals(this.webhookName, messageLogEntry.webhookName) && Objects.equals(this.request, messageLogEntry.request) && Objects.equals(this.response, messageLogEntry.response) && Objects.equals(this.createdAt, messageLogEntry.createdAt) && Objects.equals(this.entityType, messageLogEntry.entityType) && + Objects.equals(this.url, messageLogEntry.url) && Objects.equals(this.applicationId, messageLogEntry.applicationId) && - Objects.equals(this.loyaltyProgramId, messageLogEntry.loyaltyProgramId); + Objects.equals(this.loyaltyProgramId, messageLogEntry.loyaltyProgramId) && + Objects.equals(this.campaignId, messageLogEntry.campaignId); } @Override public int hashCode() { - return Objects.hash(id, service, changeType, notificationId, notificationName, request, response, createdAt, entityType, applicationId, loyaltyProgramId); + return Objects.hash(id, service, changeType, notificationId, notificationName, webhookId, webhookName, request, response, createdAt, entityType, url, applicationId, loyaltyProgramId, campaignId); } @@ -414,12 +528,16 @@ public String toString() { sb.append(" changeType: ").append(toIndentedString(changeType)).append("\n"); sb.append(" notificationId: ").append(toIndentedString(notificationId)).append("\n"); sb.append(" notificationName: ").append(toIndentedString(notificationName)).append("\n"); + sb.append(" webhookId: ").append(toIndentedString(webhookId)).append("\n"); + sb.append(" webhookName: ").append(toIndentedString(webhookName)).append("\n"); sb.append(" request: ").append(toIndentedString(request)).append("\n"); sb.append(" response: ").append(toIndentedString(response)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" entityType: ").append(toIndentedString(entityType)).append("\n"); + sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append(" applicationId: ").append(toIndentedString(applicationId)).append("\n"); sb.append(" loyaltyProgramId: ").append(toIndentedString(loyaltyProgramId)).append("\n"); + sb.append(" campaignId: ").append(toIndentedString(campaignId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/ModelImport.java b/src/main/java/one/talon/model/ModelImport.java index 4d24b069..a98c1761 100644 --- a/src/main/java/one/talon/model/ModelImport.java +++ b/src/main/java/one/talon/model/ModelImport.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ModelImport */ -@ApiModel(description = "") public class ModelImport { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/ModelReturn.java b/src/main/java/one/talon/model/ModelReturn.java index 937a299b..07bad781 100644 --- a/src/main/java/one/talon/model/ModelReturn.java +++ b/src/main/java/one/talon/model/ModelReturn.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * ModelReturn */ -@ApiModel(description = "") public class ModelReturn { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/MultipleAudiencesItem.java b/src/main/java/one/talon/model/MultipleAudiencesItem.java index 3966c0da..39919551 100644 --- a/src/main/java/one/talon/model/MultipleAudiencesItem.java +++ b/src/main/java/one/talon/model/MultipleAudiencesItem.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * MultipleAudiencesItem */ -@ApiModel(description = "") public class MultipleAudiencesItem { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/NewAccountSignUp.java b/src/main/java/one/talon/model/NewAccountSignUp.java index e0b92400..2868ebc5 100644 --- a/src/main/java/one/talon/model/NewAccountSignUp.java +++ b/src/main/java/one/talon/model/NewAccountSignUp.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewAccountSignUp */ -@ApiModel(description = "") public class NewAccountSignUp { public static final String SERIALIZED_NAME_EMAIL = "email"; diff --git a/src/main/java/one/talon/model/NewAdditionalCost.java b/src/main/java/one/talon/model/NewAdditionalCost.java index 6b250c4b..acd19ba7 100644 --- a/src/main/java/one/talon/model/NewAdditionalCost.java +++ b/src/main/java/one/talon/model/NewAdditionalCost.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * NewAdditionalCost */ -@ApiModel(description = "") public class NewAdditionalCost { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewApplicationAPIKey.java b/src/main/java/one/talon/model/NewApplicationAPIKey.java index 4c543eba..33c03c6d 100644 --- a/src/main/java/one/talon/model/NewApplicationAPIKey.java +++ b/src/main/java/one/talon/model/NewApplicationAPIKey.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewApplicationAPIKey */ -@ApiModel(description = "") public class NewApplicationAPIKey { public static final String SERIALIZED_NAME_TITLE = "title"; diff --git a/src/main/java/one/talon/model/NewAttribute.java b/src/main/java/one/talon/model/NewAttribute.java index 82797822..22ce8d71 100644 --- a/src/main/java/one/talon/model/NewAttribute.java +++ b/src/main/java/one/talon/model/NewAttribute.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * NewAttribute */ -@ApiModel(description = "") public class NewAttribute { /** diff --git a/src/main/java/one/talon/model/NewAudience.java b/src/main/java/one/talon/model/NewAudience.java index 5aaa227a..8c9c2396 100644 --- a/src/main/java/one/talon/model/NewAudience.java +++ b/src/main/java/one/talon/model/NewAudience.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewAudience */ -@ApiModel(description = "") public class NewAudience { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewBaseNotification.java b/src/main/java/one/talon/model/NewBaseNotification.java index 4f8054a1..a24a3e58 100644 --- a/src/main/java/one/talon/model/NewBaseNotification.java +++ b/src/main/java/one/talon/model/NewBaseNotification.java @@ -26,9 +26,8 @@ import one.talon.model.NewNotificationWebhook; /** - * + * NewBaseNotification */ -@ApiModel(description = "") public class NewBaseNotification { public static final String SERIALIZED_NAME_POLICY = "policy"; diff --git a/src/main/java/one/talon/model/NewCampaign.java b/src/main/java/one/talon/model/NewCampaign.java index 6be6c800..c2ff9038 100644 --- a/src/main/java/one/talon/model/NewCampaign.java +++ b/src/main/java/one/talon/model/NewCampaign.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewCampaign */ -@ApiModel(description = "") public class NewCampaign { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewCampaignCollection.java b/src/main/java/one/talon/model/NewCampaignCollection.java index 45f334b2..eeaca7b4 100644 --- a/src/main/java/one/talon/model/NewCampaignCollection.java +++ b/src/main/java/one/talon/model/NewCampaignCollection.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewCampaignCollection */ -@ApiModel(description = "") public class NewCampaignCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; diff --git a/src/main/java/one/talon/model/NewCampaignSet.java b/src/main/java/one/talon/model/NewCampaignSet.java index 2def3931..f4b06142 100644 --- a/src/main/java/one/talon/model/NewCampaignSet.java +++ b/src/main/java/one/talon/model/NewCampaignSet.java @@ -26,9 +26,8 @@ import one.talon.model.CampaignSetBranchNode; /** - * + * NewCampaignSet */ -@ApiModel(description = "") public class NewCampaignSet { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; diff --git a/src/main/java/one/talon/model/NewCampaignStoreBudget.java b/src/main/java/one/talon/model/NewCampaignStoreBudget.java new file mode 100644 index 00000000..be2cb41e --- /dev/null +++ b/src/main/java/one/talon/model/NewCampaignStoreBudget.java @@ -0,0 +1,259 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import one.talon.model.NewCampaignStoreBudgetStoreLimit; + +/** + * NewCampaignStoreBudget + */ + +public class NewCampaignStoreBudget { + /** + * Gets or Sets action + */ + @JsonAdapter(ActionEnum.Adapter.class) + public enum ActionEnum { + SETDISCOUNT("setDiscount"); + + private String value; + + ActionEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActionEnum fromValue(String value) { + for (ActionEnum b : ActionEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActionEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActionEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActionEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ACTION = "action"; + @SerializedName(SERIALIZED_NAME_ACTION) + private ActionEnum action; + + public static final String SERIALIZED_NAME_STORE_LIMITS = "storeLimits"; + @SerializedName(SERIALIZED_NAME_STORE_LIMITS) + private List storeLimits = new ArrayList(); + + /** + * Gets or Sets period + */ + @JsonAdapter(PeriodEnum.Adapter.class) + public enum PeriodEnum { + DAILY("daily"), + + WEEKLY("weekly"), + + MONTHLY("monthly"), + + YEARLY("yearly"); + + private String value; + + PeriodEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PeriodEnum fromValue(String value) { + for (PeriodEnum b : PeriodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PeriodEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PeriodEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PeriodEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_PERIOD = "period"; + @SerializedName(SERIALIZED_NAME_PERIOD) + private PeriodEnum period; + + + public NewCampaignStoreBudget action(ActionEnum action) { + + this.action = action; + return this; + } + + /** + * Get action + * @return action + **/ + @ApiModelProperty(required = true, value = "") + + public ActionEnum getAction() { + return action; + } + + + public void setAction(ActionEnum action) { + this.action = action; + } + + + public NewCampaignStoreBudget storeLimits(List storeLimits) { + + this.storeLimits = storeLimits; + return this; + } + + public NewCampaignStoreBudget addStoreLimitsItem(NewCampaignStoreBudgetStoreLimit storeLimitsItem) { + this.storeLimits.add(storeLimitsItem); + return this; + } + + /** + * The set of budget limits for stores linked to the campaign. + * @return storeLimits + **/ + @ApiModelProperty(required = true, value = "The set of budget limits for stores linked to the campaign.") + + public List getStoreLimits() { + return storeLimits; + } + + + public void setStoreLimits(List storeLimits) { + this.storeLimits = storeLimits; + } + + + public NewCampaignStoreBudget period(PeriodEnum period) { + + this.period = period; + return this; + } + + /** + * Get period + * @return period + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public PeriodEnum getPeriod() { + return period; + } + + + public void setPeriod(PeriodEnum period) { + this.period = period; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + NewCampaignStoreBudget newCampaignStoreBudget = (NewCampaignStoreBudget) o; + return Objects.equals(this.action, newCampaignStoreBudget.action) && + Objects.equals(this.storeLimits, newCampaignStoreBudget.storeLimits) && + Objects.equals(this.period, newCampaignStoreBudget.period); + } + + @Override + public int hashCode() { + return Objects.hash(action, storeLimits, period); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class NewCampaignStoreBudget {\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append(" storeLimits: ").append(toIndentedString(storeLimits)).append("\n"); + sb.append(" period: ").append(toIndentedString(period)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java b/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java new file mode 100644 index 00000000..34e68198 --- /dev/null +++ b/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java @@ -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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; + +/** + * NewCampaignStoreBudgetStoreLimit + */ + +public class NewCampaignStoreBudgetStoreLimit { + public static final String SERIALIZED_NAME_STORE_ID = "storeId"; + @SerializedName(SERIALIZED_NAME_STORE_ID) + private Integer storeId; + + public static final String SERIALIZED_NAME_LIMIT = "limit"; + @SerializedName(SERIALIZED_NAME_LIMIT) + private BigDecimal limit; + + + public NewCampaignStoreBudgetStoreLimit storeId(Integer storeId) { + + this.storeId = storeId; + return this; + } + + /** + * The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. + * @return storeId + **/ + @ApiModelProperty(example = "17", required = true, value = "The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. ") + + public Integer getStoreId() { + return storeId; + } + + + public void setStoreId(Integer storeId) { + this.storeId = storeId; + } + + + public NewCampaignStoreBudgetStoreLimit limit(BigDecimal limit) { + + this.limit = limit; + return this; + } + + /** + * The value to set for the limit. + * @return limit + **/ + @ApiModelProperty(example = "1000.0", required = true, value = "The value to set for the limit.") + + public BigDecimal getLimit() { + return limit; + } + + + public void setLimit(BigDecimal limit) { + this.limit = limit; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + NewCampaignStoreBudgetStoreLimit newCampaignStoreBudgetStoreLimit = (NewCampaignStoreBudgetStoreLimit) o; + return Objects.equals(this.storeId, newCampaignStoreBudgetStoreLimit.storeId) && + Objects.equals(this.limit, newCampaignStoreBudgetStoreLimit.limit); + } + + @Override + public int hashCode() { + return Objects.hash(storeId, limit); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class NewCampaignStoreBudgetStoreLimit {\n"); + sb.append(" storeId: ").append(toIndentedString(storeId)).append("\n"); + sb.append(" limit: ").append(toIndentedString(limit)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/NewCampaignTemplate.java b/src/main/java/one/talon/model/NewCampaignTemplate.java index 2276a918..afbb60b3 100644 --- a/src/main/java/one/talon/model/NewCampaignTemplate.java +++ b/src/main/java/one/talon/model/NewCampaignTemplate.java @@ -26,6 +26,7 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; @@ -175,6 +176,10 @@ public FeaturesEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_COUPON_SETTINGS) private CodeGeneratorSettings couponSettings; + public static final String SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS = "couponReservationSettings"; + @SerializedName(SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS) + private CampaignTemplateCouponReservationSettings couponReservationSettings; + public static final String SERIALIZED_NAME_REFERRAL_SETTINGS = "referralSettings"; @SerializedName(SERIALIZED_NAME_REFERRAL_SETTINGS) private CodeGeneratorSettings referralSettings; @@ -466,6 +471,29 @@ public void setCouponSettings(CodeGeneratorSettings couponSettings) { } + public NewCampaignTemplate couponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + + this.couponReservationSettings = couponReservationSettings; + return this; + } + + /** + * Get couponReservationSettings + * @return couponReservationSettings + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public CampaignTemplateCouponReservationSettings getCouponReservationSettings() { + return couponReservationSettings; + } + + + public void setCouponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + this.couponReservationSettings = couponReservationSettings; + } + + public NewCampaignTemplate referralSettings(CodeGeneratorSettings referralSettings) { this.referralSettings = referralSettings; @@ -645,6 +673,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tags, newCampaignTemplate.tags) && Objects.equals(this.features, newCampaignTemplate.features) && Objects.equals(this.couponSettings, newCampaignTemplate.couponSettings) && + Objects.equals(this.couponReservationSettings, newCampaignTemplate.couponReservationSettings) && Objects.equals(this.referralSettings, newCampaignTemplate.referralSettings) && Objects.equals(this.limits, newCampaignTemplate.limits) && Objects.equals(this.templateParams, newCampaignTemplate.templateParams) && @@ -655,7 +684,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(name, description, instructions, campaignAttributes, couponAttributes, state, tags, features, couponSettings, referralSettings, limits, templateParams, campaignCollections, defaultCampaignGroupId, campaignType); + return Objects.hash(name, description, instructions, campaignAttributes, couponAttributes, state, tags, features, couponSettings, couponReservationSettings, referralSettings, limits, templateParams, campaignCollections, defaultCampaignGroupId, campaignType); } @@ -672,6 +701,7 @@ public String toString() { sb.append(" tags: ").append(toIndentedString(tags)).append("\n"); sb.append(" features: ").append(toIndentedString(features)).append("\n"); sb.append(" couponSettings: ").append(toIndentedString(couponSettings)).append("\n"); + sb.append(" couponReservationSettings: ").append(toIndentedString(couponReservationSettings)).append("\n"); sb.append(" referralSettings: ").append(toIndentedString(referralSettings)).append("\n"); sb.append(" limits: ").append(toIndentedString(limits)).append("\n"); sb.append(" templateParams: ").append(toIndentedString(templateParams)).append("\n"); diff --git a/src/main/java/one/talon/model/NewCatalog.java b/src/main/java/one/talon/model/NewCatalog.java index be2413eb..d29d1d24 100644 --- a/src/main/java/one/talon/model/NewCatalog.java +++ b/src/main/java/one/talon/model/NewCatalog.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * NewCatalog */ -@ApiModel(description = "") public class NewCatalog { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewCollection.java b/src/main/java/one/talon/model/NewCollection.java index 9286519e..2838e1b8 100644 --- a/src/main/java/one/talon/model/NewCollection.java +++ b/src/main/java/one/talon/model/NewCollection.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * NewCollection */ -@ApiModel(description = "") public class NewCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; diff --git a/src/main/java/one/talon/model/NewCouponCreationJob.java b/src/main/java/one/talon/model/NewCouponCreationJob.java index 37093be5..71ba949d 100644 --- a/src/main/java/one/talon/model/NewCouponCreationJob.java +++ b/src/main/java/one/talon/model/NewCouponCreationJob.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewCouponCreationJob */ -@ApiModel(description = "") public class NewCouponCreationJob { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; diff --git a/src/main/java/one/talon/model/NewCoupons.java b/src/main/java/one/talon/model/NewCoupons.java index 93b5226f..83e44ccc 100644 --- a/src/main/java/one/talon/model/NewCoupons.java +++ b/src/main/java/one/talon/model/NewCoupons.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewCoupons */ -@ApiModel(description = "") public class NewCoupons { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; diff --git a/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java b/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java index c734c8b9..43dca7f3 100644 --- a/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java +++ b/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewCouponsForMultipleRecipients */ -@ApiModel(description = "") public class NewCouponsForMultipleRecipients { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; diff --git a/src/main/java/one/talon/model/NewCustomEffect.java b/src/main/java/one/talon/model/NewCustomEffect.java index ca761af4..65ddfbc4 100644 --- a/src/main/java/one/talon/model/NewCustomEffect.java +++ b/src/main/java/one/talon/model/NewCustomEffect.java @@ -28,9 +28,8 @@ import one.talon.model.TemplateArgDef; /** - * + * NewCustomEffect */ -@ApiModel(description = "") public class NewCustomEffect { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; diff --git a/src/main/java/one/talon/model/NewEventType.java b/src/main/java/one/talon/model/NewEventType.java index 0ab44774..5f1bec9c 100644 --- a/src/main/java/one/talon/model/NewEventType.java +++ b/src/main/java/one/talon/model/NewEventType.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewEventType */ -@ApiModel(description = "") public class NewEventType { public static final String SERIALIZED_NAME_TITLE = "title"; diff --git a/src/main/java/one/talon/model/NewLoyaltyProgram.java b/src/main/java/one/talon/model/NewLoyaltyProgram.java index 13acadef..6c56abe3 100644 --- a/src/main/java/one/talon/model/NewLoyaltyProgram.java +++ b/src/main/java/one/talon/model/NewLoyaltyProgram.java @@ -30,9 +30,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * A new loyalty program */ -@ApiModel(description = "") +@ApiModel(description = "A new loyalty program") public class NewLoyaltyProgram { public static final String SERIALIZED_NAME_TITLE = "title"; @@ -238,6 +238,57 @@ public TiersDowngradePolicyEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName(SERIALIZED_NAME_CARD_CODE_SETTINGS) private CodeGeneratorSettings cardCodeSettings; + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + */ + @JsonAdapter(ReturnPolicyEnum.Adapter.class) + public enum ReturnPolicyEnum { + ONLY_PENDING("only_pending"), + + WITHIN_BALANCE("within_balance"); + + private String value; + + ReturnPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReturnPolicyEnum fromValue(String value) { + for (ReturnPolicyEnum b : ReturnPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReturnPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReturnPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReturnPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RETURN_POLICY = "returnPolicy"; + @SerializedName(SERIALIZED_NAME_RETURN_POLICY) + private ReturnPolicyEnum returnPolicy; + public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) private String name; @@ -581,6 +632,29 @@ public void setCardCodeSettings(CodeGeneratorSettings cardCodeSettings) { } + public NewLoyaltyProgram returnPolicy(ReturnPolicyEnum returnPolicy) { + + this.returnPolicy = returnPolicy; + return this; + } + + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + * @return returnPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. ") + + public ReturnPolicyEnum getReturnPolicy() { + return returnPolicy; + } + + + public void setReturnPolicy(ReturnPolicyEnum returnPolicy) { + this.returnPolicy = returnPolicy; + } + + public NewLoyaltyProgram name(String name) { this.name = name; @@ -701,6 +775,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tiersExpireIn, newLoyaltyProgram.tiersExpireIn) && Objects.equals(this.tiersDowngradePolicy, newLoyaltyProgram.tiersDowngradePolicy) && Objects.equals(this.cardCodeSettings, newLoyaltyProgram.cardCodeSettings) && + Objects.equals(this.returnPolicy, newLoyaltyProgram.returnPolicy) && Objects.equals(this.name, newLoyaltyProgram.name) && Objects.equals(this.tiers, newLoyaltyProgram.tiers) && Objects.equals(this.timezone, newLoyaltyProgram.timezone) && @@ -709,7 +784,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, name, tiers, timezone, cardBased); + return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, returnPolicy, name, tiers, timezone, cardBased); } @@ -731,6 +806,7 @@ public String toString() { sb.append(" tiersExpireIn: ").append(toIndentedString(tiersExpireIn)).append("\n"); sb.append(" tiersDowngradePolicy: ").append(toIndentedString(tiersDowngradePolicy)).append("\n"); sb.append(" cardCodeSettings: ").append(toIndentedString(cardCodeSettings)).append("\n"); + sb.append(" returnPolicy: ").append(toIndentedString(returnPolicy)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" tiers: ").append(toIndentedString(tiers)).append("\n"); sb.append(" timezone: ").append(toIndentedString(timezone)).append("\n"); diff --git a/src/main/java/one/talon/model/NewLoyaltyTier.java b/src/main/java/one/talon/model/NewLoyaltyTier.java index 14b64f80..e0fd0031 100644 --- a/src/main/java/one/talon/model/NewLoyaltyTier.java +++ b/src/main/java/one/talon/model/NewLoyaltyTier.java @@ -47,10 +47,10 @@ public NewLoyaltyTier name(String name) { } /** - * The name of the tier + * The name of the tier. * @return name **/ - @ApiModelProperty(example = "Gold", required = true, value = "The name of the tier") + @ApiModelProperty(example = "Gold", required = true, value = "The name of the tier.") public String getName() { return name; @@ -69,12 +69,12 @@ public NewLoyaltyTier minPoints(BigDecimal minPoints) { } /** - * The minimum amount of points required to be eligible for the tier. + * The minimum amount of points required to enter the tier. * minimum: 0 * maximum: 999999999999.99 * @return minPoints **/ - @ApiModelProperty(example = "300.0", required = true, value = "The minimum amount of points required to be eligible for the tier.") + @ApiModelProperty(example = "300.0", required = true, value = "The minimum amount of points required to enter the tier.") public BigDecimal getMinPoints() { return minPoints; diff --git a/src/main/java/one/talon/model/NewManagementKey.java b/src/main/java/one/talon/model/NewManagementKey.java index 6f97d62d..10378d4b 100644 --- a/src/main/java/one/talon/model/NewManagementKey.java +++ b/src/main/java/one/talon/model/NewManagementKey.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewManagementKey */ -@ApiModel(description = "") public class NewManagementKey { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewMultipleAudiencesItem.java b/src/main/java/one/talon/model/NewMultipleAudiencesItem.java index 7e7d784f..69ef4780 100644 --- a/src/main/java/one/talon/model/NewMultipleAudiencesItem.java +++ b/src/main/java/one/talon/model/NewMultipleAudiencesItem.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewMultipleAudiencesItem */ -@ApiModel(description = "") public class NewMultipleAudiencesItem { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewReferral.java b/src/main/java/one/talon/model/NewReferral.java index 2c2fd5df..4309f840 100644 --- a/src/main/java/one/talon/model/NewReferral.java +++ b/src/main/java/one/talon/model/NewReferral.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * NewReferral */ -@ApiModel(description = "") public class NewReferral { public static final String SERIALIZED_NAME_START_DATE = "startDate"; diff --git a/src/main/java/one/talon/model/NewRole.java b/src/main/java/one/talon/model/NewRole.java index a6fc9c9b..ea2e5a17 100644 --- a/src/main/java/one/talon/model/NewRole.java +++ b/src/main/java/one/talon/model/NewRole.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * NewRole */ -@ApiModel(description = "") public class NewRole { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewRoleV2.java b/src/main/java/one/talon/model/NewRoleV2.java index 04925a67..d4ddd1c6 100644 --- a/src/main/java/one/talon/model/NewRoleV2.java +++ b/src/main/java/one/talon/model/NewRoleV2.java @@ -28,9 +28,8 @@ import one.talon.model.RoleV2Permissions; /** - * + * NewRoleV2 */ -@ApiModel(description = "") public class NewRoleV2 { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewSamlConnection.java b/src/main/java/one/talon/model/NewSamlConnection.java index 5e8762ca..c950e0ba 100644 --- a/src/main/java/one/talon/model/NewSamlConnection.java +++ b/src/main/java/one/talon/model/NewSamlConnection.java @@ -25,9 +25,9 @@ import java.io.IOException; /** - * + * A new SAML 2.0 connection. */ -@ApiModel(description = "") +@ApiModel(description = "A new SAML 2.0 connection.") public class NewSamlConnection { public static final String SERIALIZED_NAME_X509CERTIFICATE = "x509certificate"; diff --git a/src/main/java/one/talon/model/NewStore.java b/src/main/java/one/talon/model/NewStore.java index 45d69fb3..0c288dae 100644 --- a/src/main/java/one/talon/model/NewStore.java +++ b/src/main/java/one/talon/model/NewStore.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewStore */ -@ApiModel(description = "") public class NewStore { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/NewUser.java b/src/main/java/one/talon/model/NewUser.java index 19395edc..0e765e31 100644 --- a/src/main/java/one/talon/model/NewUser.java +++ b/src/main/java/one/talon/model/NewUser.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * NewUser */ -@ApiModel(description = "") public class NewUser { public static final String SERIALIZED_NAME_EMAIL = "email"; diff --git a/src/main/java/one/talon/model/NewWebhook.java b/src/main/java/one/talon/model/NewWebhook.java index 68a66bd7..f6a572b6 100644 --- a/src/main/java/one/talon/model/NewWebhook.java +++ b/src/main/java/one/talon/model/NewWebhook.java @@ -28,9 +28,8 @@ import one.talon.model.TemplateArgDef; /** - * + * NewWebhook */ -@ApiModel(description = "") public class NewWebhook { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; diff --git a/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java b/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java index d52d4c77..900329a0 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * OutgoingIntegrationTemplateWithConfigurationDetails */ -@ApiModel(description = "") public class OutgoingIntegrationTemplateWithConfigurationDetails { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Picklist.java b/src/main/java/one/talon/model/Picklist.java index 495d631b..7bf7aeb0 100644 --- a/src/main/java/one/talon/model/Picklist.java +++ b/src/main/java/one/talon/model/Picklist.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Picklist */ -@ApiModel(description = "") public class Picklist { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Referral.java b/src/main/java/one/talon/model/Referral.java index 9fefb1b9..7a721d80 100644 --- a/src/main/java/one/talon/model/Referral.java +++ b/src/main/java/one/talon/model/Referral.java @@ -26,9 +26,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Referral */ -@ApiModel(description = "") public class Referral { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Revision.java b/src/main/java/one/talon/model/Revision.java index 9c2da01c..6bd243b2 100644 --- a/src/main/java/one/talon/model/Revision.java +++ b/src/main/java/one/talon/model/Revision.java @@ -27,9 +27,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Revision */ -@ApiModel(description = "") public class Revision { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/RevisionVersion.java b/src/main/java/one/talon/model/RevisionVersion.java index a4e184a2..9bfb4a12 100644 --- a/src/main/java/one/talon/model/RevisionVersion.java +++ b/src/main/java/one/talon/model/RevisionVersion.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * RevisionVersion */ -@ApiModel(description = "") public class RevisionVersion { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Role.java b/src/main/java/one/talon/model/Role.java index 31fd2f50..56c53eea 100644 --- a/src/main/java/one/talon/model/Role.java +++ b/src/main/java/one/talon/model/Role.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Role */ -@ApiModel(description = "") public class Role { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/RoleAssign.java b/src/main/java/one/talon/model/RoleAssign.java index f6a7d198..ea565cef 100644 --- a/src/main/java/one/talon/model/RoleAssign.java +++ b/src/main/java/one/talon/model/RoleAssign.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * RoleAssign */ -@ApiModel(description = "") public class RoleAssign { public static final String SERIALIZED_NAME_USERS = "users"; diff --git a/src/main/java/one/talon/model/RoleV2.java b/src/main/java/one/talon/model/RoleV2.java index 5facc0cc..195962ef 100644 --- a/src/main/java/one/talon/model/RoleV2.java +++ b/src/main/java/one/talon/model/RoleV2.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * RoleV2 */ -@ApiModel(description = "") public class RoleV2 { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Ruleset.java b/src/main/java/one/talon/model/Ruleset.java index 90bca77f..cec45907 100644 --- a/src/main/java/one/talon/model/Ruleset.java +++ b/src/main/java/one/talon/model/Ruleset.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Ruleset */ -@ApiModel(description = "") public class Ruleset { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/SamlConnection.java b/src/main/java/one/talon/model/SamlConnection.java index 622f27ce..8e70609c 100644 --- a/src/main/java/one/talon/model/SamlConnection.java +++ b/src/main/java/one/talon/model/SamlConnection.java @@ -26,9 +26,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * A SAML 2.0 connection. */ -@ApiModel(description = "") +@ApiModel(description = "A SAML 2.0 connection.") public class SamlConnection { public static final String SERIALIZED_NAME_ASSERTION_CONSUMER_SERVICE_U_R_L = "assertionConsumerServiceURL"; diff --git a/src/main/java/one/talon/model/ScimNewUser.java b/src/main/java/one/talon/model/ScimNewUser.java index 61c1a283..155b70e4 100644 --- a/src/main/java/one/talon/model/ScimNewUser.java +++ b/src/main/java/one/talon/model/ScimNewUser.java @@ -104,8 +104,7 @@ public ScimNewUser userName(String userName) { * Unique identifier of the user. This is usually an email address. * @return userName **/ - @javax.annotation.Nullable - @ApiModelProperty(example = "john.doe@example.com", value = "Unique identifier of the user. This is usually an email address.") + @ApiModelProperty(example = "john.doe@example.com", required = true, value = "Unique identifier of the user. This is usually an email address.") public String getUserName() { return userName; diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java index fc4a138e..a225ce67 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java @@ -29,6 +29,7 @@ import one.talon.model.ScimServiceProviderConfigResponseChangePassword; import one.talon.model.ScimServiceProviderConfigResponseFilter; import one.talon.model.ScimServiceProviderConfigResponsePatch; +import one.talon.model.ScimServiceProviderConfigResponseSort; /** * Service provider configuration details. @@ -60,6 +61,10 @@ public class ScimServiceProviderConfigResponse { @SerializedName(SERIALIZED_NAME_SCHEMAS) private List schemas = null; + public static final String SERIALIZED_NAME_SORT = "sort"; + @SerializedName(SERIALIZED_NAME_SORT) + private ScimServiceProviderConfigResponseSort sort; + public ScimServiceProviderConfigResponse bulk(ScimServiceProviderConfigResponseBulk bulk) { @@ -207,6 +212,29 @@ public void setSchemas(List schemas) { } + public ScimServiceProviderConfigResponse sort(ScimServiceProviderConfigResponseSort sort) { + + this.sort = sort; + return this; + } + + /** + * Get sort + * @return sort + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public ScimServiceProviderConfigResponseSort getSort() { + return sort; + } + + + public void setSort(ScimServiceProviderConfigResponseSort sort) { + this.sort = sort; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -221,12 +249,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.documentationUri, scimServiceProviderConfigResponse.documentationUri) && Objects.equals(this.filter, scimServiceProviderConfigResponse.filter) && Objects.equals(this.patch, scimServiceProviderConfigResponse.patch) && - Objects.equals(this.schemas, scimServiceProviderConfigResponse.schemas); + Objects.equals(this.schemas, scimServiceProviderConfigResponse.schemas) && + Objects.equals(this.sort, scimServiceProviderConfigResponse.sort); } @Override public int hashCode() { - return Objects.hash(bulk, changePassword, documentationUri, filter, patch, schemas); + return Objects.hash(bulk, changePassword, documentationUri, filter, patch, schemas, sort); } @@ -240,6 +269,7 @@ public String toString() { sb.append(" filter: ").append(toIndentedString(filter)).append("\n"); sb.append(" patch: ").append(toIndentedString(patch)).append("\n"); sb.append(" schemas: ").append(toIndentedString(schemas)).append("\n"); + sb.append(" sort: ").append(toIndentedString(sort)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java new file mode 100644 index 00000000..271efc6a --- /dev/null +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java @@ -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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Configuration settings related to sorting SCIM resources in query responses. + */ +@ApiModel(description = "Configuration settings related to sorting SCIM resources in query responses.") + +public class ScimServiceProviderConfigResponseSort { + public static final String SERIALIZED_NAME_SUPPORTED = "supported"; + @SerializedName(SERIALIZED_NAME_SUPPORTED) + private Boolean supported; + + + public ScimServiceProviderConfigResponseSort supported(Boolean supported) { + + this.supported = supported; + return this; + } + + /** + * Indicates whether the service provider supports sorting operations for ordered query results. + * @return supported + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Indicates whether the service provider supports sorting operations for ordered query results.") + + public Boolean getSupported() { + return supported; + } + + + public void setSupported(Boolean supported) { + this.supported = supported; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ScimServiceProviderConfigResponseSort scimServiceProviderConfigResponseSort = (ScimServiceProviderConfigResponseSort) o; + return Objects.equals(this.supported, scimServiceProviderConfigResponseSort.supported); + } + + @Override + public int hashCode() { + return Objects.hash(supported); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ScimServiceProviderConfigResponseSort {\n"); + sb.append(" supported: ").append(toIndentedString(supported)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/ScimUser.java b/src/main/java/one/talon/model/ScimUser.java index ce6fdad9..16b9f5bf 100644 --- a/src/main/java/one/talon/model/ScimUser.java +++ b/src/main/java/one/talon/model/ScimUser.java @@ -108,8 +108,7 @@ public ScimUser userName(String userName) { * Unique identifier of the user. This is usually an email address. * @return userName **/ - @javax.annotation.Nullable - @ApiModelProperty(example = "john.doe@example.com", value = "Unique identifier of the user. This is usually an email address.") + @ApiModelProperty(example = "john.doe@example.com", required = true, value = "Unique identifier of the user. This is usually an email address.") public String getUserName() { return userName; diff --git a/src/main/java/one/talon/model/Store.java b/src/main/java/one/talon/model/Store.java index 124dabb3..a930fa27 100644 --- a/src/main/java/one/talon/model/Store.java +++ b/src/main/java/one/talon/model/Store.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Store */ -@ApiModel(description = "") public class Store { public static final String SERIALIZED_NAME_ID = "id"; @@ -99,10 +98,10 @@ public Store created(OffsetDateTime created) { } /** - * The time this entity was created. The time this entity was created. + * The time this entity was created. * @return created **/ - @ApiModelProperty(required = true, value = "The time this entity was created. The time this entity was created.") + @ApiModelProperty(example = "2020-02-07T08:15:22Z", required = true, value = "The time this entity was created.") public OffsetDateTime getCreated() { return created; diff --git a/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java b/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java new file mode 100644 index 00000000..8b07f89f --- /dev/null +++ b/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java @@ -0,0 +1,281 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * SummaryCampaignStoreBudget + */ + +public class SummaryCampaignStoreBudget { + /** + * Gets or Sets action + */ + @JsonAdapter(ActionEnum.Adapter.class) + public enum ActionEnum { + REDEEMCOUPON("redeemCoupon"), + + REDEEMREFERRAL("redeemReferral"), + + SETDISCOUNT("setDiscount"), + + SETDISCOUNTEFFECT("setDiscountEffect"), + + CREATECOUPON("createCoupon"), + + CREATEREFERRAL("createReferral"), + + CREATELOYALTYPOINTS("createLoyaltyPoints"), + + REDEEMLOYALTYPOINTS("redeemLoyaltyPoints"), + + CUSTOMEFFECT("customEffect"), + + CREATELOYALTYPOINTSEFFECT("createLoyaltyPointsEffect"), + + REDEEMLOYALTYPOINTSEFFECT("redeemLoyaltyPointsEffect"), + + CALLAPI("callApi"), + + AWARDGIVEAWAY("awardGiveaway"), + + ADDFREEITEMEFFECT("addFreeItemEffect"), + + RESERVECOUPON("reserveCoupon"); + + private String value; + + ActionEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActionEnum fromValue(String value) { + for (ActionEnum b : ActionEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActionEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActionEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActionEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ACTION = "action"; + @SerializedName(SERIALIZED_NAME_ACTION) + private ActionEnum action; + + /** + * Gets or Sets period + */ + @JsonAdapter(PeriodEnum.Adapter.class) + public enum PeriodEnum { + OVERALL("overall"), + + DAILY("daily"), + + WEEKLY("weekly"), + + MONTHLY("monthly"), + + YEARLY("yearly"); + + private String value; + + PeriodEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PeriodEnum fromValue(String value) { + for (PeriodEnum b : PeriodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PeriodEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PeriodEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PeriodEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_PERIOD = "period"; + @SerializedName(SERIALIZED_NAME_PERIOD) + private PeriodEnum period; + + public static final String SERIALIZED_NAME_STORE_COUNT = "storeCount"; + @SerializedName(SERIALIZED_NAME_STORE_COUNT) + private Integer storeCount; + + + public SummaryCampaignStoreBudget action(ActionEnum action) { + + this.action = action; + return this; + } + + /** + * Get action + * @return action + **/ + @ApiModelProperty(required = true, value = "") + + public ActionEnum getAction() { + return action; + } + + + public void setAction(ActionEnum action) { + this.action = action; + } + + + public SummaryCampaignStoreBudget period(PeriodEnum period) { + + this.period = period; + return this; + } + + /** + * Get period + * @return period + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public PeriodEnum getPeriod() { + return period; + } + + + public void setPeriod(PeriodEnum period) { + this.period = period; + } + + + public SummaryCampaignStoreBudget storeCount(Integer storeCount) { + + this.storeCount = storeCount; + return this; + } + + /** + * Get storeCount + * @return storeCount + **/ + @ApiModelProperty(required = true, value = "") + + public Integer getStoreCount() { + return storeCount; + } + + + public void setStoreCount(Integer storeCount) { + this.storeCount = storeCount; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SummaryCampaignStoreBudget summaryCampaignStoreBudget = (SummaryCampaignStoreBudget) o; + return Objects.equals(this.action, summaryCampaignStoreBudget.action) && + Objects.equals(this.period, summaryCampaignStoreBudget.period) && + Objects.equals(this.storeCount, summaryCampaignStoreBudget.storeCount); + } + + @Override + public int hashCode() { + return Objects.hash(action, period, storeCount); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SummaryCampaignStoreBudget {\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append(" period: ").append(toIndentedString(period)).append("\n"); + sb.append(" storeCount: ").append(toIndentedString(storeCount)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/TalangAttribute.java b/src/main/java/one/talon/model/TalangAttribute.java index db689a32..d67bdd37 100644 --- a/src/main/java/one/talon/model/TalangAttribute.java +++ b/src/main/java/one/talon/model/TalangAttribute.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * TalangAttribute */ -@ApiModel(description = "") public class TalangAttribute { /** diff --git a/src/main/java/one/talon/model/TemplateArgDef.java b/src/main/java/one/talon/model/TemplateArgDef.java index 2d06b38b..fc1ca9b3 100644 --- a/src/main/java/one/talon/model/TemplateArgDef.java +++ b/src/main/java/one/talon/model/TemplateArgDef.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * TemplateArgDef */ -@ApiModel(description = "") public class TemplateArgDef { /** diff --git a/src/main/java/one/talon/model/TemplateDef.java b/src/main/java/one/talon/model/TemplateDef.java index 5f1c44ba..2416ceb5 100644 --- a/src/main/java/one/talon/model/TemplateDef.java +++ b/src/main/java/one/talon/model/TemplateDef.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * TemplateDef */ -@ApiModel(description = "") public class TemplateDef { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/TemplateLimitConfig.java b/src/main/java/one/talon/model/TemplateLimitConfig.java index 4bb71a26..f0469d03 100644 --- a/src/main/java/one/talon/model/TemplateLimitConfig.java +++ b/src/main/java/one/talon/model/TemplateLimitConfig.java @@ -28,9 +28,8 @@ import java.util.List; /** - * + * TemplateLimitConfig */ -@ApiModel(description = "") public class TemplateLimitConfig { public static final String SERIALIZED_NAME_ACTION = "action"; @@ -107,7 +106,9 @@ public enum EntitiesEnum { PROFILE("Profile"), - IDENTIFIER("Identifier"); + IDENTIFIER("Identifier"), + + STORE("Store"); private String value; diff --git a/src/main/java/one/talon/model/UpdateAchievement.java b/src/main/java/one/talon/model/UpdateAchievement.java index 5d89e7f7..77e9e2a4 100644 --- a/src/main/java/one/talon/model/UpdateAchievement.java +++ b/src/main/java/one/talon/model/UpdateAchievement.java @@ -25,6 +25,7 @@ import java.io.IOException; import java.math.BigDecimal; import one.talon.model.TimePoint; +import org.threeten.bp.OffsetDateTime; /** * UpdateAchievement @@ -55,6 +56,116 @@ public class UpdateAchievement { @SerializedName(SERIALIZED_NAME_PERIOD_END_OVERRIDE) private TimePoint periodEndOverride; + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + */ + @JsonAdapter(RecurrencePolicyEnum.Adapter.class) + public enum RecurrencePolicyEnum { + NO_RECURRENCE("no_recurrence"), + + ON_EXPIRATION("on_expiration"); + + private String value; + + RecurrencePolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RecurrencePolicyEnum fromValue(String value) { + for (RecurrencePolicyEnum b : RecurrencePolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RecurrencePolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RecurrencePolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RecurrencePolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RECURRENCE_POLICY = "recurrencePolicy"; + @SerializedName(SERIALIZED_NAME_RECURRENCE_POLICY) + private RecurrencePolicyEnum recurrencePolicy; + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + */ + @JsonAdapter(ActivationPolicyEnum.Adapter.class) + public enum ActivationPolicyEnum { + USER_ACTION("user_action"), + + FIXED_SCHEDULE("fixed_schedule"); + + private String value; + + ActivationPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActivationPolicyEnum fromValue(String value) { + for (ActivationPolicyEnum b : ActivationPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActivationPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActivationPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActivationPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ACTIVATION_POLICY = "activationPolicy"; + @SerializedName(SERIALIZED_NAME_ACTIVATION_POLICY) + private ActivationPolicyEnum activationPolicy; + + public static final String SERIALIZED_NAME_FIXED_START_DATE = "fixedStartDate"; + @SerializedName(SERIALIZED_NAME_FIXED_START_DATE) + private OffsetDateTime fixedStartDate; + + public static final String SERIALIZED_NAME_END_DATE = "endDate"; + @SerializedName(SERIALIZED_NAME_END_DATE) + private OffsetDateTime endDate; + public UpdateAchievement name(String name) { @@ -194,6 +305,98 @@ public void setPeriodEndOverride(TimePoint periodEndOverride) { } + public UpdateAchievement recurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + + this.recurrencePolicy = recurrencePolicy; + return this; + } + + /** + * The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. + * @return recurrencePolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "no_recurrence", value = "The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. ") + + public RecurrencePolicyEnum getRecurrencePolicy() { + return recurrencePolicy; + } + + + public void setRecurrencePolicy(RecurrencePolicyEnum recurrencePolicy) { + this.recurrencePolicy = recurrencePolicy; + } + + + public UpdateAchievement activationPolicy(ActivationPolicyEnum activationPolicy) { + + this.activationPolicy = activationPolicy; + return this; + } + + /** + * The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. + * @return activationPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "fixed_schedule", value = "The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. ") + + public ActivationPolicyEnum getActivationPolicy() { + return activationPolicy; + } + + + public void setActivationPolicy(ActivationPolicyEnum activationPolicy) { + this.activationPolicy = activationPolicy; + } + + + public UpdateAchievement fixedStartDate(OffsetDateTime fixedStartDate) { + + this.fixedStartDate = fixedStartDate; + return this; + } + + /** + * The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. + * @return fixedStartDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getFixedStartDate() { + return fixedStartDate; + } + + + public void setFixedStartDate(OffsetDateTime fixedStartDate) { + this.fixedStartDate = fixedStartDate; + } + + + public UpdateAchievement endDate(OffsetDateTime endDate) { + + this.endDate = endDate; + return this; + } + + /** + * The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. + * @return endDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. ") + + public OffsetDateTime getEndDate() { + return endDate; + } + + + public void setEndDate(OffsetDateTime endDate) { + this.endDate = endDate; + } + + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -208,12 +411,16 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.description, updateAchievement.description) && Objects.equals(this.target, updateAchievement.target) && Objects.equals(this.period, updateAchievement.period) && - Objects.equals(this.periodEndOverride, updateAchievement.periodEndOverride); + Objects.equals(this.periodEndOverride, updateAchievement.periodEndOverride) && + Objects.equals(this.recurrencePolicy, updateAchievement.recurrencePolicy) && + Objects.equals(this.activationPolicy, updateAchievement.activationPolicy) && + Objects.equals(this.fixedStartDate, updateAchievement.fixedStartDate) && + Objects.equals(this.endDate, updateAchievement.endDate); } @Override public int hashCode() { - return Objects.hash(name, title, description, target, period, periodEndOverride); + return Objects.hash(name, title, description, target, period, periodEndOverride, recurrencePolicy, activationPolicy, fixedStartDate, endDate); } @@ -227,6 +434,10 @@ public String toString() { sb.append(" target: ").append(toIndentedString(target)).append("\n"); sb.append(" period: ").append(toIndentedString(period)).append("\n"); sb.append(" periodEndOverride: ").append(toIndentedString(periodEndOverride)).append("\n"); + sb.append(" recurrencePolicy: ").append(toIndentedString(recurrencePolicy)).append("\n"); + sb.append(" activationPolicy: ").append(toIndentedString(activationPolicy)).append("\n"); + sb.append(" fixedStartDate: ").append(toIndentedString(fixedStartDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java b/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java index ebe72d10..f31e308d 100644 --- a/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java +++ b/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java @@ -25,9 +25,8 @@ import java.io.IOException; /** - * + * UpdateCampaignEvaluationGroup */ -@ApiModel(description = "") public class UpdateCampaignEvaluationGroup { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/UpdateCampaignGroup.java b/src/main/java/one/talon/model/UpdateCampaignGroup.java index 8c308a8d..19c3e545 100644 --- a/src/main/java/one/talon/model/UpdateCampaignGroup.java +++ b/src/main/java/one/talon/model/UpdateCampaignGroup.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * UpdateCampaignGroup */ -@ApiModel(description = "") public class UpdateCampaignGroup { public static final String SERIALIZED_NAME_NAME = "name"; diff --git a/src/main/java/one/talon/model/UpdateCampaignTemplate.java b/src/main/java/one/talon/model/UpdateCampaignTemplate.java index e54e5856..a65f7d62 100644 --- a/src/main/java/one/talon/model/UpdateCampaignTemplate.java +++ b/src/main/java/one/talon/model/UpdateCampaignTemplate.java @@ -26,6 +26,7 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; @@ -179,6 +180,10 @@ public FeaturesEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_COUPON_SETTINGS) private CodeGeneratorSettings couponSettings; + public static final String SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS = "couponReservationSettings"; + @SerializedName(SERIALIZED_NAME_COUPON_RESERVATION_SETTINGS) + private CampaignTemplateCouponReservationSettings couponReservationSettings; + public static final String SERIALIZED_NAME_REFERRAL_SETTINGS = "referralSettings"; @SerializedName(SERIALIZED_NAME_REFERRAL_SETTINGS) private CodeGeneratorSettings referralSettings; @@ -497,6 +502,29 @@ public void setCouponSettings(CodeGeneratorSettings couponSettings) { } + public UpdateCampaignTemplate couponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + + this.couponReservationSettings = couponReservationSettings; + return this; + } + + /** + * Get couponReservationSettings + * @return couponReservationSettings + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + + public CampaignTemplateCouponReservationSettings getCouponReservationSettings() { + return couponReservationSettings; + } + + + public void setCouponReservationSettings(CampaignTemplateCouponReservationSettings couponReservationSettings) { + this.couponReservationSettings = couponReservationSettings; + } + + public UpdateCampaignTemplate referralSettings(CodeGeneratorSettings referralSettings) { this.referralSettings = referralSettings; @@ -705,6 +733,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tags, updateCampaignTemplate.tags) && Objects.equals(this.features, updateCampaignTemplate.features) && Objects.equals(this.couponSettings, updateCampaignTemplate.couponSettings) && + Objects.equals(this.couponReservationSettings, updateCampaignTemplate.couponReservationSettings) && Objects.equals(this.referralSettings, updateCampaignTemplate.referralSettings) && Objects.equals(this.limits, updateCampaignTemplate.limits) && Objects.equals(this.templateParams, updateCampaignTemplate.templateParams) && @@ -716,7 +745,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(name, description, instructions, campaignAttributes, couponAttributes, state, activeRulesetId, tags, features, couponSettings, referralSettings, limits, templateParams, applicationsIds, campaignCollections, defaultCampaignGroupId, campaignType); + return Objects.hash(name, description, instructions, campaignAttributes, couponAttributes, state, activeRulesetId, tags, features, couponSettings, couponReservationSettings, referralSettings, limits, templateParams, applicationsIds, campaignCollections, defaultCampaignGroupId, campaignType); } @@ -734,6 +763,7 @@ public String toString() { sb.append(" tags: ").append(toIndentedString(tags)).append("\n"); sb.append(" features: ").append(toIndentedString(features)).append("\n"); sb.append(" couponSettings: ").append(toIndentedString(couponSettings)).append("\n"); + sb.append(" couponReservationSettings: ").append(toIndentedString(couponReservationSettings)).append("\n"); sb.append(" referralSettings: ").append(toIndentedString(referralSettings)).append("\n"); sb.append(" limits: ").append(toIndentedString(limits)).append("\n"); sb.append(" templateParams: ").append(toIndentedString(templateParams)).append("\n"); diff --git a/src/main/java/one/talon/model/UpdateCoupon.java b/src/main/java/one/talon/model/UpdateCoupon.java index 88e4e3cc..d98a2a23 100644 --- a/src/main/java/one/talon/model/UpdateCoupon.java +++ b/src/main/java/one/talon/model/UpdateCoupon.java @@ -30,9 +30,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * UpdateCoupon */ -@ApiModel(description = "") public class UpdateCoupon { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; diff --git a/src/main/java/one/talon/model/UpdateCouponBatch.java b/src/main/java/one/talon/model/UpdateCouponBatch.java index 43594a9f..80224607 100644 --- a/src/main/java/one/talon/model/UpdateCouponBatch.java +++ b/src/main/java/one/talon/model/UpdateCouponBatch.java @@ -27,9 +27,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * UpdateCouponBatch */ -@ApiModel(description = "") public class UpdateCouponBatch { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; diff --git a/src/main/java/one/talon/model/UpdateLoyaltyProgram.java b/src/main/java/one/talon/model/UpdateLoyaltyProgram.java index c850b6b9..7e8ee393 100644 --- a/src/main/java/one/talon/model/UpdateLoyaltyProgram.java +++ b/src/main/java/one/talon/model/UpdateLoyaltyProgram.java @@ -30,9 +30,9 @@ import org.threeten.bp.OffsetDateTime; /** - * + * An updated loyalty program. */ -@ApiModel(description = "") +@ApiModel(description = "An updated loyalty program.") public class UpdateLoyaltyProgram { public static final String SERIALIZED_NAME_TITLE = "title"; @@ -238,6 +238,57 @@ public TiersDowngradePolicyEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName(SERIALIZED_NAME_CARD_CODE_SETTINGS) private CodeGeneratorSettings cardCodeSettings; + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + */ + @JsonAdapter(ReturnPolicyEnum.Adapter.class) + public enum ReturnPolicyEnum { + ONLY_PENDING("only_pending"), + + WITHIN_BALANCE("within_balance"); + + private String value; + + ReturnPolicyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReturnPolicyEnum fromValue(String value) { + for (ReturnPolicyEnum b : ReturnPolicyEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReturnPolicyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReturnPolicyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReturnPolicyEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RETURN_POLICY = "returnPolicy"; + @SerializedName(SERIALIZED_NAME_RETURN_POLICY) + private ReturnPolicyEnum returnPolicy; + public static final String SERIALIZED_NAME_TIERS = "tiers"; @SerializedName(SERIALIZED_NAME_TIERS) private List tiers = null; @@ -574,6 +625,29 @@ public void setCardCodeSettings(CodeGeneratorSettings cardCodeSettings) { } + public UpdateLoyaltyProgram returnPolicy(ReturnPolicyEnum returnPolicy) { + + this.returnPolicy = returnPolicy; + return this; + } + + /** + * The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. + * @return returnPolicy + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. ") + + public ReturnPolicyEnum getReturnPolicy() { + return returnPolicy; + } + + + public void setReturnPolicy(ReturnPolicyEnum returnPolicy) { + this.returnPolicy = returnPolicy; + } + + public UpdateLoyaltyProgram tiers(List tiers) { this.tiers = tiers; @@ -628,12 +702,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.tiersExpireIn, updateLoyaltyProgram.tiersExpireIn) && Objects.equals(this.tiersDowngradePolicy, updateLoyaltyProgram.tiersDowngradePolicy) && Objects.equals(this.cardCodeSettings, updateLoyaltyProgram.cardCodeSettings) && + Objects.equals(this.returnPolicy, updateLoyaltyProgram.returnPolicy) && Objects.equals(this.tiers, updateLoyaltyProgram.tiers); } @Override public int hashCode() { - return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, tiers); + return Objects.hash(title, description, subscribedApplications, defaultValidity, defaultPending, allowSubledger, usersPerCardLimit, sandbox, programJoinPolicy, tiersExpirationPolicy, tierCycleStartDate, tiersExpireIn, tiersDowngradePolicy, cardCodeSettings, returnPolicy, tiers); } @@ -655,6 +730,7 @@ public String toString() { sb.append(" tiersExpireIn: ").append(toIndentedString(tiersExpireIn)).append("\n"); sb.append(" tiersDowngradePolicy: ").append(toIndentedString(tiersDowngradePolicy)).append("\n"); sb.append(" cardCodeSettings: ").append(toIndentedString(cardCodeSettings)).append("\n"); + sb.append(" returnPolicy: ").append(toIndentedString(returnPolicy)).append("\n"); sb.append(" tiers: ").append(toIndentedString(tiers)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java b/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java new file mode 100644 index 00000000..a342f16d --- /dev/null +++ b/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java @@ -0,0 +1,160 @@ +/* + * 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. + */ + + +package one.talon.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; + +/** + * Update a tier in a specified loyalty program. + */ +@ApiModel(description = "Update a tier in a specified loyalty program.") + +public class UpdateLoyaltyProgramTier { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private Integer id; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + public static final String SERIALIZED_NAME_MIN_POINTS = "minPoints"; + @SerializedName(SERIALIZED_NAME_MIN_POINTS) + private BigDecimal minPoints; + + + public UpdateLoyaltyProgramTier id(Integer id) { + + this.id = id; + return this; + } + + /** + * The internal ID of the tier. + * @return id + **/ + @ApiModelProperty(example = "6", required = true, value = "The internal ID of the tier.") + + public Integer getId() { + return id; + } + + + public void setId(Integer id) { + this.id = id; + } + + + public UpdateLoyaltyProgramTier name(String name) { + + this.name = name; + return this; + } + + /** + * The name of the tier. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "Gold", value = "The name of the tier.") + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UpdateLoyaltyProgramTier minPoints(BigDecimal minPoints) { + + this.minPoints = minPoints; + return this; + } + + /** + * The minimum amount of points required to enter the tier. + * minimum: 0 + * maximum: 999999999999.99 + * @return minPoints + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "300.0", value = "The minimum amount of points required to enter the tier.") + + public BigDecimal getMinPoints() { + return minPoints; + } + + + public void setMinPoints(BigDecimal minPoints) { + this.minPoints = minPoints; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UpdateLoyaltyProgramTier updateLoyaltyProgramTier = (UpdateLoyaltyProgramTier) o; + return Objects.equals(this.id, updateLoyaltyProgramTier.id) && + Objects.equals(this.name, updateLoyaltyProgramTier.name) && + Objects.equals(this.minPoints, updateLoyaltyProgramTier.minPoints); + } + + @Override + public int hashCode() { + return Objects.hash(id, name, minPoints); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UpdateLoyaltyProgramTier {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" minPoints: ").append(toIndentedString(minPoints)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/one/talon/model/UpdatePicklist.java b/src/main/java/one/talon/model/UpdatePicklist.java index 6f9f8639..68433f4a 100644 --- a/src/main/java/one/talon/model/UpdatePicklist.java +++ b/src/main/java/one/talon/model/UpdatePicklist.java @@ -27,9 +27,8 @@ import java.util.List; /** - * + * UpdatePicklist */ -@ApiModel(description = "") public class UpdatePicklist { /** diff --git a/src/main/java/one/talon/model/User.java b/src/main/java/one/talon/model/User.java index d78cbf30..5b56ced6 100644 --- a/src/main/java/one/talon/model/User.java +++ b/src/main/java/one/talon/model/User.java @@ -28,9 +28,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * User */ -@ApiModel(description = "") public class User { public static final String SERIALIZED_NAME_ID = "id"; diff --git a/src/main/java/one/talon/model/Webhook.java b/src/main/java/one/talon/model/Webhook.java index 5369184c..fd277548 100644 --- a/src/main/java/one/talon/model/Webhook.java +++ b/src/main/java/one/talon/model/Webhook.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * Webhook */ -@ApiModel(description = "") public class Webhook { public static final String SERIALIZED_NAME_ID = "id"; @@ -214,10 +213,10 @@ public Webhook addApplicationIdsItem(Integer applicationIdsItem) { } /** - * The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. + * The IDs of the Applications that are related to this entity. * @return applicationIds **/ - @ApiModelProperty(required = true, value = "The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity.") + @ApiModelProperty(required = true, value = "The IDs of the Applications that are related to this entity.") public List getApplicationIds() { return applicationIds; diff --git a/src/main/java/one/talon/model/WebhookLogEntry.java b/src/main/java/one/talon/model/WebhookLogEntry.java index feaa97af..7afccda3 100644 --- a/src/main/java/one/talon/model/WebhookLogEntry.java +++ b/src/main/java/one/talon/model/WebhookLogEntry.java @@ -168,10 +168,10 @@ public WebhookLogEntry url(String url) { } /** - * Target url of request + * The target URL of the request. * @return url **/ - @ApiModelProperty(example = "www.my-company.com/my-endpoint-name", required = true, value = "Target url of request") + @ApiModelProperty(example = "www.my-company.com/my-endpoint-name", required = true, value = "The target URL of the request.") public String getUrl() { return url; diff --git a/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java b/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java index f6aee7d2..f1ffef73 100644 --- a/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java +++ b/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java @@ -29,9 +29,8 @@ import org.threeten.bp.OffsetDateTime; /** - * + * WebhookWithOutgoingIntegrationDetails */ -@ApiModel(description = "") public class WebhookWithOutgoingIntegrationDetails { public static final String SERIALIZED_NAME_ID = "id"; @@ -226,10 +225,10 @@ public WebhookWithOutgoingIntegrationDetails addApplicationIdsItem(Integer appli } /** - * The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. + * The IDs of the Applications that are related to this entity. * @return applicationIds **/ - @ApiModelProperty(required = true, value = "The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity.") + @ApiModelProperty(required = true, value = "The IDs of the Applications that are related to this entity.") public List getApplicationIds() { return applicationIds; diff --git a/src/test/java/one/talon/api/IntegrationApiTest.java b/src/test/java/one/talon/api/IntegrationApiTest.java index 566f92b8..af321ed9 100644 --- a/src/test/java/one/talon/api/IntegrationApiTest.java +++ b/src/test/java/one/talon/api/IntegrationApiTest.java @@ -186,7 +186,7 @@ public void deleteCouponReservationTest() throws ApiException { /** * Delete customer's personal data * - * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. + * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. * * @throws ApiException * if the Api call fails @@ -255,9 +255,9 @@ public void getCustomerSessionTest() throws ApiException { } /** - * Get customer's loyalty points + * Get customer's loyalty balances * - * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. 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) + * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. 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) * * @throws ApiException * if the Api call fails diff --git a/src/test/java/one/talon/api/ManagementApiTest.java b/src/test/java/one/talon/api/ManagementApiTest.java index 74bf5741..c2840594 100644 --- a/src/test/java/one/talon/api/ManagementApiTest.java +++ b/src/test/java/one/talon/api/ManagementApiTest.java @@ -18,7 +18,6 @@ import one.talon.model.AccountAdditionalCost; import one.talon.model.AccountAnalytics; import one.talon.model.Achievement; -import one.talon.model.ActivateUserRequest; import one.talon.model.AddLoyaltyPoints; import one.talon.model.Application; import one.talon.model.ApplicationApiHealth; @@ -44,7 +43,6 @@ import one.talon.model.CustomerProfileSearchQuery; import one.talon.model.DeactivateUserRequest; import one.talon.model.DeductLoyaltyPoints; -import one.talon.model.DeleteUserRequest; import one.talon.model.ErrorResponse; import one.talon.model.ErrorResponseWithStatus; import one.talon.model.InlineResponse20010; @@ -167,7 +165,7 @@ public class ManagementApiTest { */ @Test public void activateUserByEmailTest() throws ApiException { - ActivateUserRequest body = null; + DeactivateUserRequest body = null; api.activateUserByEmail(body); // TODO: test validations @@ -729,7 +727,7 @@ public void deleteUserTest() throws ApiException { */ @Test public void deleteUserByEmailTest() throws ApiException { - DeleteUserRequest body = null; + DeactivateUserRequest body = null; api.deleteUserByEmail(body); // TODO: test validations @@ -855,7 +853,7 @@ public void exportCollectionItemsTest() throws ApiException { /** * 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 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. * * @throws ApiException * if the Api call fails @@ -1024,7 +1022,8 @@ public void exportLoyaltyCardLedgerTest() throws ApiException { public void exportLoyaltyCardsTest() throws ApiException { Integer loyaltyProgramId = null; String batchId = null; - String response = api.exportLoyaltyCards(loyaltyProgramId, batchId); + String dateFormat = null; + String response = api.exportLoyaltyCards(loyaltyProgramId, batchId, dateFormat); // TODO: test validations } diff --git a/src/test/java/one/talon/model/AchievementTest.java b/src/test/java/one/talon/model/AchievementTest.java index 6bd5adc0..ce3baeca 100644 --- a/src/test/java/one/talon/model/AchievementTest.java +++ b/src/test/java/one/talon/model/AchievementTest.java @@ -107,6 +107,38 @@ public void periodEndOverrideTest() { // TODO: test periodEndOverride } + /** + * Test the property 'recurrencePolicy' + */ + @Test + public void recurrencePolicyTest() { + // TODO: test recurrencePolicy + } + + /** + * Test the property 'activationPolicy' + */ + @Test + public void activationPolicyTest() { + // TODO: test activationPolicy + } + + /** + * Test the property 'fixedStartDate' + */ + @Test + public void fixedStartDateTest() { + // TODO: test fixedStartDate + } + + /** + * Test the property 'endDate' + */ + @Test + public void endDateTest() { + // TODO: test endDate + } + /** * Test the property 'campaignId' */ diff --git a/src/test/java/one/talon/model/ApplicationCampaignStatsTest.java b/src/test/java/one/talon/model/ApplicationCampaignStatsTest.java index f6a609e2..478f8f4b 100644 --- a/src/test/java/one/talon/model/ApplicationCampaignStatsTest.java +++ b/src/test/java/one/talon/model/ApplicationCampaignStatsTest.java @@ -48,6 +48,14 @@ public void disabledTest() { // TODO: test disabled } + /** + * Test the property 'staged' + */ + @Test + public void stagedTest() { + // TODO: test staged + } + /** * Test the property 'scheduled' */ diff --git a/src/test/java/one/talon/model/BaseLoyaltyProgramTest.java b/src/test/java/one/talon/model/BaseLoyaltyProgramTest.java index a31a9741..620afab0 100644 --- a/src/test/java/one/talon/model/BaseLoyaltyProgramTest.java +++ b/src/test/java/one/talon/model/BaseLoyaltyProgramTest.java @@ -156,4 +156,12 @@ public void cardCodeSettingsTest() { // TODO: test cardCodeSettings } + /** + * Test the property 'returnPolicy' + */ + @Test + public void returnPolicyTest() { + // TODO: test returnPolicy + } + } diff --git a/src/test/java/one/talon/model/BulkOperationOnCampaignsTest.java b/src/test/java/one/talon/model/BulkOperationOnCampaignsTest.java index 577daa7f..79d20295 100644 --- a/src/test/java/one/talon/model/BulkOperationOnCampaignsTest.java +++ b/src/test/java/one/talon/model/BulkOperationOnCampaignsTest.java @@ -23,6 +23,7 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; +import org.threeten.bp.OffsetDateTime; import org.junit.Assert; import org.junit.Ignore; import org.junit.Test; @@ -58,4 +59,12 @@ public void campaignIdsTest() { // TODO: test campaignIds } + /** + * Test the property 'activateAt' + */ + @Test + public void activateAtTest() { + // TODO: test activateAt + } + } diff --git a/src/test/java/one/talon/model/CampaignTemplateCouponReservationSettingsTest.java b/src/test/java/one/talon/model/CampaignTemplateCouponReservationSettingsTest.java new file mode 100644 index 00000000..ea9645d7 --- /dev/null +++ b/src/test/java/one/talon/model/CampaignTemplateCouponReservationSettingsTest.java @@ -0,0 +1,59 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for CampaignTemplateCouponReservationSettings + */ +public class CampaignTemplateCouponReservationSettingsTest { + private final CampaignTemplateCouponReservationSettings model = new CampaignTemplateCouponReservationSettings(); + + /** + * Model tests for CampaignTemplateCouponReservationSettings + */ + @Test + public void testCampaignTemplateCouponReservationSettings() { + // TODO: test CampaignTemplateCouponReservationSettings + } + + /** + * Test the property 'reservationLimit' + */ + @Test + public void reservationLimitTest() { + // TODO: test reservationLimit + } + + /** + * Test the property 'isReservationMandatory' + */ + @Test + public void isReservationMandatoryTest() { + // TODO: test isReservationMandatory + } + +} diff --git a/src/test/java/one/talon/model/CampaignTemplateTest.java b/src/test/java/one/talon/model/CampaignTemplateTest.java index c6dcc1fa..d2a8cdba 100644 --- a/src/test/java/one/talon/model/CampaignTemplateTest.java +++ b/src/test/java/one/talon/model/CampaignTemplateTest.java @@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; @@ -159,6 +160,14 @@ public void couponSettingsTest() { // TODO: test couponSettings } + /** + * Test the property 'couponReservationSettings' + */ + @Test + public void couponReservationSettingsTest() { + // TODO: test couponReservationSettings + } + /** * Test the property 'referralSettings' */ diff --git a/src/test/java/one/talon/model/CampaignTest.java b/src/test/java/one/talon/model/CampaignTest.java index 6db2ff3f..c6e3d38b 100644 --- a/src/test/java/one/talon/model/CampaignTest.java +++ b/src/test/java/one/talon/model/CampaignTest.java @@ -383,6 +383,14 @@ public void storesImportedTest() { // TODO: test storesImported } + /** + * Test the property 'revisionFrontendState' + */ + @Test + public void revisionFrontendStateTest() { + // TODO: test revisionFrontendState + } + /** * Test the property 'activeRevisionId' */ diff --git a/src/test/java/one/talon/model/CampaignVersionsTest.java b/src/test/java/one/talon/model/CampaignVersionsTest.java index 843f104f..d76dfd0b 100644 --- a/src/test/java/one/talon/model/CampaignVersionsTest.java +++ b/src/test/java/one/talon/model/CampaignVersionsTest.java @@ -40,6 +40,14 @@ public void testCampaignVersions() { // TODO: test CampaignVersions } + /** + * Test the property 'revisionFrontendState' + */ + @Test + public void revisionFrontendStateTest() { + // TODO: test revisionFrontendState + } + /** * Test the property 'activeRevisionId' */ diff --git a/src/test/java/one/talon/model/CreateAchievementTest.java b/src/test/java/one/talon/model/CreateAchievementTest.java index c666da35..6677b783 100644 --- a/src/test/java/one/talon/model/CreateAchievementTest.java +++ b/src/test/java/one/talon/model/CreateAchievementTest.java @@ -23,6 +23,7 @@ import java.io.IOException; import java.math.BigDecimal; import one.talon.model.TimePoint; +import org.threeten.bp.OffsetDateTime; import org.junit.Assert; import org.junit.Ignore; import org.junit.Test; @@ -90,4 +91,36 @@ public void periodEndOverrideTest() { // TODO: test periodEndOverride } + /** + * Test the property 'recurrencePolicy' + */ + @Test + public void recurrencePolicyTest() { + // TODO: test recurrencePolicy + } + + /** + * Test the property 'activationPolicy' + */ + @Test + public void activationPolicyTest() { + // TODO: test activationPolicy + } + + /** + * Test the property 'fixedStartDate' + */ + @Test + public void fixedStartDateTest() { + // TODO: test fixedStartDate + } + + /** + * Test the property 'endDate' + */ + @Test + public void endDateTest() { + // TODO: test endDate + } + } diff --git a/src/test/java/one/talon/model/GenerateLoyaltyCardTest.java b/src/test/java/one/talon/model/GenerateLoyaltyCardTest.java index 9f562825..71bd3a96 100644 --- a/src/test/java/one/talon/model/GenerateLoyaltyCardTest.java +++ b/src/test/java/one/talon/model/GenerateLoyaltyCardTest.java @@ -58,4 +58,12 @@ public void customerProfileIdsTest() { // TODO: test customerProfileIds } + /** + * Test the property 'cardIdentifier' + */ + @Test + public void cardIdentifierTest() { + // TODO: test cardIdentifier + } + } diff --git a/src/test/java/one/talon/model/ListCampaignStoreBudgetsStoreTest.java b/src/test/java/one/talon/model/ListCampaignStoreBudgetsStoreTest.java new file mode 100644 index 00000000..349f0563 --- /dev/null +++ b/src/test/java/one/talon/model/ListCampaignStoreBudgetsStoreTest.java @@ -0,0 +1,67 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for ListCampaignStoreBudgetsStore + */ +public class ListCampaignStoreBudgetsStoreTest { + private final ListCampaignStoreBudgetsStore model = new ListCampaignStoreBudgetsStore(); + + /** + * Model tests for ListCampaignStoreBudgetsStore + */ + @Test + public void testListCampaignStoreBudgetsStore() { + // TODO: test ListCampaignStoreBudgetsStore + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'integrationId' + */ + @Test + public void integrationIdTest() { + // TODO: test integrationId + } + + /** + * Test the property 'name' + */ + @Test + public void nameTest() { + // TODO: test name + } + +} diff --git a/src/test/java/one/talon/model/ListCampaignStoreBudgetsTest.java b/src/test/java/one/talon/model/ListCampaignStoreBudgetsTest.java new file mode 100644 index 00000000..e10dc4c8 --- /dev/null +++ b/src/test/java/one/talon/model/ListCampaignStoreBudgetsTest.java @@ -0,0 +1,76 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import one.talon.model.ListCampaignStoreBudgetsStore; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for ListCampaignStoreBudgets + */ +public class ListCampaignStoreBudgetsTest { + private final ListCampaignStoreBudgets model = new ListCampaignStoreBudgets(); + + /** + * Model tests for ListCampaignStoreBudgets + */ + @Test + public void testListCampaignStoreBudgets() { + // TODO: test ListCampaignStoreBudgets + } + + /** + * Test the property 'store' + */ + @Test + public void storeTest() { + // TODO: test store + } + + /** + * Test the property 'limit' + */ + @Test + public void limitTest() { + // TODO: test limit + } + + /** + * Test the property 'action' + */ + @Test + public void actionTest() { + // TODO: test action + } + + /** + * Test the property 'period' + */ + @Test + public void periodTest() { + // TODO: test period + } + +} diff --git a/src/test/java/one/talon/model/LoyaltyCardBatchTest.java b/src/test/java/one/talon/model/LoyaltyCardBatchTest.java index a61971d2..ab560d84 100644 --- a/src/test/java/one/talon/model/LoyaltyCardBatchTest.java +++ b/src/test/java/one/talon/model/LoyaltyCardBatchTest.java @@ -21,6 +21,7 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import one.talon.model.CodeGeneratorSettings; import org.junit.Assert; import org.junit.Ignore; import org.junit.Test; @@ -64,4 +65,12 @@ public void statusTest() { // TODO: test status } + /** + * Test the property 'cardCodeSettings' + */ + @Test + public void cardCodeSettingsTest() { + // TODO: test cardCodeSettings + } + } diff --git a/src/test/java/one/talon/model/LoyaltyProgramTest.java b/src/test/java/one/talon/model/LoyaltyProgramTest.java index 025b011e..65994ef0 100644 --- a/src/test/java/one/talon/model/LoyaltyProgramTest.java +++ b/src/test/java/one/talon/model/LoyaltyProgramTest.java @@ -173,6 +173,14 @@ public void cardCodeSettingsTest() { // TODO: test cardCodeSettings } + /** + * Test the property 'returnPolicy' + */ + @Test + public void returnPolicyTest() { + // TODO: test returnPolicy + } + /** * Test the property 'accountID' */ diff --git a/src/test/java/one/talon/model/MessageLogEntryTest.java b/src/test/java/one/talon/model/MessageLogEntryTest.java index 5cc5730a..49742927 100644 --- a/src/test/java/one/talon/model/MessageLogEntryTest.java +++ b/src/test/java/one/talon/model/MessageLogEntryTest.java @@ -83,6 +83,22 @@ public void notificationNameTest() { // TODO: test notificationName } + /** + * Test the property 'webhookId' + */ + @Test + public void webhookIdTest() { + // TODO: test webhookId + } + + /** + * Test the property 'webhookName' + */ + @Test + public void webhookNameTest() { + // TODO: test webhookName + } + /** * Test the property 'request' */ @@ -115,6 +131,14 @@ public void entityTypeTest() { // TODO: test entityType } + /** + * Test the property 'url' + */ + @Test + public void urlTest() { + // TODO: test url + } + /** * Test the property 'applicationId' */ @@ -131,4 +155,12 @@ public void loyaltyProgramIdTest() { // TODO: test loyaltyProgramId } + /** + * Test the property 'campaignId' + */ + @Test + public void campaignIdTest() { + // TODO: test campaignId + } + } diff --git a/src/test/java/one/talon/model/NewCampaignStoreBudgetStoreLimitTest.java b/src/test/java/one/talon/model/NewCampaignStoreBudgetStoreLimitTest.java new file mode 100644 index 00000000..36f291bc --- /dev/null +++ b/src/test/java/one/talon/model/NewCampaignStoreBudgetStoreLimitTest.java @@ -0,0 +1,60 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for NewCampaignStoreBudgetStoreLimit + */ +public class NewCampaignStoreBudgetStoreLimitTest { + private final NewCampaignStoreBudgetStoreLimit model = new NewCampaignStoreBudgetStoreLimit(); + + /** + * Model tests for NewCampaignStoreBudgetStoreLimit + */ + @Test + public void testNewCampaignStoreBudgetStoreLimit() { + // TODO: test NewCampaignStoreBudgetStoreLimit + } + + /** + * Test the property 'storeId' + */ + @Test + public void storeIdTest() { + // TODO: test storeId + } + + /** + * Test the property 'limit' + */ + @Test + public void limitTest() { + // TODO: test limit + } + +} diff --git a/src/test/java/one/talon/model/NewCampaignStoreBudgetTest.java b/src/test/java/one/talon/model/NewCampaignStoreBudgetTest.java new file mode 100644 index 00000000..4a003d7a --- /dev/null +++ b/src/test/java/one/talon/model/NewCampaignStoreBudgetTest.java @@ -0,0 +1,70 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import one.talon.model.NewCampaignStoreBudgetStoreLimit; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for NewCampaignStoreBudget + */ +public class NewCampaignStoreBudgetTest { + private final NewCampaignStoreBudget model = new NewCampaignStoreBudget(); + + /** + * Model tests for NewCampaignStoreBudget + */ + @Test + public void testNewCampaignStoreBudget() { + // TODO: test NewCampaignStoreBudget + } + + /** + * Test the property 'action' + */ + @Test + public void actionTest() { + // TODO: test action + } + + /** + * Test the property 'storeLimits' + */ + @Test + public void storeLimitsTest() { + // TODO: test storeLimits + } + + /** + * Test the property 'period' + */ + @Test + public void periodTest() { + // TODO: test period + } + +} diff --git a/src/test/java/one/talon/model/NewCampaignTemplateTest.java b/src/test/java/one/talon/model/NewCampaignTemplateTest.java index 03ef5d7d..1b8598e5 100644 --- a/src/test/java/one/talon/model/NewCampaignTemplateTest.java +++ b/src/test/java/one/talon/model/NewCampaignTemplateTest.java @@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; @@ -118,6 +119,14 @@ public void couponSettingsTest() { // TODO: test couponSettings } + /** + * Test the property 'couponReservationSettings' + */ + @Test + public void couponReservationSettingsTest() { + // TODO: test couponReservationSettings + } + /** * Test the property 'referralSettings' */ diff --git a/src/test/java/one/talon/model/NewLoyaltyProgramTest.java b/src/test/java/one/talon/model/NewLoyaltyProgramTest.java index ffa5cabe..df6f13da 100644 --- a/src/test/java/one/talon/model/NewLoyaltyProgramTest.java +++ b/src/test/java/one/talon/model/NewLoyaltyProgramTest.java @@ -157,6 +157,14 @@ public void cardCodeSettingsTest() { // TODO: test cardCodeSettings } + /** + * Test the property 'returnPolicy' + */ + @Test + public void returnPolicyTest() { + // TODO: test returnPolicy + } + /** * Test the property 'name' */ diff --git a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java new file mode 100644 index 00000000..909fe01b --- /dev/null +++ b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java @@ -0,0 +1,51 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for ScimServiceProviderConfigResponseSort + */ +public class ScimServiceProviderConfigResponseSortTest { + private final ScimServiceProviderConfigResponseSort model = new ScimServiceProviderConfigResponseSort(); + + /** + * Model tests for ScimServiceProviderConfigResponseSort + */ + @Test + public void testScimServiceProviderConfigResponseSort() { + // TODO: test ScimServiceProviderConfigResponseSort + } + + /** + * Test the property 'supported' + */ + @Test + public void supportedTest() { + // TODO: test supported + } + +} diff --git a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java index c4cdc766..ab0aa365 100644 --- a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java +++ b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java @@ -27,6 +27,7 @@ import one.talon.model.ScimServiceProviderConfigResponseChangePassword; import one.talon.model.ScimServiceProviderConfigResponseFilter; import one.talon.model.ScimServiceProviderConfigResponsePatch; +import one.talon.model.ScimServiceProviderConfigResponseSort; import org.junit.Assert; import org.junit.Ignore; import org.junit.Test; @@ -94,4 +95,12 @@ public void schemasTest() { // TODO: test schemas } + /** + * Test the property 'sort' + */ + @Test + public void sortTest() { + // TODO: test sort + } + } diff --git a/src/test/java/one/talon/model/SummaryCampaignStoreBudgetTest.java b/src/test/java/one/talon/model/SummaryCampaignStoreBudgetTest.java new file mode 100644 index 00000000..72b09308 --- /dev/null +++ b/src/test/java/one/talon/model/SummaryCampaignStoreBudgetTest.java @@ -0,0 +1,67 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for SummaryCampaignStoreBudget + */ +public class SummaryCampaignStoreBudgetTest { + private final SummaryCampaignStoreBudget model = new SummaryCampaignStoreBudget(); + + /** + * Model tests for SummaryCampaignStoreBudget + */ + @Test + public void testSummaryCampaignStoreBudget() { + // TODO: test SummaryCampaignStoreBudget + } + + /** + * Test the property 'action' + */ + @Test + public void actionTest() { + // TODO: test action + } + + /** + * Test the property 'period' + */ + @Test + public void periodTest() { + // TODO: test period + } + + /** + * Test the property 'storeCount' + */ + @Test + public void storeCountTest() { + // TODO: test storeCount + } + +} diff --git a/src/test/java/one/talon/model/UpdateAchievementTest.java b/src/test/java/one/talon/model/UpdateAchievementTest.java index e793712f..e208d8a7 100644 --- a/src/test/java/one/talon/model/UpdateAchievementTest.java +++ b/src/test/java/one/talon/model/UpdateAchievementTest.java @@ -23,6 +23,7 @@ import java.io.IOException; import java.math.BigDecimal; import one.talon.model.TimePoint; +import org.threeten.bp.OffsetDateTime; import org.junit.Assert; import org.junit.Ignore; import org.junit.Test; @@ -90,4 +91,36 @@ public void periodEndOverrideTest() { // TODO: test periodEndOverride } + /** + * Test the property 'recurrencePolicy' + */ + @Test + public void recurrencePolicyTest() { + // TODO: test recurrencePolicy + } + + /** + * Test the property 'activationPolicy' + */ + @Test + public void activationPolicyTest() { + // TODO: test activationPolicy + } + + /** + * Test the property 'fixedStartDate' + */ + @Test + public void fixedStartDateTest() { + // TODO: test fixedStartDate + } + + /** + * Test the property 'endDate' + */ + @Test + public void endDateTest() { + // TODO: test endDate + } + } diff --git a/src/test/java/one/talon/model/UpdateCampaignTemplateTest.java b/src/test/java/one/talon/model/UpdateCampaignTemplateTest.java index 7acb0a29..27e1d70c 100644 --- a/src/test/java/one/talon/model/UpdateCampaignTemplateTest.java +++ b/src/test/java/one/talon/model/UpdateCampaignTemplateTest.java @@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.List; import one.talon.model.CampaignTemplateCollection; +import one.talon.model.CampaignTemplateCouponReservationSettings; import one.talon.model.CampaignTemplateParams; import one.talon.model.CodeGeneratorSettings; import one.talon.model.TemplateLimitConfig; @@ -126,6 +127,14 @@ public void couponSettingsTest() { // TODO: test couponSettings } + /** + * Test the property 'couponReservationSettings' + */ + @Test + public void couponReservationSettingsTest() { + // TODO: test couponReservationSettings + } + /** * Test the property 'referralSettings' */ diff --git a/src/test/java/one/talon/model/UpdateLoyaltyProgramTest.java b/src/test/java/one/talon/model/UpdateLoyaltyProgramTest.java index 0e1f1fc0..e1fafeb0 100644 --- a/src/test/java/one/talon/model/UpdateLoyaltyProgramTest.java +++ b/src/test/java/one/talon/model/UpdateLoyaltyProgramTest.java @@ -157,6 +157,14 @@ public void cardCodeSettingsTest() { // TODO: test cardCodeSettings } + /** + * Test the property 'returnPolicy' + */ + @Test + public void returnPolicyTest() { + // TODO: test returnPolicy + } + /** * Test the property 'tiers' */ diff --git a/src/test/java/one/talon/model/UpdateLoyaltyProgramTierTest.java b/src/test/java/one/talon/model/UpdateLoyaltyProgramTierTest.java new file mode 100644 index 00000000..73cb6939 --- /dev/null +++ b/src/test/java/one/talon/model/UpdateLoyaltyProgramTierTest.java @@ -0,0 +1,68 @@ +/* + * 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. + */ + + +package one.talon.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + + +/** + * Model tests for UpdateLoyaltyProgramTier + */ +public class UpdateLoyaltyProgramTierTest { + private final UpdateLoyaltyProgramTier model = new UpdateLoyaltyProgramTier(); + + /** + * Model tests for UpdateLoyaltyProgramTier + */ + @Test + public void testUpdateLoyaltyProgramTier() { + // TODO: test UpdateLoyaltyProgramTier + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'name' + */ + @Test + public void nameTest() { + // TODO: test name + } + + /** + * Test the property 'minPoints' + */ + @Test + public void minPointsTest() { + // TODO: test minPoints + } + +}