diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 6005749c..e409555f 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -125,6 +125,7 @@ docs/CampaignEditedNotification.md docs/CampaignEditedNotificationItem.md docs/CampaignEligibility.md docs/CampaignEligibilityDetails.md +docs/CampaignEligibilityExperiment.md docs/CampaignEligibilityFailureDetails.md docs/CampaignEntity.md docs/CampaignEvaluationGroup.md @@ -251,6 +252,8 @@ docs/EventV3Entity.md docs/EventV3RequestEntity.md docs/Experiment.md docs/ExperimentCampaignCopy.md +docs/ExperimentConfidenceTimeline.md +docs/ExperimentConfidenceTimelineDataPoint.md docs/ExperimentCopy.md docs/ExperimentCopyExperiment.md docs/ExperimentListResults.md @@ -367,13 +370,13 @@ docs/IntegrationGetAllCampaigns200Response.md docs/IntegrationHubConfig.md docs/IntegrationHubEventPayloadCouponBasedNotifications.md docs/IntegrationHubEventPayloadCouponBasedNotificationsLimits.md -docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.md docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md docs/IntegrationHubEventRecord.md docs/IntegrationHubEventStatusUpdate.md +docs/IntegrationHubEventType.md docs/IntegrationHubFlow.md docs/IntegrationHubFlowConfig.md docs/IntegrationHubFlowConfigResponse.md @@ -634,8 +637,6 @@ docs/ScimServiceProviderConfigResponse.md docs/ScimServiceProviderConfigResponseBulk.md docs/ScimServiceProviderConfigResponseChangePassword.md docs/ScimServiceProviderConfigResponseFilter.md -docs/ScimServiceProviderConfigResponsePatch.md -docs/ScimServiceProviderConfigResponseSort.md docs/ScimUser.md docs/ScimUsersListResponse.md docs/SecondaryDeployment.md @@ -703,7 +704,6 @@ docs/UpdateCoupon.md docs/UpdateCouponBatch.md docs/UpdateCouponsData.md docs/UpdateCustomEffect.md -docs/UpdateCustomerProfileV2409Response.md docs/UpdateCustomerSessionV2409Response.md docs/UpdateExperiment.md docs/UpdateExperimentVariant.md @@ -718,6 +718,7 @@ docs/UpdatePriceType.md docs/UpdateReferral.md docs/UpdateReferralBatch.md docs/UpdateReward.md +docs/UpdateRiskNotification.md docs/UpdateRole.md docs/UpdateStore.md docs/UpdateSupportRequest.md @@ -874,6 +875,7 @@ src/main/java/one/talon/model/CampaignEditedNotification.java src/main/java/one/talon/model/CampaignEditedNotificationItem.java src/main/java/one/talon/model/CampaignEligibility.java src/main/java/one/talon/model/CampaignEligibilityDetails.java +src/main/java/one/talon/model/CampaignEligibilityExperiment.java src/main/java/one/talon/model/CampaignEligibilityFailureDetails.java src/main/java/one/talon/model/CampaignEntity.java src/main/java/one/talon/model/CampaignEvaluationGroup.java @@ -1000,6 +1002,8 @@ src/main/java/one/talon/model/EventV3Entity.java src/main/java/one/talon/model/EventV3RequestEntity.java src/main/java/one/talon/model/Experiment.java src/main/java/one/talon/model/ExperimentCampaignCopy.java +src/main/java/one/talon/model/ExperimentConfidenceTimeline.java +src/main/java/one/talon/model/ExperimentConfidenceTimelineDataPoint.java src/main/java/one/talon/model/ExperimentCopy.java src/main/java/one/talon/model/ExperimentCopyExperiment.java src/main/java/one/talon/model/ExperimentListResults.java @@ -1115,13 +1119,13 @@ src/main/java/one/talon/model/IntegrationGetAllCampaigns200Response.java src/main/java/one/talon/model/IntegrationHubConfig.java src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotifications.java src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimits.java -src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.java src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.java src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.java src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.java src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.java src/main/java/one/talon/model/IntegrationHubEventRecord.java src/main/java/one/talon/model/IntegrationHubEventStatusUpdate.java +src/main/java/one/talon/model/IntegrationHubEventType.java src/main/java/one/talon/model/IntegrationHubFlow.java src/main/java/one/talon/model/IntegrationHubFlowConfig.java src/main/java/one/talon/model/IntegrationHubFlowConfigResponse.java @@ -1381,8 +1385,6 @@ src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java src/main/java/one/talon/model/ScimServiceProviderConfigResponseBulk.java src/main/java/one/talon/model/ScimServiceProviderConfigResponseChangePassword.java src/main/java/one/talon/model/ScimServiceProviderConfigResponseFilter.java -src/main/java/one/talon/model/ScimServiceProviderConfigResponsePatch.java -src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java src/main/java/one/talon/model/ScimUser.java src/main/java/one/talon/model/ScimUsersListResponse.java src/main/java/one/talon/model/SecondaryDeployment.java @@ -1450,7 +1452,6 @@ src/main/java/one/talon/model/UpdateCoupon.java src/main/java/one/talon/model/UpdateCouponBatch.java src/main/java/one/talon/model/UpdateCouponsData.java src/main/java/one/talon/model/UpdateCustomEffect.java -src/main/java/one/talon/model/UpdateCustomerProfileV2409Response.java src/main/java/one/talon/model/UpdateCustomerSessionV2409Response.java src/main/java/one/talon/model/UpdateExperiment.java src/main/java/one/talon/model/UpdateExperimentVariant.java @@ -1465,6 +1466,7 @@ src/main/java/one/talon/model/UpdatePriceType.java src/main/java/one/talon/model/UpdateReferral.java src/main/java/one/talon/model/UpdateReferralBatch.java src/main/java/one/talon/model/UpdateReward.java +src/main/java/one/talon/model/UpdateRiskNotification.java src/main/java/one/talon/model/UpdateRole.java src/main/java/one/talon/model/UpdateStore.java src/main/java/one/talon/model/UpdateSupportRequest.java @@ -1592,6 +1594,7 @@ src/test/java/one/talon/model/CampaignDetailTest.java src/test/java/one/talon/model/CampaignEditedNotificationItemTest.java src/test/java/one/talon/model/CampaignEditedNotificationTest.java src/test/java/one/talon/model/CampaignEligibilityDetailsTest.java +src/test/java/one/talon/model/CampaignEligibilityExperimentTest.java src/test/java/one/talon/model/CampaignEligibilityFailureDetailsTest.java src/test/java/one/talon/model/CampaignEligibilityTest.java src/test/java/one/talon/model/CampaignEntityTest.java @@ -1719,6 +1722,8 @@ src/test/java/one/talon/model/EventV3EntityTest.java src/test/java/one/talon/model/EventV3RequestEntityTest.java src/test/java/one/talon/model/EventV3Test.java src/test/java/one/talon/model/ExperimentCampaignCopyTest.java +src/test/java/one/talon/model/ExperimentConfidenceTimelineDataPointTest.java +src/test/java/one/talon/model/ExperimentConfidenceTimelineTest.java src/test/java/one/talon/model/ExperimentCopyExperimentTest.java src/test/java/one/talon/model/ExperimentCopyTest.java src/test/java/one/talon/model/ExperimentListResultsRequestTest.java @@ -1835,13 +1840,13 @@ src/test/java/one/talon/model/IntegrationGetAllCampaigns200ResponseTest.java src/test/java/one/talon/model/IntegrationHubConfigTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimitsTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsTest.java -src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotificationTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationActionTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotificationTest.java src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotificationTest.java src/test/java/one/talon/model/IntegrationHubEventRecordTest.java src/test/java/one/talon/model/IntegrationHubEventStatusUpdateTest.java +src/test/java/one/talon/model/IntegrationHubEventTypeTest.java src/test/java/one/talon/model/IntegrationHubFlowConfigResponseTest.java src/test/java/one/talon/model/IntegrationHubFlowConfigTest.java src/test/java/one/talon/model/IntegrationHubFlowResponseTest.java @@ -2100,8 +2105,6 @@ src/test/java/one/talon/model/ScimSchemasListResponseTest.java src/test/java/one/talon/model/ScimServiceProviderConfigResponseBulkTest.java src/test/java/one/talon/model/ScimServiceProviderConfigResponseChangePasswordTest.java src/test/java/one/talon/model/ScimServiceProviderConfigResponseFilterTest.java -src/test/java/one/talon/model/ScimServiceProviderConfigResponsePatchTest.java -src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java src/test/java/one/talon/model/ScimUserTest.java src/test/java/one/talon/model/ScimUsersListResponseTest.java @@ -2170,7 +2173,6 @@ src/test/java/one/talon/model/UpdateCouponBatchTest.java src/test/java/one/talon/model/UpdateCouponTest.java src/test/java/one/talon/model/UpdateCouponsDataTest.java src/test/java/one/talon/model/UpdateCustomEffectTest.java -src/test/java/one/talon/model/UpdateCustomerProfileV2409ResponseTest.java src/test/java/one/talon/model/UpdateCustomerSessionV2409ResponseTest.java src/test/java/one/talon/model/UpdateExperimentTest.java src/test/java/one/talon/model/UpdateExperimentVariantArrayTest.java @@ -2185,6 +2187,7 @@ src/test/java/one/talon/model/UpdatePriceTypeTest.java src/test/java/one/talon/model/UpdateReferralBatchTest.java src/test/java/one/talon/model/UpdateReferralTest.java src/test/java/one/talon/model/UpdateRewardTest.java +src/test/java/one/talon/model/UpdateRiskNotificationTest.java src/test/java/one/talon/model/UpdateRoleTest.java src/test/java/one/talon/model/UpdateStoreTest.java src/test/java/one/talon/model/UpdateSupportRequestTest.java diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 696eaac5..14d6b5dc 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.22.0 +7.23.0 diff --git a/README.md b/README.md index 98b7a563..572ec933 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Add this dependency to your project's POM: one.talon talon-one-client - 26.11.0 + 26.12.0 compile ``` @@ -52,7 +52,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:26.11.0" +compile "one.talon:talon-one-client:26.12.0" ``` ### Others @@ -223,6 +223,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**getCustomerAchievements**](docs/IntegrationApi.md#getCustomerAchievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements *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* | [**getEventV3**](docs/IntegrationApi.md#getEventV3) | **GET** /v3/events/{integrationId} | Get advanced event *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 @@ -236,6 +237,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**returnCartItems**](docs/IntegrationApi.md#returnCartItems) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items *IntegrationApi* | [**syncCatalog**](docs/IntegrationApi.md#syncCatalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog *IntegrationApi* | [**trackEventV2**](docs/IntegrationApi.md#trackEventV2) | **POST** /v2/events | Track event +*IntegrationApi* | [**trackEventV3**](docs/IntegrationApi.md#trackEventV3) | **POST** /v3/events | Track advanced event *IntegrationApi* | [**unlinkLoyaltyCardFromProfile**](docs/IntegrationApi.md#unlinkLoyaltyCardFromProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/unlink_profile | Unlink customer profile from a loyalty card *IntegrationApi* | [**updateAudienceCustomersAttributes**](docs/IntegrationApi.md#updateAudienceCustomersAttributes) | **PUT** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience *IntegrationApi* | [**updateAudienceV2**](docs/IntegrationApi.md#updateAudienceV2) | **PUT** /v2/audiences/{audienceId} | Update audience name @@ -377,6 +379,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**importCoupons**](docs/ManagementApi.md#importCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons *ManagementApi* | [**importLoyaltyCards**](docs/ManagementApi.md#importLoyaltyCards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards *ManagementApi* | [**importLoyaltyCustomersTiers**](docs/ManagementApi.md#importLoyaltyCustomersTiers) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers +*ManagementApi* | [**importLoyaltyJoinDates**](docs/ManagementApi.md#importLoyaltyJoinDates) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_join_dates | Import join dates for a loyalty program *ManagementApi* | [**importLoyaltyPoints**](docs/ManagementApi.md#importLoyaltyPoints) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points *ManagementApi* | [**importPoolGiveaways**](docs/ManagementApi.md#importPoolGiveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool *ManagementApi* | [**importReferrals**](docs/ManagementApi.md#importReferrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals @@ -543,6 +546,7 @@ Class | Method | HTTP request | Description - [CampaignEditedNotificationItem](docs/CampaignEditedNotificationItem.md) - [CampaignEligibility](docs/CampaignEligibility.md) - [CampaignEligibilityDetails](docs/CampaignEligibilityDetails.md) +- [CampaignEligibilityExperiment](docs/CampaignEligibilityExperiment.md) - [CampaignEligibilityFailureDetails](docs/CampaignEligibilityFailureDetails.md) - [CampaignEntity](docs/CampaignEntity.md) - [CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md) @@ -669,6 +673,8 @@ Class | Method | HTTP request | Description - [EventV3RequestEntity](docs/EventV3RequestEntity.md) - [Experiment](docs/Experiment.md) - [ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md) +- [ExperimentConfidenceTimeline](docs/ExperimentConfidenceTimeline.md) +- [ExperimentConfidenceTimelineDataPoint](docs/ExperimentConfidenceTimelineDataPoint.md) - [ExperimentCopy](docs/ExperimentCopy.md) - [ExperimentCopyExperiment](docs/ExperimentCopyExperiment.md) - [ExperimentListResults](docs/ExperimentListResults.md) @@ -784,13 +790,13 @@ Class | Method | HTTP request | Description - [IntegrationHubConfig](docs/IntegrationHubConfig.md) - [IntegrationHubEventPayloadCouponBasedNotifications](docs/IntegrationHubEventPayloadCouponBasedNotifications.md) - [IntegrationHubEventPayloadCouponBasedNotificationsLimits](docs/IntegrationHubEventPayloadCouponBasedNotificationsLimits.md) -- [IntegrationHubEventPayloadLoyaltyProfileBasedNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md) - [IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.md) - [IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction](docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md) - [IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md) - [IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md) - [IntegrationHubEventRecord](docs/IntegrationHubEventRecord.md) - [IntegrationHubEventStatusUpdate](docs/IntegrationHubEventStatusUpdate.md) +- [IntegrationHubEventType](docs/IntegrationHubEventType.md) - [IntegrationHubFlow](docs/IntegrationHubFlow.md) - [IntegrationHubFlowConfig](docs/IntegrationHubFlowConfig.md) - [IntegrationHubFlowConfigResponse](docs/IntegrationHubFlowConfigResponse.md) @@ -1050,8 +1056,6 @@ Class | Method | HTTP request | Description - [ScimServiceProviderConfigResponseBulk](docs/ScimServiceProviderConfigResponseBulk.md) - [ScimServiceProviderConfigResponseChangePassword](docs/ScimServiceProviderConfigResponseChangePassword.md) - [ScimServiceProviderConfigResponseFilter](docs/ScimServiceProviderConfigResponseFilter.md) -- [ScimServiceProviderConfigResponsePatch](docs/ScimServiceProviderConfigResponsePatch.md) -- [ScimServiceProviderConfigResponseSort](docs/ScimServiceProviderConfigResponseSort.md) - [ScimUser](docs/ScimUser.md) - [ScimUsersListResponse](docs/ScimUsersListResponse.md) - [SecondaryDeployment](docs/SecondaryDeployment.md) @@ -1119,7 +1123,6 @@ Class | Method | HTTP request | Description - [UpdateCouponBatch](docs/UpdateCouponBatch.md) - [UpdateCouponsData](docs/UpdateCouponsData.md) - [UpdateCustomEffect](docs/UpdateCustomEffect.md) -- [UpdateCustomerProfileV2409Response](docs/UpdateCustomerProfileV2409Response.md) - [UpdateCustomerSessionV2409Response](docs/UpdateCustomerSessionV2409Response.md) - [UpdateExperiment](docs/UpdateExperiment.md) - [UpdateExperimentVariant](docs/UpdateExperimentVariant.md) @@ -1134,6 +1137,7 @@ Class | Method | HTTP request | Description - [UpdateReferral](docs/UpdateReferral.md) - [UpdateReferralBatch](docs/UpdateReferralBatch.md) - [UpdateReward](docs/UpdateReward.md) +- [UpdateRiskNotification](docs/UpdateRiskNotification.md) - [UpdateRole](docs/UpdateRole.md) - [UpdateStore](docs/UpdateStore.md) - [UpdateSupportRequest](docs/UpdateSupportRequest.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index 3f25b9d9..2302cbfd 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -758,7 +758,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/updateCustomerProfileV2_409_response" + $ref: "#/components/schemas/updateCustomerSessionV2_409_response" description: "Too many requests or limit reached - Avoid parallel requests.\ \ See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests)." security: @@ -957,7 +957,7 @@ paths: /v2/audiences/{audienceId}: delete: description: | - Delete an audience created by a third-party integration. + Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. @@ -1379,6 +1379,7 @@ paths: items: type: string type: array + default: null style: form - description: "Filter results to only include campaigns that start on or after\ \ \nthe specified timestamp.\n\n**Note:**\n\n- It must be an RFC3339 timestamp\ @@ -1471,7 +1472,7 @@ paths: /v2/events: post: description: | - Triggers a custom event. + Trigger a custom event. To use this endpoint: @@ -1554,7 +1555,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/updateCustomerProfileV2_409_response" + $ref: "#/components/schemas/updateCustomerSessionV2_409_response" description: "Too many requests or limit reached - Avoid parallel requests.\ \ See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests)." security: @@ -2033,6 +2034,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter by one or more Achievement IDs, separated by a comma. @@ -2046,6 +2048,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter by status of the achievement. @@ -2062,6 +2065,7 @@ paths: - scheduled type: string type: array + default: null style: form - description: | Filter by customer progress status in the achievement. @@ -2077,6 +2081,7 @@ paths: - not_started type: string type: array + default: null style: form - $ref: "#/components/parameters/pageSize" - $ref: "#/components/parameters/skip" @@ -2155,6 +2160,7 @@ paths: - expired type: string type: array + default: null style: form - description: Timestamp that filters the results to only contain achievements created on or after the start date. @@ -2272,6 +2278,7 @@ paths: items: type: string type: array + default: null style: form responses: "200": @@ -2610,6 +2617,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter results by loyalty transaction type: @@ -2674,6 +2682,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -2690,6 +2699,7 @@ paths: items: type: string type: array + default: null style: form - description: The number of items in the response. explode: true @@ -2800,6 +2810,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -2816,6 +2827,7 @@ paths: items: type: string type: array + default: null style: form - description: The ID of the subledger by which we filter the data. explode: true @@ -2984,6 +2996,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -3000,6 +3013,7 @@ paths: items: type: string type: array + default: null style: form - description: The ID of the subledger used to filter the data. Leave this value empty ("") to query the main ledger. @@ -3242,6 +3256,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of customer session IDs. @@ -3258,6 +3273,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -3274,6 +3290,7 @@ paths: items: type: string type: array + default: null style: form - description: The number of items in the response. explode: true @@ -3388,13 +3405,22 @@ paths: - expired type: string style: form - - description: The ID of the subledger by which we filter the data. + - description: | + Filter the results by a list of subledger IDs. + + To include multiple IDs, repeat the parameter for each one, for example, + `?subledgerId=id1&subledgerId=id2`. + + The response contains only data associated with the specified subledgers. explode: true in: query name: subledgerId required: false schema: - type: string + items: + type: string + type: array + default: null style: form - description: "Filter the results by a list of customer session IDs. \n\nTo\ \ include multiple IDs, repeat the parameter for each one, for example,\ @@ -3408,6 +3434,7 @@ paths: items: type: string type: array + default: null style: form - description: "Filter the results by a list of transaction UUIDs.\n\nTo include\ \ multiple IDs, repeat the parameter for each one, for example, \n`?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.\n\ @@ -3420,6 +3447,7 @@ paths: items: type: string type: array + default: null style: form - description: The number of items in the response. explode: true @@ -5513,6 +5541,85 @@ paths: x-content-type: multipart/form-data x-accepts: - application/json + /v1/loyalty_programs/{loyaltyProgramId}/import_join_dates: + post: + description: | + Upload a CSV file containing customer profile IDs and their join dates for the + specified loyalty program. Send the file as multipart data. + + > [!important] This endpoint only works with profile-based loyalty programs. + + The CSV file **must** contain the following columns: + + - `customerprofileid`: The integration ID of the customer profile whose join + date you want to update. + - `newjoindate`: The new join date for the customer in RFC3339 format. You + can use the time zone of your choice. It is converted to UTC internally + by Talon.One. + + **Note**: + - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. + - If a join date already exists for a profile, the uploaded date replaces it. + + > [!note] We recommend limiting your file size to 500 MB. + + ## Example + + ```csv + customerprofileid,newjoindate + customer1,2024-03-21T07:32:14Z + customer2,2025-04-16T21:12:37Z + customer3,2026-05-03T11:47:01Z + ``` + operationId: importLoyaltyJoinDates + parameters: + - description: | + 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. + explode: false + in: path + name: loyaltyProgramId + required: true + schema: + format: int64 + type: integer + style: simple + requestBody: + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/importLoyaltyPoints_request" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/Import" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Bad request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Not found + summary: Import join dates for a loyalty program + tags: + - management + x-content-type: multipart/form-data + x-accepts: + - application/json /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}: get: deprecated: true @@ -5885,6 +5992,7 @@ paths: items: type: string type: array + default: null style: form - description: An array of tier names to filter the export by. explode: false @@ -5895,6 +6003,7 @@ paths: items: type: string type: array + default: null style: form responses: "200": @@ -6200,6 +6309,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -6216,6 +6326,7 @@ paths: items: type: string type: array + default: null style: form - description: | Date and time from which results are returned. Results are filtered by @@ -6320,14 +6431,17 @@ paths: - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). + - `attributes` (optional): A JSON object that contains the loyalty card's custom + attributes and their values. These attributes must be created and connected to this + loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv - identifier,state,customerprofileids - 123-456-789AT,active,Alexa001;UserA + identifier,state,customerprofileids,attributes + 123-456-789AT,active,Alexa001;UserA,'{""my_attributes"": ""10_off""}" ``` operationId: importLoyaltyCards parameters: @@ -6698,7 +6812,7 @@ paths: - `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. - - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. + - `attributes`: The custom attributes of this loyalty card. operationId: exportLoyaltyCards parameters: - description: | @@ -7314,6 +7428,7 @@ paths: items: type: string type: array + default: null style: form - description: | Filter the results by a list of transaction UUIDs. @@ -7330,6 +7445,7 @@ paths: items: type: string type: array + default: null style: form responses: "200": @@ -9202,7 +9318,7 @@ paths: parameters: - $ref: "#/components/parameters/sort" - description: "The IDs of one or more audiences, separated by commas, by which\ - \ to filter results." + \ to filter results. Do not provide more than 1000 audience IDs." explode: true in: query name: audienceIds @@ -9761,6 +9877,7 @@ paths: items: type: string type: array + default: null style: form - description: Filter results by one or more product names. Must be exact match. explode: true @@ -9771,6 +9888,7 @@ paths: items: type: string type: array + default: null style: form responses: "200": @@ -11036,6 +11154,26 @@ paths: format: date-time type: string style: form + - description: "Filter results comparing the parameter value, expected to be\ + \ an RFC3339 timestamp string." + explode: true + in: query + name: updatedBefore + required: false + schema: + format: date-time + type: string + style: form + - description: "Filter results comparing the parameter value, expected to be\ + \ an RFC3339 timestamp string." + explode: true + in: query + name: updatedAfter + required: false + schema: + format: date-time + type: string + style: form - description: Only return sessions for the customer that matches this customer integration ID. explode: true @@ -12508,10 +12646,10 @@ paths: - description: | Filter by the display name of the Application cart item filter in the Application. - **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. + **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. explode: true in: query - name: title + name: name required: false schema: type: string @@ -13301,6 +13439,7 @@ paths: items: type: string type: array + default: null style: form - description: | Only return results from after this timestamp. @@ -13483,6 +13622,133 @@ paths: - management x-accepts: - application/json + /v3/events: + post: + description: | + Trigger an advanced event. + + Advanced events are idempotent, uniquely identifiable events. They can also + reference a previously closed session to add more context for rule evaluation. + + To use this endpoint: + + 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) + in the Campaign Manager. + 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. + 1. Trigger the event with this endpoint. + + You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. + + For example, you can use this endpoint to trigger an event when a customer shares a + link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). + + > [!note] **Note** + > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. + > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). + > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + operationId: trackEventV3 + parameters: + - description: | + Possible values: `yes` or `no`. + - `yes`: Increases the performance of the API call by returning a 204 response. + - `no`: Returns a 200 response that contains the updated customer profiles. + explode: true + in: query + name: silent + required: false + schema: + default: "yes" + type: string + style: form + - description: | + Indicates whether to persist the changes. Changes are ignored when `dry=true`. + explode: true + in: query + name: dry + required: false + schema: + type: boolean + style: form + - description: | + Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. + explode: true + in: query + name: forceCompleteEvaluation + required: false + schema: + default: false + type: boolean + style: form + requestBody: + $ref: "#/components/requestBodies/IntegrationEventV3Request" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/IntegrationEventV3Response" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Bad request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Unauthorized - Invalid API key + "409": + content: + application/json: + schema: + $ref: "#/components/schemas/updateCustomerSessionV2_409_response" + description: "An advanced event already exists, too many requests, or limit\ + \ reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests)." + security: + - api_key_v1: [] + summary: Track advanced event + tags: + - integration + x-content-type: application/json + x-accepts: + - application/json + /v3/events/{integrationId}: + get: + description: | + Retrieve an advanced event by its identifier. + operationId: getEventV3 + parameters: + - description: The unique ID of the advanced event. + explode: false + in: path + name: integrationId + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/EventV3" + description: OK + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponseWithStatus" + description: Not found + security: + - api_key_v1: [] + summary: Get advanced event + tags: + - integration + x-accepts: + - application/json components: parameters: skip: @@ -13939,6 +14205,7 @@ components: items: $ref: "#/components/schemas/ApplicationNotification" type: array + default: null required: - data - totalResultSize @@ -13955,6 +14222,7 @@ components: type: string maxItems: 50 type: array + default: null CampaignCollectionWithoutPayload: allOf: - $ref: "#/components/schemas/Entity" @@ -13992,6 +14260,7 @@ components: format: int64 type: integer type: array + default: null CampaignNotificationGeneric: allOf: - $ref: "#/components/schemas/CampaignNotificationBase" @@ -14002,6 +14271,7 @@ components: type: object type: array x-fieldType: "[]interface{}" + default: null required: - Data CampaignStoreBudget: @@ -14022,6 +14292,7 @@ components: items: $ref: "#/components/schemas/CampaignStoreBudgetLimitConfig" type: array + default: null required: - campaignId - limits @@ -14083,6 +14354,7 @@ components: type: string title: Errors type: array + default: null createdBy: description: ID of the user who created this effect. example: 1 @@ -14159,6 +14431,7 @@ components: type: string title: Errors type: array + default: null createdBy: description: ID of the user who created this effect. example: 1 @@ -14176,6 +14449,7 @@ components: title: Campaign ID type: integer type: array + default: null required: - communicated - createdBy @@ -14215,6 +14489,7 @@ components: items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null NewAccountSignUp: allOf: - $ref: "#/components/schemas/LoginParams" @@ -14270,6 +14545,7 @@ components: items: $ref: "#/components/schemas/StrikethroughChangedItem" type: array + default: null NotificationType: description: The type of notification. enum: @@ -14352,6 +14628,7 @@ components: format: int64 type: integer type: array + default: null UpdateRoleV2: $ref: "#/components/schemas/RoleV2Base" IntegrationHubPaginatedEventPayload: @@ -14364,15 +14641,7 @@ components: format: date-time type: string EventType: - enum: - - LoyaltyPointsChanged - - LoyaltyTierDowngrade - - LoyaltyTierUpgrade - - CouponCreated - - CouponUpdated - - CouponDeleted - type: string - x-generate-enum-go: IntegrationHubEventType + $ref: "#/components/schemas/IntegrationHubEventType" Data: items: discriminator: @@ -14385,6 +14654,7 @@ components: CouponDeleted: "#/components/schemas/IntegrationHubEventPayloadCouponBasedNotifications" propertyName: EventType type: array + default: null required: - Data - EventType @@ -14462,6 +14732,7 @@ components: type: integer title: Campaigns to evaluate type: array + default: null Product: description: "The specific properties of the product this item belongs to, if\ \ available." @@ -14511,29 +14782,30 @@ components: type: string CartItem: example: - remainingQuantity: 1 - product: "" + name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -14542,7 +14814,6 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 properties: name: description: Name of item. @@ -14735,6 +15006,7 @@ components: type: string title: Coupons entered in session type: array + default: null referralCode: description: | Any referral code entered. @@ -14755,6 +15027,7 @@ components: type: string maxItems: 1 type: array + default: null state: default: open description: | @@ -14784,6 +15057,7 @@ components: $ref: "#/components/schemas/CartItem" title: Customer session's cart items type: array + default: null experimentVariantAllocations: description: | The experiment variant allocations to add to this session. @@ -14791,6 +15065,7 @@ components: $ref: "#/components/schemas/ExperimentVariantAllocation" title: Experiment variant allocations type: array + default: null additionalCosts: additionalProperties: $ref: "#/components/schemas/AdditionalCost" @@ -14822,6 +15097,7 @@ components: maxItems: 5 title: Session identifiers type: array + default: null attributes: additionalProperties: true description: | @@ -14893,61 +15169,46 @@ components: - updateCount - updated example: - couponCodes: - - XMAS-20-2021 - cartItemAdditionalCostTotal: 15 - updateCount: 3 + id: 6 created: 2020-02-07T08:15:22Z - identifiers: - - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea integrationId: URNGV8294NV - experimentVariantAllocations: - - experimentID: 1 - variantID: 2 - - experimentID: 1 - variantID: 2 - total: 134.99 - loyaltyCards: - - loyalty-card-1 - additionalCosts: - shipping: - price: 9 - additionalCostTotal: 20 - storeIntegrationId: STORE-001 + applicationId: 322 profileId: URNGV8294NV + storeIntegrationId: STORE-001 evaluableCampaignIds: - 10 - 12 + couponCodes: + - XMAS-20-2021 referralCode: NT2K54D9 - attributes: - ShippingCity: Berlin - id: 6 + loyaltyCards: + - loyalty-card-1 state: open - applicationId: 322 cartItems: - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -14956,30 +15217,30 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -14988,10 +15249,25 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - updated: 2020-02-08T14:15:22Z + experimentVariantAllocations: + - experimentID: 1 + variantID: 2 + - experimentID: 1 + variantID: 2 + additionalCosts: + shipping: + price: 9 + identifiers: + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea + attributes: + ShippingCity: Berlin firstSession: true + updateCount: 3 + total: 134.99 cartItemTotal: 99.99 + additionalCostTotal: 20 + cartItemAdditionalCostTotal: 15 + updated: 2020-02-08T14:15:22Z EffectEntity: description: "Definition of all properties that are present on all effects,\ \ independent of their type." @@ -15089,29 +15365,48 @@ components: - ruleName - rulesetId AcceptCouponEffectProps: - description: The properties specific to the "acceptCoupon" effect. This gets - triggered whenever the coupon is valid and all other conditions in the rules - of its campaign are met. + description: |- + This effect indicates that the coupon code supplied was valid. + + You should handle this effect by clearing any messages from previous `rejectCoupon` effects and informing the user that the coupon is valid. + + The code is automatically redeemed when you close the session. + + Other effects, such as [setDiscount](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscount), provide more information about the actual rewards received. + example: + value: COUP-XYZ789 properties: value: description: The coupon code that was accepted. type: string required: - value + title: acceptCoupon AcceptReferralEffectProps: - description: The properties specific to the "acceptReferral" effect. TThis gets - triggered whenever the referral code is valid and all other conditions in - the rules of its campaign are met. + description: |- + This effect indicates that the referral code supplied is valid. + + You should handle this effect by informing the user that the referral code is valid. + + The code is automatically redeemed when you close the session. + + Other effects will provide more information about the actual reward. + example: + value: REF-ABC123 properties: value: - description: The referral code that was accepted. + description: The referral code provided in the session. type: string required: - value + title: acceptReferral RedeemReferralEffectProps: description: | - This effect is **deprecated**. The properties specific to the "redeemReferral" effect. - This gets triggered whenever the referral code is valid, and a rule was triggered that contains a "redeem referral" effect. + This effect is **deprecated**. It has been replaced by the `acceptReferral` effect. + This effect indicates that the referral code is valid and has been redeemed. + example: + id: 12 + value: REF-ABC123 properties: id: description: The id of the referral code that was redeemed. @@ -15123,16 +15418,40 @@ components: required: - id - value + title: redeemReferral RejectCouponEffectProps: - description: The properties specific to the "rejectCoupon" effect. This gets - triggered whenever the coupon was rejected. See rejectionReason for more info - on why. + description: |- + This effect indicates that the coupon code supplied couldn't be used. + + You should handle this effect by informing their user the coupon code is invalid. + example: + value: COUP-XYZ789 + rejectionReason: CouponRejectedCondition + conditionIndex: 2 + effectIndex: 0 + details: Coupon usage limit reached + campaignExclusionReason: CampaignGaveLowerDiscount properties: value: description: The coupon code that was rejected. type: string rejectionReason: - description: The reason why this coupon was rejected. + description: |- + The reason why the code was rejected. + + - `CampaignLimitReached`: The campaign-wide coupon code redemption limit has been reached. + - `CouponExpired`: The coupon is expired. + - `CouponLimitReached`: The coupon redemption limit or a campaign budget was reached. + - `CouponNotFound`: The coupon code is incorrect. + - `CouponPartOfNotRunningCampaign`: The campaign the coupon belongs to is currently not active. The campaignId field contains the ID of that campaign. + - `CouponRecipientDoesNotMatch`: The given coupon value does not match the recipient or the coupon is linked to a `recipientIntegrationID` but there is no profile in the session. + - `CouponRejectedByCondition`: Other conditions failed in the rule or all conditions passed but the `Coupon code is valid` condition is not present. + - `CouponStartDateInFuture`: The coupon isn't active yet. + - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` cannot be applied because a discount limit is reached). + - `ProfileLimitReached`: The profile-specific coupon redemption limit has been reached. + - `CouponPartOfNotTriggeredCampaign`: The campaign the coupon belongs to was not triggered during evaluation (an exclusive or stackable campaign). The `campaignId` field contains the ID of that campaign. + - `CouponReservationRequired`: The coupon's `isReservationMandatory` property is `true`, but the profile does not have a reservation. + - `ProfileRequired`: The coupon's `isReservationMandatory` property is `true` or a [campaign profile budget](https://docs.talon.one/docs/product/campaigns/settings/manage-campaign-budgets) was set, but no profile exists in the session. type: string conditionIndex: description: The index of the condition that caused the rejection of the @@ -15147,22 +15466,50 @@ components: description: More details about the failure. type: string campaignExclusionReason: - description: The reason why the campaign was not applied. + description: |- + The reason why the campaign the coupon belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. + Its possible values are: + + - `CampaignGaveLowerDiscount`: The required campaign and coupon conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. + - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. + - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the coupon is part of an archived campaign. example: CampaignGaveLowerDiscount type: string required: - rejectionReason - value + title: rejectCoupon RejectReferralEffectProps: - description: The properties specific to the "rejectReferral" effect. This gets - triggered whenever the referral code was rejected. See rejectionReason for - more info on why. + description: This effect indicates that the provided referral code is invalid. + example: + value: REF-ABC123 + rejectionReason: ReferralRejectedCondition + conditionIndex: 1 + effectIndex: 0 + details: Referral code already used + campaignExclusionReason: CampaignGaveLowerDiscount properties: value: - description: The referral code that was rejected. + description: The referral code that was rejected type: string rejectionReason: - description: The reason why this referral code was rejected. + description: |- + The reason why the code was rejected. + + - `AdvocateNotFound`: The advocate was not found. + - `CampaignLimitReached`: The campaign-wide referral code redemption limit has been reached. + - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` can not be applied because a discount limit is reached). + - `ProfileLimitReached`: The profile-specific referral code redemption limit has been reached. + - `ReferralCustomerAlreadyReferred`: The friend is already referred. + - `ReferralExpired`: The transferred referral code is expired. + - `ReferralLimitReached`: The referral code redemption limit has been reached. + - `ReferralNotFound`: The transferred referral code is wrong. + - `ReferralPartOfNotRunningCampaign`: The campaign the referral code belongs to is currently not active. The campaign ID field shows the ID of that campaign. + - `ReferralRecipientDoesNotMatch`: The given referral code value does not match the recipient. + - `ReferralRecipientIdSameAsAdvocate`: The recipient (friend) has the same id as the advocate. + - `ReferralRejectedByCondition`: The referral code is valid and in an active campaign, but there were other conditions in that campaign's rules that were not met. + - `ReferralStartDateInFuture`: The transferred referral code isn't active yet. + - `ReferralPartOfNotTriggeredCampaign`: The campaign the referral code belongs to was not triggered during evaluation (an exclusive or stackable campaign). The campaign ID field shows the ID of that campaign. type: string conditionIndex: description: The index of the condition that caused the rejection of the @@ -15177,17 +15524,29 @@ components: description: More details about the failure. type: string campaignExclusionReason: - description: The reason why the campaign was not applied. + description: |- + The reason why the campaign the referral belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. + Its possible values are: + + - `CampaignGaveLowerDiscount`: The required campaign and referral conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. + - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. + - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the referral is part of an archived campaign. example: CampaignGaveLowerDiscount type: string required: - rejectionReason - value + title: rejectReferral CouponCreatedEffectProps: - description: "The properties specific to the \"couponCreated\" effect. This\ - \ gets triggered whenever a validated rule contained a \"create coupon\" effect,\ - \ and a coupon was created for a customer. See \"createdCoupons\" on the response\ - \ for all details of this coupon." + description: |- + This effect indicates that a coupon was created. + + For referrals and retention marketing, a common use case is to generate a coupon that can only be redeemed by one specific customer. + + Handle this effect by notifying the recipient about their new coupon code. + example: + value: COUP-NEW123 + profileId: customer_profile_id_1 properties: value: description: The coupon code that was created. @@ -15199,94 +15558,133 @@ components: required: - profileId - value + title: couponCreated ReferralCreatedEffectProps: - description: "The properties specific to the \"referralCreated\" effect. This\ - \ gets triggered whenever a validated rule contained a \"create referral\"\ - \ effect, and a referral code was created for a customer. See \"createdReferrals\"\ - \ on the response for all details of this referral code." + description: "The `referralCreated` effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effects#couponcreated).\ + \ If the `friendProfileIntegrationId` parameter is empty, the referral code\ + \ can be redeemed by anyone." + example: + value: REF-NEW456 properties: value: - description: The referral code that was created. + description: The referral code provided in the session. type: string required: - value + title: referralCreated SetDiscountEffectProps: - description: The properties specific to the "setDiscount" effect. This gets - triggered whenever a validated rule contained a "set discount" effect. This - is a discount that should be applied on the scope of defined with it. + description: |- + This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. + + The discount should overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for **all** effects, effectively overwriting any previous effects. + + Enabling [partial discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches `0`. Use the `desiredValue` property to identify the original value of the discount. + example: + name: 10% Off + value: 2.5 + scope: sessionTotal + desiredValue: 2.5 properties: name: - description: The name / description of this discount + description: The name or description of this discount. type: string value: - description: The total monetary value of the discount. + description: The monetary value of the effective discount. type: number scope: - description: "The scope which the discount was applied on, can be one of\ - \ (cartItems,additionalCosts,sessionTotal)." + description: |- + What the discount applies to. Possible values: + + - `cartItems`: Discount on the price of the items. + - `additionalCosts`: Discount on the [additional costs](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the items. + - `sessionTotal`: Discount on the total value of the customer session. + + **Note:** [Cascading discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#cascading-discounts) must be enabled for this property to be returned. type: string desiredValue: - description: The original value of the discount. + description: _(Partial discounts enabled only)_ The monetary value of the + discount to be applied without considering budget limitations. type: number required: - name - value + title: setDiscount SetDiscountPerItemEffectProps: - description: | - The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a - "set per item discount" effect. - This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. - This depends on the chosen scope. + description: |- + This effect schema is returned when you use the **Discount individual items**, **Discount individual items pro rata**, or **Discount individual item in bundles** effect in a rule. + + It indicates that a discount per item should be applied on the specific item specified in the effect. + + The properties it contains depends on: + + - Whether you used a pro rata effect or not. + - Whether you used an effect with bundles or not. + - Whether the partial discount feature is enabled. + example: + name: "Discount on item #1" + value: 1.5 + position: 1 + subPosition: 1 + desiredValue: 1.5 + scope: price + totalDiscount: 1.5 + desiredTotalDiscount: 1.5 + bundleIndex: 1 + bundleName: my_bundle + targetedItemPosition: 1 + targetedItemSubPosition: 1 + excludedFromPriceHistory: false properties: name: - description: | - The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies - to. It is identical to the value of the `position` property. + description: The description of this discount. `#number` is equal to the + `position` property. type: string value: - description: The total monetary value of the discount. + description: The monetary value of the effective discount applied to the + item. type: number position: - description: The index of the item in the cart items list on which this + description: The index of the item in the `cartItem` object on which this discount should be applied. type: number subPosition: - description: | - For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. + description: The index of the item unit in its line item. type: number desiredValue: - description: The original value of the discount. + description: _(Partial discounts enabled only)_ The monetary value of the + discount to be applied to the item without considering budget limitations. type: number scope: - description: | - The scope of the discount: - - `additionalCosts`: The discount applies to all the additional costs of the item. - - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - - `price`: The discount applies to the price of the item. + description: |- + What the discount applies to. Possible values: + + - `price`: discount on the price of the item. + - `additionalCosts`: discount on the [additional cost](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the item. + - `itemTotal`: discount on the sum of price + additional cost of the item. type: string totalDiscount: - description: The total discount given if this effect is a result of a prorated - discount. + description: _(Pro rata discounts only)_ The monetary value of the total + effective discount type: number desiredTotalDiscount: - description: The original total discount to give if this effect is a result - of a prorated discount. + description: _(Pro rata discounts only)_ The monetary value of the total + discount to be applied without considering budget limitations type: number bundleIndex: - description: The position of the bundle in a list of item bundles created - from the same bundle definition. + description: _(Discounts with bundles only)_ The position of the specific + item bundle in the list of bundles created from the same bundle definition. format: int64 type: integer bundleName: - description: The name of the bundle definition. + description: _(Discounts with bundles only)_ The name of the bundle definition. type: string targetedItemPosition: - description: The index of the targeted bundle item on which the applied - discount is based. + description: _(Discounting individual item in bundles only)_ The index of + the targeted bundle item on which the applied discount is based. type: number targetedItemSubPosition: - description: | - The sub-position of the targeted bundle item on which the applied discount is based. + description: _(Discounting individual item in bundles only)_ The sub-position + of the targeted bundle item on which the applied discount is based. type: number excludedFromPriceHistory: description: "When set to `true`, the applied discount is excluded from\ @@ -15296,48 +15694,60 @@ components: - name - position - value + title: setDiscountPerItem SetDiscountPerAdditionalCostEffectProps: - description: The properties specific to the "setDiscountPerAdditionalCost" effect. - This gets triggered whenever a validated rule contained a "set per additional - cost discount" effect. This is a discount that should be applied on a specific - additional cost. + description: |- + This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a **Discount additional cost** effect is validated. + + Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. + example: + name: Shipping discount + additionalCostId: 1 + additionalCost: shipping + value: 4.99 + desiredValue: 4.99 properties: name: - description: The name / description of this discount + description: The name of the discount. type: string additionalCostId: - description: The ID of the additional cost. + description: The identifier of the additional cost. format: int64 type: integer additionalCost: - description: The name of the additional cost. + description: The API name of the additional cost. type: string value: - description: The total monetary value of the discount. + description: The monetary value of the discount to apply. type: number desiredValue: - description: The original value of the discount. + description: _(Partial discounts enabled only)_ The monetary value of the + discount to be applied without considering budget limitations. type: number required: - additionalCost - additionalCostId - name - value + title: setDiscountPerAdditionalCost TriggerWebhookEffectProps: - description: The properties specific to the "triggerWebhook" effect. This gets - triggered whenever a validated rule contained a "trigger webhook" effect. - This is communicated as an FYI and should usually not require action on your - side. + description: "This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effects#webhooks)\ + \ is validated. The details are shared with you for your information only.\ + \ It usually doesn't require an action on your side." + example: + webhookId: 7 + webhookName: My Webhook properties: webhookId: - description: The ID of the webhook that was triggered. + description: The internal ID of the webhook. type: number webhookName: - description: The name of the webhook that was triggered. + description: The name of the webhook. type: string required: - webhookId - webhookName + title: triggerWebhook LoyaltyCardIdentifier: description: | The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. @@ -15347,11 +15757,42 @@ components: pattern: "^[A-Za-z0-9._%+@-]+$" type: string AddLoyaltyPointsEffectProps: - description: | - The properties specific to the "addLoyaltyPoints" effect. This gets triggered whenever a validated rule contained an "add loyalty" effect. These points are automatically stored and managed inside Talon.One. + description: |- + This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card. + + If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which item to add the loyalty points for. + + Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. + + If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. See the example below for more information. + + If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the items for which loyalty points are added. + + If you have set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. + + If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card on which these points are added. + + The points only persist when the session is closed. + example: + name: Points for purchase + programId: 5 + subLedgerId: main + value: 100 + desiredValue: 100 + recipientIntegrationId: URNGV8294NV + startDate: 2024-01-01T00:00:00Z + expiryDate: 2025-01-01T00:00:00Z + transactionUUID: 8c2d3670-6ea5-4e9e-b5c6-e7e7b4a10111 + cartItemPosition: 1 + cartItemSubPosition: 1 + cardIdentifier: loyalty-card-001 + bundleIndex: 1 + bundleName: my_bundle + awaitsActivation: false + validityDuration: 12M properties: name: - description: The name / description of this loyalty point addition. + description: The reason of this loyalty point addition. type: string programId: description: The ID of the loyalty program where these points were added. @@ -15365,7 +15806,8 @@ components: description: The amount of points that were added. type: number desiredValue: - description: The original amount of loyalty points to be awarded. + description: (Partial rewards enabled only) The amount of loyalty points + to be awarded without considering budget limitations. type: number recipientIntegrationId: description: The user for whom these points were added. @@ -15373,44 +15815,44 @@ components: maxLength: 1000 type: string startDate: - description: Date after which points will be valid. + description: The date after which the added points will be valid. format: date-time type: string expiryDate: - description: Date after which points will expire. + description: The date after which the added points will expire. format: date-time type: string transactionUUID: - description: The identifier of this addition in the loyalty ledger. + description: The identifier of this loyalty point transaction. type: string cartItemPosition: - description: The index of the item in the cart items list on which the loyal - points addition should be applied. + description: (_Add points per cart item_ only.) The index of the item in + the `cartItem` object for which these points were added. type: number cartItemSubPosition: - description: | - For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. + description: (_Add points per cart item_ ) The index of the item unit in + its line item. type: number cardIdentifier: allOf: - $ref: "#/components/schemas/LoyaltyCardIdentifier" - description: The card on which these points were added. + description: The identifier of the card on which these points were added. bundleIndex: - description: The position of the bundle in a list of item bundles created - from the same bundle definition. + description: _(With bundles only)_ The position of the specific bundle in + the list of bundles created from the same bundle definition. format: int64 type: integer bundleName: - description: The name of the bundle definition. + description: _(With bundles only)_ The name of the bundle definition. type: string awaitsActivation: - description: | - If `true`, the loyalty points remain pending until a specific action is complete. The `startDate` parameter automatically sets to `on_action`. + description: Indicates whether the points have an action-based start date. + This property is returned only for point transactions with an action-based + start date. type: boolean validityDuration: description: "The duration for which the points remain active, calculated\ - \ relative to the \nactivation date. \n\n**Note**: This value is returned\ - \ only if `awaitsActivation` is `true` \nand `expiryDate` is not set.\n" + \ relative to their start date." type: string required: - name @@ -15419,38 +15861,55 @@ components: - subLedgerId - transactionUUID - value + title: addLoyaltyPoints DeductLoyaltyPointsEffectProps: - description: The properties specific to the "deductLoyaltyPoints" effect. This - gets triggered whenever a validated rule contained a condition to only trigger - when the given number of loyalty points could be deduced. These points are - automatically stored and managed inside Talon.One. + description: |- + This effect is triggered when a customer redeems loyalty points. The points are deducted from their active point balance. + + If the loyalty program is card-based, use the `cardIdentifier` property to identify the loyalty card from which these points are deducted. + + The Rule Engine deducts points in this order: + + - Points with the earliest expiry date are deducted first, regardless of when they were added. + - Points with an unlimited expiry date are deducted last. + - For points with an unlimited expiry date, the points awarded first are deducted first. + + The points only persist when the session is closed. + example: + ruleTitle: Deduct points on return + programId: 5 + subLedgerId: main + value: 50 + transactionUUID: 9f3e4781-7fb6-5f0f-c6d7-f8f8c5b21222 + name: Points deducted for return + cardIdentifier: loyalty-card-001 properties: ruleTitle: description: The title of the rule that contained triggered this points deduction. type: string programId: - description: The ID of the loyalty program where these points were added. + description: The ID of the loyalty program from which these points were + deducted. format: int64 type: integer subLedgerId: - description: The ID of the subledger within the loyalty program where these - points were added. + description: The ID of the subledger within the loyalty program from which + these points were deducted. type: string value: description: The amount of points that were deducted. type: number transactionUUID: - description: The identifier of this deduction in the loyalty ledger. + description: The identifier of this loyalty point transaction. type: string name: - description: | - The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. + description: The reason of this loyalty points deduction. type: string cardIdentifier: allOf: - $ref: "#/components/schemas/LoyaltyCardIdentifier" - description: The card on which these points were added. + description: The identifier of the card from which these points were deducted. required: - name - programId @@ -15458,20 +15917,29 @@ components: - subLedgerId - transactionUUID - value + title: deductLoyaltyPoints ChangeLoyaltyTierLevelEffectProps: - description: | - The properties specific to the "changeLoyaltyTierLevel" effect. - This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an "addLoyaltyPoints" effect. + description: |- + This effect indicates that a customer's loyalty tier has been upgraded. + + This effect is generated only when the [Add loyalty points](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points) and the [Add loyalty points per cart item](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points-per-cart-item) effects are triggered for a particular customer, and, as a result, the customer's loyalty tier is upgraded. + example: + ruleTitle: Tier upgrade on purchase + programId: 5 + subLedgerId: main + previousTierName: Silver + newTierName: Gold + expiryDate: 2025-12-31T23:59:59Z properties: ruleTitle: description: The title of the rule that triggered the tier upgrade. type: string programId: - description: The ID of the loyalty program where these points were added. + description: The ID of the loyalty program where the points were added. format: int64 type: integer subLedgerId: - description: The ID of the subledger within the loyalty program where these + description: The ID of the subledger within the loyalty program where the points were added. type: string previousTierName: @@ -15489,16 +15957,23 @@ components: - programId - ruleTitle - subLedgerId + title: changeLoyaltyTierLevel AddFreeItemEffectProps: - description: The properties specific to the "addFreeItem" effect. This gets - triggered whenever a validated rule contained an "add free item" effect. + description: |- + This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set its price to `0`. + + The effect of a successful referral can mean a free item for someone else, such as the referrer. + example: + sku: SKU1241028 + name: Free Gift Item + desiredQuantity: 1 properties: sku: description: SKU of the item that needs to be added. example: SKU1241028 type: string name: - description: The name / description of the effect + description: Description of the effect. type: string desiredQuantity: description: The original quantity in case a partial reward was applied. @@ -15507,138 +15982,218 @@ components: required: - name - sku + title: addFreeItem ShowNotificationEffectProps: - description: The properties specific to the "showNotification" effect. This - gets triggered whenever a validated rule contained a "show notification" effect. + description: |- + You can use notifications to inform customers of certain events. There are four types of notification messages: + + - `Info` + - `Offer` + - `Error` + - `Misc` + + It is up to you to use the Rule Builder to decide why and when to show notifications. Notifications can be used as both rule effects and failure effects. + + A common use case is to display the notification at the top of the cart view in your web app. You can use the notification type to vary the styling of the notification message. + example: + notificationType: info + title: Discount applied + body: You have received a 10% discount on your order. properties: notificationType: - description: The type of notification that should be shown (e.g. error/warning/info). + description: The type of notification. type: string title: - description: Title of the notification. + description: The title of the notification. type: string body: - description: Body of the notification. + description: The body of the notification. type: string required: - body - notificationType - title + title: showNotification UpdateAttributeEffectProps: - description: The properties specific to the "updateAttribute" effect. This gets - triggered whenever a validated rule contained an "update an attribute" effect. + description: "This effect indicates that a rule containing an [Update attribute\ + \ value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects)\ + \ or [Update cart item attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects)\ + \ was validated. You should update the value of the attribute in your system\ + \ based on the content of the returned effect." + example: + path: Session.Attributes.loyaltyTier + value: Gold properties: path: - description: The exact path of the attribute that was updated. + description: The entity type and the attribute name. type: string value: {} required: - path - value + title: updateAttribute RollbackCouponEffectProps: - description: The properties specific to the "rollbackCoupon" effect. This gets - triggered whenever previously closed session is now cancelled and a coupon - redemption was cancelled on our internal usage limit counters. + description: |- + This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. + + The effect is triggered when you [cancel](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state) a session where a coupon was accepted. See an example of use in the [cancelling a session tutorial](https://docs.talon.one/docs/dev/tutorials/roll-back-effects). + example: + value: COUP-XYZ789 properties: value: - description: The coupon code whose usage has been rolled back. + description: The coupon code whose redemption has been rolled back. type: string required: - value + title: rollbackCoupon RollbackReferralEffectProps: - description: The properties specific to the "rollbackReferral" effect. This - gets triggered whenever previously closed session is now cancelled and a referral - redemption was cancelled on our internal usage limit counters. + description: |- + This effect indicates that the redemption of the referral code has been rolled back. It triggers when a closed session that redeemed a referral is gets cancelled. The code becomes redeemable again. + + For more information about session states, see [Managing states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). + example: + value: REF-ABC123 properties: value: - description: The referral code whose usage has been rolled back. + description: The referral code to be rolled back. type: string required: - value + title: rollbackReferral RollbackDiscountEffectProps: - description: The properties specific to the "rollbackDiscount" effect. This - gets triggered whenever previously closed session is now cancelled or partially - returned and a setDiscount effect was cancelled on our internal discount limit - counters. + description: |- + This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you set the status of a session to `cancel` or the status changes to `partially_returned`. + + If the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the specific item unit in its line item. See the example below. + example: + name: 10% Off + value: 2.5 + cartItemPosition: 1 + cartItemSubPosition: 1 + additionalCostId: 1 + additionalCost: shipping + scope: sessionTotal properties: name: - description: The name of the "setDiscount" effect that was rolled back. + description: The name of the discount effect that was rolled back. type: string value: - description: The value of the discount that was rolled back. + description: The monetary value of the discount that was rolled back. type: number cartItemPosition: - description: The index of the item in the cart items for which the discount - was rolled back. + description: "The index of the item in the `cartItem` object whose discount\ + \ was rolled back, or the unit containing the additional cost whose discount\ + \ was rolled back." type: number cartItemSubPosition: - description: | - For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item. + description: The index of the item unit in its line item for which the discount + was rolled back. type: number additionalCostId: - description: The ID of the additional cost that was rolled back. + description: "_Only when rolling back [setDiscountPerAdditionalCost](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcost)\ + \ and [setDiscountPerAdditionalCostPerItem](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcostperitem)_\ + \ The ID of the additional cost to be discounted." format: int64 type: integer additionalCost: - description: The name of the additional cost that was rolled back. + description: The API name of the additional cost whose discount was rolled + back. type: string scope: - description: | - The scope of the rolled back discount + description: |- + The scope of the rolled back discount. + - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` type: string required: - name - value + title: rollbackDiscount RollbackAddedLoyaltyPointsEffectProps: - description: The properties specific to the "rollbackAddedLoyaltyPoints" effect. - This gets triggered whenever previously a closed session with an addLoyaltyPoints - effect is cancelled. + description: |- + This effect is triggered in the following cases: + + - A session was cancelled in which loyalty points have been added. + - A session was partially returned and loyalty point were added by the returned items. See [returning items](https://docs.talon.one/docs/dev/tutorials/partially-return-a-session). + + If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which items the loyalty points were rolled back for. + + If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. + + If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user for whom the loyalty points are rolled back. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points were originally added. + example: + programId: 5 + subLedgerId: main + value: 100 + recipientIntegrationId: URNGV8294NV + transactionUUID: 8c2d3670-6ea5-4e9e-b5c6-e7e7b4a10111 + cartItemPosition: 1 + cartItemSubPosition: 1 + cardIdentifier: loyalty-card-001 properties: programId: - description: The ID of the loyalty program where the points were originally - added. + description: The ID of the loyalty program where these points were rolled + back. format: int64 type: integer subLedgerId: description: The ID of the subledger within the loyalty program where these - points were originally added. + points were rolled back. type: string value: description: The amount of points that were rolled back. type: number recipientIntegrationId: - description: The user for whom these points were originally added. + description: The user for whom these points were rolled back. example: URNGV8294NV maxLength: 1000 type: string transactionUUID: - description: The identifier of 'deduction' entry added to the ledger as - the `addLoyaltyPoints` effect is rolled back. + description: The identifier of this loyalty point transaction. type: string cartItemPosition: - description: The index of the item in the cart items for which the loyalty - points were rolled back. + description: (_Add points per cart item_ only.) The index of the item in + the `cartItem` object for which these points were rolled back. type: number cartItemSubPosition: - description: | - For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back. + description: (_Add points per cart item_ ) The index of the item unit in + its line item. type: number cardIdentifier: allOf: - $ref: "#/components/schemas/LoyaltyCardIdentifier" - description: The card on which these points were originally added. + description: The identifier of the card on which these points were originally + added. required: - programId - recipientIntegrationId - subLedgerId - transactionUUID - value + title: rollbackAddedLoyaltyPoints RollbackDeductedLoyaltyPointsEffectProps: - description: The properties specific to the "rollbackDeductedLoyaltyPoints" - effect. This effect is triggered whenever a previously closed session is cancelled - and a deductLoyaltyPoints effect was revoked. + description: |- + This effect is triggered in the following cases: + + - A session is _cancelled_ and this session deducted loyalty points. The rollback action returns the redeemed loyalty points to the customer. + - A session is impacted by a _partial return_. Only added loyalty points that are still **pending** are rolled back. + - A session in which loyalty points were spent is reopened. + + See the [session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). + + If you set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. + + If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/profile-based/profile-based-overview), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points are reimbursed. + example: + programId: 5 + subLedgerId: main + value: 50 + recipientIntegrationId: URNGV8294NV + startDate: 2024-01-01T00:00:00Z + expiryDate: 2025-01-01T00:00:00Z + transactionUUID: 9f3e4781-7fb6-5f0f-c6d7-f8f8c5b21222 + cardIdentifier: loyalty-card-001 properties: programId: description: The ID of the loyalty program where these points were reimbursed. @@ -15649,7 +16204,7 @@ components: points were reimbursed. type: string value: - description: The amount of reimbursed points that were added. + description: The amount of points that were reimbursed. type: number recipientIntegrationId: description: The user for whom these points were reimbursed. @@ -15657,31 +16212,44 @@ components: maxLength: 1000 type: string startDate: - description: Date after which the reimbursed points will be valid. + description: The date after which the reimbursed points will be valid. format: date-time type: string expiryDate: - description: Date after which the reimbursed points will expire. + description: The date after which the reimbursed points will expire. format: date-time type: string transactionUUID: - description: The identifier of 'addition' entries added to the ledger as - the `deductLoyaltyPoints` effect is rolled back. + description: The identifier of this loyalty point transaction. type: string cardIdentifier: allOf: - $ref: "#/components/schemas/LoyaltyCardIdentifier" - description: The card on which these points were added. + description: The identifier of the card from which these points were originally + deducted. required: - programId - recipientIntegrationId - subLedgerId - transactionUUID - value + title: rollbackDeductedLoyaltyPoints ShowBundleMetadataEffectProps: - description: | + description: |- This effect is **deprecated**. - The properties specific to the "ShowBundleMetadata" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from "normal" discounts that were not the result of a product bundle. + + The `ShowBundleMetadata` effect contains information that allows you to associate + the discounts from a rule in a bundle campaign with specific cart items. + This way you can distinguish from "normal" discounts that were not the result of a product bundle. + example: + description: Buy 2 get 1 free bundle + bundleAttributes: + - category + - brand + itemsIndices: + - 0 + - 1 + - 2 properties: description: description: Description of the product bundle. @@ -15692,41 +16260,49 @@ components: items: type: string type: array + default: null itemsIndices: description: The indices in the cart items array of the bundled items. items: type: number type: array + default: null required: - bundleAttributes - description - itemsIndices + title: showBundleMetadata AwardGiveawayEffectProps: - description: "The properties specific to the \"awardGiveaway\" effect. This\ - \ effect contains information on the giveaway item, and which profile it was\ - \ awarded to." + description: "This effect indicates the awarded giveaway item and to which profile\ + \ the item was awarded. Learn more about [giveaways](https://docs.talon.one/docs/product/giveaways/overview)." + example: + poolId: 2 + poolName: My pool + recipientIntegrationId: URNGV8294NV + giveawayId: 5 + code: 57638t-67439hty properties: poolId: - description: The ID of the giveaways pool the code was taken from. + description: The internal ID of the giveaway pool. example: 2 format: int64 type: integer poolName: - description: The name of the giveaways pool the code was taken from. + description: The name of the giveaway pool. example: My pool type: string recipientIntegrationId: - description: The integration ID of the profile that was awarded the giveaway. + description: The integration ID of the customer that receives the giveaway. example: URNGV8294NV maxLength: 1000 type: string giveawayId: - description: The internal ID for the giveaway that was awarded. + description: The internal ID of the giveaway. example: 5 format: int64 type: integer code: - description: The giveaway code that was awarded. + description: The giveaway code to be rewarded. example: 57638t-67439hty type: string required: @@ -15735,24 +16311,28 @@ components: - poolId - poolName - recipientIntegrationId + title: awardGiveaway WillAwardGiveawayEffectProps: - description: The properties specific to the "awardGiveaway" effect when the - session is not closed yet. This effect replaces "awardGiveaway" only when - updating a session with any state other than "closed". This is to ensure no - giveaway codes are leaked when they are still not guaranteed to be awarded. + description: |- + The equivalent of the `awardGiveaway` effect but returned when updating a session with any state other than `closed`. This ensures no giveaway codes are leaked when they are still not guaranteed to be awarded. + + For more information about session states, see [Manage the session's state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state). + example: + poolId: 2 + poolName: My pool + recipientIntegrationId: URNGV8294NV properties: poolId: - description: The ID of the giveaways pool the code will be taken from. + description: The internal ID of the giveaway pool. example: 2 format: int64 type: integer poolName: - description: The name of the giveaways pool the code will be taken from. + description: The name of the giveaway pool. example: My pool type: string recipientIntegrationId: - description: The integration ID of the profile that will be awarded the - giveaway. + description: The integration ID of the customer that receives the giveaway. example: URNGV8294NV maxLength: 1000 type: string @@ -15760,17 +16340,35 @@ components: - poolId - poolName - recipientIntegrationId + title: willAwardGiveaway ErrorEffectProps: - description: "Whenever an error occurred during evaluation, we return an error\ - \ effect. This should never happen for rules created in the rule builder." + description: This effect is triggered whenever an error occurs during rule evaluation. + This effect only provides information about what the error is. + example: + message: An unexpected error occurred during rule evaluation. properties: message: description: The error message. type: string required: - message + title: error CustomEffectProps: - description: Effect containing custom payload. + description: |- + If you want to return data as an effect but no effect matches your use case, you can [create a custom effect](https://docs.talon.one/docs/dev/tutorials/create-custom-effects). + + Custom effects can be used as both rule effects and failure effects. + + The structure of a custom effect depends on your specifications but is always named `customEffect`. + example: + effectId: 1 + name: my_custom_effect + cartItemPosition: 1 + cartItemSubPosition: 2 + bundleIndex: 1 + bundleName: my_bundle + payload: + key: value properties: effectId: description: The ID of the custom effect that was triggered. @@ -15809,37 +16407,47 @@ components: - effectId - name - payload + title: customEffect SetDiscountPerAdditionalCostPerItemEffectProps: - description: The properties specific to the "setDiscountPerAdditionalCostPerItem" - effect. This gets triggered whenever a validated rule contained a "set discount - per additional cost per item" effect. This is a discount that should be applied - on a specific additional cost in a specific item. + description: |- + This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a **Discount additional cost per item** effect is validated. + + Use this effect when **all** items in the cart have an additional cost. If one of more items do not have an additional cost, the rule will fail. + example: + name: "Shipping discount on item #1" + additionalCostId: 1 + value: 4.99 + position: 1 + subPosition: 1 + additionalCost: shipping + desiredValue: 4.99 properties: name: - description: The name / description of this discount + description: The description of this discount. `#number` is appended to + the name. It is equal to the `position` property. type: string additionalCostId: - description: The ID of the additional cost. + description: The identifier of the additional cost to be discounted. format: int64 type: integer value: - description: The total monetary value of the discount. + description: The monetary value of the effective discount applied to the + item's additional cost. type: number position: - description: The index of the item in the cart item list containing the - additional cost to be discounted. + description: The index of the item in the `cartItem` object containing the + additional cost that this discount applies to. type: number subPosition: - description: | - For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. + description: The index of the item unit in its line item. type: number additionalCost: - description: The name of the additional cost. + description: The API name of the additional cost to be discounted. type: string desiredValue: - description: | - Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). - Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. + description: "_[(Partial discounts enabled only)](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts)_.\ + \ The monetary value of the discount to be applied to the additional cost\ + \ without considering budget limitations." type: number required: - additionalCost @@ -15847,16 +16455,23 @@ components: - name - position - value + title: setDiscountPerAdditionalCostPerItem ReserveCouponEffectProps: - description: The properties specific to the "reserveCoupon" effect. This gets - triggered whenever a validated rule contained a "reserve coupon" effect. This - reserves the coupon currently on scope to the profile on scope. + description: |- + This effect indicates that the given coupon code was reserved for the given customer. + + Talon.One provides soft and hard reservations. For more information, see [Reserve a coupon code](https://docs.talon.one/docs/product/rules/effects/use-effects#reserve-a-coupon-code). + example: + couponValue: COUP-XYZ789 + profileIntegrationId: customer_profile_id_1 + isNewReservation: true properties: couponValue: - description: The value of the coupon currently on scope. + description: The coupon code that was created. type: string profileIntegrationId: - description: The ID of this customer profile in the third-party integration. + description: The integration identifier of the customer for whom this coupon + was reserved. type: string isNewReservation: description: Indicates whether this is a new coupon reservation or not. @@ -15865,9 +16480,17 @@ components: - couponValue - isNewReservation - profileIntegrationId + title: reserveCoupon AddToAudienceEffectProps: - description: The properties specific to the "addToAudience" effect. This gets - triggered whenever a validated rule contains an "addToAudience" effect. + description: "This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience)\ + \ effect with **Add customer to an audience** selected is validated. It indicates\ + \ that a customer was added to an audience and is returned when a customer\ + \ session is opened, updated, or closed." + example: + audienceId: 10 + audienceName: My audience + profileIntegrationId: URNGV8294NV + profileId: 150 properties: audienceId: description: The internal ID of the audience. @@ -15888,9 +16511,17 @@ components: example: 150 format: int64 type: integer + title: addToAudience RemoveFromAudienceEffectProps: - description: The properties specific to the "removeFromAudience" effect. This - gets triggered whenever a validated rule contains a "removeFromAudience" effect. + description: "This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience)\ + \ effect with **Remove customer from an audience** selected is validated.\ + \ It indicates that a customer was removed from an audience and is returned\ + \ when a customer session is opened, updated, or closed." + example: + audienceId: 10 + audienceName: My audience + profileIntegrationId: URNGV8294NV + profileId: 150 properties: audienceId: description: The internal ID of the audience. @@ -15911,10 +16542,20 @@ components: example: 150 format: int64 type: integer + title: removeFromAudience IncreaseAchievementProgressEffectProps: - description: The properties specific to the "increaseAchievementProgress" effect. - This gets triggered whenever a validated rule contained an "increase customer - progress" effect. + description: |- + This effect indicates that the customer's progress in an achievement was updated during the current session. It is triggered when a rule using the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect is successfully validated. + + For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), any customer progress exceeding the target automatically starts a new iteration. This generates a new `progressTrackerId` for each iteration, and there can be multiple progress updates for the same achievement from a single validation of this effect. + example: + achievementId: 10 + achievementName: FreeCoffee10Orders + progressTrackerId: 42 + delta: 1 + value: 7 + target: 10 + isJustCompleted: false properties: achievementId: description: The internal ID of the achievement. @@ -15926,12 +16567,14 @@ components: example: FreeCoffee10Orders type: string progressTrackerId: - description: The internal ID of the achievement progress tracker. + description: |- + The internal ID of the customer progress tracker. + For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. format: int64 type: integer delta: description: The value by which the customer's current progress in the achievement - is increased. + has increased. type: number value: description: The current progress of the customer in the achievement. @@ -15950,11 +16593,21 @@ components: - isJustCompleted - target - value + title: increaseAchievementProgress RollbackIncreasedAchievementProgressEffectProps: - description: The properties specific to the "rollbackIncreasedAchievementProgress" - effect. This gets triggered whenever a closed session where the `increaseAchievementProgress` - effect was triggered is cancelled. This is applicable only when the customer - has not completed the achievement. + description: |- + This effect indicates that the customer's progress in an achievement was rolled back. + + The Rule Engine triggers this effect when you cancel or [reopen a customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) that previously validated the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect and triggered the [increaseAchievementProgress](https://docs.talon.one/docs/dev/integration-api/api-effects#increaseachievementprogress) API effect. + + The effect is also triggered for completed achievements if the **Allow progress rollback for completed achievements** setting is enabled. You can enable this through the [Campaign Manager](https://docs.talon.one/docs/product/campaigns/achievements/manage-achievements) or the [Management API](https://docs.talon.one/management-api#tag/Achievements/operation/createAchievement) by setting the `achievementAllowRollbackAfterCompletion` property to `true`. This setting only applies to one-time and recurring on expiration achievements. + example: + achievementId: 10 + achievementName: FreeCoffee10Orders + progressTrackerId: 42 + decreaseProgressBy: 1 + currentProgress: 6 + target: 10 properties: achievementId: description: The internal ID of the achievement. @@ -15971,7 +16624,7 @@ components: type: integer decreaseProgressBy: description: The value by which the customer's current progress in the achievement - is decreased. + has decreased. type: number currentProgress: description: The current progress of the customer in the achievement. @@ -15986,6 +16639,7 @@ components: - decreaseProgressBy - progressTrackerId - target + title: rollbackIncreasedAchievementProgress LoyaltyLedgerEntryExpiryDateChange: description: The properties specific to effects for changing the expiry dates of loyalty ledger entries. @@ -16010,7 +16664,12 @@ components: - transactionUUID ExtendLoyaltyPointsExpiryDateEffectProps: description: | - The properties specific to the "extendLoyaltyPointsExpiryDate" effect. This gets triggered when a validated rule contains the "extend expiry date" effect. The current expiry date gets extended by the time frame given in the effect. + If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration. + example: + programId: 5 + subLedgerId: main + extensionDuration: 12h + affectedTransactions: [] properties: programId: description: ID of the loyalty program that contains these points. @@ -16018,7 +16677,7 @@ components: type: integer subLedgerId: description: API name of the loyalty program subledger that contains these - points. added. + points. type: string extensionDuration: description: | @@ -16050,11 +16709,47 @@ components: items: $ref: "#/components/schemas/LoyaltyLedgerEntryExpiryDateChange" type: array + default: null required: - extensionDuration - previousExpirationDate - programId - subLedgerId + title: extendLoyaltyPointsExpiryDate + SetLoyaltyPointsExpiryDateEffectProps: + description: | + This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date. + example: + programId: 5 + subLedgerId: main + newExpiryDate: 2024-07-24T14:15:22Z + affectedTransactions: [] + properties: + programId: + description: ID of the loyalty program that contains these points. + format: int64 + type: integer + subLedgerId: + description: API name of the loyalty program subledger that contains these + points. + type: string + newExpiryDate: + description: The specified expiry date and time for all active and pending + point transactions in the loyalty program subledger. + example: 2024-07-24T14:15:22Z + format: date-time + type: string + affectedTransactions: + description: List of transactions affected by the expiry date update. + items: + $ref: "#/components/schemas/LoyaltyLedgerEntryExpiryDateChange" + type: array + default: null + required: + - newExpiryDate + - programId + - subLedgerId + title: setLoyaltyPointsExpiryDate Effect: allOf: - $ref: "#/components/schemas/EffectEntity" @@ -16065,116 +16760,66 @@ components: required: - props example: + experimentId: 12 + campaignId: 244 rulesetId: 73 ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 IntegrationCustomerSessionResponse: example: - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 customerSession: - couponCodes: - - XMAS-20-2021 - cartItemAdditionalCostTotal: 15 - updateCount: 3 + id: 6 created: 2020-02-07T08:15:22Z - identifiers: - - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea integrationId: URNGV8294NV - experimentVariantAllocations: - - experimentID: 1 - variantID: 2 - - experimentID: 1 - variantID: 2 - total: 134.99 - loyaltyCards: - - loyalty-card-1 - additionalCosts: - shipping: - price: 9 - additionalCostTotal: 20 - storeIntegrationId: STORE-001 + applicationId: 322 profileId: URNGV8294NV + storeIntegrationId: STORE-001 evaluableCampaignIds: - 10 - 12 + couponCodes: + - XMAS-20-2021 referralCode: NT2K54D9 - attributes: - ShippingCity: Berlin - id: 6 + loyaltyCards: + - loyalty-card-1 state: open - applicationId: 322 cartItems: - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -16183,30 +16828,30 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -16215,10 +16860,60 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - updated: 2020-02-08T14:15:22Z + experimentVariantAllocations: + - experimentID: 1 + variantID: 2 + - experimentID: 1 + variantID: 2 + additionalCosts: + shipping: + price: 9 + identifiers: + - d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea + attributes: + ShippingCity: Berlin firstSession: true + updateCount: 3 + total: 134.99 cartItemTotal: 99.99 + additionalCostTotal: 20 + cartItemAdditionalCostTotal: 15 + updated: 2020-02-08T14:15:22Z + effects: + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" properties: customerSession: $ref: "#/components/schemas/CustomerSessionV2" @@ -16230,14 +16925,15 @@ components: items: $ref: "#/components/schemas/Effect" type: array + default: null ErrorSource: description: | The source of the current error, exactly one of `pointer`, `parameter` or `line` will be defined. example: pointer: pointer - resource: resource - line: line parameter: parameter + line: line + resource: resource properties: pointer: description: Pointer to the path in the payload that caused this error. @@ -16254,13 +16950,13 @@ components: type: string APIError: example: + title: title details: details source: pointer: pointer - resource: resource - line: line parameter: parameter - title: title + line: line + resource: resource properties: title: description: Short description of the problem. @@ -16277,20 +16973,20 @@ components: example: message: message errors: - - details: details + - title: title + details: details source: pointer: pointer - resource: resource - line: line parameter: parameter - title: title - - details: details + line: line + resource: resource + - title: title + details: details source: pointer: pointer - resource: resource - line: line parameter: parameter - title: title + line: line + resource: resource properties: message: description: A message describing the error. @@ -16300,27 +16996,28 @@ components: items: $ref: "#/components/schemas/APIError" type: array + default: null required: - message ErrorResponseWithStatus: example: message: message - StatusCode: 2 errors: - - details: details + - title: title + details: details source: pointer: pointer - resource: resource - line: line parameter: parameter - title: title - - details: details + line: line + resource: resource + - title: title + details: details source: pointer: pointer - resource: resource - line: line parameter: parameter - title: title + line: line + resource: resource + StatusCode: 2 properties: message: type: string @@ -16329,6 +17026,7 @@ components: items: $ref: "#/components/schemas/APIError" type: array + default: null StatusCode: description: The error code format: int64 @@ -16371,6 +17069,7 @@ components: - campaignEligibility type: string type: array + default: null required: - customerSession CustomerProfileEntity: @@ -16418,8 +17117,8 @@ components: - loyaltyProgramId AudienceMembership: example: - name: Travel audience id: 2 + name: Travel audience properties: id: description: The ID of the audience belonging to this entity. @@ -16471,12 +17170,14 @@ components: $ref: "#/components/schemas/LoyaltyMembership" title: Loyalty programed joined type: array + default: null audienceMemberships: description: The audiences the customer belongs to. items: $ref: "#/components/schemas/AudienceMembership" title: Audience memberships type: array + default: null lastActivity: description: | Timestamp of the most recent event received from this customer. @@ -16501,27 +17202,27 @@ components: - lastActivity - totalSales example: - accountId: 31 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false LoyaltyProgramEntity: properties: programID: @@ -16692,17 +17393,17 @@ components: example: Silver type: string example: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver LoyaltyCard: allOf: - $ref: "#/components/schemas/Entity" @@ -16723,6 +17424,7 @@ components: items: $ref: "#/components/schemas/LoyaltyCardProfileRegistration" type: array + default: null ledger: allOf: - $ref: "#/components/schemas/LedgerInfo" @@ -16756,59 +17458,59 @@ components: - identifier - usersPerCardLimit example: - ledger: "" + id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active + batchId: wdefpov LoyaltyProgramLedgers: description: Customer-specific information about loyalty points. example: - ledger: "" + id: 5 + title: My loyalty program + name: program1 joinDate: 2024-04-30T15:04:05Z07:00 + ledger: "" subLedgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - name: program1 - id: 5 - title: My loyalty program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver properties: id: description: The internal ID of loyalty program. @@ -16849,90 +17551,90 @@ components: description: Customer-specific information about loyalty points. example: cards: - - ledger: "" + - id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 + batchId: wdefpov + - id: 6 + created: 2020-06-10T09:05:27.993483Z programID: 125 + programName: Loyalty_program + programTitle: Loyalty program status: active - - ledger: "" + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active + batchId: wdefpov programs: key: - ledger: "" + id: 5 + title: My loyalty program + name: program1 joinDate: 2024-04-30T15:04:05Z07:00 + ledger: "" subLedgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - name: program1 - id: 5 - title: My loyalty program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver properties: cards: description: Displays information about the balances of the loyalty cards. @@ -16940,6 +17642,7 @@ components: $ref: "#/components/schemas/LoyaltyCard" title: Point balances of the loyalty cards used. type: array + default: null programs: additionalProperties: $ref: "#/components/schemas/LoyaltyProgramLedgers" @@ -16974,7 +17677,6 @@ components: - userId CodeGeneratorSettings: example: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -17012,6 +17714,7 @@ components: - "7" - "8" - "9" + couponPattern: SUMMER-####-#### properties: validCharacters: description: | @@ -17056,6 +17759,7 @@ components: items: type: string type: array + default: null couponPattern: description: | The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. @@ -17069,11 +17773,11 @@ components: - validCharacters LimitConfig: example: + action: createCoupon + limit: 1000 period: yearly entities: - Coupon - limit: 1000 - action: createCoupon properties: action: description: | @@ -17112,6 +17816,7 @@ components: - Session type: string type: array + default: null required: - action - entities @@ -17169,6 +17874,7 @@ components: type: string maxItems: 50 type: array + default: null reevaluateOnReturn: description: Indicates whether this campaign should be reevaluated when a customer returns an item. @@ -17191,6 +17897,7 @@ components: - advancedEvents type: string type: array + default: null couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" referralSettings: @@ -17201,6 +17908,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null campaignGroups: description: | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. @@ -17211,6 +17919,7 @@ components: format: int64 type: integer type: array + default: null type: default: advanced description: | @@ -17238,6 +17947,7 @@ components: format: int64 type: integer type: array + default: null couponAttributes: description: Arbitrary properties associated with coupons in this campaign. type: object @@ -17249,8 +17959,8 @@ components: - tags CampaignBudget: example: - limit: 1000 action: createCoupon + limit: 1000 counter: 42 properties: action: @@ -17288,6 +17998,7 @@ components: items: $ref: "#/components/schemas/CampaignBudget" type: array + default: null couponRedemptionCount: description: | This property is **deprecated**. The count should be available under *budgets* property. @@ -17440,6 +18151,7 @@ components: format: int64 type: integer type: array + default: null experimentId: description: The ID of the Experiment this Campaign is part of. example: 1 @@ -17505,120 +18217,24 @@ components: - reevaluateOnReturn type: object example: - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 - features: - - coupons - - referrals - createdLoyaltyPointsCount: 9 - storesImported: true - 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" - experimentId: 1 id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - revisionFrontendState: revised + userId: 388 + name: Summer promotions 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled activeRulesetId: 6 + tags: + - summer reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: - couponPattern: SUMMER-####-#### + features: + - coupons + - referrals + couponSettings: validCharacters: - A - B @@ -17656,10 +18272,106 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + referralSettings: + 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" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false IntegrationCampaignBase: allOf: - $ref: "#/components/schemas/ApplicationEntity" @@ -17710,6 +18422,7 @@ components: type: string maxItems: 50 type: array + default: null features: description: The features enabled in this campaign. example: @@ -17725,6 +18438,7 @@ components: - achievements type: string type: array + default: null required: - features - id @@ -17747,9 +18461,9 @@ components: - failureCode CampaignEligibilityDetails: example: - details: "" passed: true couponCode: couponCode + details: "" properties: passed: description: Indicates whether the customer was eligible for the campaign @@ -17768,11 +18482,11 @@ components: - passed RuleMetadata: example: + title: Give discount via coupon + displayName: 20% off all shoes! displayDescription: Get a 20% discount on all shoes during Thanksgiving! Offer valid till Dec 5 only. - displayName: 20% off all shoes! relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon properties: title: description: A short description of the rule. @@ -17844,9 +18558,9 @@ components: description: "The customer's eligibility for a rule in the current session,\ \ based on whether all of the rule's conditions were met." example: - details: "" passed: true couponCode: couponCode + details: "" properties: passed: description: "Indicates whether the customer was eligible for the rule in\ @@ -17873,29 +18587,51 @@ components: items: $ref: "#/components/schemas/RuleEligibility" type: array + default: null required: - eligibility example: + title: Give discount via coupon + displayName: 20% off all shoes! displayDescription: Get a 20% discount on all shoes during Thanksgiving! Offer valid till Dec 5 only. - displayName: 20% off all shoes! + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon + details: "" + CampaignEligibilityExperiment: + description: | + The identifiers for the [experiment](https://docs.talon.one/management-api#tag/Experiments) and the variant assigned to the customer profile. + Only returned when the customer profile has been assigned to a variant in an experiment campaign. + example: + id: 0 + variantId: 6 + properties: + id: + description: The ID of the experiment. + format: int64 + type: integer + variantId: + description: The ID of the variant assigned to the customer profile. + format: int64 + type: integer + required: + - id + - variantId CampaignEligibility: allOf: - $ref: "#/components/schemas/IntegrationCampaignBase" - description: "A list of campaigns and their evaluation status for the current\ - \ customer session.\n\n**Note**:\n\n- This response can **only** be included\ - \ if the `dry` parameter in the query is set to `true`. \n- Do not include\ - \ `triggeredCampaigns` or `ruleFailureReasons` in `responseContent` to avoid\ - \ duplicate results.\n" + \ customer session.\n\nFor experiment campaigns, the experiment and variant\ + \ assigned to the customer profile are\nreturned through the `experiment`\ + \ field. Customer profiles with no variant assignment are not included.\n\ + \n**Note**:\n\n- This response can **only** be included if the `dry` parameter\ + \ in the query is set to `true`. \n- Do not include `triggeredCampaigns`\ + \ or `ruleFailureReasons` in `responseContent` to avoid duplicate results.\n" properties: eligibility: description: The customer's eligibility for each campaign in the current @@ -17903,78 +18639,85 @@ components: items: $ref: "#/components/schemas/CampaignEligibilityDetails" type: array + default: null rules: description: A list of rules containing customer-facing details of the rewards defined in the campaign. items: $ref: "#/components/schemas/RuleMetadataEligibility" type: array + default: null + experiment: + $ref: "#/components/schemas/CampaignEligibilityExperiment" required: - eligibility - rules example: + applicationId: 322 + id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer features: - coupons - referrals - name: Summer promotions - description: Campaign for all summer 2021 promotions eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer + details: "" + experiment: + id: 0 + variantId: 6 RuleFailureReason: description: Details about why a rule failed. example: - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable + campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName + evaluationGroupID: 3 + evaluationGroupMode: stackable properties: campaignID: description: The ID of the campaign that contains the rule that failed. @@ -18122,6 +18865,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null Coupon: allOf: - $ref: "#/components/schemas/CouponEntity" @@ -18204,38 +18948,38 @@ components: required: - usageCounter example: - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false + implicitlyReserved: false ReferralConstraints: properties: startDate: @@ -18283,18 +19027,18 @@ components: title: Friend's Profile ID type: string attributes: - $ref: "#/components/schemas/NewReferral_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" required: - advocateProfileIntegrationId - campaignId example: + startDate: 2020-11-10T23:00:00Z expiryDate: 2021-11-10T23:00:00Z - friendProfileIntegrationId: BZGGC2454PA usageLimit: 1 campaignId: 78 - attributes: "{channel=web}" - startDate: 2020-11-10T23:00:00Z advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null ImportEntity: properties: importId: @@ -18330,19 +19074,19 @@ components: - code - usageCounter example: - code: 27G47Y54VH9L + id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe Giveaway: allOf: - $ref: "#/components/schemas/Entity" @@ -18367,7 +19111,7 @@ components: format: date-time type: string attributes: - $ref: "#/components/schemas/Giveaway_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" used: description: Indicates whether this giveaway code was given before. example: true @@ -18392,17 +19136,17 @@ components: - code - poolId example: - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 + id: 6 created: 2020-06-10T09:05:27.993483Z - profileId: 1 + code: GIVEAWAY1 poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 attributes: null - id: 6 used: true - startDate: 2022-01-02T15:04:05Z07:00 + importId: 4 + profileIntegrationId: R195412 + profileId: 1 IntegrationResponse: description: | Contains entities that might be valuable in Talon.One integrations. @@ -18421,6 +19165,7 @@ components: items: $ref: "#/components/schemas/Campaign" type: array + default: null campaignEligibility: description: "A list of campaigns and their evaluation status for the current\ \ customer session.\n\n**Note**:\n\n- This response can **only** be included\ @@ -18430,12 +19175,14 @@ components: items: $ref: "#/components/schemas/CampaignEligibility" type: array + default: null effects: description: "The effects generated by the rules in your running campaigns.\ \ See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects)." items: $ref: "#/components/schemas/Effect" type: array + default: null ruleFailureReasons: description: | The reasons why certain rules were not triggered during the event @@ -18443,21 +19190,25 @@ components: items: $ref: "#/components/schemas/RuleFailureReason" type: array + default: null createdCoupons: description: The coupons that were created during the event processing. items: $ref: "#/components/schemas/Coupon" type: array + default: null createdReferrals: description: The referrals that were created during the event processing. items: $ref: "#/components/schemas/Referral" type: array + default: null awardedGiveaways: description: The giveaways that were awarded during the event processing. items: $ref: "#/components/schemas/Giveaway" type: array + default: null required: - createdCoupons - createdReferrals @@ -18471,25 +19222,26 @@ components: items: type: string type: array + default: null required: - referredCustomers example: - code: 27G47Y54VH9L + id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe referredCustomers: - referredCustomers - referredCustomers - id: 6 - startDate: 2020-11-10T23:00:00Z IntegrationCoupon: allOf: - $ref: "#/components/schemas/Coupon" @@ -18503,39 +19255,39 @@ components: required: - profileRedemptionCount example: - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 IntegrationEvent: allOf: - $ref: "#/components/schemas/IntegrationProfileEntity" @@ -18549,7 +19301,7 @@ components: title: Event Type type: string attributes: - $ref: "#/components/schemas/IntegrationEvent_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" required: - attributes - type @@ -18607,24 +19359,24 @@ components: - loyaltyProgramId - reason example: - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 + id: 6 created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV + accountId: 0 loyaltyProgramId: 323414846 - id: 6 + eventId: 3 + amount: 100 + reason: Customer appeasement. + expiryDate: 2022-04-26T11:02:38Z referenceId: 6 CouponRejectionReason: description: "Holds a reference to the campaign, the coupon and the reason for\ \ which that coupon was rejected. Should only be present when there is a 'rejectCoupon'\ \ effect." example: - reason: CouponNotFound campaignId: 244 couponId: 4928 + reason: CouponNotFound properties: campaignId: example: 244 @@ -18659,9 +19411,9 @@ components: \ for which that referral was rejected. Should only be present when there\ \ is a 'rejectReferral' effect." example: - reason: ReferralNotFound campaignId: 1 referralId: 5 + reason: ReferralNotFound properties: campaignId: format: int64 @@ -18693,15 +19445,15 @@ components: example: campaigns: "{}" coupons: "{}" + couponRejectionReason: + campaignId: 244 + couponId: 4928 + reason: CouponNotFound referralRejectionReason: - reason: ReferralNotFound campaignId: 1 referralId: 5 + reason: ReferralNotFound warnings: "{}" - couponRejectionReason: - reason: CouponNotFound - campaignId: 244 - couponId: 4928 properties: campaigns: description: Maps each evaluated campaign ID to a key-value list of that @@ -18737,61 +19489,63 @@ components: items: type: object type: array + default: null ledgerEntries: description: Ledger entries for the event. items: $ref: "#/components/schemas/LedgerEntry" type: array + default: null meta: $ref: "#/components/schemas/Meta" required: - effects example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: URNGV8294NV + storeIntegrationId: STORE-001 + type: pageViewed + attributes: null + integrationId: 175KJPS947296 + sessionId: 175KJPS947296 effects: - "{}" - "{}" - storeIntegrationId: STORE-001 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - meta: - campaigns: "{}" - coupons: "{}" - referralRejectionReason: - reason: ReferralNotFound - campaignId: 1 - referralId: 5 - warnings: "{}" - couponRejectionReason: - reason: CouponNotFound - campaignId: 244 - couponId: 4928 ledgerEntries: - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 + - id: 6 created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV - loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - - expiryDate: 2022-04-26T11:02:38Z accountId: 0 + loyaltyProgramId: 323414846 eventId: 3 - reason: Customer appeasement. amount: 100 + reason: Customer appeasement. + expiryDate: 2022-04-26T11:02:38Z + referenceId: 6 + - id: 6 created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV + accountId: 0 loyaltyProgramId: 323414846 - id: 6 + eventId: 3 + amount: 100 + reason: Customer appeasement. + expiryDate: 2022-04-26T11:02:38Z referenceId: 6 - integrationId: 175KJPS947296 - attributes: "{myAttribute=myValue}" - id: 6 - sessionId: 175KJPS947296 - applicationId: 322 - type: pageViewed + meta: + campaigns: "{}" + coupons: "{}" + couponRejectionReason: + campaignId: 244 + couponId: 4928 + reason: CouponNotFound + referralRejectionReason: + campaignId: 1 + referralId: 5 + reason: ReferralNotFound + warnings: "{}" EventV3Connections: properties: connectedSessionId: @@ -18816,8 +19570,22 @@ components: items: type: object type: array + default: null required: - effects + example: + connectedSessionId: 175KJPS947296 + id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: URNGV8294NV + storeIntegrationId: STORE-001 + type: pageViewed + attributes: null + integrationId: 175KJPS947296 + effects: + - "{}" + - "{}" AccountEntity: properties: accountId: @@ -18829,8 +19597,8 @@ components: - accountId ReturnedCartItem: example: - quantity: 1 position: 2 + quantity: 1 sku: SKU1241028 properties: position: @@ -18858,6 +19626,7 @@ components: items: $ref: "#/components/schemas/ReturnedCartItem" type: array + default: null required: - returnedCartItems Return: @@ -18912,23 +19681,23 @@ components: - sessionId - sessionIntegrationId example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + accountId: 3886 returnedCartItems: - - quantity: 1 - position: 2 + - position: 2 + quantity: 1 sku: SKU1241028 - - quantity: 1 - position: 2 + - position: 2 + quantity: 1 sku: SKU1241028 - accountId: 3886 eventId: 123 - profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionId: 123 sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c - createdBy: 123 - created: 2020-06-10T09:05:27.993483Z profileId: 123 - id: 6 - sessionId: 123 - applicationId: 322 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 IntegrationStateV2: allOf: - $ref: "#/components/schemas/IntegrationResponse" @@ -18944,6 +19713,7 @@ components: items: $ref: "#/components/schemas/IntegrationCoupon" type: array + default: null event: allOf: - $ref: "#/components/schemas/Event" @@ -18965,172 +19735,29 @@ components: items: $ref: "#/components/schemas/Return" type: array + default: null example: customerProfile: "" loyalty: "" - awardedGiveaways: - - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z - profileId: 1 - poolId: 1 - attributes: null - id: 6 - used: true - startDate: 2022-01-02T15:04:05Z07:00 - - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z - profileId: 1 - poolId: 1 - attributes: null - id: 6 - used: true - startDate: 2022-01-02T15:04:05Z07:00 - createdCoupons: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - createdReferrals: - - code: 27G47Y54VH9L - created: 2020-06-10T09:05:27.993483Z - usageLimit: 1 - campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe - advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 - friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L - created: 2020-06-10T09:05:27.993483Z - usageLimit: 1 - campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe - advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 - friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - referral: "" triggeredCampaigns: - - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -19168,72 +19795,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -19271,21 +19834,85 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - - type: advanced - templateId: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -19323,72 +19950,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -19426,236 +19989,450 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z - referralRedemptionCount: 3 - coupons: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z + couponPattern: SUMMER-####-#### limits: - - period: yearly - entities: - - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z - limits: - - period: yearly + period: yearly entities: - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon + counter: 42 + - action: createCoupon limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - customerSession: "" - previousReturns: - - returnedCartItems: - - quantity: 1 - position: 2 - sku: SKU1241028 - - quantity: 1 - position: 2 - sku: SKU1241028 - accountId: 3886 - eventId: 123 - profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c - sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c - createdBy: 123 - created: 2020-06-10T09:05:27.993483Z - profileId: 123 - id: 6 - sessionId: 123 - applicationId: 322 - - returnedCartItems: - - quantity: 1 - position: 2 - sku: SKU1241028 - - quantity: 1 - position: 2 - sku: SKU1241028 - accountId: 3886 - eventId: 123 - profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c - sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c - createdBy: 123 - created: 2020-06-10T09:05:27.993483Z - profileId: 123 - id: 6 - sessionId: 123 - applicationId: 322 + counter: 42 + couponRedemptionCount: 163 + referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false campaignEligibility: - - features: - - coupons - - referrals + - applicationId: 322 + id: 4 name: Summer promotions description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon + details: "" + experiment: + id: 0 + variantId: 6 + - applicationId: 322 id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z endTime: 2021-09-22T22:00:00Z + attributes: null state: enabled - applicationId: 322 tags: - summer - - features: + features: - coupons - referrals - name: Summer promotions - description: Campaign for all summer 2021 promotions eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer - advancedEvent: "" - event: "" - ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 + details: "" + experiment: + id: 0 + variantId: 6 + effects: + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + ruleFailureReasons: + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 + evaluationGroupID: 3 evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName + evaluationGroupID: 3 + evaluationGroupMode: stackable + createdCoupons: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + createdReferrals: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 + created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + awardedGiveaways: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + referral: "" + coupons: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 + event: "" + advancedEvent: "" + customerSession: "" return: "" + previousReturns: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + accountId: 3886 + returnedCartItems: + - position: 2 + quantity: 1 + sku: SKU1241028 + - position: 2 + quantity: 1 + sku: SKU1241028 + eventId: 123 + sessionId: 123 + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + profileId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + accountId: 3886 + returnedCartItems: + - position: 2 + quantity: 1 + sku: SKU1241028 + - position: 2 + quantity: 1 + sku: SKU1241028 + eventId: 123 + sessionId: 123 + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + profileId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 ReturnIntegrationRequest: description: "The body of a return integration API request. Next to the cart\ \ items details, this contains an optional listing of extra properties that\ @@ -19689,6 +20466,7 @@ components: - previousReturns type: string type: array + default: null required: - return ReopenSessionResponse: @@ -19696,40 +20474,40 @@ components: This is the response type returned by the Reopen customer sessions endpoint. It contains the rolled back effects. example: effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 + - experimentId: 12 campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 ruleName: Give 20% discount - experimentId: 12 + effectType: rejectCoupon triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 properties: effects: description: "The effects generated by the rules in your running campaigns.\ @@ -19737,6 +20515,7 @@ components: items: $ref: "#/components/schemas/Effect" type: array + default: null required: - effects ResponseContentObject: @@ -19758,6 +20537,7 @@ components: - campaignEligibility type: string type: array + default: null ProfileAudiencesChanges: properties: adds: @@ -19770,6 +20550,7 @@ components: type: integer title: Audiences to join type: array + default: null deletes: description: The IDs of the audiences for the customer to leave. example: @@ -19779,6 +20560,7 @@ components: type: integer title: Audiences to leave type: array + default: null required: - adds - deletes @@ -19796,67 +20578,193 @@ components: - $ref: "#/components/schemas/ProfileAudiencesChanges" description: Audiences memberships changes for this profile. example: - evaluableCampaignIds: - - 10 - - 12 attributes: Language: english ShippingCountry: DE - audiencesChanges: "" + evaluableCampaignIds: + - 10 + - 12 responseContent: - triggeredCampaigns - customerProfile + audiencesChanges: "" CustomerProfileIntegrationResponseV2: description: | This is the response type returned by the updateCustomerProfileV2 endpoint. example: - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 + customerProfile: + id: 6 + created: 2020-02-07T08:15:22Z + integrationId: URNGV8294NV + attributes: + Language: english + ShippingCountry: DE + accountId: 31 + closedSessions: 3 + totalSales: 299.99 + loyaltyMemberships: + - joined: 2012-03-20T14:15:22Z + loyaltyProgramId: 323414846 + - joined: 2012-03-20T14:15:22Z + loyaltyProgramId: 323414846 + audienceMemberships: + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false + event: + id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: URNGV8294NV + storeIntegrationId: STORE-001 + type: pageViewed + attributes: null + integrationId: 175KJPS947296 + sessionId: 175KJPS947296 + effects: + - "{}" + - "{}" + ledgerEntries: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + profileId: URNGV8294NV + accountId: 0 + loyaltyProgramId: 323414846 + eventId: 3 + amount: 100 + reason: Customer appeasement. + expiryDate: 2022-04-26T11:02:38Z + referenceId: 6 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + profileId: URNGV8294NV + accountId: 0 + loyaltyProgramId: 323414846 + eventId: 3 + amount: 100 + reason: Customer appeasement. + expiryDate: 2022-04-26T11:02:38Z + referenceId: 6 + meta: + campaigns: "{}" + coupons: "{}" + couponRejectionReason: + campaignId: 244 + couponId: 4928 + reason: CouponNotFound + referralRejectionReason: + campaignId: 1 + referralId: 5 + reason: ReferralNotFound + warnings: "{}" + loyalty: + cards: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. + identifier: summer-loyalty-card-0543 + usersPerCardLimit: 111 + profiles: + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + ledger: "" + subledgers: + key: + currentBalance: 100 + pendingBalance: 10 + negativeBalance: 10 + expiredBalance: 0 + spentBalance: 0 + tentativeCurrentBalance: 100 + tentativePendingBalance: 20 + tentativeNegativeBalance: 100 + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver + modified: 2021-09-12T10:12:42Z + oldCardIdentifier: summer-loyalty-card-0543 + newCardIdentifier: autumn-loyalty-card-5822 + batchId: wdefpov + - id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. + identifier: summer-loyalty-card-0543 + usersPerCardLimit: 111 + profiles: + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + ledger: "" + subledgers: + key: + currentBalance: 100 + pendingBalance: 10 + negativeBalance: 10 + expiredBalance: 0 + spentBalance: 0 + tentativeCurrentBalance: 100 + tentativePendingBalance: 20 + tentativeNegativeBalance: 100 + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver + modified: 2021-09-12T10:12:42Z + oldCardIdentifier: summer-loyalty-card-0543 + newCardIdentifier: autumn-loyalty-card-5822 + batchId: wdefpov + programs: + key: + id: 5 + title: My loyalty program + name: program1 + joinDate: 2024-04-30T15:04:05Z07:00 + ledger: "" + subLedgers: + key: + currentBalance: 100 + pendingBalance: 10 + negativeBalance: 10 + expiredBalance: 0 + spentBalance: 0 + tentativeCurrentBalance: 100 + tentativePendingBalance: 20 + tentativeNegativeBalance: 100 + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver triggeredCampaigns: - - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -19894,72 +20802,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -19997,21 +20841,85 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - - type: advanced - templateId: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -20049,72 +20957,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -20141,410 +20985,354 @@ components: - W - X - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z - referralRedemptionCount: 3 - customerProfile: - accountId: 31 - closedSessions: 3 - created: 2020-02-07T08:15:22Z - sandbox: false - integrationId: URNGV8294NV - attributes: - Language: english - ShippingCountry: DE - totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 - loyaltyMemberships: - - joined: 2012-03-20T14:15:22Z - loyaltyProgramId: 323414846 - - joined: 2012-03-20T14:15:22Z - loyaltyProgramId: 323414846 - audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - loyalty: - cards: - - ledger: "" - identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 - usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z - profiles: - - integrationId: R195412 - timestamp: 2021-09-12T10:12:42Z - - integrationId: R195412 - timestamp: 2021-09-12T10:12:42Z - subledgers: - key: - pendingBalance: 10 - nextTierName: Silver - negativeBalance: 10 - currentBalance: 100 - spentBalance: 0 - tentativeCurrentBalance: 100 - tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze - tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program - modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. - newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active - - ledger: "" - identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 - usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z - profiles: - - integrationId: R195412 - timestamp: 2021-09-12T10:12:42Z - - integrationId: R195412 - timestamp: 2021-09-12T10:12:42Z - subledgers: - key: - pendingBalance: 10 - nextTierName: Silver - negativeBalance: 10 - currentBalance: 100 - spentBalance: 0 - tentativeCurrentBalance: 100 - tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze - tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program - modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. - newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active - programs: - key: - ledger: "" - joinDate: 2024-04-30T15:04:05Z07:00 - subLedgers: - key: - pendingBalance: 10 - nextTierName: Silver - negativeBalance: 10 - currentBalance: 100 - spentBalance: 0 - tentativeCurrentBalance: 100 - tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze - tentativeNegativeBalance: 100 - name: program1 - id: 5 - title: My loyalty program + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 + referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + ruleFailureReasons: + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable campaignEligibility: - - features: - - coupons - - referrals + - applicationId: 322 + id: 4 name: Summer promotions description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon + details: "" + experiment: + id: 0 + variantId: 6 + - applicationId: 322 id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z endTime: 2021-09-22T22:00:00Z + attributes: null state: enabled - applicationId: 322 tags: - summer - - features: + features: - coupons - referrals - name: Summer promotions - description: Campaign for all summer 2021 promotions eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer + details: "" + experiment: + id: 0 + variantId: 6 awardedGiveaways: - - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z - profileId: 1 + code: GIVEAWAY1 poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 attributes: null - id: 6 used: true - startDate: 2022-01-02T15:04:05Z07:00 - - profileIntegrationId: R195412 - code: GIVEAWAY1 importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z + profileIntegrationId: R195412 profileId: 1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 attributes: null - id: 6 used: true - startDate: 2022-01-02T15:04:05Z07:00 - event: - effects: - - "{}" - - "{}" - storeIntegrationId: STORE-001 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - meta: - campaigns: "{}" - coupons: "{}" - referralRejectionReason: - reason: ReferralNotFound - campaignId: 1 - referralId: 5 - warnings: "{}" - couponRejectionReason: - reason: CouponNotFound - campaignId: 244 - couponId: 4928 - ledgerEntries: - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - integrationId: 175KJPS947296 - attributes: "{myAttribute=myValue}" - id: 6 - sessionId: 175KJPS947296 - applicationId: 322 - type: pageViewed + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + effects: + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" createdCoupons: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable - couponID: 4928 - referralValue: referralValue - couponValue: couponValue - evaluationGroupID: 3 - ruleName: ruleName - details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable - couponID: 4928 - referralValue: referralValue - couponValue: couponValue - evaluationGroupID: 3 - ruleName: ruleName - details: details - campaignName: campaignName + implicitlyReserved: false createdReferrals: - - code: 27G47Y54VH9L + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe properties: customerProfile: $ref: "#/components/schemas/CustomerProfile" @@ -20556,32 +21344,39 @@ components: items: $ref: "#/components/schemas/Campaign" type: array + default: null ruleFailureReasons: items: $ref: "#/components/schemas/RuleFailureReason" type: array + default: null campaignEligibility: items: $ref: "#/components/schemas/CampaignEligibility" type: array + default: null awardedGiveaways: items: $ref: "#/components/schemas/Giveaway" type: array + default: null effects: description: "The effects generated by the rules in your running campaigns.\ \ See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects)." items: $ref: "#/components/schemas/Effect" type: array + default: null createdCoupons: items: $ref: "#/components/schemas/Coupon" type: array + default: null createdReferrals: items: $ref: "#/components/schemas/Referral" type: array + default: null required: - createdCoupons - createdReferrals @@ -20605,52 +21400,53 @@ components: required: - integrationId example: - integrationId: R195412 attributes: Language: english ShippingCountry: DE + integrationId: R195412 MultipleCustomerProfileIntegrationRequest: example: customerProfiles: - - integrationId: R195412 - attributes: + - attributes: Language: english ShippingCountry: DE - - integrationId: R195412 - attributes: + integrationId: R195412 + - attributes: Language: english ShippingCountry: DE + integrationId: R195412 properties: customerProfiles: items: $ref: "#/components/schemas/MultipleCustomerProfileIntegrationRequestItem" type: array + default: null CustomerProfileUpdateV2Response: description: | Contains the updated customer profiles entities. This is the response type returned by the V2 PUT customer_profiles endpoint example: customerProfile: - accountId: 31 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: customerProfile: $ref: "#/components/schemas/CustomerProfile" @@ -20660,54 +21456,55 @@ components: example: integrationStates: - customerProfile: - accountId: 31 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false - customerProfile: - accountId: 31 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: integrationStates: items: $ref: "#/components/schemas/CustomerProfileUpdateV2Response" type: array + default: null NewInternalAudience: properties: name: @@ -20734,6 +21531,7 @@ components: type: integer type: array uniqueItems: true + default: null required: - name NewAudience: @@ -20768,16 +21566,16 @@ components: format: date-time type: string example: - lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true + description: Travel audience 18-27 subscribedApplicationsIds: - 3 - 13 integration: mparticle - description: Travel audience 18-27 integrationId: 382370BKDB946 createdIn3rdParty: false + lastUpdate: 2022-04-26T11:02:38Z Audience: allOf: - $ref: "#/components/schemas/AccountEntity" @@ -20785,18 +21583,18 @@ components: - $ref: "#/components/schemas/NewAudience" example: accountId: 3886 + id: 6 created: 2020-06-10T09:05:27.993483Z - lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true + description: Travel audience 18-27 subscribedApplicationsIds: - 3 - 13 integration: mparticle - description: Travel audience 18-27 integrationId: 382370BKDB946 - id: 6 createdIn3rdParty: false + lastUpdate: 2022-04-26T11:02:38Z UpdateAudience: example: name: Travel audience @@ -20820,12 +21618,13 @@ components: type: integer type: array uniqueItems: true + default: null required: - name CustomerProfileAudienceRequestItem: example: - profileIntegrationId: R195412 action: add + profileIntegrationId: R195412 audienceId: 748 properties: action: @@ -20859,17 +21658,18 @@ components: CustomerProfileAudienceRequest: example: data: - - profileIntegrationId: R195412 - action: add + - action: add + profileIntegrationId: R195412 audienceId: 748 - - profileIntegrationId: R195412 - action: add + - action: add + profileIntegrationId: R195412 audienceId: 748 properties: data: items: $ref: "#/components/schemas/CustomerProfileAudienceRequestItem" type: array + default: null AttributeQuery: description: Object representing a set of of attributes and their respective values. @@ -20923,6 +21723,7 @@ components: items: $ref: "#/components/schemas/IntegrationCustomerProfileAudienceRequestItem" type: array + default: null IntegrationCampaign: allOf: - $ref: "#/components/schemas/IntegrationCampaignBase" @@ -20933,33 +21734,34 @@ components: items: $ref: "#/components/schemas/RuleMetadata" type: array + default: null required: - rules example: - features: - - coupons - - referrals + applicationId: 322 + id: 4 name: Summer promotions description: Campaign for all summer 2021 promotions startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer NewAttribute: allOf: - properties: @@ -21026,6 +21828,7 @@ components: type: string maxItems: 50 type: array + default: null hasAllowedList: default: false description: Whether or not this attribute has an allowed list of values @@ -21054,6 +21857,7 @@ components: format: int64 type: integer type: array + default: null subscribedCatalogsIds: description: A list of the IDs of the catalogs where this attribute is available. @@ -21064,6 +21868,7 @@ components: format: int64 type: integer type: array + default: null allowedSubscriptions: description: | A list of allowed subscription types for this attribute. @@ -21079,6 +21884,7 @@ components: type: string maxItems: 2 type: array + default: null required: - description - editable @@ -21088,31 +21894,31 @@ components: - title - type example: - editable: true - subscribedApplicationsIds: - - 1 - - 4 - - 9 - description: Event triggered when a customer displays a page. - restrictedBySuggestions: false + entity: Event eventType: pageViewed + name: pageViewed title: Page view event type: string - hasAllowedList: false - allowedSubscriptions: - - application - - catalog - name: pageViewed + description: Event triggered when a customer displays a page. suggestions: - suggestions - suggestions - suggestions - suggestions - suggestions + hasAllowedList: false + restrictedBySuggestions: false + editable: true + subscribedApplicationsIds: + - 1 + - 4 + - 9 subscribedCatalogsIds: - 2 - 5 - entity: Event + allowedSubscriptions: + - application + - catalog Attribute: allOf: - $ref: "#/components/schemas/Entity" @@ -21124,35 +21930,35 @@ components: format: int64 type: integer example: + id: 6 created: 2020-06-10T09:05:27.993483Z - editable: true - subscribedApplicationsIds: - - 1 - - 4 - - 9 - description: Event triggered when a customer displays a page. - restrictedBySuggestions: false + accountId: 3886 + entity: Event eventType: pageViewed + name: pageViewed title: Page view event type: string - accountId: 3886 - eventTypeId: 22 - hasAllowedList: false - allowedSubscriptions: - - application - - catalog - name: pageViewed + description: Event triggered when a customer displays a page. suggestions: - suggestions - suggestions - suggestions - suggestions - suggestions - id: 6 + hasAllowedList: false + restrictedBySuggestions: false + editable: true + subscribedApplicationsIds: + - 1 + - 4 + - 9 subscribedCatalogsIds: - 2 - 5 - entity: Event + allowedSubscriptions: + - application + - catalog + eventTypeId: 22 GetIntegrationCouponRequest: properties: campaignIds: @@ -21165,6 +21971,7 @@ components: format: int64 type: integer type: array + default: null limit: default: 10 description: The maximum number of coupons included in the response. @@ -21202,40 +22009,40 @@ components: - profileRedemptionCount - state example: - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - state: active value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 + state: active EventAttributesEntity: properties: type: @@ -21273,31 +22080,32 @@ components: type: string maxItems: 1 type: array + default: null example: - loyaltyCards: - - loyalty-card-1 - storeIntegrationId: STORE-001 profileId: URNGV8294NV + storeIntegrationId: STORE-001 evaluableCampaignIds: - 10 - 12 + type: pageViewed attributes: myAttribute: myValue - type: pageViewed responseContent: - triggeredCampaigns - customerProfile + loyaltyCards: + - loyalty-card-1 AddLoyaltyPoints: description: Points to add. example: - subledgerId: sub-123 + points: 300 name: Compensation validityDuration: 5D - pendingDuration: 12h validUntil: 2021-07-20T22:00:00Z - applicationId: 322 + pendingDuration: 12h pendingUntil: 2021-07-20T22:00:00Z - points: 300 + subledgerId: sub-123 + applicationId: 322 properties: points: description: Amount of loyalty points. @@ -21412,11 +22220,13 @@ components: items: type: string type: array + default: null coupons: description: List of mandatory attributes for campaigns. items: type: string type: array + default: null AttributesSettings: description: Arbitrary settings associated with attributes. example: @@ -21468,6 +22278,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null defaultDiscountScope: description: | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. @@ -21548,6 +22359,7 @@ components: format: int64 type: integer type: array + default: null defaultValidity: description: | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. @@ -21723,6 +22535,7 @@ components: items: $ref: "#/components/schemas/LoyaltyTier" type: array + default: null timezone: description: A string containing an IANA timezone descriptor. example: Europe/Berlin @@ -21766,36 +22579,24 @@ components: - name - timezone example: - cardBased: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programID: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z - timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent + id: 139 + created: 2020-06-10T09:05:27.993483Z title: Point collection - canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -21833,20 +22634,32 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programID: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programID: 139 + timezone: Europe/Berlin + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true + canUpdateSubledgers: true Application: allOf: - $ref: "#/components/schemas/Entity" @@ -21860,16 +22673,34 @@ components: items: $ref: "#/components/schemas/LoyaltyProgram" type: array + default: null required: - loyaltyPrograms example: - enableFlattenedCartItems: true + id: 6 created: 2020-06-10T09:05:27.993483Z - timezone: Europe/Berlin - defaultCartItemFilterId: 3 - enableCampaignStateManagement: false - sandbox: true + modified: 2021-09-12T10:12:42Z + accountId: 3886 + name: My Application description: A test Application + timezone: Europe/Berlin + currency: EUR + caseSensitivity: sensitive + attributes: "{}" + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + defaultDiscountScope: sessionTotal + enableCascadingDiscounts: true + enableFlattenedCartItems: true attributesSettings: mandatory: campaigns: @@ -21878,41 +22709,31 @@ components: coupons: - coupons - coupons - caseSensitivity: sensitive - accountId: 3886 + sandbox: true + enablePartialDiscounts: false + defaultDiscountAdditionalCostPerItemScope: price defaultEvaluationGroupId: 3 - enableCascadingDiscounts: true + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false loyaltyPrograms: - - cardBased: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programID: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z - timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent + - id: 139 + created: 2020-06-10T09:05:27.993483Z title: Point collection - canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -21950,21 +22771,10 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - - cardBased: true tiers: - name: Gold minPoints: 300 @@ -21981,19 +22791,30 @@ components: id: 1 created: 2021-06-10T09:04:39.355258Z programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent - title: Point collection + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + - id: 139 + created: 2020-06-10T09:05:27.993483Z + title: Point collection + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -22031,51 +22852,46 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - name: My Application - modified: 2021-09-12T10:12:42Z - defaultDiscountScope: sessionTotal - currency: EUR - attributes: "{}" - defaultDiscountAdditionalCostPerItemScope: price - id: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - enablePartialDiscounts: false + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programID: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programID: 139 + timezone: Europe/Berlin + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true + canUpdateSubledgers: true MultipleNewAttribute: properties: attributes: items: $ref: "#/components/schemas/NewAttribute" type: array + default: null MultipleAttribute: properties: attributes: items: $ref: "#/components/schemas/Attribute" type: array + default: null AudienceIntegrationID: properties: integrationId: @@ -22097,6 +22913,7 @@ components: items: $ref: "#/components/schemas/NewMultipleAudiencesItem" type: array + default: null required: - audiences MultipleAudiencesItem: @@ -22126,6 +22943,7 @@ components: items: $ref: "#/components/schemas/MultipleAudiencesItem" type: array + default: null required: - accountId - audiences @@ -22170,6 +22988,7 @@ components: $ref: "#/components/schemas/CartItem" title: Items in customer's cart type: array + default: null identifiers: description: | Session custom identifiers that you can set limits on or use inside your rules. @@ -22183,12 +23002,13 @@ components: maxItems: 5 title: Session identifiers type: array + default: null total: description: The total sum of the cart in one session. title: Session Total type: number attributes: - $ref: "#/components/schemas/NewCustomerSession_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" CustomerSession: allOf: - $ref: "#/components/schemas/IntegrationEntity" @@ -22269,53 +23089,27 @@ components: - $ref: "#/components/schemas/Event" description: The event that was processed. example: - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 - conditionIndex: 786 - evaluationGroupMode: stackable - effectType: rejectCoupon - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 + customerProfile: "" + loyalty: "" triggeredCampaigns: - - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -22353,72 +23147,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -22456,21 +23186,85 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - - type: advanced - templateId: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -22508,72 +23302,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -22611,248 +23341,344 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - customerProfile: "" - loyalty: "" + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false campaignEligibility: - - features: - - coupons - - referrals + - applicationId: 322 + id: 4 name: Summer promotions description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon + details: "" + experiment: + id: 0 + variantId: 6 + - applicationId: 322 id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z endTime: 2021-09-22T22:00:00Z + attributes: null state: enabled - applicationId: 322 tags: - summer - - features: + features: - coupons - referrals - name: Summer promotions - description: Campaign for all summer 2021 promotions eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - startTime: 2021-07-20T22:00:00Z - attributes: null + details: "" rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + details: "" + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png eligibility: - - details: "" - passed: true + - passed: true couponCode: couponCode - - details: "" - passed: true + details: "" + - passed: true couponCode: couponCode - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer - awardedGiveaways: - - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z - profileId: 1 - poolId: 1 - attributes: null - id: 6 - used: true - startDate: 2022-01-02T15:04:05Z07:00 - - profileIntegrationId: R195412 - code: GIVEAWAY1 - importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z - profileId: 1 - poolId: 1 - attributes: null - id: 6 - used: true - startDate: 2022-01-02T15:04:05Z07:00 + details: "" + experiment: + id: 0 + variantId: 6 + effects: + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + ruleFailureReasons: + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable createdCoupons: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - event: "" - ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable - couponID: 4928 - referralValue: referralValue - couponValue: couponValue - evaluationGroupID: 3 - ruleName: ruleName - details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable - couponID: 4928 - referralValue: referralValue - couponValue: couponValue - evaluationGroupID: 3 - ruleName: ruleName - details: details - campaignName: campaignName + implicitlyReserved: false createdReferrals: - - code: 27G47Y54VH9L + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L usageCounter: 1 batchId: tqyrgahe - advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z + awardedGiveaways: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true importId: 4 - friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z + profileIntegrationId: R195412 + profileId: 1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + event: "" NewReferralsForMultipleAdvocates: allOf: - $ref: "#/components/schemas/ReferralConstraints" @@ -22875,8 +23701,9 @@ components: minItems: 1 title: Advocate Profile List type: array + default: null attributes: - $ref: "#/components/schemas/NewReferralsForMultipleAdvocates_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" validCharacters: description: | List of characters used to generate the random parts of a code. By default, the list of characters @@ -22911,6 +23738,7 @@ components: items: type: string type: array + default: null referralPattern: description: | The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. @@ -22922,10 +23750,14 @@ components: - advocateProfileIntegrationIds - campaignId example: + startDate: 2020-11-10T23:00:00Z expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 45 advocateProfileIntegrationIds: - URNGV8294NV - DRPVV9476AF + attributes: null validCharacters: - A - B @@ -22953,11 +23785,7 @@ components: - X - "Y" - Z - usageLimit: 1 - campaignId: 45 referralPattern: REF-###-### - attributes: "{channel=web}" - startDate: 2020-11-10T23:00:00Z CouponReservations: example: integrationIDs: @@ -22973,16 +23801,17 @@ components: type: string maxItems: 1000 type: array + default: null required: - integrationIDs AchievementProgress: description: The current progress of the customer in the achievement. example: - endDate: 2024-02-01T15:04:05Z07:00 + status: completed progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 startDate: 2024-01-01T15:04:05Z07:00 - status: completed + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 properties: status: description: The status of the achievement. @@ -23032,362 +23861,362 @@ components: maxLength: 1000 minLength: 1 pattern: "^[a-zA-Z]\\w+$" - type: string - title: - description: The display name of the achievement in the Campaign Manager. - example: 50% off on 50th purchase. - type: string - description: - description: The description of the achievement in the Campaign Manager. - example: 50% off for every 50th purchase in a year. - format: string - type: string - campaignId: - description: The ID of the campaign the achievement belongs to. - example: 3 - format: int64 - type: integer - target: - description: The required number of actions or the transactional milestone - to complete the achievement. - example: 10 - type: number - achievementRecurrencePolicy: - 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. - - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. - enum: - - no_recurrence - - on_expiration - - on_completion - example: no_recurrence - type: string - achievementActivationPolicy: - 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 - achievementFixedStartDate: - description: | - The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. - - **Note:** It is an RFC3339 timestamp string. - example: 2024-01-15T15:04:05Z07:00 - format: date-time - type: string - achievementEndDate: - description: | - The achievement's end date. If defined, customers cannot participate in the achievement after this date. - - **Note:** It is an RFC3339 timestamp string. - example: 2024-02-15T15:04:05Z07:00 - format: date-time - type: string - achievementAllowRollbackAfterCompletion: - description: "When `true`, customer progress can be rolled back in completed\ - \ achievements." - example: false - type: boolean - required: - - achievementActivationPolicy - - achievementId - - achievementRecurrencePolicy - - campaignId - - description - - name - - title - example: - endDate: 2024-02-01T15:04:05Z07:00 - achievementAllowRollbackAfterCompletion: false - campaignId: 3 - achievementId: 3 - description: 50% off for every 50th purchase in a year. - achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 - title: 50% off on 50th purchase. - target: 10 - achievementRecurrencePolicy: no_recurrence - achievementActivationPolicy: fixed_schedule - name: FreeCoffee10Orders - achievementEndDate: 2024-02-15T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - CustomerInventory: - example: - achievements: - - endDate: 2024-02-01T15:04:05Z07:00 - achievementAllowRollbackAfterCompletion: false - campaignId: 3 - achievementId: 3 - description: 50% off for every 50th purchase in a year. - achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 - title: 50% off on 50th purchase. - target: 10 - achievementRecurrencePolicy: no_recurrence - achievementActivationPolicy: fixed_schedule - name: FreeCoffee10Orders - achievementEndDate: 2024-02-15T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - - endDate: 2024-02-01T15:04:05Z07:00 - achievementAllowRollbackAfterCompletion: false - campaignId: 3 - achievementId: 3 - description: 50% off for every 50th purchase in a year. - achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 - title: 50% off on 50th purchase. - target: 10 - achievementRecurrencePolicy: no_recurrence - achievementActivationPolicy: fixed_schedule - name: FreeCoffee10Orders - achievementEndDate: 2024-02-15T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - coupons: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - state: active - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false - created: 2020-06-10T09:05:27.993483Z - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - profileRedemptionCount: 5 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 - state: active - value: XMAS-20-2021 - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - discountRemainder: 5 - isReservationMandatory: false - referrals: - - code: 27G47Y54VH9L - created: 2020-06-10T09:05:27.993483Z - usageLimit: 1 - campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe - advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 - friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - referredCustomers: - - referredCustomers - - referredCustomers - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L - created: 2020-06-10T09:05:27.993483Z - usageLimit: 1 - campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe - advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 - friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - referredCustomers: - - referredCustomers - - referredCustomers - id: 6 - startDate: 2020-11-10T23:00:00Z + type: string + title: + description: The display name of the achievement in the Campaign Manager. + example: 50% off on 50th purchase. + type: string + description: + description: The description of the achievement in the Campaign Manager. + example: 50% off for every 50th purchase in a year. + format: string + type: string + campaignId: + description: The ID of the campaign the achievement belongs to. + example: 3 + format: int64 + type: integer + target: + description: The required number of actions or the transactional milestone + to complete the achievement. + example: 10 + type: number + achievementRecurrencePolicy: + 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. + - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. + enum: + - no_recurrence + - on_expiration + - on_completion + example: no_recurrence + type: string + achievementActivationPolicy: + 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 + achievementFixedStartDate: + description: | + The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. + + **Note:** It is an RFC3339 timestamp string. + example: 2024-01-15T15:04:05Z07:00 + format: date-time + type: string + achievementEndDate: + description: | + The achievement's end date. If defined, customers cannot participate in the achievement after this date. + + **Note:** It is an RFC3339 timestamp string. + example: 2024-02-15T15:04:05Z07:00 + format: date-time + type: string + achievementAllowRollbackAfterCompletion: + description: "When `true`, customer progress can be rolled back in completed\ + \ achievements." + example: false + type: boolean + required: + - achievementActivationPolicy + - achievementId + - achievementRecurrencePolicy + - campaignId + - description + - name + - title + example: + status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 + achievementId: 3 + name: FreeCoffee10Orders + title: 50% off on 50th purchase. + description: 50% off for every 50th purchase in a year. + campaignId: 3 + target: 10 + achievementRecurrencePolicy: no_recurrence + achievementActivationPolicy: fixed_schedule + achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 + achievementEndDate: 2024-02-15T15:04:05Z07:00 + achievementAllowRollbackAfterCompletion: false + CustomerInventory: + example: profile: - accountId: 31 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false loyalty: cards: - - ledger: "" + - id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 + batchId: wdefpov + - id: 6 + created: 2020-06-10T09:05:27.993483Z programID: 125 + programName: Loyalty_program + programTitle: Loyalty program status: active - - ledger: "" + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active + batchId: wdefpov programs: key: - ledger: "" + id: 5 + title: My loyalty program + name: program1 joinDate: 2024-04-30T15:04:05Z07:00 + ledger: "" subLedgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - name: program1 - id: 5 - title: My loyalty program - giveaways: - - profileIntegrationId: R195412 - code: GIVEAWAY1 + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver + referrals: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + referredCustomers: + - referredCustomers + - referredCustomers + - id: 6 created: 2020-06-10T09:05:27.993483Z - profileId: 1 + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + referredCustomers: + - referredCustomers + - referredCustomers + coupons: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 + state: active + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + profileRedemptionCount: 5 + state: active + giveaways: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 attributes: null - id: 6 used: true - startDate: 2022-01-02T15:04:05Z07:00 - - profileIntegrationId: R195412 - code: GIVEAWAY1 importId: 4 - endDate: 2023-01-02T15:04:05Z07:00 - created: 2020-06-10T09:05:27.993483Z + profileIntegrationId: R195412 profileId: 1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 attributes: null - id: 6 used: true - startDate: 2022-01-02T15:04:05Z07:00 + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + achievements: + - status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 + achievementId: 3 + name: FreeCoffee10Orders + title: 50% off on 50th purchase. + description: 50% off for every 50th purchase in a year. + campaignId: 3 + target: 10 + achievementRecurrencePolicy: no_recurrence + achievementActivationPolicy: fixed_schedule + achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 + achievementEndDate: 2024-02-15T15:04:05Z07:00 + achievementAllowRollbackAfterCompletion: false + - status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 + achievementId: 3 + name: FreeCoffee10Orders + title: 50% off on 50th purchase. + description: 50% off for every 50th purchase in a year. + campaignId: 3 + target: 10 + achievementRecurrencePolicy: no_recurrence + achievementActivationPolicy: fixed_schedule + achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 + achievementEndDate: 2024-02-15T15:04:05Z07:00 + achievementAllowRollbackAfterCompletion: false properties: profile: $ref: "#/components/schemas/CustomerProfile" @@ -23397,20 +24226,24 @@ components: items: $ref: "#/components/schemas/InventoryReferral" type: array + default: null coupons: description: | The coupons reserved by this profile. This array includes hard and soft reservations. items: $ref: "#/components/schemas/InventoryCoupon" type: array + default: null giveaways: items: $ref: "#/components/schemas/Giveaway" type: array + default: null achievements: items: $ref: "#/components/schemas/AchievementProgressWithDefinition" type: array + default: null TimePoint: description: | The absolute duration after which the achievement ends and resets for a particular customer profile. @@ -23583,17 +24416,17 @@ components: - title type: object example: - fixedStartDate: 2024-01-15T15:04:05Z07:00 - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 name: Order50Discount - periodEndOverride: "" - description: 50% off for every 50th purchase in a year. - activationPolicy: fixed_schedule title: 50% off on 50th purchase. - allowRollbackAfterCompletion: false + description: 50% off for every 50th purchase in a year. target: 50 + period: 1Y + periodEndOverride: "" recurrencePolicy: no_recurrence + activationPolicy: fixed_schedule + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 + allowRollbackAfterCompletion: false AchievementStatusEntry: allOf: - $ref: "#/components/schemas/Entity" @@ -23614,27 +24447,27 @@ components: currentProgress: $ref: "#/components/schemas/AchievementProgress" example: - currentProgress: - endDate: 2024-02-01T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 - description: 50% off for every 50th purchase in a year. - activationPolicy: fixed_schedule + name: Order50Discount title: 50% off on 50th purchase. - allowRollbackAfterCompletion: false + description: 50% off for every 50th purchase in a year. target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 - name: Order50Discount + period: 1Y periodEndOverride: "" - id: 6 recurrencePolicy: no_recurrence + activationPolicy: fixed_schedule + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 + allowRollbackAfterCompletion: false + campaignId: 1 status: active + currentProgress: + status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 LoyaltyBalance: description: Point balance of a ledger in the Loyalty Program. properties: @@ -23695,6 +24528,7 @@ components: items: $ref: "#/components/schemas/LoyaltyCardProfileRegistration" type: array + default: null example: balance: "" subledgerBalances: @@ -23783,21 +24617,21 @@ components: CardLedgerTransactionLogEntryIntegrationAPI: description: Log entry for a given loyalty card transaction. example: - rulesetId: 11 - amount: 10.25 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 + programId: 324 + cardIdentifier: summer-loyalty-card-0543 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points + amount: 10.25 id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 + rulesetId: 11 + ruleName: Add 2 points + validityDuration: 30D properties: transactionUUID: description: Unique identifier of the transaction in the UUID format. @@ -23919,21 +24753,21 @@ components: LedgerTransactionLogEntryIntegrationAPI: description: Log entry for a given loyalty profile transaction. example: - rulesetId: 11 - amount: 10.25 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 - flags: "" + programId: 324 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points + amount: 10.25 id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 + rulesetId: 11 + ruleName: Add 2 points + flags: "" + validityDuration: 30D properties: transactionUUID: description: Unique identifier of the transaction in the UUID format. @@ -24036,10 +24870,10 @@ components: DeleteLoyaltyTransactionsRequest: description: Request to delete transactions based on the specified scope. example: + scope: SelectedSubledgers subledgerIds: - subledger1 - subledger2 - scope: SelectedSubledgers properties: scope: description: | @@ -24063,23 +24897,24 @@ components: type: string nullable: true type: array + default: null required: - scope CardLedgerPointsEntryIntegrationAPI: description: Loyalty card points with start and expiry dates. example: - expiryDate: 2022-08-02T15:04:05Z07:00 + id: 123 transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 - customerProfileID: URNGV8294NV created: 2022-01-02T15:04:05Z07:00 - subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 programId: 324 + customerProfileID: URNGV8294NV + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + name: Reward 10% points of a purchase's current total startDate: 2022-01-02T15:04:05Z07:00 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + amount: 10.25 + validityDuration: 30D properties: id: description: ID of the transaction that adds loyalty points. @@ -24158,17 +24993,17 @@ components: LedgerPointsEntryIntegrationAPI: description: Loyalty profile points with start and expiry dates. example: - expiryDate: 2022-08-02T15:04:05Z07:00 + id: 123 transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 created: 2022-01-02T15:04:05Z07:00 - subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 programId: 324 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + name: Reward 10% points of a purchase's current total startDate: 2022-01-02T15:04:05Z07:00 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + amount: 10.25 + validityDuration: 30D properties: id: description: ID of the transaction that adds loyalty points. @@ -24278,6 +25113,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null defaultDiscountScope: description: | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. @@ -24394,6 +25230,7 @@ components: type: string maxItems: 50 type: array + default: null couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" referralSettings: @@ -24403,6 +25240,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null reevaluateOnReturn: description: Indicates whether this campaign should be reevaluated when a customer returns an item. @@ -24422,6 +25260,7 @@ components: - advancedEvents type: string type: array + default: null couponAttributes: description: Arbitrary properties associated with coupons in this campaign. type: object @@ -24507,6 +25346,7 @@ components: type: integer maxItems: 5 type: array + default: null activateAt: description: | Time when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. @@ -24593,6 +25433,7 @@ components: items: $ref: "#/components/schemas/CampaignSetNode" type: array + default: null groupId: description: The ID of the campaign set. format: int64 @@ -24691,27 +25532,22 @@ components: - version UpdateCampaign: example: - activeRulesetId: 2 + name: Summer promotions description: Campaign for all summer 2021 promotions - reevaluateOnReturn: true - type: advanced - campaignGroups: - - 1 - - 3 + startTime: 2021-07-20T22:00:00Z + endTime: 2021-10-01T02:00:00Z + attributes: + myattribute: 20 + state: disabled + activeRulesetId: 2 tags: - Summer - Shoes + reevaluateOnReturn: true features: - coupons - loyalty - linkedStoreIds: - - 1 - - 2 - - 3 - evaluationGroupId: 2 - name: Summer promotions - referralSettings: - couponPattern: SUMMER-####-#### + couponSettings: validCharacters: - A - B @@ -24749,8 +25585,8 @@ components: - "7" - "8" - "9" - couponSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -24788,23 +25624,28 @@ components: - "7" - "8" - "9" - startTime: 2021-07-20T22:00:00Z - attributes: - myattribute: 20 - endTime: 2021-10-01T02:00:00Z - state: disabled - couponAttributes: "{}" + couponPattern: SUMMER-####-#### limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + campaignGroups: + - 1 + - 3 + evaluationGroupId: 2 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" properties: name: description: A user-facing name for this campaign. @@ -24860,6 +25701,7 @@ components: type: string maxItems: 50 type: array + default: null reevaluateOnReturn: description: Indicates whether this campaign should be reevaluated when a customer returns an item. @@ -24882,6 +25724,7 @@ components: - advancedEvents type: string type: array + default: null couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" referralSettings: @@ -24891,6 +25734,7 @@ components: items: $ref: "#/components/schemas/LimitConfig" type: array + default: null campaignGroups: description: | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. @@ -24901,6 +25745,7 @@ components: format: int64 type: integer type: array + default: null evaluationGroupId: description: The ID of the campaign evaluation group the campaign belongs to. @@ -24936,6 +25781,7 @@ components: format: int64 type: integer type: array + default: null couponAttributes: description: Arbitrary properties associated with coupons in this campaign. type: object @@ -24946,18 +25792,18 @@ components: - tags CampaignCopy: example: - evaluationGroupId: 2 name: Copy of Summer promotions - description: Campaign for all summer 2021 promotions - startTime: 2021-06-01T09:00:27.993483Z - endTime: 2021-09-10T01:00:00.993483Z applicationIds: - 1 - 2 - 3 + description: Campaign for all summer 2021 promotions + startTime: 2021-06-01T09:00:27.993483Z + endTime: 2021-09-10T01:00:00.993483Z tags: - Summer - Shoes + evaluationGroupId: 2 properties: name: description: Name of the copied campaign (Defaults to "Copy of original @@ -24975,6 +25821,7 @@ components: format: int64 type: integer type: array + default: null description: description: A detailed description of the campaign. example: Campaign for all summer 2021 promotions @@ -25001,6 +25848,7 @@ components: type: string maxItems: 50 type: array + default: null evaluationGroupId: description: The ID of the campaign evaluation group the campaign belongs to. @@ -25023,6 +25871,7 @@ components: type: integer maxItems: 5 type: array + default: null required: - userIds CampaignDeactivationRequest: @@ -25039,6 +25888,7 @@ components: type: integer maxItems: 5 type: array + default: null required: - userIds BulkOperationOnCampaigns: @@ -25062,6 +25912,7 @@ components: type: integer maxItems: 50 type: array + default: null activateAt: description: | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. @@ -25114,6 +25965,7 @@ components: items: $ref: "#/components/schemas/OutgoingIntegrationType" type: array + default: null OutgoingIntegrationBrazePolicy: properties: baseUrl: @@ -25266,6 +26118,7 @@ components: pattern: "^([^:,]*):([^]*|[^,]*)$" type: string type: array + default: null required: - description - headers @@ -25282,6 +26135,7 @@ components: items: $ref: "#/components/schemas/OutgoingIntegrationTemplate" type: array + default: null OutgoingIntegrationTemplateWithConfigurationDetails: allOf: - $ref: "#/components/schemas/OutgoingIntegrationTemplate" @@ -25310,6 +26164,7 @@ components: format: int64 type: integer type: array + default: null required: - applicationIds - title @@ -25342,7 +26197,7 @@ components: minLength: 1 type: string ui: - $ref: "#/components/schemas/TemplateArgDef_allOf_ui" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" key: description: The identifier for the associated value within the JSON object. type: string @@ -25367,6 +26222,7 @@ components: format: int64 type: integer type: array + default: null title: description: Name or title for this webhook. example: Send message @@ -25403,6 +26259,7 @@ components: pattern: "^([^:,]*):([^]*|[^,]*)$" type: string type: array + default: null payload: description: API payload (supports templating using parameters) for this webhook. @@ -25414,6 +26271,7 @@ components: items: $ref: "#/components/schemas/TemplateArgDef" type: array + default: null enabled: description: Enables or disables webhook from showing in the Rule Builder. example: true @@ -25438,24 +26296,24 @@ components: - $ref: "#/components/schemas/MutableEntity" - $ref: "#/components/schemas/NewWebhook" example: - headers: - - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" - - "{\"Content-Type\": \"application/json\"}" + id: 6 created: 2020-06-10T09:05:27.993483Z - verb: POST - description: A webhook to send a coupon to the user. - authenticationId: 1 - title: Send message - params: [] - url: www.my-company.com/my-endpoint-name - enabled: true + modified: 2021-09-12T10:12:42Z applicationIds: - 0 - 0 - payload: "{\n\t\"message\": \"${message}\"\n}" + title: Send message + description: A webhook to send a coupon to the user. draft: false - modified: 2021-09-12T10:12:42Z - id: 6 + verb: POST + url: www.my-company.com/my-endpoint-name + headers: + - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" + - "{\"Content-Type\": \"application/json\"}" + payload: "{\n\t\"message\": \"${message}\"\n}" + params: [] + enabled: true + authenticationId: 1 ExpiringCouponsNotificationTrigger: properties: amount: @@ -25486,6 +26344,7 @@ components: maxItems: 3 minItems: 1 type: array + default: null batchingEnabled: default: true description: Indicates whether batching is activated. @@ -25531,6 +26390,7 @@ components: maxItems: 3 minItems: 1 type: array + default: null batchingEnabled: default: true description: Indicates whether batching is activated. @@ -25576,6 +26436,7 @@ components: maxItems: 3 minItems: 1 type: array + default: null batchingEnabled: default: true description: Indicates whether batching is activated. @@ -25609,6 +26470,7 @@ components: maxItems: 4 minItems: 1 type: array + default: null required: - name - scopes @@ -25630,6 +26492,7 @@ components: maxItems: 4 minItems: 1 type: array + default: null required: - name - scopes @@ -25657,6 +26520,7 @@ components: maxItems: 4 minItems: 1 type: array + default: null batchingEnabled: default: true description: Indicates whether batching is activated. @@ -25824,6 +26688,7 @@ components: maxItems: 3 minItems: 1 type: array + default: null required: - name - triggers @@ -25854,6 +26719,7 @@ components: pattern: "^[^:,]+:[^,]*$" type: string type: array + default: null enabled: default: true description: Indicates whether the notification is activated. @@ -25918,6 +26784,7 @@ components: items: $ref: "#/components/schemas/BaseNotification" type: array + default: null NotificationActivation: properties: enabled: @@ -26072,6 +26939,7 @@ components: items: $ref: "#/components/schemas/LabelTarget" type: array + default: null required: - campaignId - props @@ -26087,12 +26955,14 @@ components: format: int64 type: integer type: array + default: null effects: description: The strikethrough effects that are returned from the evaluation process. items: $ref: "#/components/schemas/StrikethroughEffect" type: array + default: null PriceType: allOf: - $ref: "#/components/schemas/Entity" @@ -26132,6 +27002,7 @@ components: format: int64 type: integer type: array + default: null targetedAudiencesIds: description: A list of the IDs of the audiences targeted by this price type. @@ -26143,6 +27014,7 @@ components: format: int64 type: integer type: array + default: null required: - modified - name @@ -26177,6 +27049,7 @@ components: format: int64 type: integer type: array + default: null required: - name - title @@ -26201,6 +27074,7 @@ components: type: integer type: array uniqueItems: true + default: null required: - targetedAudiencesIds - title @@ -26247,6 +27121,7 @@ components: items: $ref: "#/components/schemas/PriceTypeReferenceDetail" type: array + default: null required: - priceTypeId NewMessageTest: @@ -26281,6 +27156,7 @@ components: items: $ref: "#/components/schemas/TemplateArgDef" type: array + default: null applicationIds: description: | The IDs of the Applications in which this webhook is available. @@ -26289,6 +27165,7 @@ components: format: int64 type: integer type: array + default: null authenticationId: description: The ID of the credential that this webhook is using. example: 1 @@ -26331,16 +27208,16 @@ components: - attributes Binding: example: - attributeId: 100 - minValue: 0 + name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter properties: name: description: A descriptive name for the value to be bound. @@ -26363,6 +27240,7 @@ components: - string2 items: {} type: array + default: null valueType: description: | Can be one of the following: @@ -26395,6 +27273,31 @@ components: - name Rule: example: + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. condition: - and - - couponValid @@ -26410,31 +27313,6 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 properties: id: description: A unique identifier for the rule. @@ -26462,6 +27340,7 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null condition: description: A Talang expression that will be evaluated in the context of the given event. @@ -26471,6 +27350,7 @@ components: items: {} minItems: 1 type: array + default: null effects: description: An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. @@ -26489,6 +27369,7 @@ components: items: type: object type: array + default: null required: - condition - effects @@ -26500,11 +27381,13 @@ components: items: $ref: "#/components/schemas/Rule" type: array + default: null strikethroughRules: description: Set of rules to apply for strikethrough. items: $ref: "#/components/schemas/Rule" type: array + default: null bindings: description: An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during @@ -26514,6 +27397,7 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null rbVersion: description: The version of the rulebuilder used to create this ruleset. example: v2 @@ -26549,14 +27433,36 @@ components: format: date-time type: string example: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -26571,32 +27477,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -26611,34 +27517,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -26653,32 +27558,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -26693,51 +27598,30 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 + activatedAt: 2000-01-23T04:56:07.000+00:00 UpdateCouponBatch: allOf: - $ref: "#/components/schemas/CouponConstraints" - properties: attributes: - $ref: "#/components/schemas/UpdateCouponBatch_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" batchID: description: The ID of the batch the coupon(s) belong to. title: Batch ID type: string example: - expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 + discountLimit: 30 reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z attributes: null batchID: batchID - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z NewCoupons: allOf: - $ref: "#/components/schemas/CouponConstraints" @@ -26756,7 +27640,7 @@ components: title: Coupon code unique prefix type: string attributes: - $ref: "#/components/schemas/NewCoupons_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" recipientIntegrationId: description: The integration ID for this coupon's beneficiary's profile. example: URNGV8294NV @@ -26775,6 +27659,7 @@ components: items: type: string type: array + default: null couponPattern: description: | The pattern used to generate coupon codes. @@ -26799,40 +27684,40 @@ components: required: - numberOfCoupons example: - recipientIntegrationId: URNGV8294NV - uniquePrefix: "" - implicitlyReserved: false usageLimit: 100 - numberOfCoupons: 1 - expiryDate: 2023-08-24T14:15:22Z - couponPattern: SUMMER-##### - validCharacters: - - A - - B - - G - - "Y" - reservationLimit: 45 - attributes: "{venueId=12}" discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + numberOfCoupons: 1 + uniquePrefix: "" + attributes: null + recipientIntegrationId: URNGV8294NV + validCharacters: + - A + - B + - G + - "Y" + couponPattern: SUMMER-##### isReservationMandatory: false + implicitlyReserved: false NewCouponsForMultipleRecipients: allOf: - $ref: "#/components/schemas/CouponConstraints" - properties: attributes: - $ref: "#/components/schemas/NewCoupons_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" recipientsIntegrationIds: description: The integration IDs for recipients. example: @@ -26844,6 +27729,7 @@ components: minItems: 1 title: Receiving customer profiles integration IDs type: array + default: null validCharacters: description: | List of characters used to generate the random parts of a code. By default, the list of @@ -26878,6 +27764,7 @@ components: items: type: string type: array + default: null couponPattern: description: | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. @@ -26888,8 +27775,15 @@ components: required: - recipientsIntegrationIds example: + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z expiryDate: 2023-08-24T14:15:22Z - couponPattern: SUMMER-##### + attributes: null + recipientsIntegrationIds: + - URNGV8294NV + - BZGGC2454PA validCharacters: - A - B @@ -26917,14 +27811,7 @@ components: - X - "Y" - Z - usageLimit: 100 - reservationLimit: 45 - recipientsIntegrationIds: - - URNGV8294NV - - BZGGC2454PA - attributes: "{venueId=12}" - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z + couponPattern: SUMMER-##### NewCouponCreationJob: allOf: - $ref: "#/components/schemas/CouponConstraints" @@ -26939,7 +27826,7 @@ components: couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" attributes: - $ref: "#/components/schemas/NewCouponCreationJob_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" isReservationMandatory: default: false description: An indication of whether the code can be redeemed only if @@ -26950,12 +27837,13 @@ components: - attributes - numberOfCoupons example: - expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 + discountLimit: 30 reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z numberOfCoupons: 200000 couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -26993,9 +27881,8 @@ components: - "7" - "8" - "9" + couponPattern: SUMMER-####-#### attributes: null - discountLimit: 30 - startDate: 2020-01-24T14:15:22Z isReservationMandatory: false AsyncCouponCreationResponse: example: @@ -27009,20 +27896,20 @@ components: - batchId CouponDeletionFilters: example: + createdBefore: 2000-01-23T04:56:07.000+00:00 + createdAfter: 2000-01-23T04:56:07.000+00:00 startsAfter: 2000-01-23T04:56:07.000+00:00 + startsBefore: 2000-01-23T04:56:07.000+00:00 + valid: expired + usable: true + redeemed: true recipientIntegrationId: recipientIntegrationId exactMatch: false - redeemed: true - referralId: 0 - createdAfter: 2000-01-23T04:56:07.000+00:00 + value: value batchId: batchId - valid: expired - usable: true + referralId: 0 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: value - startsBefore: 2000-01-23T04:56:07.000+00:00 properties: createdBefore: description: "Filter results comparing the parameter value, expected to\ @@ -27106,20 +27993,20 @@ components: NewCouponDeletionJob: example: filters: + createdBefore: 2000-01-23T04:56:07.000+00:00 + createdAfter: 2000-01-23T04:56:07.000+00:00 startsAfter: 2000-01-23T04:56:07.000+00:00 + startsBefore: 2000-01-23T04:56:07.000+00:00 + valid: expired + usable: true + redeemed: true recipientIntegrationId: recipientIntegrationId exactMatch: false - redeemed: true - referralId: 0 - createdAfter: 2000-01-23T04:56:07.000+00:00 + value: value batchId: batchId - valid: expired - usable: true + referralId: 0 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: value - startsBefore: 2000-01-23T04:56:07.000+00:00 properties: filters: $ref: "#/components/schemas/CouponDeletionFilters" @@ -27140,6 +28027,7 @@ components: format: int64 type: integer type: array + default: null required: - campaignids - filters @@ -27155,7 +28043,7 @@ components: title: Receiving customer profile integration ID type: string attributes: - $ref: "#/components/schemas/UpdateCoupon_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" isReservationMandatory: default: false description: An indication of whether the code can be redeemed only if @@ -27170,26 +28058,26 @@ components: title: Is coupon implicitly reserved for all customers type: boolean example: - expiryDate: 2023-08-24T14:15:22Z - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false usageLimit: 100 - reservationLimit: 45 - attributes: null discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + recipientIntegrationId: URNGV8294NV + attributes: null isReservationMandatory: false + implicitlyReserved: false CouponSearch: properties: attributes: @@ -27234,11 +28122,11 @@ components: - batchID UpdateReferral: example: - expiryDate: 2021-11-10T23:00:00Z friendProfileIntegrationId: BZGGC2454PA + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 attributes: "{}" - startDate: 2020-11-10T23:00:00Z properties: friendProfileIntegrationId: description: An optional Integration ID of the Friend's Profile. @@ -27293,6 +28181,7 @@ components: format: int64 type: integer type: array + default: null campaignIds: description: A list of IDs of the campaigns that are part of the campaign access group. @@ -27304,6 +28193,7 @@ components: format: int64 type: integer type: array + default: null required: - name CampaignGroup: @@ -27314,17 +28204,17 @@ components: - $ref: "#/components/schemas/NewCampaignGroup" - type: object example: - accountId: 3886 + id: 6 created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + accountId: 3886 name: Europe access group + description: A group that gives access to all the campaigns for the Europe + market. subscribedApplicationsIds: - 1 - 2 - 3 - modified: 2021-09-12T10:12:42Z - description: A group that gives access to all the campaigns for the Europe - market. - id: 6 campaignIds: - 4 - 6 @@ -27365,6 +28255,7 @@ components: format: int64 type: integer type: array + default: null acl: $ref: "#/components/schemas/Role_allOf_acl" required: @@ -27394,17 +28285,17 @@ components: allOf: - $ref: "#/components/schemas/LimitConfig" example: + action: createCoupon + limit: 1000 period: yearly entities: - Coupon - limit: 1000 - action: createCoupon CampaignTemplateParams: example: - attributeId: 42 name: discount_value - description: This is a template parameter of type `number`. type: number + description: This is a template parameter of type `number`. + attributeId: 42 properties: name: description: Name of the campaign template parameter. @@ -27504,6 +28395,7 @@ components: type: string maxItems: 50 type: array + default: null reevaluateOnReturn: description: Indicates whether campaigns created from this template should be reevaluated when a customer returns an item. @@ -27522,6 +28414,7 @@ components: - advancedEvents type: string type: array + default: null couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" couponReservationSettings: @@ -27533,11 +28426,13 @@ components: items: $ref: "#/components/schemas/TemplateLimitConfig" type: array + default: null templateParams: description: Fields which can be used to replace values in a rule. items: $ref: "#/components/schemas/CampaignTemplateParams" type: array + default: null applicationsIds: description: A list of IDs of the Applications that are subscribed to this campaign template. @@ -27549,12 +28444,14 @@ components: format: int64 type: integer type: array + default: null campaignCollections: description: The campaign collections from the blueprint campaign for the template. items: $ref: "#/components/schemas/CampaignTemplateCollection" type: array + default: null defaultCampaignGroupId: description: The default campaign group ID. example: 42 @@ -27593,6 +28490,7 @@ components: format: int64 type: integer type: array + default: null campaignsCount: description: The number of Campaigns created from this template. example: 3 @@ -27619,6 +28517,7 @@ components: format: int64 type: integer type: array + default: null isUserFavorite: default: false description: A flag indicating whether the user marked the template as @@ -27631,25 +28530,26 @@ components: - reevaluateOnReturn type: object example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + userId: 388 + name: Discount campaign + description: This is a template for a discount 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." - campaignCollections: - - name: My collection - description: My collection of SKUs - - name: My collection - description: My collection of SKUs - campaignsCount: 3 - defaultCampaignGroupId: 42 - description: This is a template for a discount campaign. + campaignAttributes: "{}" + couponAttributes: "{}" + state: draft + activeRulesetId: 5 + tags: + - discount + reevaluateOnReturn: true features: - coupons - coupons - couponReservationSettings: - reservationLimit: 45 - isReservationMandatory: false couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -27687,51 +28587,11 @@ 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 - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 5 - campaignAttributes: "{}" - applicationsIds: - - 1 - - 2 - - 3 - campaignType: advanced - updatedBy: Jane Doe - created: 2020-06-10T09:05:27.993483Z - isUserFavorite: false - reevaluateOnReturn: true - userId: 388 - tags: - - discount - accountId: 3886 - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: couponPattern: SUMMER-####-#### + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false + referralSettings: validCharacters: - A - B @@ -27769,7 +28629,46 @@ components: - "7" - "8" - "9" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + templateParams: + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + applicationsIds: + - 1 + - 2 + - 3 + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + defaultCampaignGroupId: 42 + campaignType: advanced + campaignsCount: 3 updated: 2022-08-24T14:15:22Z + updatedBy: Jane Doe + validApplicationIds: + - 1 + - 2 + - 3 + isUserFavorite: false NewCampaignTemplate: properties: name: @@ -27809,6 +28708,7 @@ components: type: string maxItems: 50 type: array + default: null reevaluateOnReturn: description: Indicates whether campaigns created from this template should be reevaluated when a customer returns an item. @@ -27827,6 +28727,7 @@ components: - advancedEvents type: string type: array + default: null couponSettings: $ref: "#/components/schemas/CodeGeneratorSettings" couponReservationSettings: @@ -27838,17 +28739,20 @@ components: items: $ref: "#/components/schemas/TemplateLimitConfig" type: array + default: null templateParams: description: Fields which can be used to replace values in a rule. items: $ref: "#/components/schemas/CampaignTemplateParams" type: array + default: null campaignCollections: description: The campaign collections from the blueprint campaign for the template. items: $ref: "#/components/schemas/CampaignTemplateCollection" type: array + default: null defaultCampaignGroupId: description: The default campaign group ID. example: 42 @@ -27895,18 +28799,41 @@ components: - isPrimary - name example: + id: 6 created: 2020-06-10T09:05:27.993483Z - isPrimary: true name: Variant A + experimentId: 10 ruleset: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -27921,32 +28848,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -27961,34 +28888,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -28003,32 +28929,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -28043,36 +28969,14 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 + activatedAt: 2000-01-23T04:56:07.000+00:00 weight: 12 - experimentId: 10 - id: 6 + isPrimary: true Experiment: allOf: - $ref: "#/components/schemas/Entity" @@ -28103,6 +29007,7 @@ components: items: $ref: "#/components/schemas/ExperimentVariant" type: array + default: null goalType: description: | The goal of the experiment. Determines which single metric is used to decide the winning variant. When set to `other`, multiple metrics are used. @@ -28127,23 +29032,29 @@ components: - goalType - state example: - goalType: other - goalDescription: Offering free shipping will increase average order revenue - more than a 10% discount - deletedat: 2000-01-23T04:56:07.000+00:00 + id: 6 created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + isVariantAssignmentExternal: true campaign: - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -28181,72 +29092,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -28284,25 +29131,105 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - id: 6 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + activated: 2000-01-23T04:56:07.000+00:00 state: enabled variants: - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z name: Variant A + experimentId: 10 ruleset: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -28317,32 +29244,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -28357,34 +29284,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -28399,32 +29325,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -28439,48 +29365,49 @@ components: - - / - 10 - 100 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 + templateId: 3 + activatedAt: 2000-01-23T04:56:07.000+00:00 + weight: 12 + isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z + name: Variant A + experimentId: 10 + ruleset: + id: 6 + created: 2020-06-10T09:05:27.993483Z + userId: 388 + rules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - templateId: 3 - userId: 388 - weight: 12 - experimentId: 10 - id: 6 - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true - name: Variant A - ruleset: - rbVersion: v2 - created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true - rules: - - condition: + condition: - and - - couponValid effects: @@ -28495,32 +29422,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -28535,34 +29462,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -28577,32 +29503,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -28617,39 +29543,18 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 + activatedAt: 2000-01-23T04:56:07.000+00:00 weight: 12 - experimentId: 10 - id: 6 - applicationId: 322 - isVariantAssignmentExternal: true - activated: 2000-01-23T04:56:07.000+00:00 + isPrimary: true + goalType: other + goalDescription: Offering free shipping will increase average order revenue + more than a 10% discount + deletedat: 2000-01-23T04:56:07.000+00:00 NewExperiment: properties: isVariantAssignmentExternal: @@ -28685,6 +29590,7 @@ components: format: int64 type: integer type: array + default: null required: - experimentIds ExperimentVariantResult: @@ -28766,6 +29672,7 @@ components: items: $ref: "#/components/schemas/ExperimentVariantResult" type: array + default: null confidence: $ref: "#/components/schemas/ExperimentVariantResultConfidence" required: @@ -28787,6 +29694,7 @@ components: items: $ref: "#/components/schemas/ExperimentResult" type: array + default: null UpdateExperiment: allOf: - properties: @@ -28849,6 +29757,7 @@ components: items: $ref: "#/components/schemas/UpdateExperimentVariant" type: array + default: null required: - variants NewExperimentVariant: @@ -28884,6 +29793,7 @@ components: items: $ref: "#/components/schemas/NewExperimentVariant" type: array + default: null required: - variants UpdateExperimentVariantName: @@ -28930,6 +29840,7 @@ components: type: string maxItems: 50 type: array + default: null evaluationGroupId: description: The ID of the campaign evaluation group the campaign belongs to. @@ -28986,6 +29897,7 @@ components: items: type: string type: array + default: null aiConfidenceLevel: description: "Your confidence in this overall verdict, from 0 to 100." type: string @@ -29077,6 +29989,7 @@ components: items: $ref: "#/components/schemas/ExperimentSegmentInsightVariant" type: array + default: null required: - bucket - confidence @@ -29099,6 +30012,7 @@ components: items: $ref: "#/components/schemas/ExperimentSegmentInsight" type: array + default: null required: - metric - segments @@ -29110,6 +30024,7 @@ components: items: $ref: "#/components/schemas/ExperimentSegmentInsightMetric" type: array + default: null totalSegmentsTested: description: | Total number of segment-metric combinations that were tested for statistical significance. @@ -29132,54 +30047,77 @@ components: - metrics - reason - totalSegmentsTested + ExperimentConfidenceTimelineDataPoint: + properties: + date: + description: The date-time this data point represents. + example: 2024-01-15T00:00:00+07:00 + format: date-time + type: string + confidence: + $ref: "#/components/schemas/ExperimentVariantResultConfidence" + required: + - confidence + - date + ExperimentConfidenceTimeline: + properties: + data: + description: | + Daily cumulative confidence values ordered chronologically from experiment start to end, or to today if the experiment is still running. Empty if the experiment has no data yet. + items: + $ref: "#/components/schemas/ExperimentConfidenceTimelineDataPoint" + type: array + default: null + required: + - data CreateTemplateCampaign: example: - campaignAttributesOverrides: "{}" - linkedStoreIds: - - 1 - - 2 - - 3 - evaluationGroupId: 2 name: Discount campaign description: This template is for discount campaigns. - limitOverrides: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon + templateId: 4 + campaignAttributesOverrides: "{}" templateParamValues: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - templateId: 4 + limitOverrides: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon campaignGroups: - 1 - 3 tags: - summer + evaluationGroupId: 2 + linkedStoreIds: + - 1 + - 2 + - 3 properties: name: description: A user-facing name for this campaign. @@ -29208,12 +30146,14 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null limitOverrides: description: "Limits for this Campaign. If the Campaign Template or Application\ \ define default values for the same limits, they will be overridden." items: $ref: "#/components/schemas/LimitConfig" type: array + default: null campaignGroups: description: | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. @@ -29224,6 +30164,7 @@ components: format: int64 type: integer type: array + default: null tags: description: "A list of tags for the campaign. If the campaign template\ \ has tags, they will be overridden by this list." @@ -29235,6 +30176,7 @@ components: type: string maxItems: 50 type: array + default: null evaluationGroupId: description: The ID of the campaign evaluation group the campaign belongs to. @@ -29256,16 +30198,17 @@ components: format: int64 type: integer type: array + default: null required: - name - templateId UpdateCollection: example: + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 - description: My collection of SKUs properties: description: description: A short description of the purpose of this collection. @@ -29282,6 +30225,7 @@ components: format: int64 type: integer type: array + default: null NewCollection: allOf: - $ref: "#/components/schemas/UpdateCollection" @@ -29295,12 +30239,12 @@ components: required: - name example: + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 name: My collection - description: My collection of SKUs CollectionWithoutPayload: allOf: - $ref: "#/components/schemas/Entity" @@ -29331,20 +30275,20 @@ components: required: - createdBy example: - accountId: 3886 - createdBy: 134 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 7 + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs modifiedBy: 48 - id: 6 + createdBy: 134 applicationId: 1 + campaignId: 7 Collection: allOf: - $ref: "#/components/schemas/CollectionWithoutPayload" @@ -29358,70 +30302,214 @@ components: type: string maxItems: 50 type: array + default: null example: - accountId: 3886 - createdBy: 134 - payload: - - KTL-WH-ET-1 - - KTL-BL-ET-1 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 7 + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs modifiedBy: 48 - id: 6 + createdBy: 134 applicationId: 1 + campaignId: 7 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 CreateTemplateCampaignResponse: example: - collections: - - accountId: 3886 - createdBy: 134 - payload: - - KTL-WH-ET-1 - - KTL-BL-ET-1 + campaign: + id: 4 created: 2020-06-10T09:05:27.993483Z - campaignId: 7 - subscribedApplicationsIds: + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true + features: + - coupons + - referrals + couponSettings: + 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" + couponPattern: SUMMER-####-#### + referralSettings: + 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" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: - 1 - - 2 - 3 - name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs - modifiedBy: 48 - id: 6 - applicationId: 1 - - accountId: 3886 - createdBy: 134 - payload: - - KTL-WH-ET-1 - - KTL-BL-ET-1 - created: 2020-06-10T09:05:27.993483Z - campaignId: 7 - subscribedApplicationsIds: + type: advanced + linkedStoreIds: - 1 - 2 - 3 - name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs - modifiedBy: 48 - id: 6 - applicationId: 1 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 + referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false ruleset: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -29436,32 +30524,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -29476,34 +30564,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -29518,32 +30605,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -29558,189 +30645,47 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - templateId: 3 - userId: 388 - campaign: - type: advanced + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 - features: - - coupons - - referrals - createdLoyaltyPointsCount: 9 - storesImported: true - 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" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running + activatedAt: 2000-01-23T04:56:07.000+00:00 + collections: + - id: 6 created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + subscribedApplicationsIds: - 1 + - 2 - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: + name: My collection + modifiedBy: 48 + createdBy: 134 + applicationId: 1 + campaignId: 7 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + subscribedApplicationsIds: - 1 - 2 - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - 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" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z - referralRedemptionCount: 3 + name: My collection + modifiedBy: 48 + createdBy: 134 + applicationId: 1 + campaignId: 7 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 properties: campaign: $ref: "#/components/schemas/Campaign" @@ -29750,6 +30695,7 @@ components: items: $ref: "#/components/schemas/Collection" type: array + default: null required: - campaign - ruleset @@ -29768,6 +30714,7 @@ components: items: $ref: "#/components/schemas/NewLoyaltyTier" type: array + default: null timezone: description: A string containing an IANA timezone descriptor. minLength: 1 @@ -29799,6 +30746,7 @@ components: items: $ref: "#/components/schemas/NewLoyaltyTier" type: array + default: null ActivateLoyaltyPoints: description: Activate loyalty points example: @@ -29820,6 +30768,7 @@ components: minItems: 1 type: array uniqueItems: true + default: null sessionId: description: | The ID of the session containing the pending point transactions to activate. @@ -29831,22 +30780,22 @@ components: LoyaltyLedgerEntry: description: "A single row of the ledger, describing one addition or deduction." example: - eventID: 5 - amount: 100 created: 2021-07-20T22:00:00Z - flags: "" - subLedgerID: mysubledger + programID: 5 + customerProfileID: URNGV8294NV + cardID: 241 customerSessionID: t2gy5s-47274 + eventID: 5 type: addition - userID: 499 + amount: 100 + startDate: 2021-07-20T22:00:00Z expiryDate: 2022-07-20T22:00:00Z - archived: false - customerProfileID: URNGV8294NV - cardID: 241 name: Add points on purchase + subLedgerID: mysubledger + userID: 499 + archived: false + flags: "" validityDuration: 30D - programID: 5 - startDate: 2021-07-20T22:00:00Z properties: created: example: 2021-07-20T22:00:00Z @@ -29931,44 +30880,45 @@ components: ActivateLoyaltyPointsResponse: example: ledgerEntries: - - eventID: 5 - amount: 100 - created: 2021-07-20T22:00:00Z - flags: "" - subLedgerID: mysubledger + - created: 2021-07-20T22:00:00Z + programID: 5 + customerProfileID: URNGV8294NV + cardID: 241 customerSessionID: t2gy5s-47274 + eventID: 5 type: addition - userID: 499 + amount: 100 + startDate: 2021-07-20T22:00:00Z expiryDate: 2022-07-20T22:00:00Z - archived: false - customerProfileID: URNGV8294NV - cardID: 241 name: Add points on purchase - validityDuration: 30D - programID: 5 - startDate: 2021-07-20T22:00:00Z - - eventID: 5 - amount: 100 - created: 2021-07-20T22:00:00Z - flags: "" subLedgerID: mysubledger - customerSessionID: t2gy5s-47274 - type: addition userID: 499 - expiryDate: 2022-07-20T22:00:00Z archived: false + flags: "" + validityDuration: 30D + - created: 2021-07-20T22:00:00Z + programID: 5 customerProfileID: URNGV8294NV cardID: 241 + customerSessionID: t2gy5s-47274 + eventID: 5 + type: addition + amount: 100 + startDate: 2021-07-20T22:00:00Z + expiryDate: 2022-07-20T22:00:00Z name: Add points on purchase + subLedgerID: mysubledger + userID: 499 + archived: false + flags: "" validityDuration: 30D - programID: 5 - startDate: 2021-07-20T22:00:00Z properties: ledgerEntries: description: Updated ledger entries after activation. items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null UpdateLoyaltyProgramTier: description: Update a tier in a specified loyalty program. properties: @@ -29994,11 +30944,13 @@ components: items: $ref: "#/components/schemas/UpdateLoyaltyProgramTier" type: array + default: null LoyaltyTiers: description: A list of the loyalty program's tiers. items: $ref: "#/components/schemas/LoyaltyTier" type: array + default: null LoyaltyDashboardPointsBreakdown: properties: createdManually: @@ -30014,14 +30966,14 @@ components: description: Datapoint for the graphs and cards on a loyalty program dashboard. example: date: 2000-01-23T04:56:07.000+00:00 - totalMembers: 2582 - totalSpentPoints: 25668 - spentPoints: "" totalActivePoints: 9756 totalPendingPoints: 548 + totalSpentPoints: 25668 totalExpiredPoints: 1156 totalNegativePoints: 32 + totalMembers: 2582 newMembers: 3 + spentPoints: "" earnedPoints: "" properties: date: @@ -30096,12 +31048,12 @@ components: - amount - entity example: - accountId: 3886 - amount: 10 - created: 2020-06-10T09:05:27.993483Z id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 userId: 388 entity: AttributeAllowedList + amount: 10 LoyaltySubLedger: description: Ledger of Balance in Loyalty Program for a Customer. properties: @@ -30139,26 +31091,31 @@ components: items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null expiringPoints: description: List of all points that will expire. items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null activePoints: description: List of all currently active points. items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null pendingPoints: description: List of all points pending activation. items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null expiredPoints: description: List of expired points. items: $ref: "#/components/schemas/LoyaltyLedgerEntry" type: array + default: null currentTier: allOf: - $ref: "#/components/schemas/Tier" @@ -30205,10 +31162,10 @@ components: DeductLoyaltyPoints: description: Points to deduct. example: - subledgerId: sub-123 + points: 300 name: Penalty + subledgerId: sub-123 applicationId: 322 - points: 300 properties: points: description: Amount of loyalty points. @@ -30234,27 +31191,27 @@ components: - points LoyaltyProgramTransaction: example: - rulesetId: 11 - amount: 10.25 + id: 123 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f + programId: 324 campaignId: 324 created: 2022-01-02T15:04:05Z07:00 - flags: "" - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - userId: 5 - cardIdentifier: summer-loyalty-card-0543 + amount: 10.25 + name: Reward 50 points for each $500 purchase + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-01-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - importId: 4 customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + cardIdentifier: summer-loyalty-card-0543 subledgerId: sub-123 - name: Reward 50 points for each $500 purchase - validityDuration: 30D - ruleName: 10 points for every $100 spent + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + importId: 4 + userId: 5 userEmail: john.doe@example.com - id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 + rulesetId: 11 + ruleName: 10 points for every $100 spent + flags: "" + validityDuration: 30D properties: id: description: ID of the loyalty ledger transaction. @@ -30417,8 +31374,10 @@ components: required: - numberOfCards example: + numberOfCards: 5000 + batchId: hwernpjz + status: active cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -30456,9 +31415,7 @@ components: - "7" - "8" - "9" - numberOfCards: 5000 - batchId: hwernpjz - status: active + couponPattern: SUMMER-####-#### LoyaltyCardBatchResponse: example: numberOfCardsGenerated: 5000 @@ -30504,6 +31461,7 @@ components: items: type: string type: array + default: null cardIdentifier: description: | The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. @@ -30515,20 +31473,20 @@ components: CardLedgerTransactionLogEntry: description: Log entry for a given loyalty card transaction. example: - amount: 10.25 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + programId: 324 + cardIdentifier: summer-loyalty-card-0543 + applicationId: 322 sessionId: 233 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total + amount: 10.25 id: 123 - applicationId: 322 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 properties: transactionUUID: description: Unique identifier of the transaction in the UUID format. @@ -30665,6 +31623,7 @@ components: format: int64 type: integer type: array + default: null sandbox: description: Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. @@ -30770,6 +31729,7 @@ components: type: integer minItems: 1 type: array + default: null required: - applicationIds NewCustomEffect: @@ -30802,6 +31762,7 @@ components: items: $ref: "#/components/schemas/TemplateArgDef" type: array + default: null required: - enabled - name @@ -30851,6 +31812,7 @@ components: type: string maxItems: 50 type: array + default: null required: - type - values @@ -30914,8 +31876,8 @@ components: required: - name example: - name: My collection description: My collection of SKUs + name: My collection AccountDashboardStatisticRevenue: properties: total: @@ -30999,21 +31961,25 @@ components: items: $ref: "#/components/schemas/AccountDashboardStatisticRevenue" type: array + default: null discounts: description: Aggregated statistic for account discount. items: $ref: "#/components/schemas/AccountDashboardStatisticDiscount" type: array + default: null loyaltyPoints: description: Aggregated statistic for account loyalty points. items: $ref: "#/components/schemas/AccountDashboardStatisticLoyaltyPoints" type: array + default: null referrals: description: Aggregated statistic for account referrals. items: $ref: "#/components/schemas/AccountDashboardStatisticReferrals" type: array + default: null campaigns: $ref: "#/components/schemas/AccountDashboardStatisticCampaigns" required: @@ -31177,9 +32143,9 @@ components: - userId Session: example: - created: 2021-07-20T22:00:00Z userId: 109 token: dy_Fa_lQ4iDAnqldJFvVEmnsN8xDTxej19l0LZDBJhQ + created: 2021-07-20T22:00:00Z properties: userId: description: The ID of the user of this session. @@ -31247,7 +32213,11 @@ components: AccessLogEntry: description: Log of application accesses. example: + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 method: PUT + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z requestPayload: |- { "customerSession": { @@ -31256,10 +32226,6 @@ components: ... } responsePayload: "{\"coupons\":[],\"createdCoupons\":[],...}" - requestUri: /v2/customer_sessions/Session136667 - time: 2023-01-16T16:00:00.700763Z - uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 - status: 200 properties: uuid: description: UUID reference of request. @@ -31317,6 +32283,7 @@ components: items: type: string type: array + default: null conditions: description: List of hidden conditions. example: @@ -31325,6 +32292,7 @@ components: items: type: string type: array + default: null customEffects: description: List of the IDs of hidden custom effects. example: @@ -31334,6 +32302,7 @@ components: format: int64 type: integer type: array + default: null webhooks: description: List of the IDs of hidden webhooks. example: @@ -31343,6 +32312,7 @@ components: format: int64 type: integer type: array + default: null CampaignAnalytics: allOf: - properties: @@ -31482,30 +32452,30 @@ components: - totalReferralsCreated example: date: 2021-10-12T10:12:42Z - couponRolledbackRedemptions: 2 - totalCouponRolledbackRedemptions: 4 + campaignRevenue: 3539.76 + totalCampaignRevenue: 5784.63 + campaignRefund: 0.8008281904610115 + totalCampaignRefund: 6.027456183070403 + campaignDiscountCosts: 1.4658129805029452 + totalCampaignDiscountCosts: 5.962133916683182 campaignRefundedDiscounts: 5.637376656633329 - totalDeductedLoyaltyPoints: 220 + totalCampaignRefundedDiscounts: 2.3021358869347655 + campaignFreeItems: 7 + totalCampaignFreeItems: 86 couponRedemptions: 9 - totalCampaignDiscountCosts: 5.962133916683182 + totalCouponRedemptions: 3 + couponRolledbackRedemptions: 2 + totalCouponRolledbackRedemptions: 4 referralRedemptions: 7 - totalCampaignRevenue: 5784.63 - campaignRevenue: 3539.76 - campaignDiscountCosts: 1.4658129805029452 totalReferralRedemptions: 1 couponsCreated: 1 - addedLoyaltyPoints: 250 - campaignRefund: 0.8008281904610115 - campaignFreeItems: 7 - totalAddedLoyaltyPoints: 340 - totalCampaignFreeItems: 86 - totalCampaignRefundedDiscounts: 2.3021358869347655 - totalCampaignRefund: 6.027456183070403 totalCouponsCreated: 1 - deductedLoyaltyPoints: 120 - totalCouponRedemptions: 3 referralsCreated: 6 totalReferralsCreated: 7 + addedLoyaltyPoints: 250 + totalAddedLoyaltyPoints: 340 + deductedLoyaltyPoints: 120 + totalDeductedLoyaltyPoints: 220 ApplicationCustomer: allOf: - $ref: "#/components/schemas/Entity" @@ -31524,37 +32494,37 @@ components: required: - accountId example: - accountId: 0 - closedSessions: 3 + id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 0 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false + advocateIntegrationId: advocateIntegrationId CustomerProfileSearchQuery: example: + attributes: "{}" integrationIDs: - integrationIDs - integrationIDs profileIDs: - 0 - 0 - attributes: "{}" properties: attributes: description: Properties to match against a customer profile. All provided @@ -31564,11 +32534,13 @@ components: items: type: string type: array + default: null profileIDs: items: format: int64 type: integer type: array + default: null CustomerActivityReport: allOf: - $ref: "#/components/schemas/IntegrationEntity" @@ -31626,19 +32598,19 @@ components: - totalOrdersNoCoupon description: A summary report of customer activity for a given time range. example: - couponUseAttempts: 1 - created: 2020-02-07T08:15:22Z - totalOrdersNoCoupon: 9 integrationId: URNGV8294NV - couponRedemptions: 6 - couponFailedAttempts: 5 - accruedRevenue: 2.3021358869347655 + created: 2020-02-07T08:15:22Z name: name customerId: 0 lastActivity: 2000-01-23T04:56:07.000+00:00 + couponRedemptions: 6 + couponUseAttempts: 1 + couponFailedAttempts: 5 + accruedDiscounts: 5.637376656633329 + accruedRevenue: 2.3021358869347655 totalOrders: 7 + totalOrdersNoCoupon: 9 campaignName: campaignName - accruedDiscounts: 5.637376656633329 CustomerAnalytics: allOf: - properties: @@ -31678,13 +32650,13 @@ components: - totalRevenue description: A summary report of customer activity for a given time range. example: - freeItems: 1 acceptedCoupons: 0 - totalDiscounts: 7.061401241503109 - totalDiscountedOrders: 5 + createdCoupons: 6 + freeItems: 1 totalOrders: 5 + totalDiscountedOrders: 5 totalRevenue: 2.3021358869347655 - createdCoupons: 6 + totalDiscounts: 7.061401241503109 ApplicationCustomerEntity: properties: profileId: @@ -31736,6 +32708,7 @@ components: items: $ref: "#/components/schemas/CartItem" type: array + default: null discounts: additionalProperties: type: number @@ -31755,7 +32728,7 @@ components: example: 200 type: number attributes: - $ref: "#/components/schemas/UpdateCoupon_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" required: - cartItems - coupon @@ -31765,45 +32738,41 @@ components: - total - totalDiscounts example: - coupon: BKDB946 + id: 6 created: 2020-02-07T08:15:22Z - totalDiscounts: 100 integrationId: URNGV8294NV - profileintegrationid: 382370BKDB946 - total: 200 - referral: BKDB946 - discounts: - key: 0.8008281904610115 storeIntegrationId: STORE-001 + applicationId: 322 profileId: 138 - attributes: null - id: 6 + profileintegrationid: 382370BKDB946 + coupon: BKDB946 + referral: BKDB946 state: closed - applicationId: 322 cartItems: - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -31812,30 +32781,30 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -31844,7 +32813,11 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 + discounts: + key: 0.8008281904610115 + totalDiscounts: 100 + total: 200 + attributes: null ApplicationStoreEntity: properties: storeId: @@ -31870,103 +32843,105 @@ components: \ not a built-in event." type: string attributes: - $ref: "#/components/schemas/ApplicationEvent_allOf_attributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" effects: description: An array containing the effects that were applied as a result of this event. items: $ref: "#/components/schemas/Effect" type: array + default: null ruleFailureReasons: description: An array containing the rule failure reasons which happened during this event. items: $ref: "#/components/schemas/RuleFailureReason" type: array + default: null required: - attributes - effects - type example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: 138 + storeId: 0 + storeIntegrationId: STORE-001 + integrationId: 175KJPS947296 + sessionId: 6 + type: type + attributes: null effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 + - experimentId: 12 campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 ruleName: Give 20% discount - experimentId: 12 + effectType: rejectCoupon triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - storeIntegrationId: STORE-001 - created: 2020-06-10T09:05:27.993483Z - profileId: 138 - integrationId: 175KJPS947296 - attributes: null - id: 6 - sessionId: 6 - applicationId: 322 - storeId: 0 - type: type ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 + evaluationGroupID: 3 evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName + evaluationGroupID: 3 + evaluationGroupMode: stackable AudienceAnalytics: description: The audiences and their member count. example: - membersCount: 1234 audienceId: 1 + membersCount: 1234 properties: audienceId: description: The ID of the audience. @@ -31993,6 +32968,7 @@ components: format: int64 type: integer type: array + default: null connectedAudiences: description: A list of the IDs of the audiences that are connected to this customer profile. @@ -32004,6 +32980,7 @@ components: format: int64 type: integer type: array + default: null ApplicationReferee: allOf: - $ref: "#/components/schemas/ApplicationEntity" @@ -32036,12 +33013,12 @@ components: - friendIntegrationId - sessionId example: + applicationId: 322 + sessionId: sessionId + advocateIntegrationId: advocateIntegrationId friendIntegrationId: friendIntegrationId code: code created: 2000-01-23T04:56:07.000+00:00 - sessionId: sessionId - advocateIntegrationId: advocateIntegrationId - applicationId: 322 SlotDef: properties: name: @@ -32088,6 +33065,7 @@ components: items: $ref: "#/components/schemas/FuncArgDef" type: array + default: null required: - args - name @@ -32115,11 +33093,13 @@ components: to args. items: {} type: array + default: null args: description: An array of argument definitions. items: $ref: "#/components/schemas/TemplateArgDef" type: array + default: null expose: default: false description: A flag to control exposure in Rule Builder. @@ -32182,23 +33162,23 @@ components: - $ref: "#/components/schemas/AchievementAdditionalProperties" - type: object example: - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 + name: Order50Discount + title: 50% off on 50th purchase. description: 50% off for every 50th purchase in a year. + target: 50 + period: 1Y + periodEndOverride: "" + recurrencePolicy: no_recurrence activationPolicy: fixed_schedule - title: 50% off on 50th purchase. + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 allowRollbackAfterCompletion: false + campaignId: 1 userId: 1234 - hasProgress: true - target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 createdBy: John Doe - name: Order50Discount - periodEndOverride: "" - id: 6 - recurrencePolicy: no_recurrence + hasProgress: true status: inprogress NewAdditionalCost: allOf: @@ -32229,6 +33209,7 @@ components: format: int64 type: integer type: array + default: null type: default: session description: | @@ -32248,11 +33229,11 @@ components: - title example: name: shippingFee + title: Shipping fee + description: A shipping fee subscribedApplicationsIds: - 3 - 13 - description: A shipping fee - title: Shipping fee type: session AccountAdditionalCost: allOf: @@ -32260,15 +33241,15 @@ components: - $ref: "#/components/schemas/AccountEntity" - $ref: "#/components/schemas/NewAdditionalCost" example: - accountId: 3886 + id: 6 created: 2020-06-10T09:05:27.993483Z + accountId: 3886 name: shippingFee + title: Shipping fee + description: A shipping fee subscribedApplicationsIds: - 3 - 13 - description: A shipping fee - id: 6 - title: Shipping fee type: session NewApplicationCIF: properties: @@ -32317,15 +33298,15 @@ components: required: - applicationId example: - createdBy: 216 + id: 6 created: 2020-06-10T09:05:27.993483Z name: Filter items by product description: This filter allows filtering by shoes - modified: 2000-01-23T04:56:07.000+00:00 + activeExpressionId: 1 modifiedBy: 334 - id: 6 + createdBy: 216 + modified: 2000-01-23T04:56:07.000+00:00 applicationId: 322 - activeExpressionId: 1 Environment: allOf: - $ref: "#/components/schemas/Entity" @@ -32336,16 +33317,19 @@ components: items: $ref: "#/components/schemas/SlotDef" type: array + default: null functions: description: The functions defined for this application. items: $ref: "#/components/schemas/FunctionDef" type: array + default: null templates: description: The templates defined for this application. items: $ref: "#/components/schemas/TemplateDef" type: array + default: null variables: description: A stringified version of the environment's Talang variables scope. @@ -32355,49 +33339,58 @@ components: items: $ref: "#/components/schemas/GiveawaysPool" type: array + default: null loyaltyPrograms: description: The loyalty programs that the application is subscribed to. items: $ref: "#/components/schemas/LoyaltyProgram" type: array + default: null achievements: description: "The achievements, linked to the campaigns, belonging to\ \ the application." items: $ref: "#/components/schemas/Achievement" type: array + default: null attributes: description: The attributes that the application is subscribed to. items: $ref: "#/components/schemas/Attribute" type: array + default: null additionalCosts: description: The additional costs that the application is subscribed to. items: $ref: "#/components/schemas/AccountAdditionalCost" type: array + default: null audiences: description: The audiences contained in the account which the application belongs to. items: $ref: "#/components/schemas/Audience" type: array + default: null collections: description: The account-level collections that the application is subscribed to. items: $ref: "#/components/schemas/Collection" type: array + default: null applicationCartItemFilters: description: The cart item filters belonging to the Application. items: $ref: "#/components/schemas/ApplicationCIF" type: array + default: null priceTypes: description: The price types that this Application can use. items: $ref: "#/components/schemas/PriceType" type: array + default: null required: - functions - slots @@ -32448,11 +33441,13 @@ components: items: type: string type: array + default: null suggestions: description: Short suggestions that are used to group attributes. items: type: string type: array + default: null required: - description - entity @@ -32486,11 +33481,11 @@ components: - targetType BestPriorPriceRequest: example: - timeframeEndDate: 2020-11-10T23:00:00Z - timeframe: "30" skus: - comma - period + timeframeEndDate: 2020-11-10T23:00:00Z + timeframe: "30" timeframeEndDateType: sale target: targetType: AUDIENCE @@ -32506,6 +33501,7 @@ components: type: string minItems: 1 type: array + default: null timeframeEndDate: description: The end date and time that defines the latest time for retrieving historical SKU prices. @@ -32574,18 +33570,19 @@ components: BestPriorPriceMetadata: description: Auxiliary data for found price observation. example: - adjustmentDetails: "" influencingCampaignDetails: - campaignId: 0 discountValue: 6.027456183070403 - campaignId: 0 discountValue: 6.027456183070403 + adjustmentDetails: "" properties: influencingCampaignDetails: description: Details about campaigns that influenced the final price. items: $ref: "#/components/schemas/InfluencingCampaignDetails" type: array + default: null adjustmentDetails: allOf: - $ref: "#/components/schemas/AdjustmentDetails" @@ -32594,21 +33591,21 @@ components: - influencingCampaignDetails BestPriorPrice: example: + id: 1 + sku: NVR-GN-GV-UUP + observedAt: 2025-11-10T23:00:00Z + contextIds: + - SpringSale + - SummerSale2025 + contextId: "" + price: 99.99 metadata: - adjustmentDetails: "" influencingCampaignDetails: - campaignId: 0 discountValue: 6.027456183070403 - campaignId: 0 discountValue: 6.027456183070403 - observedAt: 2025-11-10T23:00:00Z - price: 99.99 - contextIds: - - SpringSale - - SummerSale2025 - contextId: "" - id: 1 - sku: NVR-GN-GV-UUP + adjustmentDetails: "" target: "{}" properties: id: @@ -32634,6 +33631,7 @@ components: items: type: string type: array + default: null contextId: default: "" description: | @@ -32660,12 +33658,13 @@ components: items: $ref: "#/components/schemas/BestPriorPrice" type: array + default: null PriceHistoryRequest: example: - endDate: 2020-12-10T23:00:00Z sku: - sku-124 startDate: 2020-11-10T23:00:00Z + endDate: 2020-12-10T23:00:00Z properties: sku: description: The SKU of the item for which the historical prices are being @@ -32691,20 +33690,20 @@ components: - startDate History: example: + id: 1 + observedAt: 2025-11-10T23:00:00Z + contextIds: + - SpringSale + - SummerSale2025 + contextId: "" + price: 99.99 metadata: - adjustmentDetails: "" influencingCampaignDetails: - campaignId: 0 discountValue: 6.027456183070403 - campaignId: 0 discountValue: 6.027456183070403 - observedAt: 2025-11-10T23:00:00Z - price: 99.99 - contextIds: - - SpringSale - - SummerSale2025 - contextId: "" - id: 1 + adjustmentDetails: "" target: "{}" properties: id: @@ -32726,6 +33725,7 @@ components: items: type: string type: array + default: null contextId: default: "" description: | @@ -32749,39 +33749,39 @@ components: - target PriceHistoryResponse: example: + sku: + - SKU1241028 history: - - metadata: - adjustmentDetails: "" - influencingCampaignDetails: - - campaignId: 0 - discountValue: 6.027456183070403 - - campaignId: 0 - discountValue: 6.027456183070403 + - id: 1 observedAt: 2025-11-10T23:00:00Z - price: 99.99 contextIds: - SpringSale - SummerSale2025 contextId: "" - id: 1 - target: "{}" - - metadata: - adjustmentDetails: "" + price: 99.99 + metadata: influencingCampaignDetails: - campaignId: 0 discountValue: 6.027456183070403 - campaignId: 0 discountValue: 6.027456183070403 + adjustmentDetails: "" + target: "{}" + - id: 1 observedAt: 2025-11-10T23:00:00Z - price: 99.99 contextIds: - SpringSale - SummerSale2025 contextId: "" - id: 1 + price: 99.99 + metadata: + influencingCampaignDetails: + - campaignId: 0 + discountValue: 6.027456183070403 + - campaignId: 0 + discountValue: 6.027456183070403 + adjustmentDetails: "" target: "{}" - sku: - - SKU1241028 properties: sku: description: The SKU of the item for which historical prices should be retrieved. @@ -32792,6 +33792,7 @@ components: items: $ref: "#/components/schemas/History" type: array + default: null required: - history - sku @@ -32857,6 +33858,7 @@ components: items: type: string type: array + default: null required: - campaignsCount - kind @@ -32870,11 +33872,13 @@ components: items: type: string type: array + default: null visible: description: List of attribute names to show in the UI. items: type: string type: array + default: null NewCatalog: allOf: - properties: @@ -32897,6 +33901,7 @@ components: format: int64 type: integer type: array + default: null required: - description - name @@ -32921,18 +33926,18 @@ components: - createdBy - version example: - accountId: 3886 - createdBy: 6 + id: 6 created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + modified: 2021-09-12T10:12:42Z name: seafood + description: seafood catalog subscribedApplicationsIds: - 1 - 2 - 3 - modified: 2021-09-12T10:12:42Z - description: seafood catalog - id: 6 version: 6 + createdBy: 6 ItemAttribute: allOf: - properties: @@ -32981,6 +33986,7 @@ components: items: $ref: "#/components/schemas/ItemAttribute" type: array + default: null product: $ref: "#/components/schemas/Product" required: @@ -32988,11 +33994,12 @@ components: - sku - version example: - product: - name: sample_product - catalogid: 6 + id: 6 created: 2020-06-10T09:05:27.993483Z + sku: SKU1241028 price: 99.99 + catalogid: 6 + version: 5 attributes: - attributeid: 6 name: name @@ -33000,9 +34007,8 @@ components: - attributeid: 6 name: name value: "" - id: 6 - sku: SKU1241028 - version: 5 + product: + name: sample_product AddItemCatalogAction: description: | The specific properties of the "ADD" catalog sync action. @@ -33098,6 +34104,7 @@ components: items: $ref: "#/components/schemas/CatalogActionFilter" type: array + default: null attributes: description: The attributes of the items to patch. type: object @@ -33120,6 +34127,7 @@ components: items: $ref: "#/components/schemas/CatalogActionFilter" type: array + default: null NewPriceAdjustment: properties: priceType: @@ -33179,6 +34187,7 @@ components: items: $ref: "#/components/schemas/NewPriceAdjustment" type: array + default: null required: - adjustments - sku @@ -33186,8 +34195,8 @@ components: description: Definition of all the properties that are needed for a single catalog sync action. example: - payload: "{}" type: ADD + payload: "{}" properties: type: description: The type of sync action. @@ -33208,16 +34217,16 @@ components: CatalogSyncRequest: example: actions: - - payload: "{}" - type: ADD - - payload: "{}" - type: ADD - - payload: "{}" - type: ADD - - payload: "{}" - type: ADD - - payload: "{}" - type: ADD + - type: ADD + payload: "{}" + - type: ADD + payload: "{}" + - type: ADD + payload: "{}" + - type: ADD + payload: "{}" + - type: ADD + payload: "{}" version: 244 properties: actions: @@ -33226,6 +34235,7 @@ components: maxItems: 1000 minItems: 1 type: array + default: null version: description: The version number of the catalog to apply the actions on. example: 244 @@ -33253,27 +34263,27 @@ components: example: Braze type: string example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + applicationIds: + - 0 + - 0 + title: Send message + description: A webhook to send a coupon to the user. + draft: false + verb: POST + url: www.my-company.com/my-endpoint-name headers: - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" - "{\"Content-Type\": \"application/json\"}" - created: 2020-06-10T09:05:27.993483Z - outgoingIntegrationTemplateId: 1 - verb: POST - description: A webhook to send a coupon to the user. - authenticationId: 1 - title: Send message + payload: "{\n\t\"message\": \"${message}\"\n}" params: [] - url: www.my-company.com/my-endpoint-name enabled: true - applicationIds: - - 0 - - 0 + authenticationId: 1 + outgoingIntegrationTemplateId: 1 outgoingIntegrationTypeId: 1 outgoingIntegrationTypeName: Braze - payload: "{\n\t\"message\": \"${message}\"\n}" - draft: false - modified: 2021-09-12T10:12:42Z - id: 6 WebhookAuthenticationWebhookRef: properties: id: @@ -33324,6 +34334,7 @@ components: items: $ref: "#/components/schemas/WebhookAuthenticationWebhookRef" type: array + default: null name: description: The name of the webhook authentication. example: My basic auth @@ -33393,26 +34404,26 @@ components: MessageLogEntry: description: Message Log. example: + id: 123e4567-e89b-12d3-a456-426614174000 + service: NotificationService + changeType: Update + notificationId: 101 + notificationName: My campaign notification + webhookId: 101 + webhookName: My webhook request: createdAt: 2021-07-20T21:59:00Z request: SGVsbG8sIHdvcmxkIQ== - webhookId: 101 - entityType: loyalty_program - campaignId: 2 - changeType: Update - url: www.my-company.com/my-endpoint-name - createdAt: 2021-07-20T22:00:00Z - service: NotificationService response: createdAt: 2021-07-20T22:00:50Z response: UmVzcG9uc2UgY29udGVudA== status: 200 - webhookName: My webhook - notificationId: 101 - loyaltyProgramId: 2 - id: 123e4567-e89b-12d3-a456-426614174000 + createdAt: 2021-07-20T22:00:00Z + entityType: loyalty_program + url: www.my-company.com/my-endpoint-name applicationId: 5 - notificationName: My campaign notification + loyaltyProgramId: 2 + campaignId: 2 properties: id: description: Unique identifier of the message. @@ -33493,46 +34504,46 @@ components: example: nextCursor: SmJlNERRMHdyNWFsTmRDZDVYU0c= data: - - request: + - id: 123e4567-e89b-12d3-a456-426614174000 + service: NotificationService + changeType: Update + notificationId: 101 + notificationName: My campaign notification + webhookId: 101 + webhookName: My webhook + request: createdAt: 2021-07-20T21:59:00Z request: SGVsbG8sIHdvcmxkIQ== - webhookId: 101 - entityType: loyalty_program - campaignId: 2 - changeType: Update - url: www.my-company.com/my-endpoint-name - createdAt: 2021-07-20T22:00:00Z - service: NotificationService response: createdAt: 2021-07-20T22:00:50Z response: UmVzcG9uc2UgY29udGVudA== status: 200 - webhookName: My webhook - notificationId: 101 - loyaltyProgramId: 2 - id: 123e4567-e89b-12d3-a456-426614174000 + createdAt: 2021-07-20T22:00:00Z + entityType: loyalty_program + url: www.my-company.com/my-endpoint-name applicationId: 5 + loyaltyProgramId: 2 + campaignId: 2 + - id: 123e4567-e89b-12d3-a456-426614174000 + service: NotificationService + changeType: Update + notificationId: 101 notificationName: My campaign notification - - request: + webhookId: 101 + webhookName: My webhook + request: createdAt: 2021-07-20T21:59:00Z request: SGVsbG8sIHdvcmxkIQ== - webhookId: 101 - entityType: loyalty_program - campaignId: 2 - changeType: Update - url: www.my-company.com/my-endpoint-name - createdAt: 2021-07-20T22:00:00Z - service: NotificationService response: createdAt: 2021-07-20T22:00:50Z response: UmVzcG9uc2UgY29udGVudA== status: 200 - webhookName: My webhook - notificationId: 101 - loyaltyProgramId: 2 - id: 123e4567-e89b-12d3-a456-426614174000 + createdAt: 2021-07-20T22:00:00Z + entityType: loyalty_program + url: www.my-company.com/my-endpoint-name applicationId: 5 - notificationName: My campaign notification + loyaltyProgramId: 2 + campaignId: 2 properties: nextCursor: description: | @@ -33547,6 +34558,7 @@ components: items: $ref: "#/components/schemas/MessageLogEntry" type: array + default: null required: - data NewEventType: @@ -33576,11 +34588,11 @@ components: - $ref: "#/components/schemas/Entity" - $ref: "#/components/schemas/NewEventType" example: + id: 6 created: 2020-06-10T09:05:27.993483Z + title: Survey Completed name: surveyCompleted description: The survey was submitted by the customer. - id: 6 - title: Survey Completed EmailEntity: properties: email: @@ -33630,12 +34642,13 @@ components: format: int64 type: integer type: array + default: null authMethod: description: Authentication method for this user. example: basic_auth type: string applicationNotificationSubscriptions: - $ref: "#/components/schemas/User_allOf_applicationNotificationSubscriptions" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" lastSignedIn: description: Timestamp when the user last signed in to Talon.One. example: 2021-09-12T10:12:42Z @@ -33653,42 +34666,42 @@ components: format: date-time type: string additionalAttributes: - $ref: "#/components/schemas/User_allOf_additionalAttributes" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" required: - inviteToken - name - policy - state example: + id: 6 created: 2020-06-10T09:05:27.993483Z - roles: - - 71 - isAdmin: false + modified: 2021-09-12T10:12:42Z + email: john.doe@example.com accountId: 3886 - applicationNotificationSubscriptions: "{}" - inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 name: John Doe - modified: 2021-09-12T10:12:42Z - lastAccessed: 2021-09-12T10:14:42Z - id: 6 state: invited + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + isAdmin: false + policy: "{Role=127}" + roles: + - 71 authMethod: basic_auth - latestFeedTimestamp: 2020-06-01T00:00:00Z + applicationNotificationSubscriptions: null lastSignedIn: 2021-09-12T10:12:42Z - email: john.doe@example.com - policy: "{Role=127}" - additionalAttributes: "{}" + lastAccessed: 2021-09-12T10:14:42Z + latestFeedTimestamp: 2020-06-01T00:00:00Z + additionalAttributes: null UpdateUser: example: - applicationNotificationSubscriptions: "{}" - roles: - - 1 - - 3 name: John Doe state: deactivated isAdmin: false policy: Role: 127 + roles: + - 1 + - 3 + applicationNotificationSubscriptions: "{}" properties: name: description: Name of the user. @@ -33727,6 +34740,7 @@ components: format: int64 type: integer type: array + default: null applicationNotificationSubscriptions: description: Application notifications that the user is subscribed to. type: object @@ -33760,6 +34774,7 @@ components: items: $ref: "#/components/schemas/OktaEventTarget" type: array + default: null required: - eventType - target @@ -33770,6 +34785,7 @@ components: items: $ref: "#/components/schemas/OktaEvent" type: array + default: null required: - events OktaEventPayload: @@ -33792,8 +34808,8 @@ components: description: "Member of the SCIM group. In Talon.One, the member is a [user](https://docs.talon.one/docs/product/account/account-settings/managing-users)\ \ assigned to a specific role." example: - display: john.doe@example.com value: "258" + display: john.doe@example.com properties: value: description: Unique identifier of the member. @@ -33809,10 +34825,10 @@ components: example: displayName: Manager members: - - display: john.doe@example.com - value: "258" - - display: john.doe@example.com - value: "258" + - value: "258" + display: john.doe@example.com + - value: "258" + display: john.doe@example.com properties: displayName: description: Display name of the group (Talon.One role). @@ -33823,6 +34839,7 @@ components: items: $ref: "#/components/schemas/ScimGroupMember" type: array + default: null ScimGroup: allOf: - $ref: "#/components/schemas/ScimBaseGroup" @@ -33839,10 +34856,10 @@ components: example: displayName: Manager members: - - display: john.doe@example.com - value: "258" - - display: john.doe@example.com - value: "258" + - value: "258" + display: john.doe@example.com + - value: "258" + display: john.doe@example.com id: "359" ScimGroupsListResponse: description: |- @@ -33868,12 +34885,14 @@ components: items: $ref: "#/components/schemas/ScimGroup" type: array + default: null schemas: description: SCIM schema for the given resource. items: example: urn:ietf:params:scim:api:messages:2.0:ListResponse type: string type: array + default: null totalResults: description: Number of results in the response. format: int64 @@ -33922,10 +34941,12 @@ components: example: urn:ietf:params:scim:api:messages:2.0:PatchOp type: string type: array + default: null Operations: items: $ref: "#/components/schemas/ScimPatchOperation" type: array + default: null required: - Operations ScimBaseUser: @@ -33955,11 +34976,11 @@ components: description: "Payload for users that are created using the SCIM provisioning\ \ protocol with an identity provider, for example, Microsoft Entra ID." example: + active: true displayName: John Doe + userName: john.doe@example.com name: formatted: Mr. John J Doe - active: true - userName: john.doe@example.com required: - userName ScimUser: @@ -33975,12 +34996,12 @@ components: description: "Schema definition for users that have been provisioned using the\ \ SCIM protocol with an identity provider, for example, Microsoft Entra ID." example: + active: true displayName: John Doe + userName: john.doe@example.com name: formatted: Mr. John J Doe - active: true id: "359" - userName: john.doe@example.com ScimUsersListResponse: description: "List of users that have been provisioned using the SCIM protocol\ \ with an identity provider, for example, Microsoft Entra ID." @@ -34004,12 +35025,14 @@ components: items: $ref: "#/components/schemas/ScimUser" type: array + default: null schemas: description: SCIM schema for the given resource. items: example: urn:ietf:params:scim:api:messages:2.0:ListResponse type: string type: array + default: null totalResults: description: Number of total results in the response. format: int64 @@ -34047,6 +35070,7 @@ components: items: $ref: "#/components/schemas/ScimResource" type: array + default: null required: - Resources ScimServiceProviderConfigResponse: @@ -34080,15 +35104,16 @@ components: filter: $ref: "#/components/schemas/ScimServiceProviderConfigResponse_filter" patch: - $ref: "#/components/schemas/ScimServiceProviderConfigResponse_patch" + $ref: "#/components/schemas/ScimServiceProviderConfigResponse_changePassword" schemas: description: A list of SCIM schemas that define the structure and data types supported by the service provider. items: type: string type: array + default: null sort: - $ref: "#/components/schemas/ScimServiceProviderConfigResponse_sort" + $ref: "#/components/schemas/ScimServiceProviderConfigResponse_changePassword" ScimSchemaResource: description: Resource schema definition for the SCIM provisioning protocol. example: @@ -34117,13 +35142,10 @@ components: description: Key-value attributes of the resource. type: object type: array + default: null ScimSchemasListResponse: description: List of resource schemas supported by the SCIM provisioning protocol. example: - totalResults: 0 - schemas: - - urn:ietf:params:scim:api:messages:2.0:ListResponse - - urn:ietf:params:scim:api:messages:2.0:ListResponse Resources: - id: urn:ietf:params:scim:schemas:core:2.0:User name: User @@ -34145,17 +35167,23 @@ components: - name: profileUrl required: false mutability: readWrite + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 0 properties: Resources: items: $ref: "#/components/schemas/ScimSchemaResource" type: array + default: null schemas: description: SCIM schema for the given resource. items: example: urn:ietf:params:scim:api:messages:2.0:ListResponse type: string type: array + default: null totalResults: description: Number of total results in the response. format: int64 @@ -34180,10 +35208,10 @@ components: NewExternalInvitation: description: Parameters for inviting a new user from an external identity provider. example: + name: John Doe userGroups: - Managers - Customer support - name: John Doe email: john.doe@example.com properties: name: @@ -34202,6 +35230,7 @@ components: items: type: string type: array + default: null email: description: Email address of the user. example: john.doe@example.com @@ -34307,6 +35336,17 @@ components: - active - modified description: A risk notification configuration rule. + UpdateRiskNotification: + allOf: + - $ref: "#/components/schemas/NewRiskNotification" + - properties: + active: + description: Indicates whether this risk notification is active. + example: true + type: boolean + required: + - active + description: Data for updating a risk notification. Change: allOf: - $ref: "#/components/schemas/Entity" @@ -34322,9 +35362,9 @@ components: example: /v1/applications/359/campaigns/6727 type: string old: - $ref: "#/components/schemas/Change_allOf_old" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" new: - $ref: "#/components/schemas/Change_allOf_new" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" managementKeyId: description: ID of management key used to perform changes. example: 3 @@ -34333,26 +35373,24 @@ components: required: - entity example: - new: "{applicationId\"=359, attributes\"={}, campaignGroups\"=[], created\"\ - =2022-07-08T13:04:02.972762328Z, description\"=, features\"=[referrals,\ - \ loyalty], id=6727}" - created: 2020-06-10T09:05:27.993483Z - old: "{}" id: 6 - applicationId: 359 + created: 2020-06-10T09:05:27.993483Z userId: 388 + applicationId: 359 entity: /v1/applications/359/campaigns/6727 + old: null + new: null managementKeyId: 3 NewInvitation: description: Parameters for inviting a new user. example: + name: John Doe + email: john.doe@example.com + isAdmin: false roles: - 13 - 13 - name: John Doe - isAdmin: false acl: acl - email: john.doe@example.com properties: name: description: Name of the user. @@ -34374,6 +35412,7 @@ components: format: int64 type: integer type: array + default: null acl: description: Indicates the access level of the user. type: string @@ -34407,8 +35446,8 @@ components: required: - password example: - password: admin123456 email: john.doe@example.com + password: admin123456 NewUser: allOf: - $ref: "#/components/schemas/LoginParams" @@ -34552,46 +35591,46 @@ components: - state - userCount example: - applicationCount: 5 - planExpires: 2000-01-23T04:56:07.000+00:00 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignsActiveCount: 7 + modified: 2021-09-12T10:12:42Z companyName: companyName - campaignsInactiveCount: 9 + domainName: domainName + state: active + billingEmail: billingEmail planName: planName + planExpires: 2000-01-23T04:56:07.000+00:00 applicationLimit: 0 - userCount: 2 - billingEmail: billingEmail + userLimit: 6 campaignLimit: 1 - domainName: domainName apiLimit: 5 - modified: 2021-09-12T10:12:42Z + applicationCount: 5 + userCount: 2 + campaignsActiveCount: 7 + campaignsInactiveCount: 9 attributes: null - id: 6 - state: active - userLimit: 6 AccountAnalytics: example: - liveActiveCampaigns: 10 - expiredCoupons: 200 - lastUpdatedAt: 2022-12-12T12:12:12Z - roles: 10 - activeCampaigns: 15 - activeCoupons: 650 - liveLoyaltyPrograms: 5 - sandboxApplications: 2 - activeRules: 35 - users: 0 + applications: 11 liveApplications: 6 + sandboxApplications: 2 campaigns: 35 + activeCampaigns: 15 + liveActiveCampaigns: 10 coupons: 850 - expiredReferralCodes: 400 - webhooks: 2 - loyaltyPrograms: 5 + activeCoupons: 650 + expiredCoupons: 200 referralCodes: 500 - applications: 11 activeReferralCodes: 100 + expiredReferralCodes: 400 + activeRules: 35 + users: 0 + roles: 10 customAttributes: 18 + webhooks: 2 + loyaltyPrograms: 5 + liveLoyaltyPrograms: 5 + lastUpdatedAt: 2022-12-12T12:12:12Z properties: applications: description: Total number of applications in the account. @@ -34766,6 +35805,7 @@ components: items: type: string type: array + default: null SecondaryDeploymentPrice: description: The price for a secondary deployment according to contractual agreements. @@ -34817,17 +35857,17 @@ components: - Collection type: string filter: - $ref: "#/components/schemas/Export_allOf_filter" + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" required: - entity - filter example: - filter: null - accountId: 3886 - created: 2020-06-10T09:05:27.993483Z id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 userId: 388 entity: Coupon + filter: null ManagerConfig: properties: schemaVersion: @@ -34899,6 +35939,7 @@ components: format: int64 type: integer type: array + default: null NewRole: allOf: - $ref: "#/components/schemas/UpdateRole" @@ -34921,6 +35962,7 @@ components: format: int64 type: integer type: array + default: null roles: description: An array of role IDs. example: @@ -34930,6 +35972,7 @@ components: format: int64 type: integer type: array + default: null required: - roles - users @@ -34951,17 +35994,10 @@ components: type: string maxItems: 1000 type: array + default: null required: - logicalOperations - name - RolesV2Thresholds: - properties: - loyaltyPointsLimit: - description: Maximum number of loyalty points a support user can award without - approval. - example: 100 - format: int64 - type: integer RoleV2ApplicationDetails: properties: application: @@ -34979,11 +36015,6 @@ components: description: Name of the tools-related permission set. example: Tools permission set type: string - thresholds: - allOf: - - $ref: "#/components/schemas/RolesV2Thresholds" - description: Support user limits for actions that require admin approval - within the given application. RoleV2Application: additionalProperties: $ref: "#/components/schemas/RoleV2ApplicationDetails" @@ -35051,6 +36082,21 @@ components: account: description: Name of the account-level permission set type: string + RolesV2Thresholds: + properties: + loyaltyProgramId: + description: "Identifier of the loyalty program. You can get the ID with\ + \ the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms)\ + \ endpoint." + example: 8 + format: int64 + type: integer + loyaltyPointsLimit: + description: Maximum number of loyalty points a support user can award without + approval. + example: 100 + format: int64 + type: integer RoleV2Permissions: properties: permissionSets: @@ -35080,17 +36126,25 @@ components: $ref: "#/components/schemas/RoleV2PermissionSet" maxItems: 500 type: array + default: null roles: $ref: "#/components/schemas/RoleV2RolesGroup" + thresholds: + description: Support user limits for actions that require admin approval + within the given application. + items: + $ref: "#/components/schemas/RolesV2Thresholds" + type: array + default: null RoleV2Base: example: + name: Campaign and campaign access group manager + description: "Allows you to create and edit campaigns for specific Applications,\ + \ delete specific campaign access groups, and view loyalty programs." permissions: "" members: - 10 - 12 - name: Campaign and campaign access group manager - description: "Allows you to create and edit campaigns for specific Applications,\ - \ delete specific campaign access groups, and view loyalty programs." properties: name: description: Name of the role. @@ -35114,6 +36168,7 @@ components: format: int64 type: integer type: array + default: null RoleV2Readonly: properties: isReadonly: @@ -35133,18 +36188,18 @@ components: - $ref: "#/components/schemas/RoleV2Base" - $ref: "#/components/schemas/RoleV2Readonly" example: - accountId: 3886 - isReadonly: false + id: 6 created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + accountId: 3886 + name: Campaign and campaign access group manager + description: "Allows you to create and edit campaigns for specific Applications,\ + \ delete specific campaign access groups, and view loyalty programs." permissions: "" members: - 10 - 12 - name: Campaign and campaign access group manager - modified: 2021-09-12T10:12:42Z - description: "Allows you to create and edit campaigns for specific Applications,\ - \ delete specific campaign access groups, and view loyalty programs." - id: 6 + isReadonly: false NewRoleV2: allOf: - $ref: "#/components/schemas/RoleV2Base" @@ -35275,6 +36330,7 @@ components: items: $ref: "#/components/schemas/Notification" type: array + default: null NotificationListItem: properties: notificationId: @@ -35306,6 +36362,7 @@ components: items: $ref: "#/components/schemas/NotificationListItem" type: array + default: null Endpoint: properties: path: @@ -35330,6 +36387,7 @@ components: items: $ref: "#/components/schemas/Endpoint" type: array + default: null allowedApplicationIds: description: | A list of Application IDs that you can access with the management key. @@ -35342,6 +36400,7 @@ components: format: int64 type: integer type: array + default: null required: - endpoints - expiryDate @@ -35519,10 +36578,10 @@ components: example: name: South US store description: This is the description of the store in south US. - integrationId: STORE-001 attributes: country: USA code: 1234 + integrationId: STORE-001 Store: allOf: - $ref: "#/components/schemas/Entity" @@ -35554,25 +36613,26 @@ components: format: int64 type: integer type: array + default: null required: - applicationId - created - updated example: - linkedCampaignIds: - - 4 - - 6 - - 8 + id: 6 created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. - integrationId: STORE-001 attributes: country: USA code: 1234 - id: 6 + integrationId: STORE-001 applicationId: 322 updated: 2021-09-23T10:12:42Z + linkedCampaignIds: + - 4 + - 6 + - 8 CampaignDetail: properties: campaignId: @@ -35600,6 +36660,7 @@ components: items: $ref: "#/components/schemas/CampaignDetail" type: array + default: null UpdateApplicationCIF: properties: description: @@ -35654,6 +36715,7 @@ components: - Kitchen items: {} type: array + default: null ApplicationCIFExpression: allOf: - $ref: "#/components/schemas/Entity" @@ -35667,6 +36729,10 @@ components: required: - applicationId example: + id: 6 + created: 2020-06-10T09:05:27.993483Z + cartItemFilterId: 216 + createdBy: 216 expression: expr: - filter @@ -35681,10 +36747,6 @@ components: - Item - Category - Kitchen - cartItemFilterId: 216 - createdBy: 216 - created: 2020-06-10T09:05:27.993483Z - id: 6 applicationId: 322 CatalogRule: description: "A rule template stored in a catalog entry. Rules in catalog entries\ @@ -35703,6 +36765,7 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null condition: description: A Talang expression that will be evaluated in the context of the given event. @@ -35712,6 +36775,7 @@ components: items: {} minItems: 1 type: array + default: null effects: description: An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. @@ -35730,6 +36794,7 @@ components: items: type: object type: array + default: null required: - condition - effects @@ -35760,6 +36825,7 @@ components: - Kitchen items: {} type: array + default: null required: - expression - name @@ -35804,6 +36870,7 @@ components: items: $ref: "#/components/schemas/CatalogRule" type: array + default: null cartItemFilters: description: "Array of cart item filter templates in this blueprint. Cart\ \ item filters only contain name (no description, as description is at\ @@ -35811,6 +36878,7 @@ components: items: $ref: "#/components/schemas/CartItemFilterTemplate" type: array + default: null created: description: Timestamp when the blueprint was created. format: date-time @@ -35863,6 +36931,7 @@ components: items: $ref: "#/components/schemas/CatalogRule" type: array + default: null cartItemFilters: description: "Array of cart item filters to store in this blueprint. If\ \ not provided, will be extracted from the rules. Cart item filters should\ @@ -35871,6 +36940,7 @@ components: items: $ref: "#/components/schemas/CartItemFilterTemplate" type: array + default: null required: - title UpdateBlueprint: @@ -35895,6 +36965,7 @@ components: items: $ref: "#/components/schemas/CatalogRule" type: array + default: null cartItemFilters: description: "Replaces the stored cart item filters. Cart item filters should\ \ only contain name (no description, as description is at the blueprint\ @@ -35902,11 +36973,12 @@ components: items: $ref: "#/components/schemas/CartItemFilterTemplate" type: array + default: null ListCampaignStoreBudgetsStore: example: - name: name - integrationId: integrationId id: 0 + integrationId: integrationId + name: name properties: id: format: int64 @@ -35921,13 +36993,13 @@ components: - name ListCampaignStoreBudgets: example: - period: period - limit: 6 - action: action store: - name: name - integrationId: integrationId id: 0 + integrationId: integrationId + name: name + limit: 6 + action: action + period: period properties: store: $ref: "#/components/schemas/ListCampaignStoreBudgetsStore" @@ -35944,8 +37016,8 @@ components: - store NewCampaignStoreBudgetStoreLimit: example: - limit: 1000 storeId: 17 + limit: 1000 properties: storeId: description: | @@ -35963,13 +37035,13 @@ components: - storeId NewCampaignStoreBudget: example: - period: daily action: setDiscount storeLimits: - - limit: 1000 - storeId: 17 - - limit: 1000 - storeId: 17 + - storeId: 17 + limit: 1000 + - storeId: 17 + limit: 1000 + period: daily properties: action: enum: @@ -35980,6 +37052,7 @@ components: items: $ref: "#/components/schemas/NewCampaignStoreBudgetStoreLimit" type: array + default: null period: enum: - daily @@ -35992,10 +37065,10 @@ components: - storeLimits SummaryCampaignStoreBudget: example: + action: redeemCoupon period: overall - imported: true storeCount: 0 - action: redeemCoupon + imported: true properties: action: enum: @@ -36036,17 +37109,17 @@ components: allOf: - $ref: "#/components/schemas/AchievementBase" example: - fixedStartDate: 2024-01-15T15:04:05Z07:00 - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 name: Order50Discount - periodEndOverride: "" - description: 50% off for every 50th purchase in a year. - activationPolicy: fixed_schedule title: 50% off on 50th purchase. - allowRollbackAfterCompletion: false + description: 50% off for every 50th purchase in a year. target: 50 + period: 1Y + periodEndOverride: "" recurrencePolicy: no_recurrence + activationPolicy: fixed_schedule + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 + allowRollbackAfterCompletion: false AchievementBaseV2: properties: name: @@ -36157,6 +37230,7 @@ components: type: integer minItems: 0 type: array + default: null AchievementAdditionalPropertiesV2: properties: userId: @@ -36171,17 +37245,24 @@ components: **Note**: This is not available if the user has been deleted. example: John Doe type: string + periodEndOverride: + allOf: + - $ref: "#/components/schemas/TimePoint" + deprecated: true hasProgress: description: Indicates if a customer has made progress in the achievement. type: boolean status: - description: The status of the achievement. + description: "The status of the achievement. \ + \ \n\ + - `active`: The achievement is available to customers.\n- `scheduled`:\ + \ The achievement has a `fixedStartDate` set in the future.\n- `expired`:\ + \ The achievement's `endDate` is in the past.\n" enum: - - inprogress + - active + - scheduled - expired - - not_started - - completed - example: inprogress + example: active type: string required: - userId @@ -36271,11 +37352,16 @@ components: example: 4501 format: int64 type: integer + campaignName: + description: The name of the campaign that references this achievement. + example: Summer promotions + type: string required: - achievementId - applicationId - applicationName - campaignId + - campaignName AnalyticsDataPoint: properties: total: @@ -36406,6 +37492,7 @@ components: type: string maxItems: 50 type: array + default: null campaignState: description: | The state of the campaign. @@ -36541,6 +37628,7 @@ components: items: $ref: "#/components/schemas/ProductUnitAnalyticsDataPoint" type: array + default: null totals: $ref: "#/components/schemas/ProductUnitAnalytics_totals" required: @@ -36611,6 +37699,7 @@ components: items: $ref: "#/components/schemas/SkuUnitAnalyticsDataPoint" type: array + default: null totals: $ref: "#/components/schemas/ProductUnitAnalytics_totals" required: @@ -36663,6 +37752,7 @@ components: items: type: object type: array + default: null required: - itemFilter GenerateCampaignSummary: @@ -36717,15 +37807,15 @@ components: CouponFailureSummary: description: Summary of the reasons for coupon redemption failure. example: - summary: Session total was less than the required total. - eventID: 1011 - createdAt: 2021-07-20T21:59:00Z - profileID: a48f10dddb5c9493aad194e49bb9c1dac - language: en id: 1 + eventID: 1011 sessionID: 1 - couponCode: ABC123 + profileID: a48f10dddb5c9493aad194e49bb9c1dac status: rejected + couponCode: ABC123 + language: en + summary: Session total was less than the required total. + createdAt: 2021-07-20T21:59:00Z updatedAt: 2021-07-20T21:59:00Z properties: id: @@ -36842,6 +37932,18 @@ components: - email - name - summary + IntegrationHubEventType: + description: The type of integration hub event. + enum: + - LoyaltyPointsChanged + - LoyaltyTierDowngrade + - LoyaltyTierUpgrade + - CouponCreated + - CouponUpdated + - CouponDeleted + example: CouponCreated + type: string + x-generate-enum-go: true IntegrationHubFlowConfigResponse: properties: WorkerCount: @@ -36864,30 +37966,52 @@ components: type: integer IntegrationHubFlowResponse: properties: - Id: + id: description: ID of the integration hub flow. format: int64 type: integer - ApplicationID: - description: ID of application the flow is registered for. + integrationName: + description: Name of the integration. + type: string + instanceName: + description: Name of the integration instance. + type: string + createdAt: + description: Timestamp when the flow was created. + format: date-time + type: string + disabledUntil: + description: Timestamp until which the flow is disabled. Null when the flow + is active. + format: date-time + nullable: true + type: string + applicationId: + description: ID of the application the flow is registered for. example: 54 format: int64 type: integer - EventType: + loyaltyProgramId: + description: ID of the loyalty program the flow is registered for. + example: 12 + format: int64 + type: integer + eventType: description: The event type we want to register a flow for. type: string x-fieldType: IntegrationHubEventType - IntegrationHubFlowUrl: + integrationHubFlowUrl: description: The URL of the integration hub flow that we want to trigger for the event. type: string - Config: + config: $ref: "#/components/schemas/IntegrationHubFlowConfigResponse" required: - - Config - - EventType - - Id - - IntegrationHubFlowUrl + - config + - createdAt + - eventType + - id + - integrationHubFlowUrl IntegrationHubFlowConfig: properties: ApiKey: @@ -36918,14 +38042,17 @@ components: IntegrationHubFlowWithConfig: properties: ApplicationID: - description: ID of application the flow is registered for. + description: ID of the application the flow is registered for. example: 54 format: int64 type: integer + LoyaltyProgramID: + description: ID of the loyalty program the flow is registered for. + example: 12 + format: int64 + type: integer EventType: - description: The event type we want to register a flow for. - type: string - x-fieldType: IntegrationHubEventType + $ref: "#/components/schemas/IntegrationHubEventType" IntegrationHubFlowUrl: description: The URL of the integration hub flow that we want to trigger for the event. @@ -36939,14 +38066,17 @@ components: IntegrationHubFlow: properties: ApplicationID: - description: ID of application the flow is registered for. + description: ID of the application the flow is registered for. example: 54 format: int64 type: integer + LoyaltyProgramID: + description: ID of the loyalty program the flow is registered for. + example: 12 + format: int64 + type: integer EventType: - description: The event type we want to register a flow for. - type: string - x-fieldType: IntegrationHubEventType + $ref: "#/components/schemas/IntegrationHubEventType" IntegrationHubFlowUrl: description: The URL of the integration hub flow that we want to trigger for the event. @@ -36954,294 +38084,55 @@ components: required: - EventType - IntegrationHubFlowUrl - IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction: - allOf: - - properties: - Amount: - format: float - type: number - Reason: - type: string - Operation: - enum: - - addition - - subtraction - type: string - StartDate: - format: date-time - type: string - ExpiryDate: - format: date-time - type: string - TransactionUUID: - description: The identifier of the transaction in the loyalty ledger. - format: uuid - type: string - required: - - Amount - - Operation - - TransactionUUID - IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification: - allOf: - - properties: - ProfileIntegrationID: - type: string - LoyaltyProgramID: - format: int64 - type: integer - LoyaltyProgramName: - description: The name of the loyalty program. - type: string - SubledgerID: - type: string - SourceOfEvent: - type: string - CurrentTier: - description: The name of the customer's current tier. - type: string - EmployeeName: - type: string - UserID: - format: int64 - type: integer - CurrentPoints: - format: float - type: number - Actions: - items: - $ref: "#/components/schemas/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction" - type: array - PublishedAt: - description: Timestamp when the event was published. - format: date-time - type: string - required: - - CurrentPoints - - CurrentTier - - LoyaltyProgramID - - LoyaltyProgramName - - ProfileIntegrationID - - PublishedAt - - SourceOfEvent - - SubledgerID - IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification: - allOf: - - properties: - ProfileIntegrationID: - type: string - LoyaltyProgramID: - format: int64 - type: integer - LoyaltyProgramName: - description: The name of the loyalty program. - type: string - SubledgerID: - type: string - SourceOfEvent: - type: string - CurrentTier: - description: "The name of the customer's current tier, or null if the\ - \ customer was downgraded below all tiers." - type: string - CurrentPoints: - format: float - type: number - OldTier: - type: string - TierExpirationDate: - format: date-time - type: string - TimestampOfTierChange: - format: date-time - type: string - PublishedAt: - description: Timestamp when the event was published. - format: date-time - type: string - required: - - CurrentPoints - - LoyaltyProgramID - - LoyaltyProgramName - - ProfileIntegrationID - - PublishedAt - - SourceOfEvent - - SubledgerID - IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification: - allOf: - - properties: - ProfileIntegrationID: - type: string - LoyaltyProgramID: - format: int64 - type: integer - LoyaltyProgramName: - description: The name of the loyalty program. - type: string - SubledgerID: - type: string - SourceOfEvent: - type: string - CurrentTier: - description: The name of the customer's current tier. - type: string - CurrentPoints: - format: float - type: number - OldTier: - type: string - PointsRequiredToTheNextTier: - format: float - type: number - NextTier: - type: string - TierExpirationDate: - format: date-time - type: string - TimestampOfTierChange: - format: date-time - type: string - PublishedAt: - description: Timestamp when the event was published. - format: date-time - type: string - required: - - CurrentPoints - - CurrentTier - - LoyaltyProgramID - - LoyaltyProgramName - - ProfileIntegrationID - - PublishedAt - - SourceOfEvent - - SubledgerID - IntegrationHubEventPayloadLoyaltyProfileBasedNotification: - allOf: - - $ref: "#/components/schemas/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification" - - $ref: "#/components/schemas/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification" - - $ref: "#/components/schemas/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification" - IntegrationHubEventPayloadCouponBasedNotificationsLimits: - properties: - Action: - type: string - Limit: - format: float - type: number - Period: - type: string - Entities: - items: - type: string - type: array - required: - - Action - - Entities - - Limit - IntegrationHubEventPayloadCouponBasedNotifications: - allOf: - - properties: - Id: - format: int64 - type: integer - Created: - format: date-time - type: string - CampaignId: - format: int64 - type: integer - Value: - type: string - UsageLimit: - format: int64 - type: integer - DiscountLimit: - format: float - type: number - ReservationLimit: - format: int64 - type: integer - StartDate: - format: date-time - type: string - ExpiryDate: - format: date-time - type: string - UsageCounter: - format: int64 - type: integer - DiscountCounter: - format: float - type: number - DiscountRemainder: - format: float - type: number - ReferralId: - format: int64 - type: integer - RecipientIntegrationId: - type: string - ImportId: - format: int64 - type: integer - BatchId: - type: string - Attributes: - $ref: "#/components/schemas/IntegrationHubEventPayloadCouponBasedNotifications_allOf_Attributes" - Limits: - items: - $ref: "#/components/schemas/IntegrationHubEventPayloadCouponBasedNotificationsLimits" - type: array - PublishedAt: - description: Timestamp when the event was published. - format: date-time - type: string - SourceOfEvent: - type: string - EmployeeName: - type: string - required: - - CampaignId - - Created - - EmployeeName - - Id - - PublishedAt - - SourceOfEvent - - UsageCounter - - UsageLimit - - Value IntegrationHubEventRecord: properties: - Id: + id: + description: ID of the event record. format: int64 type: integer - FlowId: + flowId: + description: ID of the integration hub flow. format: int64 type: integer - EventType: + integrationName: + description: Name of the integration. type: string - x-fieldType: IntegrationHubEventType - EventData: {} - PublishedAt: + instanceName: + description: Name of the integration instance. + type: string + eventType: + $ref: "#/components/schemas/IntegrationHubEventType" + publishedAt: + description: Timestamp when the event was published. format: date-time type: string - ProcessedAt: + processedAt: + description: Timestamp when the event was processed. format: date-time type: string - DeliveredAt: + deliveredAt: + description: Timestamp when the event was delivered. format: date-time type: string - ProcessAfter: + scheduledTo: + description: Timestamp after which the event is scheduled to be processed. format: date-time type: string - Retry: + retry: + description: Number of delivery retries attempted. format: int64 type: integer + payload: + description: The event payload as a formatted JSON string. + type: string required: - - EventData - - EventType - - FlowId - - Id - - ProcessAfter - - PublishedAt - - Retry + - eventType + - flowId + - id + - payload + - publishedAt + - retry + - scheduledTo IntegrationHubEventStatusUpdate: properties: EventId: @@ -37263,6 +38154,7 @@ components: items: $ref: "#/components/schemas/IntegrationHubEventStatusUpdate" type: array + default: null IntegrationHubConfig: description: Config used for accessing integrations in IntegrationHub properties: @@ -37496,6 +38388,7 @@ components: format: int64 type: integer type: array + default: null sandbox: description: Indicates if this is a live or sandbox reward. Rewards of a given type can only be connected to Applications of the same type. @@ -37572,6 +38465,7 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null modified: description: The timestamp when the reward was last updated in RFC3339 format. @@ -37589,6 +38483,7 @@ components: items: $ref: "#/components/schemas/RewardPointsRequired" type: array + default: null required: - status UpdateReward: @@ -37637,6 +38532,7 @@ components: items: $ref: "#/components/schemas/Binding" type: array + default: null pointsRequired: description: | The loyalty points required to activate the reward. Each object defines the specific @@ -37649,6 +38545,7 @@ components: items: $ref: "#/components/schemas/RewardPointsRequired" type: array + default: null required: - name - status @@ -37693,6 +38590,7 @@ components: type: string maxItems: 1 type: array + default: null responseContent: description: | Optional list of requested information to be present on the response related to the tracking custom event. @@ -37709,6 +38607,23 @@ components: - ruleFailureReasons type: string type: array + default: null + example: + profileId: URNGV8294NV + storeIntegrationId: STORE-001 + evaluableCampaignIds: + - 10 + - 12 + type: pageViewed + attributes: + myAttribute: myValue + integrationId: 175KJPS947296 + connectedSessionId: 175KJPS947296 + loyaltyCards: + - loyalty-card-1 + responseContent: + - triggeredCampaigns + - customerProfile IntegrationEventV3Response: allOf: - $ref: "#/components/schemas/IntegrationResponse" @@ -37719,6 +38634,597 @@ components: allOf: - $ref: "#/components/schemas/EventV3" description: The advanced event that was processed. + example: + customerProfile: "" + loyalty: "" + triggeredCampaigns: + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true + features: + - coupons + - referrals + couponSettings: + 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" + couponPattern: SUMMER-####-#### + referralSettings: + 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" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 + referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true + features: + - coupons + - referrals + couponSettings: + 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" + couponPattern: SUMMER-####-#### + referralSettings: + 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" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 + referralRedemptionCount: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + campaignEligibility: + - applicationId: 322 + id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + rules: + - title: Give discount via coupon + displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + - title: Give discount via coupon + displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + experiment: + id: 0 + variantId: 6 + - applicationId: 322 + id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + rules: + - title: Give discount via coupon + displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + - title: Give discount via coupon + displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + eligibility: + - passed: true + couponCode: couponCode + details: "" + - passed: true + couponCode: couponCode + details: "" + experiment: + id: 0 + variantId: 6 + effects: + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 + conditionIndex: 786 + evaluationGroupID: 3 + evaluationGroupMode: stackable + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + props: "" + ruleFailureReasons: + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 + couponID: 4928 + couponValue: couponValue + referralID: 5 + referralValue: referralValue + ruleIndex: 2 + ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 + details: details + evaluationGroupID: 3 + evaluationGroupMode: stackable + createdCoupons: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + value: XMAS-20-2021 + usageLimit: 100 + discountLimit: 30 + reservationLimit: 45 + startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + usageCounter: 10 + discountCounter: 10 + discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 + isReservationMandatory: false + implicitlyReserved: false + createdReferrals: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 + created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z + usageLimit: 1 + campaignId: 78 + advocateProfileIntegrationId: URNGV8294NV + friendProfileIntegrationId: BZGGC2454PA + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + awardedGiveaways: + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + code: GIVEAWAY1 + poolId: 1 + startDate: 2022-01-02T15:04:05Z07:00 + endDate: 2023-01-02T15:04:05Z07:00 + attributes: null + used: true + importId: 4 + profileIntegrationId: R195412 + profileId: 1 + advancedEvent: "" EmbeddedDashboardConfiguration: properties: workspaceId: @@ -37779,6 +39285,7 @@ components: - sku_value items: {} type: array + default: null required: - name - type @@ -37825,6 +39332,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null evaluationPosition: allOf: - $ref: "#/components/schemas/CampaignEvaluationPosition" @@ -37841,6 +39349,7 @@ components: items: $ref: "#/components/schemas/CampaignCreatedNotificationItem" type: array + default: null required: - TotalResultSize CampaignStateChangedNotificationItem: @@ -37872,6 +39381,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null required: - campaign - newState @@ -37885,6 +39395,7 @@ components: items: $ref: "#/components/schemas/CampaignStateChangedNotificationItem" type: array + default: null required: - TotalResultSize CampaignRulesetChangedNotificationItem: @@ -37906,6 +39417,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null ruleset: allOf: - $ref: "#/components/schemas/Ruleset" @@ -37916,6 +39428,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null required: - campaign CampaignRulesetChangedNotification: @@ -37927,6 +39440,7 @@ components: items: $ref: "#/components/schemas/CampaignRulesetChangedNotificationItem" type: array + default: null required: - TotalResultSize CampaignEditedNotificationItem: @@ -37952,6 +39466,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null required: - campaign - oldCampaign @@ -37964,6 +39479,7 @@ components: items: $ref: "#/components/schemas/CampaignEditedNotificationItem" type: array + default: null required: - TotalResultSize CampaignCollectionEditedNotificationItem: @@ -37985,6 +39501,7 @@ components: items: $ref: "#/components/schemas/PlaceholderDetails" type: array + default: null collection: allOf: - $ref: "#/components/schemas/CollectionWithoutPayload" @@ -38001,6 +39518,7 @@ components: items: $ref: "#/components/schemas/CampaignCollectionEditedNotificationItem" type: array + default: null required: - TotalResultSize CampaignDeletedNotificationItem: @@ -38029,6 +39547,7 @@ components: items: $ref: "#/components/schemas/CampaignDeletedNotificationItem" type: array + default: null required: - TotalResultSize CampaignEvaluationTreeChangedNotification: @@ -38060,6 +39579,7 @@ components: items: $ref: "#/components/schemas/ApplicationNotification" type: array + default: null required: - data StrikethroughTrigger: @@ -38149,6 +39669,7 @@ components: $ref: "#/components/schemas/StrikethroughEffect" type: array x-omit-if-zero: true + default: null required: - catalogId - evaluatedAt @@ -38196,6 +39717,7 @@ components: items: $ref: "#/components/schemas/ExtendedCoupon" type: array + default: null totalResultSize: example: 1 format: int64 @@ -38248,6 +39770,7 @@ components: items: $ref: "#/components/schemas/ExtendedCoupon" type: array + default: null totalResultSize: example: 1 format: int64 @@ -38401,6 +39924,7 @@ components: items: $ref: "#/components/schemas/ExpiringPointsData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -38450,6 +39974,7 @@ components: example: URNGV8294NV type: string type: array + default: null required: - AmountOfExpiringPoints - CardIdentifier @@ -38469,6 +39994,7 @@ components: items: $ref: "#/components/schemas/ExpiringCardPointsData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -38662,6 +40188,7 @@ components: $ref: "#/components/schemas/AddedDeductedPointsBalancesAction" minItems: 1 type: array + default: null CurrentPoints: description: The current points balance. example: 10.99 @@ -38731,6 +40258,7 @@ components: items: $ref: "#/components/schemas/PendingActivePointsData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -38808,6 +40336,7 @@ components: items: $ref: "#/components/schemas/TierUpgradeData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -38875,6 +40404,7 @@ components: items: $ref: "#/components/schemas/TierDowngradeData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -38943,6 +40473,7 @@ components: items: $ref: "#/components/schemas/TierWillDowngradeData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -39027,6 +40558,7 @@ components: items: $ref: "#/components/schemas/GiveawayPoolNotificationData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -39112,6 +40644,7 @@ components: items: $ref: "#/components/schemas/ExpiringCouponsData" type: array + default: null NotificationType: description: The type of notification. enum: @@ -39152,6 +40685,7 @@ components: items: type: string type: array + default: null SessionIntegrationID: description: The integration ID of the session through which the points were earned or lost. @@ -39260,178 +40794,387 @@ components: - test-user-4zoj1c items: type: string - type: array - SessionIntegrationID: - description: The integration ID of the session through which the points - were earned or lost. - example: cc53e4fa-547f-4f5e-8333-76e05c381f67 - type: string - SubledgerID: - description: The ID of the subledger within the loyalty program where these - points were added or deducted. - example: sub-123 - type: string - TypeOfChange: - description: | - The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: - - [The Campaign Manager](/docs/product/getting-started) - - [Management API](/management-api#tag/Loyalty) - - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) - enum: - - campaign_manager - - rule_engine - - management_api - type: string - UserID: - description: The ID of the employee who added or deducted points. - example: 25 - format: int64 - type: integer - UsersPerCardLimit: - description: The max amount of user profiles with whom a card can be shared. - This can be set to `0` for no limit. - example: 10 - format: int64 - type: integer - Actions: - description: The list of actions that have been triggered in the loyalty - program. - items: - $ref: "#/components/schemas/AddedDeductedPointsBalancesAction" - minItems: 1 - type: array - CurrentPoints: - description: The current points balance. - example: 10.99 - type: number - required: - - Actions - - CardIdentifier - - CurrentPoints - - EmployeeName - - LoyaltyProgramID - - NotificationType - - ProfileIntegrationIDs - - SessionIntegrationID - - SubledgerID - - TypeOfChange - - UserID - - UsersPerCardLimit - SetLoyaltyPointsExpiryDateEffectProps: - description: | - The properties specific to the "setLoyaltyPointsExpiryDate" effect. This gets triggered when a validated rule contains the "set expiry date" effect. The current expiry date gets set to the date given in the effect. + type: array + default: null + SessionIntegrationID: + description: The integration ID of the session through which the points + were earned or lost. + example: cc53e4fa-547f-4f5e-8333-76e05c381f67 + type: string + SubledgerID: + description: The ID of the subledger within the loyalty program where these + points were added or deducted. + example: sub-123 + type: string + TypeOfChange: + description: | + The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: + - [The Campaign Manager](/docs/product/getting-started) + - [Management API](/management-api#tag/Loyalty) + - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) + enum: + - campaign_manager + - rule_engine + - management_api + type: string + UserID: + description: The ID of the employee who added or deducted points. + example: 25 + format: int64 + type: integer + UsersPerCardLimit: + description: The max amount of user profiles with whom a card can be shared. + This can be set to `0` for no limit. + example: 10 + format: int64 + type: integer + Actions: + description: The list of actions that have been triggered in the loyalty + program. + items: + $ref: "#/components/schemas/AddedDeductedPointsBalancesAction" + minItems: 1 + type: array + default: null + CurrentPoints: + description: The current points balance. + example: 10.99 + type: number + required: + - Actions + - CardIdentifier + - CurrentPoints + - EmployeeName + - LoyaltyProgramID + - NotificationType + - ProfileIntegrationIDs + - SessionIntegrationID + - SubledgerID + - TypeOfChange + - UserID + - UsersPerCardLimit + IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction: + allOf: + - properties: + Amount: + format: float + type: number + Reason: + type: string + Operation: + enum: + - addition + - subtraction + type: string + StartDate: + format: date-time + type: string + ExpiryDate: + format: date-time + type: string + TransactionUUID: + description: The identifier of the transaction in the loyalty ledger. + format: uuid + type: string + required: + - Amount + - Operation + - TransactionUUID + IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification: + allOf: + - properties: + ProfileIntegrationID: + type: string + LoyaltyProgramID: + format: int64 + type: integer + LoyaltyProgramName: + description: The name of the loyalty program. + type: string + SubledgerID: + type: string + SourceOfEvent: + type: string + CurrentTier: + description: The name of the customer's current tier. + type: string + EmployeeName: + type: string + UserID: + format: int64 + type: integer + CurrentPoints: + format: float + type: number + Actions: + items: + $ref: "#/components/schemas/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction" + type: array + default: null + PublishedAt: + description: Timestamp when the event was published. + format: date-time + type: string + required: + - CurrentPoints + - CurrentTier + - LoyaltyProgramID + - LoyaltyProgramName + - ProfileIntegrationID + - PublishedAt + - SourceOfEvent + - SubledgerID + IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification: + allOf: + - properties: + ProfileIntegrationID: + type: string + LoyaltyProgramID: + format: int64 + type: integer + LoyaltyProgramName: + description: The name of the loyalty program. + type: string + SubledgerID: + type: string + SourceOfEvent: + type: string + CurrentTier: + description: "The name of the customer's current tier, or null if the\ + \ customer was downgraded below all tiers." + type: string + CurrentPoints: + format: float + type: number + OldTier: + type: string + TierExpirationDate: + format: date-time + type: string + TimestampOfTierChange: + format: date-time + type: string + PublishedAt: + description: Timestamp when the event was published. + format: date-time + type: string + required: + - CurrentPoints + - LoyaltyProgramID + - LoyaltyProgramName + - ProfileIntegrationID + - PublishedAt + - SourceOfEvent + - SubledgerID + IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification: + allOf: + - properties: + ProfileIntegrationID: + type: string + LoyaltyProgramID: + format: int64 + type: integer + LoyaltyProgramName: + description: The name of the loyalty program. + type: string + SubledgerID: + type: string + SourceOfEvent: + type: string + CurrentTier: + description: The name of the customer's current tier. + type: string + CurrentPoints: + format: float + type: number + OldTier: + type: string + PointsRequiredToTheNextTier: + format: float + type: number + NextTier: + type: string + TierExpirationDate: + format: date-time + type: string + TimestampOfTierChange: + format: date-time + type: string + PublishedAt: + description: Timestamp when the event was published. + format: date-time + type: string + required: + - CurrentPoints + - CurrentTier + - LoyaltyProgramID + - LoyaltyProgramName + - ProfileIntegrationID + - PublishedAt + - SourceOfEvent + - SubledgerID + IntegrationHubEventPayloadCouponBasedNotificationsLimits: properties: - programId: - description: ID of the loyalty program that contains these points. - format: int64 - type: integer - subLedgerId: - description: API name of the loyalty program subledger that contains these - points. + Action: type: string - newExpiryDate: - description: The specified expiry date and time for all active and pending - point transactions in the loyalty program subledger. - example: 2024-07-24T14:15:22Z - format: date-time + Limit: + format: float + type: number + Period: type: string - affectedTransactions: - description: List of transactions affected by the expiry date update. + Entities: items: - $ref: "#/components/schemas/LoyaltyLedgerEntryExpiryDateChange" + type: string type: array + default: null required: - - newExpiryDate - - programId - - subLedgerId + - Action + - Entities + - Limit + IntegrationHubEventPayloadCouponBasedNotifications: + allOf: + - properties: + Id: + format: int64 + type: integer + Created: + format: date-time + type: string + CampaignId: + format: int64 + type: integer + Value: + type: string + UsageLimit: + format: int64 + type: integer + DiscountLimit: + format: float + type: number + ReservationLimit: + format: int64 + type: integer + StartDate: + format: date-time + type: string + ExpiryDate: + format: date-time + type: string + UsageCounter: + format: int64 + type: integer + DiscountCounter: + format: float + type: number + DiscountRemainder: + format: float + type: number + ReferralId: + format: int64 + type: integer + RecipientIntegrationId: + type: string + ImportId: + format: int64 + type: integer + BatchId: + type: string + Attributes: + $ref: "#/components/schemas/IntegrationCampaignBase_allOf_attributes" + Limits: + items: + $ref: "#/components/schemas/IntegrationHubEventPayloadCouponBasedNotificationsLimits" + type: array + default: null + PublishedAt: + description: Timestamp when the event was published. + format: date-time + type: string + SourceOfEvent: + type: string + EmployeeName: + type: string + required: + - CampaignId + - Created + - EmployeeName + - Id + - PublishedAt + - SourceOfEvent + - UsageCounter + - UsageLimit + - Value updateCustomerSessionV2_409_response: example: message: Too many requests are updating this session at the same time - StatusCode: 409 errors: - "" - "" - properties: - message: - example: Too many requests are updating this session at the same time - type: string - errors: - items: {} - type: array - StatusCode: - example: 409 - format: int64 - type: integer - updateCustomerProfileV2_409_response: - example: - message: Too many requests are updating this profile at the same time StatusCode: 409 - errors: - - "" - - "" properties: message: - example: Too many requests are updating this profile at the same time + example: Too many requests are updating this session at the same time type: string errors: items: {} type: array + default: null StatusCode: example: 409 format: int64 type: integer integrationGetAllCampaigns_200_response: example: + hasMore: true data: - - features: - - coupons - - referrals + - applicationId: 322 + id: 4 name: Summer promotions description: Campaign for all summer 2021 promotions startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z attributes: null + state: enabled + tags: + - summer + features: + - coupons + - referrals rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon + - applicationId: 322 id: 4 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z endTime: 2021-09-22T22:00:00Z + attributes: null state: enabled - applicationId: 322 tags: - summer - - features: + features: - coupons - referrals - name: Summer promotions - description: Campaign for all summer 2021 promotions - startTime: 2021-07-20T22:00:00Z - attributes: null rules: - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! - Offer valid till Dec 5 only. + - title: Give discount via coupon displayName: 20% off all shoes! - relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - - displayDescription: Get a 20% discount on all shoes during Thanksgiving! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! Offer valid till Dec 5 only. + relatedData: https://example.com/discounts/20-off-shoes.png + - title: Give discount via coupon displayName: 20% off all shoes! + displayDescription: Get a 20% discount on all shoes during Thanksgiving! + Offer valid till Dec 5 only. relatedData: https://example.com/discounts/20-off-shoes.png - title: Give discount via coupon - id: 4 - endTime: 2021-09-22T22:00:00Z - state: enabled - applicationId: 322 - tags: - - summer - hasMore: true properties: hasMore: type: boolean @@ -39439,39 +41182,40 @@ components: items: $ref: "#/components/schemas/IntegrationCampaign" type: array + default: null required: - data - hasMore createReferralsForMultipleAdvocates_201_response: example: + totalResultSize: 1 data: - - code: 27G47Y54VH9L + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - totalResultSize: 1 + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe properties: totalResultSize: example: 1 @@ -39481,55 +41225,56 @@ components: items: $ref: "#/components/schemas/Referral" type: array + default: null required: - data - totalResultSize getReservedCustomers_200_response: example: + totalResultSize: 1 data: - - accountId: 31 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 31 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - totalResultSize: 1 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: totalResultSize: example: 1 @@ -39539,55 +41284,56 @@ components: items: $ref: "#/components/schemas/CustomerProfile" type: array + default: null required: - data - totalResultSize getCustomerAchievements_200_response: example: + totalResultSize: 1 data: - - currentProgress: - endDate: 2024-02-01T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 - description: 50% off for every 50th purchase in a year. - activationPolicy: fixed_schedule + name: Order50Discount title: 50% off on 50th purchase. - allowRollbackAfterCompletion: false + description: 50% off for every 50th purchase in a year. target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 - name: Order50Discount + period: 1Y periodEndOverride: "" - id: 6 recurrencePolicy: no_recurrence + activationPolicy: fixed_schedule + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 + allowRollbackAfterCompletion: false + campaignId: 1 status: active - - currentProgress: - endDate: 2024-02-01T15:04:05Z07:00 + currentProgress: + status: completed progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 startDate: 2024-01-01T15:04:05Z07:00 - status: completed - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 - description: 50% off for every 50th purchase in a year. - activationPolicy: fixed_schedule + name: Order50Discount title: 50% off on 50th purchase. - allowRollbackAfterCompletion: false + description: 50% off for every 50th purchase in a year. target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 - name: Order50Discount + period: 1Y periodEndOverride: "" - id: 6 recurrencePolicy: no_recurrence + activationPolicy: fixed_schedule + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 + allowRollbackAfterCompletion: false + campaignId: 1 status: active - totalResultSize: 1 + currentProgress: + status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 properties: totalResultSize: example: 1 @@ -39597,23 +41343,24 @@ components: items: $ref: "#/components/schemas/AchievementStatusEntry" type: array + default: null required: - data - totalResultSize getCustomerAchievementHistory_200_response: example: + totalResultSize: 1 data: - - endDate: 2024-02-01T15:04:05Z07:00 + - status: completed progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 startDate: 2024-01-01T15:04:05Z07:00 - status: completed - - endDate: 2024-02-01T15:04:05Z07:00 - progress: 10 completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 + - status: completed + progress: 10 startDate: 2024-01-01T15:04:05Z07:00 - status: completed - totalResultSize: 1 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 properties: totalResultSize: example: 1 @@ -39623,43 +41370,44 @@ components: items: $ref: "#/components/schemas/AchievementProgress" type: array + default: null required: - data - totalResultSize getLoyaltyCardTransactions_200_response: example: + hasMore: true data: - - rulesetId: 11 - amount: 10.25 + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 + programId: 324 + cardIdentifier: summer-loyalty-card-0543 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 - expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - subledgerId: sub-123 name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points - id: 123 - programId: 324 startDate: 2022-01-02T15:04:05Z07:00 - - rulesetId: 11 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 amount: 10.25 + id: 123 + rulesetId: 11 + ruleName: Add 2 points + validityDuration: 30D + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 + programId: 324 + cardIdentifier: summer-loyalty-card-0543 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points + amount: 10.25 id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true + rulesetId: 11 + ruleName: Add 2 points + validityDuration: 30D properties: hasMore: example: true @@ -39668,43 +41416,44 @@ components: items: $ref: "#/components/schemas/CardLedgerTransactionLogEntryIntegrationAPI" type: array + default: null required: - data - hasMore getLoyaltyProgramProfileTransactions_200_response: example: + hasMore: true data: - - rulesetId: 11 - amount: 10.25 + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 - flags: "" + programId: 324 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - subledgerId: sub-123 name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points - id: 123 - programId: 324 startDate: 2022-01-02T15:04:05Z07:00 - - rulesetId: 11 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 amount: 10.25 - created: 2022-01-02T15:04:05Z07:00 + id: 123 + rulesetId: 11 + ruleName: Add 2 points flags: "" + validityDuration: 30D + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f + created: 2022-01-02T15:04:05Z07:00 + programId: 324 customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - ruleName: Add 2 points + amount: 10.25 id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true + rulesetId: 11 + ruleName: Add 2 points + flags: "" + validityDuration: 30D properties: hasMore: example: true @@ -39713,37 +41462,38 @@ components: items: $ref: "#/components/schemas/LedgerTransactionLogEntryIntegrationAPI" type: array + default: null required: - data - hasMore getLoyaltyCardPoints_200_response: example: + hasMore: true data: - - expiryDate: 2022-08-02T15:04:05Z07:00 + - id: 123 transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 - customerProfileID: URNGV8294NV created: 2022-01-02T15:04:05Z07:00 - subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - - expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 customerProfileID: URNGV8294NV - created: 2022-01-02T15:04:05Z07:00 - subledgerId: sub-123 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + amount: 10.25 validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 + - id: 123 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f + created: 2022-01-02T15:04:05Z07:00 programId: 324 + customerProfileID: URNGV8294NV + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + name: Reward 10% points of a purchase's current total startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + amount: 10.25 + validityDuration: 30D properties: hasMore: example: true @@ -39752,35 +41502,36 @@ components: items: $ref: "#/components/schemas/CardLedgerPointsEntryIntegrationAPI" type: array + default: null required: - data - hasMore getLoyaltyProgramProfilePoints_200_response: example: + hasMore: true data: - - expiryDate: 2022-08-02T15:04:05Z07:00 + - id: 123 transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 created: 2022-01-02T15:04:05Z07:00 - subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 programId: 324 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + name: Reward 10% points of a purchase's current total startDate: 2022-01-02T15:04:05Z07:00 - - expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - amount: 10.25 - created: 2022-01-02T15:04:05Z07:00 + expiryDate: 2022-08-02T15:04:05Z07:00 subledgerId: sub-123 - name: Reward 10% points of a purchase's current total - validityDuration: 30D - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d - id: 123 + amount: 10.25 + validityDuration: 30D + - id: 123 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f + created: 2022-01-02T15:04:05Z07:00 programId: 324 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + name: Reward 10% points of a purchase's current total startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + amount: 10.25 + validityDuration: 30D properties: hasMore: example: true @@ -39789,19 +41540,38 @@ components: items: $ref: "#/components/schemas/LedgerPointsEntryIntegrationAPI" type: array + default: null required: - data - hasMore getApplications_200_response: example: + totalResultSize: 1 data: - - enableFlattenedCartItems: true + - id: 6 created: 2020-06-10T09:05:27.993483Z - timezone: Europe/Berlin - defaultCartItemFilterId: 3 - enableCampaignStateManagement: false - sandbox: true + modified: 2021-09-12T10:12:42Z + accountId: 3886 + name: My Application description: A test Application + timezone: Europe/Berlin + currency: EUR + caseSensitivity: sensitive + attributes: "{}" + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + defaultDiscountScope: sessionTotal + enableCascadingDiscounts: true + enableFlattenedCartItems: true attributesSettings: mandatory: campaigns: @@ -39810,41 +41580,31 @@ components: coupons: - coupons - coupons - caseSensitivity: sensitive - accountId: 3886 + sandbox: true + enablePartialDiscounts: false + defaultDiscountAdditionalCostPerItemScope: price defaultEvaluationGroupId: 3 - enableCascadingDiscounts: true + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false loyaltyPrograms: - - cardBased: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programID: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z - timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent + - id: 139 + created: 2020-06-10T09:05:27.993483Z title: Point collection - canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -39882,21 +41642,10 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - - cardBased: true tiers: - name: Gold minPoints: 300 @@ -39913,19 +41662,30 @@ components: id: 1 created: 2021-06-10T09:04:39.355258Z programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent - title: Point collection + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + - id: 139 + created: 2020-06-10T09:05:27.993483Z + title: Point collection + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -39963,46 +41723,56 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - name: My Application + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programID: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programID: 139 + timezone: Europe/Berlin + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true + canUpdateSubledgers: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z modified: 2021-09-12T10:12:42Z - defaultDiscountScope: sessionTotal + accountId: 3886 + name: My Application + description: A test Application + timezone: Europe/Berlin currency: EUR + caseSensitivity: sensitive attributes: "{}" - defaultDiscountAdditionalCostPerItemScope: price - id: 6 limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon - enablePartialDiscounts: false - - enableFlattenedCartItems: true - created: 2020-06-10T09:05:27.993483Z - timezone: Europe/Berlin - defaultCartItemFilterId: 3 - enableCampaignStateManagement: false - sandbox: true - description: A test Application + defaultDiscountScope: sessionTotal + enableCascadingDiscounts: true + enableFlattenedCartItems: true attributesSettings: mandatory: campaigns: @@ -40011,41 +41781,31 @@ components: coupons: - coupons - coupons - caseSensitivity: sensitive - accountId: 3886 + sandbox: true + enablePartialDiscounts: false + defaultDiscountAdditionalCostPerItemScope: price defaultEvaluationGroupId: 3 - enableCascadingDiscounts: true + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false loyaltyPrograms: - - cardBased: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programID: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z - timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent + - id: 139 + created: 2020-06-10T09:05:27.993483Z title: Point collection - canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -40083,21 +41843,10 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - - cardBased: true tiers: - name: Gold minPoints: 300 @@ -40114,19 +41863,30 @@ components: id: 1 created: 2021-06-10T09:04:39.355258Z programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent - title: Point collection + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + - id: 139 + created: 2020-06-10T09:05:27.993483Z + title: Point collection + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -40164,40 +41924,32 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - name: My Application - modified: 2021-09-12T10:12:42Z - defaultDiscountScope: sessionTotal - currency: EUR - attributes: "{}" - defaultDiscountAdditionalCostPerItemScope: price - id: 6 - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - enablePartialDiscounts: false - totalResultSize: 1 + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programID: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programID: 139 + timezone: Europe/Berlin + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true + canUpdateSubledgers: true properties: totalResultSize: example: 1 @@ -40207,23 +41959,32 @@ components: items: $ref: "#/components/schemas/Application" type: array + default: null required: - data - totalResultSize getCampaigns_200_response: example: + totalResultSize: 1 data: - - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -40261,72 +42022,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -40364,21 +42061,85 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - - type: advanced - templateId: 3 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + - id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -40416,72 +42177,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -40519,11 +42216,67 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - totalResultSize: 1 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false properties: totalResultSize: example: 1 @@ -40533,20 +42286,44 @@ components: items: $ref: "#/components/schemas/Campaign" type: array + default: null required: - data - totalResultSize getRulesets_200_response: example: + totalResultSize: 1 data: - - rbVersion: v2 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -40561,32 +42338,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -40601,34 +42378,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -40643,32 +42419,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -40683,41 +42459,42 @@ components: - - / - 10 - 100 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 + templateId: 3 + activatedAt: 2000-01-23T04:56:07.000+00:00 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + userId: 388 + rules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - templateId: 3 - userId: 388 - - rbVersion: v2 - created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true - rules: - - condition: + condition: - and - - couponValid effects: @@ -40732,32 +42509,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -40772,34 +42549,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -40814,32 +42590,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -40854,34 +42630,12 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 - totalResultSize: 1 + activatedAt: 2000-01-23T04:56:07.000+00:00 properties: totalResultSize: example: 1 @@ -40891,77 +42645,78 @@ components: items: $ref: "#/components/schemas/Ruleset" type: array + default: null required: - data - totalResultSize createCoupons_200_response: example: + totalResultSize: 1 data: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - totalResultSize: 1 + implicitlyReserved: false properties: totalResultSize: example: 1 @@ -40971,77 +42726,78 @@ components: items: $ref: "#/components/schemas/Coupon" type: array + default: null required: - data - totalResultSize getCouponsWithoutTotalCount_200_response: example: + hasMore: true data: - - recipientIntegrationId: URNGV8294NV - implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - - recipientIntegrationId: URNGV8294NV implicitlyReserved: false + - id: 6 created: 2020-06-10T09:05:27.993483Z campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 10 - expiryDate: 2023-08-24T14:15:22Z - importId: 4 - reservationLimit: 45 - reservationCounter: 1 - reservation: false - attributes: null - id: 6 value: XMAS-20-2021 + usageLimit: 100 discountLimit: 30 + reservationLimit: 45 startDate: 2020-01-24T14:15:22Z + expiryDate: 2023-08-24T14:15:22Z limits: - - period: yearly + - action: createCoupon + limit: 1000 + period: yearly entities: - Coupon + - action: createCoupon limit: 1000 - action: createCoupon - - period: yearly + period: yearly entities: - Coupon - limit: 1000 - action: createCoupon + usageCounter: 10 + discountCounter: 10 discountRemainder: 5 + reservationCounter: 1 + attributes: null + referralId: 326632952 + recipientIntegrationId: URNGV8294NV + importId: 4 + reservation: false + batchId: 32535-43255 isReservationMandatory: false - hasMore: true + implicitlyReserved: false properties: hasMore: example: true @@ -41050,39 +42806,40 @@ components: items: $ref: "#/components/schemas/Coupon" type: array + default: null required: - data - hasMore getReferralsWithoutTotalCount_200_response: example: + hasMore: true data: - - code: 27G47Y54VH9L + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - - code: 27G47Y54VH9L + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe + - id: 6 created: 2020-06-10T09:05:27.993483Z + startDate: 2020-11-10T23:00:00Z + expiryDate: 2021-11-10T23:00:00Z usageLimit: 1 campaignId: 78 - usageCounter: 1 - batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV - expiryDate: 2021-11-10T23:00:00Z - importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: "{channel=web}" - id: 6 - startDate: 2020-11-10T23:00:00Z - hasMore: true + attributes: null + importId: 4 + code: 27G47Y54VH9L + usageCounter: 1 + batchId: tqyrgahe properties: hasMore: example: true @@ -41091,43 +42848,44 @@ components: items: $ref: "#/components/schemas/Referral" type: array + default: null required: - data - hasMore getCampaignGroups_200_response: example: + totalResultSize: 1 data: - - accountId: 3886 + - id: 6 created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + accountId: 3886 name: Europe access group + description: A group that gives access to all the campaigns for the Europe + market. subscribedApplicationsIds: - 1 - 2 - 3 - modified: 2021-09-12T10:12:42Z - description: A group that gives access to all the campaigns for the Europe - market. - id: 6 campaignIds: - 4 - 6 - 8 - - accountId: 3886 + - id: 6 created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + accountId: 3886 name: Europe access group + description: A group that gives access to all the campaigns for the Europe + market. subscribedApplicationsIds: - 1 - 2 - 3 - modified: 2021-09-12T10:12:42Z - description: A group that gives access to all the campaigns for the Europe - market. - id: 6 campaignIds: - 4 - 6 - 8 - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -41137,31 +42895,34 @@ components: items: $ref: "#/components/schemas/CampaignGroup" type: array + default: null required: - data - totalResultSize getCampaignTemplates_200_response: example: + hasMore: true data: - - instructions: "Use this template for discount campaigns. Set the campaign\ + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + userId: 388 + name: Discount campaign + description: This is a template for a discount 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." - campaignCollections: - - name: My collection - description: My collection of SKUs - - name: My collection - description: My collection of SKUs - campaignsCount: 3 - defaultCampaignGroupId: 42 - description: This is a template for a discount campaign. + campaignAttributes: "{}" + couponAttributes: "{}" + state: draft + activeRulesetId: 5 + tags: + - discount + reevaluateOnReturn: true features: - coupons - coupons - couponReservationSettings: - reservationLimit: 45 - isReservationMandatory: false couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -41199,51 +42960,11 @@ 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 - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 5 - campaignAttributes: "{}" - applicationsIds: - - 1 - - 2 - - 3 - campaignType: advanced - updatedBy: Jane Doe - created: 2020-06-10T09:05:27.993483Z - isUserFavorite: false - reevaluateOnReturn: true - userId: 388 - tags: - - discount - accountId: 3886 - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: couponPattern: SUMMER-####-#### + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false + referralSettings: validCharacters: - A - B @@ -41281,26 +43002,66 @@ components: - "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." + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + templateParams: + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + applicationsIds: + - 1 + - 2 + - 3 campaignCollections: - name: My collection description: My collection of SKUs - name: My collection description: My collection of SKUs - campaignsCount: 3 defaultCampaignGroupId: 42 + campaignType: advanced + campaignsCount: 3 + updated: 2022-08-24T14:15:22Z + updatedBy: Jane Doe + validApplicationIds: + - 1 + - 2 + - 3 + isUserFavorite: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + userId: 388 + name: Discount campaign description: This is a template for a discount 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: "{}" + couponAttributes: "{}" + state: draft + activeRulesetId: 5 + tags: + - discount + reevaluateOnReturn: true features: - coupons - - coupons - couponReservationSettings: - reservationLimit: 45 - isReservationMandatory: false + - coupons couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -41338,51 +43099,11 @@ 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 - limits: - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 5 - campaignAttributes: "{}" - applicationsIds: - - 1 - - 2 - - 3 - campaignType: advanced - updatedBy: Jane Doe - created: 2020-06-10T09:05:27.993483Z - isUserFavorite: false - reevaluateOnReturn: true - userId: 388 - tags: - - discount - accountId: 3886 - validApplicationIds: - - 1 - - 2 - - 3 - name: Discount campaign - referralSettings: couponPattern: SUMMER-####-#### + couponReservationSettings: + reservationLimit: 45 + isReservationMandatory: false + referralSettings: validCharacters: - A - B @@ -41420,8 +43141,46 @@ components: - "7" - "8" - "9" + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + templateParams: + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + - name: discount_value + type: number + description: This is a template parameter of type `number`. + attributeId: 42 + applicationsIds: + - 1 + - 2 + - 3 + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + defaultCampaignGroupId: 42 + campaignType: advanced + campaignsCount: 3 updated: 2022-08-24T14:15:22Z - hasMore: true + updatedBy: Jane Doe + validApplicationIds: + - 1 + - 2 + - 3 + isUserFavorite: false properties: hasMore: example: true @@ -41430,29 +43189,37 @@ components: items: $ref: "#/components/schemas/CampaignTemplate" type: array + default: null required: - data - hasMore listExperiments_200_response: example: + totalResultSize: 1 data: - - goalType: other - goalDescription: Offering free shipping will increase average order revenue - more than a 10% discount - deletedat: 2000-01-23T04:56:07.000+00:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + isVariantAssignmentExternal: true campaign: - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -41490,72 +43257,8 @@ components: - "7" - "8" - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -41593,25 +43296,105 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - id: 6 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + activated: 2000-01-23T04:56:07.000+00:00 state: enabled variants: - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z name: Variant A + experimentId: 10 ruleset: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -41626,32 +43409,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -41666,34 +43449,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -41708,32 +43490,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -41748,48 +43530,49 @@ components: - - / - 10 - 100 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 + templateId: 3 + activatedAt: 2000-01-23T04:56:07.000+00:00 + weight: 12 + isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z + name: Variant A + experimentId: 10 + ruleset: + id: 6 + created: 2020-06-10T09:05:27.993483Z + userId: 388 + rules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - templateId: 3 - userId: 388 - weight: 12 - experimentId: 10 - id: 6 - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true - name: Variant A - ruleset: - rbVersion: v2 - created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true - rules: - - condition: + condition: - and - - couponValid effects: @@ -41804,32 +43587,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -41844,34 +43627,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -41886,32 +43668,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -41926,56 +43708,41 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 + activatedAt: 2000-01-23T04:56:07.000+00:00 weight: 12 - experimentId: 10 - id: 6 - applicationId: 322 - isVariantAssignmentExternal: true - activated: 2000-01-23T04:56:07.000+00:00 - - goalType: other + isPrimary: true + goalType: other goalDescription: Offering free shipping will increase average order revenue more than a 10% discount deletedat: 2000-01-23T04:56:07.000+00:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + isVariantAssignmentExternal: true campaign: - type: advanced - templateId: 3 - customEffectCount: 0 - activeRevisionId: 6 + id: 4 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + userId: 388 + name: Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-07-20T22:00:00Z + endTime: 2021-09-22T22:00:00Z + attributes: "{}" + state: enabled + activeRulesetId: 6 + tags: + - summer + reevaluateOnReturn: true features: - coupons - referrals - createdLoyaltyPointsCount: 9 - storesImported: true couponSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -42010,75 +43777,11 @@ components: - "4" - "5" - "6" - - "7" - - "8" - - "9" - experimentId: 1 - id: 4 - state: enabled - couponAttributes: "{}" - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - stageRevision: false - couponRedemptionCount: 163 - couponCreationCount: 16 - version: 6 - campaignGroups: - - 1 - - 3 - tags: - - summer - discountEffectCount: 343 - budgets: - - limit: 1000 - action: createCoupon - counter: 42 - - limit: 1000 - action: createCoupon - counter: 42 - redeemedLoyaltyPointsCount: 8 - name: Summer promotions - valueMapsIds: - - 100 - - 215 - applicationId: 322 - updated: 2022-10-97T35:00:00Z - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288 - 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 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000 - action: createCoupon - activeRulesetId: 6 - reevaluateOnReturn: true - userId: 388 - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - createdBy: John Doe - addFreeItemEffectCount: 0 - referralSettings: + - "7" + - "8" + - "9" couponPattern: SUMMER-####-#### + referralSettings: validCharacters: - A - B @@ -42116,25 +43819,105 @@ components: - "7" - "8" - "9" - attributes: "{}" - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z + couponPattern: SUMMER-####-#### + limits: + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + - action: createCoupon + limit: 1000 + period: yearly + entities: + - Coupon + campaignGroups: + - 1 + - 3 + type: advanced + linkedStoreIds: + - 1 + - 2 + - 3 + couponAttributes: "{}" + budgets: + - action: createCoupon + limit: 1000 + counter: 42 + - action: createCoupon + limit: 1000 + counter: 42 + couponRedemptionCount: 163 referralRedemptionCount: 3 - id: 6 + discountCount: 288 + discountEffectCount: 343 + couponCreationCount: 16 + customEffectCount: 0 + referralCreationCount: 8 + addFreeItemEffectCount: 0 + awardedGiveawaysCount: 9 + createdLoyaltyPointsCount: 9 + createdLoyaltyPointsEffectCount: 2 + redeemedLoyaltyPointsCount: 8 + redeemedLoyaltyPointsEffectCount: 9 + callApiEffectCount: 0 + reservecouponEffectCount: 9 + lastActivity: 2022-11-10T23:00:00Z + updated: 2022-10-97T35:00:00Z + createdBy: John Doe + updatedBy: Jane Doe + templateId: 3 + frontendState: running + storesImported: true + valueMapsIds: + - 100 + - 215 + experimentId: 1 + revisionFrontendState: revised + activeRevisionId: 6 + activeRevisionVersionId: 6 + version: 6 + currentRevisionId: 6 + currentRevisionVersionId: 6 + stageRevision: false + activated: 2000-01-23T04:56:07.000+00:00 state: enabled variants: - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z name: Variant A + experimentId: 10 ruleset: - rbVersion: v2 + id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true + userId: 388 rules: - - condition: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid + bindings: + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + - name: my property + type: templateParameter + expression: + - string1 + - string2 + valueType: string + minValue: 0 + maxValue: 19.9 + attributeId: 100 + description: This is a template parameter of type `number`. + condition: - and - - couponValid effects: @@ -42149,32 +43932,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -42189,34 +43972,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -42231,32 +44013,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -42271,48 +44053,49 @@ components: - - / - 10 - 100 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 + templateId: 3 + activatedAt: 2000-01-23T04:56:07.000+00:00 + weight: 12 + isPrimary: true + - id: 6 + created: 2020-06-10T09:05:27.993483Z + name: Variant A + experimentId: 10 + ruleset: + id: 6 + created: 2020-06-10T09:05:27.993483Z + userId: 388 + rules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - templateId: 3 - userId: 388 - weight: 12 - experimentId: 10 - id: 6 - - created: 2020-06-10T09:05:27.993483Z - isPrimary: true - name: Variant A - ruleset: - rbVersion: v2 - created: 2020-06-10T09:05:27.993483Z - campaignId: 320 - bindings: [] - activatedAt: 2000-01-23T04:56:07.000+00:00 - activate: true - rules: - - condition: + condition: - and - - couponValid effects: @@ -42327,32 +44110,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -42367,34 +44150,33 @@ components: - - / - 10 - 100 + strikethroughRules: + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - id: 6 - strikethroughRules: - - condition: + condition: - and - - couponValid effects: @@ -42409,32 +44191,32 @@ components: - - / - 10 - 100 + - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + description: Creates a discount when a coupon is valid bindings: - - attributeId: 100 - minValue: 0 + - name: my property + type: templateParameter expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. + - name: my property type: templateParameter - - attributeId: 100 - minValue: 0 expression: - string1 - string2 - maxValue: 19.9 valueType: string - name: my property + minValue: 0 + maxValue: 19.9 + attributeId: 100 description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - - condition: + condition: - and - - couponValid effects: @@ -42449,40 +44231,18 @@ components: - - / - 10 - 100 - bindings: - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - - attributeId: 100 - minValue: 0 - expression: - - string1 - - string2 - maxValue: 19.9 - valueType: string - name: my property - description: This is a template parameter of type `number`. - type: templateParameter - description: Creates a discount when a coupon is valid - id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - title: Give discount via coupon - parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + bindings: [] + rbVersion: v2 + activate: true + campaignId: 320 templateId: 3 - userId: 388 + activatedAt: 2000-01-23T04:56:07.000+00:00 weight: 12 - experimentId: 10 - id: 6 - applicationId: 322 - isVariantAssignmentExternal: true - activated: 2000-01-23T04:56:07.000+00:00 - totalResultSize: 1 + isPrimary: true + goalType: other + goalDescription: Offering free shipping will increase average order revenue + more than a 10% discount + deletedat: 2000-01-23T04:56:07.000+00:00 properties: totalResultSize: example: 1 @@ -42492,42 +44252,32 @@ components: items: $ref: "#/components/schemas/Experiment" type: array + default: null required: - data - totalResultSize getLoyaltyPrograms_200_response: example: + totalResultSize: 1 data: - - cardBased: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programID: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z - timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent + - id: 139 + created: 2020-06-10T09:05:27.993483Z title: Point collection - canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -42565,21 +44315,10 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - - cardBased: true tiers: - name: Gold minPoints: 300 @@ -42596,19 +44335,30 @@ components: id: 1 created: 2021-06-10T09:04:39.355258Z programID: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - description: Customers collect 10 points per 1$ spent - title: Point collection + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true canUpdateSubledgers: true - programJoinPolicy: not_join - accountID: 1 + - id: 139 + created: 2020-06-10T09:05:27.993483Z + title: Point collection + description: Customers collect 10 points per 1$ spent + subscribedApplications: + - 132 + - 97 + defaultValidity: 2W_U defaultPending: immediate + allowSubledger: false + usersPerCardLimit: 111 + sandbox: true + programJoinPolicy: not_join + tiersExpirationPolicy: tier_start_date + tierCycleStartDate: 2021-09-12T10:12:42Z + tiersExpireIn: 27W_U tiersDowngradePolicy: one_down cardCodeSettings: - couponPattern: SUMMER-####-#### validCharacters: - A - B @@ -42646,21 +44396,32 @@ components: - "7" - "8" - "9" - id: 139 - canUpgradeToAdvancedTiers: true - created: 2020-06-10T09:05:27.993483Z - sandbox: true + couponPattern: SUMMER-####-#### returnPolicy: only_pending - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - defaultValidity: 2W_U - canUpdateTierExpirationPolicy: true - allowSubledger: false - tiersExpireIn: 27W_U + accountID: 1 name: my_program - totalResultSize: 1 + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programID: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programID: 139 + timezone: Europe/Berlin + cardBased: true + canUpdateTiers: true + canUpdateTierExpirationPolicy: true + canUpgradeToAdvancedTiers: true + canUpdateSubledgers: true properties: totalResultSize: example: 1 @@ -42670,33 +44431,34 @@ components: items: $ref: "#/components/schemas/LoyaltyProgram" type: array + default: null required: - data - totalResultSize getDashboardStatistics_200_response: example: + totalResultSize: 1 data: - date: 2000-01-23T04:56:07.000+00:00 - totalMembers: 2582 - totalSpentPoints: 25668 - spentPoints: "" totalActivePoints: 9756 totalPendingPoints: 548 + totalSpentPoints: 25668 totalExpiredPoints: 1156 totalNegativePoints: 32 + totalMembers: 2582 newMembers: 3 + spentPoints: "" earnedPoints: "" - date: 2000-01-23T04:56:07.000+00:00 - totalMembers: 2582 - totalSpentPoints: 25668 - spentPoints: "" totalActivePoints: 9756 totalPendingPoints: 548 + totalSpentPoints: 25668 totalExpiredPoints: 1156 totalNegativePoints: 32 + totalMembers: 2582 newMembers: 3 + spentPoints: "" earnedPoints: "" - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -42706,6 +44468,7 @@ components: items: $ref: "#/components/schemas/LoyaltyDashboardData" type: array + default: null required: - data - totalResultSize @@ -42717,50 +44480,50 @@ components: type: string getLoyaltyProgramTransactions_200_response: example: + hasMore: true data: - - rulesetId: 11 - amount: 10.25 + - id: 123 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f + programId: 324 campaignId: 324 created: 2022-01-02T15:04:05Z07:00 - flags: "" - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - userId: 5 - cardIdentifier: summer-loyalty-card-0543 + amount: 10.25 + name: Reward 50 points for each $500 purchase + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-01-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - importId: 4 customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + cardIdentifier: summer-loyalty-card-0543 subledgerId: sub-123 - name: Reward 50 points for each $500 purchase - validityDuration: 30D - ruleName: 10 points for every $100 spent + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + importId: 4 + userId: 5 userEmail: john.doe@example.com - id: 123 + rulesetId: 11 + ruleName: 10 points for every $100 spent + flags: "" + validityDuration: 30D + - id: 123 + transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - - rulesetId: 11 - amount: 10.25 campaignId: 324 created: 2022-01-02T15:04:05Z07:00 - flags: "" - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - userId: 5 - cardIdentifier: summer-loyalty-card-0543 + amount: 10.25 + name: Reward 50 points for each $500 purchase + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-01-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f - importId: 4 customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + cardIdentifier: summer-loyalty-card-0543 subledgerId: sub-123 - name: Reward 50 points for each $500 purchase - validityDuration: 30D - ruleName: 10 points for every $100 spent + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + importId: 4 + userId: 5 userEmail: john.doe@example.com - id: 123 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true + rulesetId: 11 + ruleName: 10 points for every $100 spent + flags: "" + validityDuration: 30D properties: hasMore: example: true @@ -42769,77 +44532,78 @@ components: items: $ref: "#/components/schemas/LoyaltyProgramTransaction" type: array + default: null required: - data - hasMore getLoyaltyCards_200_response: example: + hasMore: true data: - - ledger: "" + - id: 6 + created: 2020-06-10T09:05:27.993483Z + programID: 125 + programName: Loyalty_program + programTitle: Loyalty program + status: active + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 + batchId: wdefpov + - id: 6 + created: 2020-06-10T09:05:27.993483Z programID: 125 + programName: Loyalty_program + programTitle: Loyalty program status: active - - ledger: "" + blockReason: Current card lost. Customer needs a new card. identifier: summer-loyalty-card-0543 - oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z profiles: - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z + ledger: "" subledgers: key: + currentBalance: 100 pendingBalance: 10 - nextTierName: Silver negativeBalance: 10 - currentBalance: 100 + expiredBalance: 0 spentBalance: 0 tentativeCurrentBalance: 100 tentativePendingBalance: 20 - pointsToNextTier: 20 - expiredBalance: 0 - currentTier: bronze tentativeNegativeBalance: 100 - batchId: wdefpov - programTitle: Loyalty program - programName: Loyalty_program + currentTier: bronze + pointsToNextTier: 20 + nextTierName: Silver modified: 2021-09-12T10:12:42Z - id: 6 - blockReason: Current card lost. Customer needs a new card. + oldCardIdentifier: summer-loyalty-card-0543 newCardIdentifier: autumn-loyalty-card-5822 - programID: 125 - status: active - hasMore: true + batchId: wdefpov properties: hasMore: example: true @@ -42848,41 +44612,42 @@ components: items: $ref: "#/components/schemas/LoyaltyCard" type: array + default: null required: - data - hasMore getLoyaltyCardTransactionLogs_200_response: example: + hasMore: true data: - - amount: 10.25 + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + programId: 324 + cardIdentifier: summer-loyalty-card-0543 + applicationId: 322 sessionId: 233 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total + amount: 10.25 id: 123 - applicationId: 322 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - - amount: 10.25 + - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f created: 2022-01-02T15:04:05Z07:00 - customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + programId: 324 + cardIdentifier: summer-loyalty-card-0543 + applicationId: 322 sessionId: 233 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d type: addition - cardIdentifier: summer-loyalty-card-0543 + name: Reward 10% points of a purchase's current total + startDate: 2022-01-02T15:04:05Z07:00 expiryDate: 2022-08-02T15:04:05Z07:00 - transactionUUID: ce59f12a-f53b-4014-a745-636d93f2bd3f subledgerId: sub-123 - name: Reward 10% points of a purchase's current total + amount: 10.25 id: 123 - applicationId: 322 - programId: 324 - startDate: 2022-01-02T15:04:05Z07:00 - hasMore: true properties: hasMore: description: true means there is more data in the source collection to request.. @@ -42893,42 +44658,43 @@ components: items: $ref: "#/components/schemas/CardLedgerTransactionLogEntry" type: array + default: null required: - data - hasMore listAccountCollections_200_response: example: + hasMore: true + totalResultSize: 1 data: - - accountId: 3886 - createdBy: 134 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 7 + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs modifiedBy: 48 - id: 6 - applicationId: 1 - - accountId: 3886 createdBy: 134 - created: 2020-06-10T09:05:27.993483Z + applicationId: 1 campaignId: 7 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs subscribedApplicationsIds: - 1 - 2 - 3 name: My collection - modified: 2021-09-12T10:12:42Z - description: My collection of SKUs modifiedBy: 48 - id: 6 + createdBy: 134 applicationId: 1 - hasMore: true - totalResultSize: 1 + campaignId: 7 properties: hasMore: type: boolean @@ -42940,14 +44706,15 @@ components: items: $ref: "#/components/schemas/CollectionWithoutPayload" type: array + default: null required: - data getCollectionItems_200_response: example: + hasMore: true data: - item: item - item: item - hasMore: true properties: hasMore: type: boolean @@ -42955,13 +44722,19 @@ components: items: $ref: "#/components/schemas/CollectionItem" type: array + default: null required: - data - hasMore getAccessLogsWithoutTotalCount_200_response: example: + hasMore: true data: - - method: PUT + - uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 + method: PUT + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z requestPayload: |- { "customerSession": { @@ -42970,11 +44743,11 @@ components: ... } responsePayload: "{\"coupons\":[],\"createdCoupons\":[],...}" + - uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 + method: PUT requestUri: /v2/customer_sessions/Session136667 time: 2023-01-16T16:00:00.700763Z - uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 - status: 200 - - method: PUT requestPayload: |- { "customerSession": { @@ -42983,11 +44756,6 @@ components: ... } responsePayload: "{\"coupons\":[],\"createdCoupons\":[],...}" - requestUri: /v2/customer_sessions/Session136667 - time: 2023-01-16T16:00:00.700763Z - uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 - status: 200 - hasMore: true properties: hasMore: type: boolean @@ -42995,63 +44763,64 @@ components: items: $ref: "#/components/schemas/AccessLogEntry" type: array + default: null required: - data - hasMore getCampaignAnalytics_200_response: example: + totalResultSize: 1 data: - date: 2021-10-12T10:12:42Z - couponRolledbackRedemptions: 2 - totalCouponRolledbackRedemptions: 4 + campaignRevenue: 3539.76 + totalCampaignRevenue: 5784.63 + campaignRefund: 0.8008281904610115 + totalCampaignRefund: 6.027456183070403 + campaignDiscountCosts: 1.4658129805029452 + totalCampaignDiscountCosts: 5.962133916683182 campaignRefundedDiscounts: 5.637376656633329 - totalDeductedLoyaltyPoints: 220 + totalCampaignRefundedDiscounts: 2.3021358869347655 + campaignFreeItems: 7 + totalCampaignFreeItems: 86 couponRedemptions: 9 - totalCampaignDiscountCosts: 5.962133916683182 + totalCouponRedemptions: 3 + couponRolledbackRedemptions: 2 + totalCouponRolledbackRedemptions: 4 referralRedemptions: 7 - totalCampaignRevenue: 5784.63 - campaignRevenue: 3539.76 - campaignDiscountCosts: 1.4658129805029452 totalReferralRedemptions: 1 couponsCreated: 1 + totalCouponsCreated: 1 + referralsCreated: 6 + totalReferralsCreated: 7 addedLoyaltyPoints: 250 + totalAddedLoyaltyPoints: 340 + deductedLoyaltyPoints: 120 + totalDeductedLoyaltyPoints: 220 + - date: 2021-10-12T10:12:42Z + campaignRevenue: 3539.76 + totalCampaignRevenue: 5784.63 campaignRefund: 0.8008281904610115 + totalCampaignRefund: 6.027456183070403 + campaignDiscountCosts: 1.4658129805029452 + totalCampaignDiscountCosts: 5.962133916683182 + campaignRefundedDiscounts: 5.637376656633329 + totalCampaignRefundedDiscounts: 2.3021358869347655 campaignFreeItems: 7 - totalAddedLoyaltyPoints: 340 totalCampaignFreeItems: 86 - totalCampaignRefundedDiscounts: 2.3021358869347655 - totalCampaignRefund: 6.027456183070403 - totalCouponsCreated: 1 - deductedLoyaltyPoints: 120 + couponRedemptions: 9 totalCouponRedemptions: 3 - referralsCreated: 6 - totalReferralsCreated: 7 - - date: 2021-10-12T10:12:42Z couponRolledbackRedemptions: 2 totalCouponRolledbackRedemptions: 4 - campaignRefundedDiscounts: 5.637376656633329 - totalDeductedLoyaltyPoints: 220 - couponRedemptions: 9 - totalCampaignDiscountCosts: 5.962133916683182 referralRedemptions: 7 - totalCampaignRevenue: 5784.63 - campaignRevenue: 3539.76 - campaignDiscountCosts: 1.4658129805029452 totalReferralRedemptions: 1 couponsCreated: 1 - addedLoyaltyPoints: 250 - campaignRefund: 0.8008281904610115 - campaignFreeItems: 7 - totalAddedLoyaltyPoints: 340 - totalCampaignFreeItems: 86 - totalCampaignRefundedDiscounts: 2.3021358869347655 - totalCampaignRefund: 6.027456183070403 totalCouponsCreated: 1 - deductedLoyaltyPoints: 120 - totalCouponRedemptions: 3 referralsCreated: 6 totalReferralsCreated: 7 - totalResultSize: 1 + addedLoyaltyPoints: 250 + totalAddedLoyaltyPoints: 340 + deductedLoyaltyPoints: 120 + totalDeductedLoyaltyPoints: 220 properties: totalResultSize: example: 1 @@ -43061,58 +44830,59 @@ components: items: $ref: "#/components/schemas/CampaignAnalytics" type: array + default: null required: - data - totalResultSize getApplicationCustomers_200_response: example: + totalResultSize: 1 + hasMore: true data: - - accountId: 0 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 0 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 0 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + advocateIntegrationId: advocateIntegrationId + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 0 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - hasMore: true - totalResultSize: 1 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false + advocateIntegrationId: advocateIntegrationId properties: totalResultSize: example: 1 @@ -43124,57 +44894,58 @@ components: items: $ref: "#/components/schemas/ApplicationCustomer" type: array + default: null required: - data getApplicationCustomersByAttributes_200_response: example: + hasMore: true + totalResultSize: 0 data: - - accountId: 0 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 0 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 0 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + advocateIntegrationId: advocateIntegrationId + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 0 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - hasMore: true - totalResultSize: 0 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false + advocateIntegrationId: advocateIntegrationId properties: hasMore: type: boolean @@ -43185,55 +44956,56 @@ components: items: $ref: "#/components/schemas/ApplicationCustomer" type: array + default: null required: - data getCustomersByAttributes_200_response: example: + hasMore: true + totalResultSize: 0 data: - - accountId: 31 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 31 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - hasMore: true - totalResultSize: 0 + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: hasMore: type: boolean @@ -43244,54 +45016,55 @@ components: items: $ref: "#/components/schemas/CustomerProfile" type: array + default: null required: - data getCustomerProfiles_200_response: example: + hasMore: true data: - - accountId: 31 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 31 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - hasMore: true + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: hasMore: type: boolean @@ -43299,39 +45072,40 @@ components: items: $ref: "#/components/schemas/CustomerProfile" type: array + default: null required: - data - hasMore getCustomerActivityReportsWithoutTotalCount_200_response: example: + hasMore: true data: - - couponUseAttempts: 1 + - integrationId: URNGV8294NV created: 2020-02-07T08:15:22Z - totalOrdersNoCoupon: 9 - integrationId: URNGV8294NV - couponRedemptions: 6 - couponFailedAttempts: 5 - accruedRevenue: 2.3021358869347655 name: name customerId: 0 lastActivity: 2000-01-23T04:56:07.000+00:00 - totalOrders: 7 - campaignName: campaignName - accruedDiscounts: 5.637376656633329 - - couponUseAttempts: 1 - created: 2020-02-07T08:15:22Z - totalOrdersNoCoupon: 9 - integrationId: URNGV8294NV couponRedemptions: 6 + couponUseAttempts: 1 couponFailedAttempts: 5 + accruedDiscounts: 5.637376656633329 accruedRevenue: 2.3021358869347655 + totalOrders: 7 + totalOrdersNoCoupon: 9 + campaignName: campaignName + - integrationId: URNGV8294NV + created: 2020-02-07T08:15:22Z name: name customerId: 0 lastActivity: 2000-01-23T04:56:07.000+00:00 + couponRedemptions: 6 + couponUseAttempts: 1 + couponFailedAttempts: 5 + accruedDiscounts: 5.637376656633329 + accruedRevenue: 2.3021358869347655 totalOrders: 7 + totalOrdersNoCoupon: 9 campaignName: campaignName - accruedDiscounts: 5.637376656633329 - hasMore: true properties: hasMore: type: boolean @@ -43339,51 +45113,49 @@ components: items: $ref: "#/components/schemas/CustomerActivityReport" type: array + default: null required: - data - hasMore getApplicationSessions_200_response: example: + hasMore: true data: - - coupon: BKDB946 + - id: 6 created: 2020-02-07T08:15:22Z - totalDiscounts: 100 integrationId: URNGV8294NV - profileintegrationid: 382370BKDB946 - total: 200 - referral: BKDB946 - discounts: - key: 0.8008281904610115 storeIntegrationId: STORE-001 + applicationId: 322 profileId: 138 - attributes: null - id: 6 + profileintegrationid: 382370BKDB946 + coupon: BKDB946 + referral: BKDB946 state: closed - applicationId: 322 cartItems: - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -43392,30 +45164,30 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -43424,46 +45196,46 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - coupon: BKDB946 - created: 2020-02-07T08:15:22Z - totalDiscounts: 100 - integrationId: URNGV8294NV - profileintegrationid: 382370BKDB946 - total: 200 - referral: BKDB946 discounts: key: 0.8008281904610115 + totalDiscounts: 100 + total: 200 + attributes: null + - id: 6 + created: 2020-02-07T08:15:22Z + integrationId: URNGV8294NV storeIntegrationId: STORE-001 + applicationId: 322 profileId: 138 - attributes: null - id: 6 + profileintegrationid: 382370BKDB946 + coupon: BKDB946 + referral: BKDB946 state: closed - applicationId: 322 cartItems: - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -43472,30 +45244,30 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - - remainingQuantity: 1 - product: "" + - name: Air Glide + sku: SKU1241028 quantity: 1 returnedQuantity: 1 - length: 1.4658129805029452 - weight: 1130 - adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b - adjustmentEffectiveFrom: 2021-09-12T10:12:42Z - catalogItemID: 5 - additionalCosts: - shipping: - price: 9 + remainingQuantity: 1 price: 99.99 - selectedPriceType: member - name: Air Glide + category: shoes + product: "" + weight: 1130 + height: 0.8008281904610115 width: 6.027456183070403 + length: 1.4658129805029452 + position: 5.962133916683182 attributes: image: 11.jpeg material: leather + additionalCosts: + shipping: + price: 9 + catalogItemID: 5 + selectedPriceType: member + adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b + adjustmentEffectiveFrom: 2021-09-12T10:12:42Z adjustmentEffectiveUntil: 2021-09-12T10:12:42Z - position: 5.962133916683182 - sku: SKU1241028 - category: shoes prices: member: price: 90 @@ -43504,8 +45276,11 @@ components: effectiveUntil: 2025-05-30T00:00:00Z base: price: 100 - height: 0.8008281904610115 - hasMore: true + discounts: + key: 0.8008281904610115 + totalDiscounts: 100 + total: 200 + attributes: null properties: hasMore: type: boolean @@ -43513,160 +45288,161 @@ components: items: $ref: "#/components/schemas/ApplicationSession" type: array + default: null required: - data getApplicationEventsWithoutTotalCount_200_response: example: + hasMore: true data: - - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: 138 + storeId: 0 + storeIntegrationId: STORE-001 + integrationId: 175KJPS947296 + sessionId: 6 + type: type + attributes: null + effects: + - experimentId: 12 campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 ruleName: Give 20% discount - experimentId: 12 + effectType: rejectCoupon triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - storeIntegrationId: STORE-001 - created: 2020-06-10T09:05:27.993483Z - profileId: 138 - integrationId: 175KJPS947296 - attributes: null - id: 6 - sessionId: 6 - applicationId: 322 - storeId: 0 - type: type ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 + evaluationGroupID: 3 evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - - effects: - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 + evaluationGroupID: 3 + evaluationGroupMode: stackable + - id: 6 + created: 2020-06-10T09:05:27.993483Z + applicationId: 322 + profileId: 138 + storeId: 0 + storeIntegrationId: STORE-001 + integrationId: 175KJPS947296 + sessionId: 6 + type: type + attributes: null + effects: + - experimentId: 12 campaignId: 244 + rulesetId: 73 + ruleIndex: 2 + ruleName: Give 20% discount + effectType: rejectCoupon + triggeredByCoupon: 4928 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 + - experimentId: 12 + campaignId: 244 + rulesetId: 73 + ruleIndex: 2 ruleName: Give 20% discount - experimentId: 12 + effectType: rejectCoupon triggeredByCoupon: 4928 - - rulesetId: 73 - ruleIndex: 2 - campaignRevisionVersionId: 5 - campaignId: 244 + triggeredForCatalogItem: 786 conditionIndex: 786 + evaluationGroupID: 3 evaluationGroupMode: stackable - effectType: rejectCoupon + campaignRevisionId: 1 + campaignRevisionVersionId: 5 + selectedPriceType: member + selectedPrice: 100 adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b props: "" - selectedPrice: 100 - evaluationGroupID: 3 - triggeredForCatalogItem: 786 - selectedPriceType: member - campaignRevisionId: 1 - ruleName: Give 20% discount - experimentId: 12 - triggeredByCoupon: 4928 - storeIntegrationId: STORE-001 - created: 2020-06-10T09:05:27.993483Z - profileId: 138 - integrationId: 175KJPS947296 - attributes: null - id: 6 - sessionId: 6 - applicationId: 322 - storeId: 0 - type: type ruleFailureReasons: - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 - evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - - rulesetID: 6 - ruleIndex: 5 - campaignID: 0 - referralID: 1 - conditionIndex: 5 - effectIndex: 2 + evaluationGroupID: 3 evaluationGroupMode: stackable + - campaignID: 1 + campaignName: campaignName + rulesetID: 5 couponID: 4928 - referralValue: referralValue couponValue: couponValue - evaluationGroupID: 3 + referralID: 5 + referralValue: referralValue + ruleIndex: 2 ruleName: ruleName + conditionIndex: 7 + effectIndex: 9 details: details - campaignName: campaignName - hasMore: true + evaluationGroupID: 3 + evaluationGroupMode: stackable properties: hasMore: type: boolean @@ -43674,15 +45450,16 @@ components: items: $ref: "#/components/schemas/ApplicationEvent" type: array + default: null required: - data - hasMore getApplicationEventTypes_200_response: example: + totalResultSize: 1 data: - data - data - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -43692,40 +45469,41 @@ components: items: type: string type: array + default: null required: - data - totalResultSize getAudiences_200_response: example: + hasMore: true + totalResultSize: 1 data: - accountId: 3886 + id: 6 created: 2020-06-10T09:05:27.993483Z - lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true + description: Travel audience 18-27 subscribedApplicationsIds: - 3 - 13 integration: mparticle - description: Travel audience 18-27 integrationId: 382370BKDB946 - id: 6 createdIn3rdParty: false + lastUpdate: 2022-04-26T11:02:38Z - accountId: 3886 + id: 6 created: 2020-06-10T09:05:27.993483Z - lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true + description: Travel audience 18-27 subscribedApplicationsIds: - 3 - 13 integration: mparticle - description: Travel audience 18-27 integrationId: 382370BKDB946 - id: 6 createdIn3rdParty: false - hasMore: true - totalResultSize: 1 + lastUpdate: 2022-04-26T11:02:38Z properties: hasMore: type: boolean @@ -43737,16 +45515,17 @@ components: items: $ref: "#/components/schemas/Audience" type: array + default: null required: - data getAudiencesAnalytics_200_response: example: - data: - - membersCount: 1234 - audienceId: 1 - - membersCount: 1234 - audienceId: 1 hasMore: true + data: + - audienceId: 1 + membersCount: 1234 + - audienceId: 1 + membersCount: 1234 properties: hasMore: type: boolean @@ -43754,54 +45533,55 @@ components: items: $ref: "#/components/schemas/AudienceAnalytics" type: array + default: null required: - data getAudienceMemberships_200_response: example: + hasMore: true data: - - accountId: 31 - closedSessions: 3 + - id: 6 created: 2020-02-07T08:15:22Z - sandbox: false integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - - accountId: 31 - closedSessions: 3 - created: 2020-02-07T08:15:22Z + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z sandbox: false + - id: 6 + created: 2020-02-07T08:15:22Z integrationId: URNGV8294NV attributes: Language: english ShippingCountry: DE + accountId: 31 + closedSessions: 3 totalSales: 299.99 - lastActivity: 2020-02-08T14:15:20Z - id: 6 loyaltyMemberships: - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 - joined: 2012-03-20T14:15:22Z loyaltyProgramId: 323414846 audienceMemberships: - - name: Travel audience - id: 2 - - name: Travel audience - id: 2 - hasMore: true + - id: 2 + name: Travel audience + - id: 2 + name: Travel audience + lastActivity: 2020-02-08T14:15:20Z + sandbox: false properties: hasMore: type: boolean @@ -43809,25 +45589,26 @@ components: items: $ref: "#/components/schemas/CustomerProfile" type: array + default: null required: - data getApplicationCustomerFriends_200_response: example: + hasMore: true + totalResultSize: 1 data: - - friendIntegrationId: friendIntegrationId - code: code - created: 2000-01-23T04:56:07.000+00:00 + - applicationId: 322 sessionId: sessionId advocateIntegrationId: advocateIntegrationId - applicationId: 322 - - friendIntegrationId: friendIntegrationId + friendIntegrationId: friendIntegrationId code: code created: 2000-01-23T04:56:07.000+00:00 + - applicationId: 322 sessionId: sessionId advocateIntegrationId: advocateIntegrationId - applicationId: 322 - hasMore: true - totalResultSize: 1 + friendIntegrationId: friendIntegrationId + code: code + created: 2000-01-23T04:56:07.000+00:00 properties: hasMore: type: boolean @@ -43839,70 +45620,71 @@ components: items: $ref: "#/components/schemas/ApplicationReferee" type: array + default: null required: - data getAttributes_200_response: example: + totalResultSize: 1 data: - - created: 2020-06-10T09:05:27.993483Z - editable: true - subscribedApplicationsIds: - - 1 - - 4 - - 9 - description: Event triggered when a customer displays a page. - restrictedBySuggestions: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + entity: Event eventType: pageViewed + name: pageViewed title: Page view event type: string - accountId: 3886 - eventTypeId: 22 - hasAllowedList: false - allowedSubscriptions: - - application - - catalog - name: pageViewed + description: Event triggered when a customer displays a page. suggestions: - suggestions - suggestions - suggestions - suggestions - suggestions - id: 6 - subscribedCatalogsIds: - - 2 - - 5 - entity: Event - - created: 2020-06-10T09:05:27.993483Z + hasAllowedList: false + restrictedBySuggestions: false editable: true subscribedApplicationsIds: - 1 - 4 - 9 - description: Event triggered when a customer displays a page. - restrictedBySuggestions: false - eventType: pageViewed - title: Page view event - type: string - accountId: 3886 - eventTypeId: 22 - hasAllowedList: false + subscribedCatalogsIds: + - 2 + - 5 allowedSubscriptions: - application - catalog + eventTypeId: 22 + - id: 6 + created: 2020-06-10T09:05:27.993483Z + accountId: 3886 + entity: Event + eventType: pageViewed name: pageViewed + title: Page view event + type: string + description: Event triggered when a customer displays a page. suggestions: - suggestions - suggestions - suggestions - suggestions - suggestions - id: 6 + hasAllowedList: false + restrictedBySuggestions: false + editable: true + subscribedApplicationsIds: + - 1 + - 4 + - 9 subscribedCatalogsIds: - 2 - 5 - entity: Event - totalResultSize: 1 + allowedSubscriptions: + - application + - catalog + eventTypeId: 22 properties: totalResultSize: example: 1 @@ -43912,17 +45694,21 @@ components: items: $ref: "#/components/schemas/Attribute" type: array + default: null required: - data - totalResultSize listCatalogItems_200_response: example: + hasMore: true + totalResultSize: 1 data: - - product: - name: sample_product - catalogid: 6 + - id: 6 created: 2020-06-10T09:05:27.993483Z + sku: SKU1241028 price: 99.99 + catalogid: 6 + version: 5 attributes: - attributeid: 6 name: name @@ -43930,14 +45716,14 @@ components: - attributeid: 6 name: name value: "" - id: 6 - sku: SKU1241028 - version: 5 - - product: + product: name: sample_product - catalogid: 6 + - id: 6 created: 2020-06-10T09:05:27.993483Z + sku: SKU1241028 price: 99.99 + catalogid: 6 + version: 5 attributes: - attributeid: 6 name: name @@ -43945,11 +45731,8 @@ components: - attributeid: 6 name: name value: "" - id: 6 - sku: SKU1241028 - version: 5 - hasMore: true - totalResultSize: 1 + product: + name: sample_product properties: hasMore: type: boolean @@ -43961,32 +45744,33 @@ components: items: $ref: "#/components/schemas/CatalogItem" type: array + default: null required: - data getAdditionalCosts_200_response: example: + totalResultSize: 1 data: - - accountId: 3886 + - id: 6 created: 2020-06-10T09:05:27.993483Z + accountId: 3886 name: shippingFee + title: Shipping fee + description: A shipping fee subscribedApplicationsIds: - 3 - 13 - description: A shipping fee - id: 6 - title: Shipping fee type: session - - accountId: 3886 + - id: 6 created: 2020-06-10T09:05:27.993483Z + accountId: 3886 name: shippingFee + title: Shipping fee + description: A shipping fee subscribedApplicationsIds: - 3 - 13 - description: A shipping fee - id: 6 - title: Shipping fee type: session - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -43996,55 +45780,56 @@ components: items: $ref: "#/components/schemas/AccountAdditionalCost" type: array + default: null required: - data - totalResultSize getWebhooks_200_response: example: + totalResultSize: 1 data: - - headers: - - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" - - "{\"Content-Type\": \"application/json\"}" + - id: 6 created: 2020-06-10T09:05:27.993483Z - outgoingIntegrationTemplateId: 1 - verb: POST - description: A webhook to send a coupon to the user. - authenticationId: 1 - title: Send message - params: [] - url: www.my-company.com/my-endpoint-name - enabled: true + modified: 2021-09-12T10:12:42Z applicationIds: - 0 - 0 - outgoingIntegrationTypeId: 1 - outgoingIntegrationTypeName: Braze - payload: "{\n\t\"message\": \"${message}\"\n}" + title: Send message + description: A webhook to send a coupon to the user. draft: false - modified: 2021-09-12T10:12:42Z - id: 6 - - headers: + verb: POST + url: www.my-company.com/my-endpoint-name + headers: - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" - "{\"Content-Type\": \"application/json\"}" - created: 2020-06-10T09:05:27.993483Z - outgoingIntegrationTemplateId: 1 - verb: POST - description: A webhook to send a coupon to the user. - authenticationId: 1 - title: Send message + payload: "{\n\t\"message\": \"${message}\"\n}" params: [] - url: www.my-company.com/my-endpoint-name enabled: true + authenticationId: 1 + outgoingIntegrationTemplateId: 1 + outgoingIntegrationTypeId: 1 + outgoingIntegrationTypeName: Braze + - id: 6 + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z applicationIds: - 0 - 0 + title: Send message + description: A webhook to send a coupon to the user. + draft: false + verb: POST + url: www.my-company.com/my-endpoint-name + headers: + - "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}" + - "{\"Content-Type\": \"application/json\"}" + payload: "{\n\t\"message\": \"${message}\"\n}" + params: [] + enabled: true + authenticationId: 1 + outgoingIntegrationTemplateId: 1 outgoingIntegrationTypeId: 1 outgoingIntegrationTypeName: Braze - payload: "{\n\t\"message\": \"${message}\"\n}" - draft: false - modified: 2021-09-12T10:12:42Z - id: 6 - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -44054,23 +45839,24 @@ components: items: $ref: "#/components/schemas/WebhookWithOutgoingIntegrationDetails" type: array + default: null required: - data - totalResultSize getEventTypes_200_response: example: + totalResultSize: 1 data: - - created: 2020-06-10T09:05:27.993483Z + - id: 6 + created: 2020-06-10T09:05:27.993483Z + title: Survey Completed name: surveyCompleted description: The survey was submitted by the customer. - id: 6 + - id: 6 + created: 2020-06-10T09:05:27.993483Z title: Survey Completed - - created: 2020-06-10T09:05:27.993483Z name: surveyCompleted description: The survey was submitted by the customer. - id: 6 - title: Survey Completed - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -44080,49 +45866,50 @@ components: items: $ref: "#/components/schemas/EventType" type: array + default: null required: - data - totalResultSize getUsers_200_response: example: + totalResultSize: 1 data: - - created: 2020-06-10T09:05:27.993483Z - roles: - - 71 - isAdmin: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + email: john.doe@example.com accountId: 3886 - applicationNotificationSubscriptions: "{}" - inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 name: John Doe - modified: 2021-09-12T10:12:42Z - lastAccessed: 2021-09-12T10:14:42Z - id: 6 state: invited - authMethod: basic_auth - latestFeedTimestamp: 2020-06-01T00:00:00Z - lastSignedIn: 2021-09-12T10:12:42Z - email: john.doe@example.com + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + isAdmin: false policy: "{Role=127}" - additionalAttributes: "{}" - - created: 2020-06-10T09:05:27.993483Z roles: - 71 - isAdmin: false + authMethod: basic_auth + applicationNotificationSubscriptions: null + lastSignedIn: 2021-09-12T10:12:42Z + lastAccessed: 2021-09-12T10:14:42Z + latestFeedTimestamp: 2020-06-01T00:00:00Z + additionalAttributes: null + - id: 6 + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + email: john.doe@example.com accountId: 3886 - applicationNotificationSubscriptions: "{}" - inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 name: John Doe - modified: 2021-09-12T10:12:42Z - lastAccessed: 2021-09-12T10:14:42Z - id: 6 state: invited + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + isAdmin: false + policy: "{Role=127}" + roles: + - 71 authMethod: basic_auth - latestFeedTimestamp: 2020-06-01T00:00:00Z + applicationNotificationSubscriptions: null lastSignedIn: 2021-09-12T10:12:42Z - email: john.doe@example.com - policy: "{Role=127}" - additionalAttributes: "{}" - totalResultSize: 1 + lastAccessed: 2021-09-12T10:14:42Z + latestFeedTimestamp: 2020-06-01T00:00:00Z + additionalAttributes: null properties: totalResultSize: example: 1 @@ -44132,34 +45919,31 @@ components: items: $ref: "#/components/schemas/User" type: array + default: null required: - data - totalResultSize getChanges_200_response: example: + totalResultSize: 1 + hasMore: true data: - - new: "{applicationId\"=359, attributes\"={}, campaignGroups\"=[], created\"\ - =2022-07-08T13:04:02.972762328Z, description\"=, features\"=[referrals,\ - \ loyalty], id=6727}" + - id: 6 created: 2020-06-10T09:05:27.993483Z - old: "{}" - id: 6 - applicationId: 359 userId: 388 + applicationId: 359 entity: /v1/applications/359/campaigns/6727 + old: null + new: null managementKeyId: 3 - - new: "{applicationId\"=359, attributes\"={}, campaignGroups\"=[], created\"\ - =2022-07-08T13:04:02.972762328Z, description\"=, features\"=[referrals,\ - \ loyalty], id=6727}" + - id: 6 created: 2020-06-10T09:05:27.993483Z - old: "{}" - id: 6 - applicationId: 359 userId: 388 + applicationId: 359 entity: /v1/applications/359/campaigns/6727 + old: null + new: null managementKeyId: 3 - hasMore: true - totalResultSize: 1 properties: totalResultSize: example: 1 @@ -44171,24 +45955,25 @@ components: items: $ref: "#/components/schemas/Change" type: array + default: null required: - data getExports_200_response: example: + totalResultSize: 1 data: - - filter: null - accountId: 3886 + - id: 6 created: 2020-06-10T09:05:27.993483Z - id: 6 + accountId: 3886 userId: 388 entity: Coupon - - filter: null - accountId: 3886 + filter: null + - id: 6 created: 2020-06-10T09:05:27.993483Z - id: 6 + accountId: 3886 userId: 388 entity: Coupon - totalResultSize: 1 + filter: null properties: totalResultSize: example: 1 @@ -44198,37 +45983,38 @@ components: items: $ref: "#/components/schemas/Export" type: array + default: null required: - data - totalResultSize listAllRolesV2_200_response: example: + totalResultSize: 1 data: - - accountId: 3886 - isReadonly: false + - id: 6 created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + accountId: 3886 + name: Campaign and campaign access group manager + description: "Allows you to create and edit campaigns for specific Applications,\ + \ delete specific campaign access groups, and view loyalty programs." permissions: "" members: - 10 - 12 - name: Campaign and campaign access group manager + isReadonly: false + - id: 6 + created: 2020-06-10T09:05:27.993483Z modified: 2021-09-12T10:12:42Z + accountId: 3886 + name: Campaign and campaign access group manager description: "Allows you to create and edit campaigns for specific Applications,\ \ delete specific campaign access groups, and view loyalty programs." - id: 6 - - accountId: 3886 - isReadonly: false - created: 2020-06-10T09:05:27.993483Z permissions: "" members: - 10 - 12 - name: Campaign and campaign access group manager - modified: 2021-09-12T10:12:42Z - description: "Allows you to create and edit campaigns for specific Applications,\ - \ delete specific campaign access groups, and view loyalty programs." - id: 6 - totalResultSize: 1 + isReadonly: false properties: totalResultSize: example: 1 @@ -44238,42 +46024,43 @@ components: items: $ref: "#/components/schemas/RoleV2" type: array + default: null required: - data - totalResultSize listStores_200_response: example: + hasMore: true + totalResultSize: 1 data: - - linkedCampaignIds: - - 4 - - 6 - - 8 + - id: 6 created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. - integrationId: STORE-001 attributes: country: USA code: 1234 - id: 6 + integrationId: STORE-001 applicationId: 322 updated: 2021-09-23T10:12:42Z - - linkedCampaignIds: + linkedCampaignIds: - 4 - 6 - 8 + - id: 6 created: 2020-02-07T08:15:22Z name: South US store description: This is the description of the store in south US. - integrationId: STORE-001 attributes: country: USA code: 1234 - id: 6 + integrationId: STORE-001 applicationId: 322 updated: 2021-09-23T10:12:42Z - hasMore: true - totalResultSize: 1 + linkedCampaignIds: + - 4 + - 6 + - 8 properties: hasMore: type: boolean @@ -44285,30 +46072,31 @@ components: items: $ref: "#/components/schemas/Store" type: array + default: null required: - data listApplicationCartItemFilters_200_response: example: + hasMore: true data: - - createdBy: 216 + - id: 6 created: 2020-06-10T09:05:27.993483Z name: Filter items by product description: This filter allows filtering by shoes - modified: 2000-01-23T04:56:07.000+00:00 + activeExpressionId: 1 modifiedBy: 334 - id: 6 + createdBy: 216 + modified: 2000-01-23T04:56:07.000+00:00 applicationId: 322 - activeExpressionId: 1 - - createdBy: 216 + - id: 6 created: 2020-06-10T09:05:27.993483Z name: Filter items by product description: This filter allows filtering by shoes - modified: 2000-01-23T04:56:07.000+00:00 + activeExpressionId: 1 modifiedBy: 334 - id: 6 + createdBy: 216 + modified: 2000-01-23T04:56:07.000+00:00 applicationId: 322 - activeExpressionId: 1 - hasMore: true properties: hasMore: type: boolean @@ -44316,86 +46104,89 @@ components: items: $ref: "#/components/schemas/ApplicationCIF" type: array + default: null required: - data listCampaignStoreBudgetLimits_200_response: example: data: - - period: period + - store: + id: 0 + integrationId: integrationId + name: name limit: 6 action: action - store: - name: name - integrationId: integrationId + period: period + - store: id: 0 - - period: period + integrationId: integrationId + name: name limit: 6 action: action - store: - name: name - integrationId: integrationId - id: 0 + period: period properties: data: items: $ref: "#/components/schemas/ListCampaignStoreBudgets" type: array + default: null summarizeCampaignStoreBudget_200_response: example: data: - - period: overall - imported: true + - action: redeemCoupon + period: overall storeCount: 0 - action: redeemCoupon - - period: overall imported: true + - action: redeemCoupon + period: overall storeCount: 0 - action: redeemCoupon + imported: true properties: data: items: $ref: "#/components/schemas/SummaryCampaignStoreBudget" type: array + default: null listAchievements_200_response: example: + hasMore: true data: - - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 + name: Order50Discount + title: 50% off on 50th purchase. description: 50% off for every 50th purchase in a year. + target: 50 + period: 1Y + periodEndOverride: "" + recurrencePolicy: no_recurrence activationPolicy: fixed_schedule - title: 50% off on 50th purchase. + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 allowRollbackAfterCompletion: false + campaignId: 1 userId: 1234 - hasProgress: true - target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 createdBy: John Doe - name: Order50Discount - periodEndOverride: "" - id: 6 - recurrencePolicy: no_recurrence + hasProgress: true status: inprogress - - period: 1Y - endDate: 2024-02-15T15:04:05Z07:00 + - id: 6 created: 2020-06-10T09:05:27.993483Z - campaignId: 1 + name: Order50Discount + title: 50% off on 50th purchase. description: 50% off for every 50th purchase in a year. + target: 50 + period: 1Y + periodEndOverride: "" + recurrencePolicy: no_recurrence activationPolicy: fixed_schedule - title: 50% off on 50th purchase. + fixedStartDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-15T15:04:05Z07:00 allowRollbackAfterCompletion: false + campaignId: 1 userId: 1234 - hasProgress: true - target: 50 - fixedStartDate: 2024-01-15T15:04:05Z07:00 createdBy: John Doe - name: Order50Discount - periodEndOverride: "" - id: 6 - recurrencePolicy: no_recurrence + hasProgress: true status: inprogress - hasMore: true properties: hasMore: type: boolean @@ -44403,44 +46194,45 @@ components: items: $ref: "#/components/schemas/Achievement" type: array + default: null required: - data getCustomerProfileAchievementProgress_200_response: example: + hasMore: true data: - - endDate: 2024-02-01T15:04:05Z07:00 - achievementAllowRollbackAfterCompletion: false - campaignId: 3 + - status: completed + progress: 10 + startDate: 2024-01-01T15:04:05Z07:00 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 achievementId: 3 - description: 50% off for every 50th purchase in a year. - achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 + name: FreeCoffee10Orders title: 50% off on 50th purchase. + description: 50% off for every 50th purchase in a year. + campaignId: 3 target: 10 achievementRecurrencePolicy: no_recurrence achievementActivationPolicy: fixed_schedule - name: FreeCoffee10Orders + achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 achievementEndDate: 2024-02-15T15:04:05Z07:00 + achievementAllowRollbackAfterCompletion: false + - status: completed progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 startDate: 2024-01-01T15:04:05Z07:00 - status: completed - - endDate: 2024-02-01T15:04:05Z07:00 - achievementAllowRollbackAfterCompletion: false - campaignId: 3 + completionDate: 2024-01-15T15:04:05Z07:00 + endDate: 2024-02-01T15:04:05Z07:00 achievementId: 3 - description: 50% off for every 50th purchase in a year. - achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 + name: FreeCoffee10Orders title: 50% off on 50th purchase. + description: 50% off for every 50th purchase in a year. + campaignId: 3 target: 10 achievementRecurrencePolicy: no_recurrence achievementActivationPolicy: fixed_schedule - name: FreeCoffee10Orders + achievementFixedStartDate: 2024-01-15T15:04:05Z07:00 achievementEndDate: 2024-02-15T15:04:05Z07:00 - progress: 10 - completionDate: 2024-01-15T15:04:05Z07:00 - startDate: 2024-01-01T15:04:05Z07:00 - status: completed - hasMore: true + achievementAllowRollbackAfterCompletion: false properties: hasMore: example: true @@ -44449,37 +46241,39 @@ components: items: $ref: "#/components/schemas/AchievementProgressWithDefinition" type: array + default: null required: - data - hasMore generateCouponRejections_200_response: example: data: - - summary: Session total was less than the required total. + - id: 1 eventID: 1011 - createdAt: 2021-07-20T21:59:00Z - profileID: a48f10dddb5c9493aad194e49bb9c1dac - language: en - id: 1 sessionID: 1 - couponCode: ABC123 + profileID: a48f10dddb5c9493aad194e49bb9c1dac status: rejected + couponCode: ABC123 + language: en + summary: Session total was less than the required total. + createdAt: 2021-07-20T21:59:00Z updatedAt: 2021-07-20T21:59:00Z - - summary: Session total was less than the required total. + - id: 1 eventID: 1011 - createdAt: 2021-07-20T21:59:00Z - profileID: a48f10dddb5c9493aad194e49bb9c1dac - language: en - id: 1 sessionID: 1 - couponCode: ABC123 + profileID: a48f10dddb5c9493aad194e49bb9c1dac status: rejected + couponCode: ABC123 + language: en + summary: Session total was less than the required total. + createdAt: 2021-07-20T21:59:00Z updatedAt: 2021-07-20T21:59:00Z properties: data: items: $ref: "#/components/schemas/CouponFailureSummary" type: array + default: null required: - data GenerateRuleTitle_rule: @@ -44502,6 +46296,7 @@ components: items: type: object type: array + default: null condition: description: A Talang expression that will be evaluated in the context of the given event. @@ -44511,6 +46306,7 @@ components: items: {} minItems: 1 type: array + default: null IntegrationCampaignBase_allOf_attributes: description: Arbitrary properties associated with this campaign. type: object @@ -44518,47 +46314,6 @@ components: description: Custom attributes associated with this coupon. title: Attributes of coupon type: object - NewReferral_allOf_attributes: - description: Arbitrary properties associated with this item. - example: "{channel=web}" - type: object - Giveaway_allOf_attributes: - description: Arbitrary properties associated with this giveaway. - type: object - IntegrationEvent_allOf_attributes: - description: Arbitrary additional JSON data associated with the event. - example: "{myAttribute=myValue}" - type: object - NewCustomerSession_allOf_attributes: - description: | - A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. - type: object - NewReferralsForMultipleAdvocates_allOf_attributes: - description: Arbitrary properties associated with this referral code. - example: "{channel=web}" - type: object - TemplateArgDef_allOf_ui: - description: Arbitrary metadata that may be used to render an input for this - argument. - type: object - UpdateCouponBatch_allOf_attributes: - description: | - Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, - see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). - - Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). - If your Application uses mandatory attributes, you must use this property to set their value. - type: object - NewCoupons_allOf_attributes: - description: Arbitrary properties associated with this item. - example: "{venueId=12}" - type: object - NewCouponCreationJob_allOf_attributes: - description: Arbitrary properties associated with coupons. - type: object - UpdateCoupon_allOf_attributes: - description: Arbitrary properties associated with this item. - type: object Role_allOf_acl: description: The `Access Control List` json defining the role of the user. This represents the access control on the user level. @@ -44589,23 +46344,11 @@ components: required: - campaign - isVariantAssignmentExternal - ApplicationEvent_allOf_attributes: - description: Additional JSON serialized data associated with the event. - type: object User_allOf_policy: description: Access level of the user. example: "{Role=127}" format: acl type: object - User_allOf_applicationNotificationSubscriptions: - description: Application notifications that the user is subscribed to. - example: "{}" - type: object - User_allOf_additionalAttributes: - description: "Additional user attributes, created and used by external identity\ - \ providers." - example: "{}" - type: object ScimBaseUser_name: description: The components of the user’s real name. example: @@ -44653,43 +46396,12 @@ components: description: Indicates whether the SCIM service provider supports filtering operations. type: boolean - ScimServiceProviderConfigResponse_patch: - description: "Configuration settings related to patch operations, which allow\ - \ partial updates to SCIM resources." - properties: - supported: - 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 - Change_allOf_old: - description: Resource before the change occurred. - example: "{}" - type: object - Change_allOf_new: - description: Resource after the change occurred. - example: "{applicationId\"=359, attributes\"={}, campaignGroups\"=[], created\"\ - =2022-07-08T13:04:02.972762328Z, description\"=, features\"=[referrals, loyalty],\ - \ id=6727}" - type: object - Export_allOf_filter: - description: Map of keys and values that were used to filter the exported rows. - type: object ProductUnitAnalytics_totals: properties: unitsSold: allOf: - $ref: "#/components/schemas/AnalyticsDataPointWithTrend" description: The number of times the product or SKU was purchased. - IntegrationHubEventPayloadCouponBasedNotifications_allOf_Attributes: - type: object EmbeddedAnalyticsConfiguration_dashboards: properties: campaignInsights: diff --git a/build.gradle b/build.gradle index 206f2283..8bcf0177 100644 --- a/build.gradle +++ b/build.gradle @@ -4,7 +4,7 @@ apply plugin: 'java' apply plugin: 'com.diffplug.spotless' group = 'one.talon' -version = '26.11.0' +version = '26.12.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 812f6972..41cd5816 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 := "26.11.0", + version := "26.12.0", scalaVersion := "2.11.12", scalacOptions ++= Seq("-feature"), compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/docs/AcceptCouponEffectProps.md b/docs/AcceptCouponEffectProps.md index 2124de28..5a67ad5b 100644 --- a/docs/AcceptCouponEffectProps.md +++ b/docs/AcceptCouponEffectProps.md @@ -2,7 +2,7 @@ # AcceptCouponEffectProps -The properties specific to the \"acceptCoupon\" effect. This gets triggered whenever the coupon is valid and all other conditions in the rules of its campaign are met. +This effect indicates that the coupon code supplied was valid. You should handle this effect by clearing any messages from previous `rejectCoupon` effects and informing the user that the coupon is valid. The code is automatically redeemed when you close the session. Other effects, such as [setDiscount](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscount), provide more information about the actual rewards received. ## Properties diff --git a/docs/AcceptReferralEffectProps.md b/docs/AcceptReferralEffectProps.md index c0ed4825..667d3da8 100644 --- a/docs/AcceptReferralEffectProps.md +++ b/docs/AcceptReferralEffectProps.md @@ -2,13 +2,13 @@ # AcceptReferralEffectProps -The properties specific to the \"acceptReferral\" effect. TThis gets triggered whenever the referral code is valid and all other conditions in the rules of its campaign are met. +This effect indicates that the referral code supplied is valid. You should handle this effect by informing the user that the referral code is valid. The code is automatically redeemed when you close the session. Other effects will provide more information about the actual reward. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**value** | **String** | The referral code that was accepted. | | +|**value** | **String** | The referral code provided in the session. | | diff --git a/docs/AchievementAdditionalPropertiesV2.md b/docs/AchievementAdditionalPropertiesV2.md index 7760573d..9765a568 100644 --- a/docs/AchievementAdditionalPropertiesV2.md +++ b/docs/AchievementAdditionalPropertiesV2.md @@ -9,8 +9,9 @@ |------------ | ------------- | ------------- | -------------| |**userId** | **Long** | The 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. | [optional] | +|**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] | |**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] | -|**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional] | +|**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. | [optional] | @@ -18,10 +19,9 @@ | Name | Value | |---- | -----| -| INPROGRESS | "inprogress" | +| ACTIVE | "active" | +| SCHEDULED | "scheduled" | | EXPIRED | "expired" | -| NOT_STARTED | "not_started" | -| COMPLETED | "completed" | diff --git a/docs/AchievementReference.md b/docs/AchievementReference.md index 64980548..9e5aae2c 100644 --- a/docs/AchievementReference.md +++ b/docs/AchievementReference.md @@ -11,6 +11,7 @@ |**applicationId** | **Long** | The ID of the Application associated with the campaign that references this achievement. | | |**applicationName** | **String** | The name of the Application associated with the campaign that references this achievement. | | |**campaignId** | **Long** | The ID of the campaign that references this achievement. | | +|**campaignName** | **String** | The name of the campaign that references this achievement. | | diff --git a/docs/AchievementV2.md b/docs/AchievementV2.md index e96857a1..4dd5e009 100644 --- a/docs/AchievementV2.md +++ b/docs/AchievementV2.md @@ -22,8 +22,9 @@ |**subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | | |**userId** | **Long** | The 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. | [optional] | +|**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional] | |**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] | -|**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional] | +|**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. | [optional] | |**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | | |**timezone** | **String** | A string containing an IANA timezone descriptor. | | @@ -52,10 +53,9 @@ | Name | Value | |---- | -----| -| INPROGRESS | "inprogress" | +| ACTIVE | "active" | +| SCHEDULED | "scheduled" | | EXPIRED | "expired" | -| NOT_STARTED | "not_started" | -| COMPLETED | "completed" | diff --git a/docs/AddFreeItemEffectProps.md b/docs/AddFreeItemEffectProps.md index 626e5390..c01dc585 100644 --- a/docs/AddFreeItemEffectProps.md +++ b/docs/AddFreeItemEffectProps.md @@ -2,14 +2,14 @@ # AddFreeItemEffectProps -The properties specific to the \"addFreeItem\" effect. This gets triggered whenever a validated rule contained an \"add free item\" effect. +This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set its price to `0`. The effect of a successful referral can mean a free item for someone else, such as the referrer. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**sku** | **String** | SKU of the item that needs to be added. | | -|**name** | **String** | The name / description of the effect | | +|**name** | **String** | Description of the effect. | | |**desiredQuantity** | **Long** | The original quantity in case a partial reward was applied. | [optional] | diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md index a1a40bb3..8aad3928 100644 --- a/docs/AddLoyaltyPointsEffectProps.md +++ b/docs/AddLoyaltyPointsEffectProps.md @@ -2,28 +2,28 @@ # AddLoyaltyPointsEffectProps -The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. +This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card. If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which item to add the loyalty points for. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. See the example below for more information. If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the items for which loyalty points are added. If you have set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card on which these points are added. The points only persist when the session is closed. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name / description of this loyalty point addition. | | +|**name** | **String** | The reason of this loyalty point addition. | | |**programId** | **Long** | The ID of the loyalty program where these points were added. | | |**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. | | |**value** | **BigDecimal** | The amount of points that were added. | | -|**desiredValue** | **BigDecimal** | The original amount of loyalty points to be awarded. | [optional] | +|**desiredValue** | **BigDecimal** | (Partial rewards enabled only) The amount of loyalty points to be awarded without considering budget limitations. | [optional] | |**recipientIntegrationId** | **String** | The user for whom these points were added. | | -|**startDate** | **OffsetDateTime** | Date after which points will be valid. | [optional] | -|**expiryDate** | **OffsetDateTime** | Date after which points will expire. | [optional] | -|**transactionUUID** | **String** | The identifier of this addition in the loyalty ledger. | | -|**cartItemPosition** | **BigDecimal** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] | -|**cartItemSubPosition** | **BigDecimal** | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional] | -|**cardIdentifier** | **String** | The card on which these points were added. | [optional] | -|**bundleIndex** | **Long** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] | -|**bundleName** | **String** | The name of the bundle definition. | [optional] | -|**awaitsActivation** | **Boolean** | If `true`, the loyalty points remain pending until a specific action is complete. The `startDate` parameter automatically sets to `on_action`. | [optional] | -|**validityDuration** | **String** | The duration for which the points remain active, calculated relative to the activation date. **Note**: This value is returned only if `awaitsActivation` is `true` and `expiryDate` is not set. | [optional] | +|**startDate** | **OffsetDateTime** | The date after which the added points will be valid. | [optional] | +|**expiryDate** | **OffsetDateTime** | The date after which the added points will expire. | [optional] | +|**transactionUUID** | **String** | The identifier of this loyalty point transaction. | | +|**cartItemPosition** | **BigDecimal** | (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were added. | [optional] | +|**cartItemSubPosition** | **BigDecimal** | (_Add points per cart item_ ) The index of the item unit in its line item. | [optional] | +|**cardIdentifier** | **String** | The identifier of the card on which these points were added. | [optional] | +|**bundleIndex** | **Long** | _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. | [optional] | +|**bundleName** | **String** | _(With bundles only)_ The name of the bundle definition. | [optional] | +|**awaitsActivation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. | [optional] | +|**validityDuration** | **String** | The duration for which the points remain active, calculated relative to their start date. | [optional] | diff --git a/docs/AddToAudienceEffectProps.md b/docs/AddToAudienceEffectProps.md index 546b1670..ef240d8a 100644 --- a/docs/AddToAudienceEffectProps.md +++ b/docs/AddToAudienceEffectProps.md @@ -2,7 +2,7 @@ # AddToAudienceEffectProps -The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect. +This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Add customer to an audience** selected is validated. It indicates that a customer was added to an audience and is returned when a customer session is opened, updated, or closed. ## Properties diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index 19b05280..d1a08055 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -16,7 +16,7 @@ |**integrationId** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] | |**sessionId** | **Long** | The globally unique Talon.One ID of the session that contains this event. | [optional] | |**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. | | -|**attributes** | **Object** | Additional JSON serialized data associated with the event. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**effects** | [**List<Effect>**](Effect.md) | An array containing the effects that were applied as a result of this event. | | |**ruleFailureReasons** | [**List<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional] | diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index 8ce6033e..5d11b92d 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -21,7 +21,7 @@ |**discounts** | **Map<String, BigDecimal>** | **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. | | |**totalDiscounts** | **BigDecimal** | The total sum of the discounts applied to this session. **Note:** If more than one session is returned, this value is displayed as `0`. | | |**total** | **BigDecimal** | The total sum of the session before any discounts applied. | | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | diff --git a/docs/AwardGiveawayEffectProps.md b/docs/AwardGiveawayEffectProps.md index b318432b..c482a279 100644 --- a/docs/AwardGiveawayEffectProps.md +++ b/docs/AwardGiveawayEffectProps.md @@ -2,17 +2,17 @@ # AwardGiveawayEffectProps -The properties specific to the \"awardGiveaway\" effect. This effect contains information on the giveaway item, and which profile it was awarded to. +This effect indicates the awarded giveaway item and to which profile the item was awarded. Learn more about [giveaways](https://docs.talon.one/docs/product/giveaways/overview). ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**poolId** | **Long** | The ID of the giveaways pool the code was taken from. | | -|**poolName** | **String** | The name of the giveaways pool the code was taken from. | | -|**recipientIntegrationId** | **String** | The integration ID of the profile that was awarded the giveaway. | | -|**giveawayId** | **Long** | The internal ID for the giveaway that was awarded. | | -|**code** | **String** | The giveaway code that was awarded. | | +|**poolId** | **Long** | The internal ID of the giveaway pool. | | +|**poolName** | **String** | The name of the giveaway pool. | | +|**recipientIntegrationId** | **String** | The integration ID of the customer that receives the giveaway. | | +|**giveawayId** | **Long** | The internal ID of the giveaway. | | +|**code** | **String** | The giveaway code to be rewarded. | | diff --git a/docs/CampaignEligibility.md b/docs/CampaignEligibility.md index d6d2e802..52b7469d 100644 --- a/docs/CampaignEligibility.md +++ b/docs/CampaignEligibility.md @@ -19,6 +19,7 @@ |**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. | | |**eligibility** | [**List<CampaignEligibilityDetails>**](CampaignEligibilityDetails.md) | The customer's eligibility for each campaign in the current customer session. | | |**rules** | [**List<RuleMetadataEligibility>**](RuleMetadataEligibility.md) | A list of rules containing customer-facing details of the rewards defined in the campaign. | | +|**experiment** | [**CampaignEligibilityExperiment**](CampaignEligibilityExperiment.md) | | [optional] | diff --git a/docs/CampaignEligibilityExperiment.md b/docs/CampaignEligibilityExperiment.md new file mode 100644 index 00000000..c307d196 --- /dev/null +++ b/docs/CampaignEligibilityExperiment.md @@ -0,0 +1,15 @@ + + +# CampaignEligibilityExperiment + +The identifiers for the [experiment](https://docs.talon.one/management-api#tag/Experiments) and the variant assigned to the customer profile. Only returned when the customer profile has been assigned to a variant in an experiment campaign. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**id** | **Long** | The ID of the experiment. | | +|**variantId** | **Long** | The ID of the variant assigned to the customer profile. | | + + + diff --git a/docs/Change.md b/docs/Change.md index 1bf7ed2f..5e0886f9 100644 --- a/docs/Change.md +++ b/docs/Change.md @@ -12,8 +12,8 @@ |**userId** | **Long** | The ID of the user associated with this entity. | | |**applicationId** | **Long** | ID of application associated with change. | [optional] | |**entity** | **String** | API endpoint on which the change was initiated. | | -|**old** | **Object** | Resource before the change occurred. | [optional] | -|**_new** | **Object** | Resource after the change occurred. | [optional] | +|**old** | **Object** | Arbitrary properties associated with this campaign. | [optional] | +|**_new** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**managementKeyId** | **Long** | ID of management key used to perform changes. | [optional] | diff --git a/docs/ChangeLoyaltyTierLevelEffectProps.md b/docs/ChangeLoyaltyTierLevelEffectProps.md index 52edae5c..41979882 100644 --- a/docs/ChangeLoyaltyTierLevelEffectProps.md +++ b/docs/ChangeLoyaltyTierLevelEffectProps.md @@ -2,15 +2,15 @@ # ChangeLoyaltyTierLevelEffectProps -The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an \"addLoyaltyPoints\" effect. +This effect indicates that a customer's loyalty tier has been upgraded. This effect is generated only when the [Add loyalty points](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points) and the [Add loyalty points per cart item](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points-per-cart-item) effects are triggered for a particular customer, and, as a result, the customer's loyalty tier is upgraded. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**ruleTitle** | **String** | The title of the rule that triggered the tier upgrade. | | -|**programId** | **Long** | The ID of the loyalty program where these points were added. | | -|**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. | | +|**programId** | **Long** | The ID of the loyalty program where the points were added. | | +|**subLedgerId** | **String** | The ID of the subledger within the loyalty program where the points were added. | | |**previousTierName** | **String** | The name of the tier from which the user was upgraded. | [optional] | |**newTierName** | **String** | The name of the tier to which the user has been upgraded. | | |**expiryDate** | **OffsetDateTime** | The expiration date of the new tier. | [optional] | diff --git a/docs/CouponCreatedEffectProps.md b/docs/CouponCreatedEffectProps.md index 406770e1..f7f78286 100644 --- a/docs/CouponCreatedEffectProps.md +++ b/docs/CouponCreatedEffectProps.md @@ -2,7 +2,7 @@ # CouponCreatedEffectProps -The properties specific to the \"couponCreated\" effect. This gets triggered whenever a validated rule contained a \"create coupon\" effect, and a coupon was created for a customer. See \"createdCoupons\" on the response for all details of this coupon. +This effect indicates that a coupon was created. For referrals and retention marketing, a common use case is to generate a coupon that can only be redeemed by one specific customer. Handle this effect by notifying the recipient about their new coupon code. ## Properties diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index ab42a05f..703eda72 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -19,7 +19,7 @@ |**expiryDate** | **OffsetDateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] | |**numberOfCoupons** | **Long** | The number of new coupon codes to generate for the campaign. | | |**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with coupons. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] | |**batchId** | **String** | The batch ID coupons created by this job will bear. | | |**status** | **String** | The current status of this request. Possible values: - `pending verification` - `pending` - `completed` - `failed` - `coupon pattern full` | | diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md index fedc0539..f0156078 100644 --- a/docs/CustomEffectProps.md +++ b/docs/CustomEffectProps.md @@ -2,7 +2,7 @@ # CustomEffectProps -Effect containing custom payload. +If you want to return data as an effect but no effect matches your use case, you can [create a custom effect](https://docs.talon.one/docs/dev/tutorials/create-custom-effects). Custom effects can be used as both rule effects and failure effects. The structure of a custom effect depends on your specifications but is always named `customEffect`. ## Properties diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index 93d72d3e..bcf0418a 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -17,7 +17,7 @@ |**cartItems** | [**List<CartItem>**](CartItem.md) | Serialized JSON representation. | [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). | [optional] | |**total** | **BigDecimal** | The total sum of the cart in one session. | [optional] | -|**attributes** | **Object** | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**firstSession** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | | |**updateCount** | **Long** | The number of times the session was updated. When the session is created, this value is initialized to `1`. | | |**discounts** | **Map<String, BigDecimal>** | A map of labelled discount values, values will be in the same currency as the application associated with the session. | | diff --git a/docs/DeductLoyaltyPointsEffectProps.md b/docs/DeductLoyaltyPointsEffectProps.md index 9978eb03..aa1ddb47 100644 --- a/docs/DeductLoyaltyPointsEffectProps.md +++ b/docs/DeductLoyaltyPointsEffectProps.md @@ -2,19 +2,19 @@ # DeductLoyaltyPointsEffectProps -The properties specific to the \"deductLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained a condition to only trigger when the given number of loyalty points could be deduced. These points are automatically stored and managed inside Talon.One. +This effect is triggered when a customer redeems loyalty points. The points are deducted from their active point balance. If the loyalty program is card-based, use the `cardIdentifier` property to identify the loyalty card from which these points are deducted. The Rule Engine deducts points in this order: - Points with the earliest expiry date are deducted first, regardless of when they were added. - Points with an unlimited expiry date are deducted last. - For points with an unlimited expiry date, the points awarded first are deducted first. The points only persist when the session is closed. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**ruleTitle** | **String** | The title of the rule that contained triggered this points deduction. | | -|**programId** | **Long** | The ID of the loyalty program where these points were added. | | -|**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. | | +|**programId** | **Long** | The ID of the loyalty program from which these points were deducted. | | +|**subLedgerId** | **String** | The ID of the subledger within the loyalty program from which these points were deducted. | | |**value** | **BigDecimal** | The amount of points that were deducted. | | -|**transactionUUID** | **String** | The identifier of this deduction in the loyalty ledger. | | -|**name** | **String** | The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. | | -|**cardIdentifier** | **String** | The card on which these points were added. | [optional] | +|**transactionUUID** | **String** | The identifier of this loyalty point transaction. | | +|**name** | **String** | The reason of this loyalty points deduction. | | +|**cardIdentifier** | **String** | The identifier of the card from which these points were deducted. | [optional] | diff --git a/docs/ErrorEffectProps.md b/docs/ErrorEffectProps.md index 66e54086..c074a1ed 100644 --- a/docs/ErrorEffectProps.md +++ b/docs/ErrorEffectProps.md @@ -2,7 +2,7 @@ # ErrorEffectProps -Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder. +This effect is triggered whenever an error occurs during rule evaluation. This effect only provides information about what the error is. ## Properties diff --git a/docs/Event.md b/docs/Event.md index 465ecd8d..549d45b9 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -13,7 +13,7 @@ |**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] | |**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] | |**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. | | -|**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**integrationId** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] | |**sessionId** | **String** | The ID of the session that this event occurred in. | [optional] | |**effects** | **List<Object>** | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | | diff --git a/docs/EventV3.md b/docs/EventV3.md index 852b1c43..b562f0a4 100644 --- a/docs/EventV3.md +++ b/docs/EventV3.md @@ -14,7 +14,7 @@ |**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] | |**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] | |**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. | | -|**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**integrationId** | **String** | The unique ID of the event. Only one event with this ID can be registered. | [optional] | |**effects** | **List<Object>** | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | | diff --git a/docs/ExperimentConfidenceTimeline.md b/docs/ExperimentConfidenceTimeline.md new file mode 100644 index 00000000..2e4c51e2 --- /dev/null +++ b/docs/ExperimentConfidenceTimeline.md @@ -0,0 +1,13 @@ + + +# ExperimentConfidenceTimeline + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**List<ExperimentConfidenceTimelineDataPoint>**](ExperimentConfidenceTimelineDataPoint.md) | Daily cumulative confidence values ordered chronologically from experiment start to end, or to today if the experiment is still running. Empty if the experiment has no data yet. | | + + + diff --git a/docs/ExperimentConfidenceTimelineDataPoint.md b/docs/ExperimentConfidenceTimelineDataPoint.md new file mode 100644 index 00000000..922961f9 --- /dev/null +++ b/docs/ExperimentConfidenceTimelineDataPoint.md @@ -0,0 +1,14 @@ + + +# ExperimentConfidenceTimelineDataPoint + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**date** | **OffsetDateTime** | The date-time this data point represents. | | +|**confidence** | [**ExperimentVariantResultConfidence**](ExperimentVariantResultConfidence.md) | | | + + + diff --git a/docs/Export.md b/docs/Export.md index 32803621..049f35b6 100644 --- a/docs/Export.md +++ b/docs/Export.md @@ -12,7 +12,7 @@ |**accountId** | **Long** | The ID of the account that owns this entity. | | |**userId** | **Long** | The ID of the user associated with this entity. | | |**entity** | [**EntityEnum**](#EntityEnum) | The name of the entity that was exported. | | -|**filter** | **Object** | Map of keys and values that were used to filter the exported rows. | | +|**filter** | **Object** | Arbitrary properties associated with this campaign. | | diff --git a/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md b/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md index f910a005..df08ed9b 100644 --- a/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +++ b/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md @@ -2,14 +2,14 @@ # ExtendLoyaltyPointsExpiryDateEffectProps -The properties specific to the \"extendLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"extend expiry date\" effect. The current expiry date gets extended by the time frame given in the effect. +If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**programId** | **Long** | ID of the loyalty program that contains these points. | | -|**subLedgerId** | **String** | API name of the loyalty program subledger that contains these points. added. | | +|**subLedgerId** | **String** | API name of the loyalty program subledger that contains these points. | | |**extensionDuration** | **String** | Time frame by which the expiry date extends. The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | | |**affectedTransactions** | [**List<LoyaltyLedgerEntryExpiryDateChange>**](LoyaltyLedgerEntryExpiryDateChange.md) | List of transactions affected by the expiry date update. | [optional] | diff --git a/docs/Giveaway.md b/docs/Giveaway.md index 22ac1b57..0ad01a85 100644 --- a/docs/Giveaway.md +++ b/docs/Giveaway.md @@ -13,7 +13,7 @@ |**poolId** | **Long** | The ID of the pool to return giveaway codes from. | | |**startDate** | **OffsetDateTime** | Timestamp at which point the giveaway becomes valid. | [optional] | |**endDate** | **OffsetDateTime** | Timestamp at which point the giveaway becomes invalid. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this giveaway. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**used** | **Boolean** | Indicates whether this giveaway code was given before. | [optional] | |**importId** | **Long** | The ID of the Import which created this giveaway. | [optional] | |**profileIntegrationId** | **String** | The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded. | [optional] | diff --git a/docs/IncreaseAchievementProgressEffectProps.md b/docs/IncreaseAchievementProgressEffectProps.md index 7c2d03d2..d1371918 100644 --- a/docs/IncreaseAchievementProgressEffectProps.md +++ b/docs/IncreaseAchievementProgressEffectProps.md @@ -2,7 +2,7 @@ # IncreaseAchievementProgressEffectProps -The properties specific to the \"increaseAchievementProgress\" effect. This gets triggered whenever a validated rule contained an \"increase customer progress\" effect. +This effect indicates that the customer's progress in an achievement was updated during the current session. It is triggered when a rule using the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect is successfully validated. For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), any customer progress exceeding the target automatically starts a new iteration. This generates a new `progressTrackerId` for each iteration, and there can be multiple progress updates for the same achievement from a single validation of this effect. ## Properties @@ -10,8 +10,8 @@ The properties specific to the \"increaseAchievementProgress\" effect. This gets |------------ | ------------- | ------------- | -------------| |**achievementId** | **Long** | The internal ID of the achievement. | | |**achievementName** | **String** | The name of the achievement. | | -|**progressTrackerId** | **Long** | The internal ID of the achievement progress tracker. | [optional] | -|**delta** | **BigDecimal** | The value by which the customer's current progress in the achievement is increased. | | +|**progressTrackerId** | **Long** | The internal ID of the customer progress tracker. For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. | [optional] | +|**delta** | **BigDecimal** | The value by which the customer's current progress in the achievement has increased. | | |**value** | **BigDecimal** | The current progress of the customer in the achievement. | | |**target** | **BigDecimal** | The target value to complete the achievement. | | |**isJustCompleted** | **Boolean** | Indicates if the customer has completed the achievement in the current session. | | diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index 8622db6b..f564aabd 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -20,6 +20,7 @@ All URIs are relative to *https://yourbaseurl.talon.one* | [**getCustomerAchievements**](IntegrationApi.md#getCustomerAchievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements | | [**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 | +| [**getEventV3**](IntegrationApi.md#getEventV3) | **GET** /v3/events/{integrationId} | Get advanced event | | [**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 | @@ -33,6 +34,7 @@ All URIs are relative to *https://yourbaseurl.talon.one* | [**returnCartItems**](IntegrationApi.md#returnCartItems) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items | | [**syncCatalog**](IntegrationApi.md#syncCatalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog | | [**trackEventV2**](IntegrationApi.md#trackEventV2) | **POST** /v2/events | Track event | +| [**trackEventV3**](IntegrationApi.md#trackEventV3) | **POST** /v3/events | Track advanced event | | [**unlinkLoyaltyCardFromProfile**](IntegrationApi.md#unlinkLoyaltyCardFromProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/unlink_profile | Unlink customer profile from a loyalty card | | [**updateAudienceCustomersAttributes**](IntegrationApi.md#updateAudienceCustomersAttributes) | **PUT** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience | | [**updateAudienceV2**](IntegrationApi.md#updateAudienceV2) | **PUT** /v2/audiences/{audienceId} | Update audience name | @@ -552,7 +554,7 @@ null (empty response body) Delete audience -Delete an audience created by a third-party integration. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). +Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). ### Example ```java @@ -1230,6 +1232,76 @@ public class Example { | **400** | Bad request | - | | **401** | Unauthorized - Invalid API key | - | + +# **getEventV3** +> EventV3 getEventV3(integrationId) + +Get advanced event + +Retrieve an advanced event by its identifier. + +### Example +```java +// Import classes: +import one.talon.ApiClient; +import one.talon.ApiException; +import one.talon.Configuration; +import one.talon.auth.*; +import one.talon.models.*; +import one.talon.api.IntegrationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://yourbaseurl.talon.one"); + + // Configure API key authorization: api_key_v1 + ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1"); + api_key_v1.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //api_key_v1.setApiKeyPrefix("Token"); + + IntegrationApi apiInstance = new IntegrationApi(defaultClient); + String integrationId = "integrationId_example"; // String | The unique ID of the advanced event. + try { + EventV3 result = apiInstance.getEventV3(integrationId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IntegrationApi#getEventV3"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **integrationId** | **String**| The unique ID of the advanced event. | | + +### Return type + +[**EventV3**](EventV3.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | OK | - | +| **404** | Not found | - | + # **getLoyaltyBalances** > LoyaltyBalancesWithTiers getLoyaltyBalances(loyaltyProgramId, integrationId, endDate, subledgerId, includeTiers, includeProjectedTier) @@ -1603,7 +1675,7 @@ public class Example { Long loyaltyProgramId = 56L; // Long | 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. String integrationId = "integrationId_example"; // String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. String status = "active"; // String | Filter points based on their status. - String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data. + List subledgerId = Arrays.asList(); // List | Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. List customerSessionIDs = Arrays.asList(); // List | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. List transactionUUIDs = Arrays.asList(); // List | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. Long pageSize = 50L; // Long | The number of items in the response. @@ -1630,7 +1702,7 @@ public class Example { | **loyaltyProgramId** | **Long**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | | | **integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | | | **status** | **String**| Filter points based on their status. | [optional] [default to active] [enum: active, pending, expired] | -| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] | +| **subledgerId** | [**List<String>**](String.md)| Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. | [optional] | | **customerSessionIDs** | [**List<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional] | | **transactionUUIDs** | [**List<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional] | | **pageSize** | **Long**| The number of items in the response. | [optional] [default to 50] | @@ -2210,7 +2282,7 @@ public class Example { Track event -Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. +Trigger a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. ### Example ```java @@ -2283,6 +2355,84 @@ public class Example { | **401** | Unauthorized - Invalid API key | - | | **409** | Too many requests or limit reached - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - | + +# **trackEventV3** +> IntegrationEventV3Response trackEventV3(integrationEventV3Request, silent, dry, forceCompleteEvaluation) + +Track advanced event + +Trigger an advanced event. Advanced events are idempotent, uniquely identifiable events. They can also reference a previously closed session to add more context for rule evaluation. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + +### Example +```java +// Import classes: +import one.talon.ApiClient; +import one.talon.ApiException; +import one.talon.Configuration; +import one.talon.auth.*; +import one.talon.models.*; +import one.talon.api.IntegrationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://yourbaseurl.talon.one"); + + // Configure API key authorization: api_key_v1 + ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1"); + api_key_v1.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //api_key_v1.setApiKeyPrefix("Token"); + + IntegrationApi apiInstance = new IntegrationApi(defaultClient); + IntegrationEventV3Request integrationEventV3Request = new IntegrationEventV3Request(); // IntegrationEventV3Request | body + String silent = "yes"; // String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. + Boolean dry = true; // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. + Boolean forceCompleteEvaluation = false; // Boolean | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. + try { + IntegrationEventV3Response result = apiInstance.trackEventV3(integrationEventV3Request, silent, dry, forceCompleteEvaluation); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IntegrationApi#trackEventV3"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **integrationEventV3Request** | [**IntegrationEventV3Request**](IntegrationEventV3Request.md)| body | | +| **silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to yes] | +| **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional] | +| **forceCompleteEvaluation** | **Boolean**| Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. | [optional] [default to false] | + +### Return type + +[**IntegrationEventV3Response**](IntegrationEventV3Response.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | OK | - | +| **400** | Bad request | - | +| **401** | Unauthorized - Invalid API key | - | +| **409** | An advanced event already exists, too many requests, or limit reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - | + # **unlinkLoyaltyCardFromProfile** > LoyaltyCard unlinkLoyaltyCardFromProfile(loyaltyProgramId, loyaltyCardId, loyaltyCardRegistration) diff --git a/docs/IntegrationEvent.md b/docs/IntegrationEvent.md index 60e7fc63..79ab865e 100644 --- a/docs/IntegrationEvent.md +++ b/docs/IntegrationEvent.md @@ -10,7 +10,7 @@ |**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] | |**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] | |**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. | | -|**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | diff --git a/docs/IntegrationHubEventPayloadCouponBasedNotifications.md b/docs/IntegrationHubEventPayloadCouponBasedNotifications.md index d593dce8..b1379377 100644 --- a/docs/IntegrationHubEventPayloadCouponBasedNotifications.md +++ b/docs/IntegrationHubEventPayloadCouponBasedNotifications.md @@ -23,7 +23,7 @@ |**recipientIntegrationId** | **String** | | [optional] | |**importId** | **Long** | | [optional] | |**batchId** | **String** | | [optional] | -|**attributes** | **Object** | | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**limits** | [**List<IntegrationHubEventPayloadCouponBasedNotificationsLimits>**](IntegrationHubEventPayloadCouponBasedNotificationsLimits.md) | | [optional] | |**publishedAt** | **OffsetDateTime** | Timestamp when the event was published. | | |**sourceOfEvent** | **String** | | | diff --git a/docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md b/docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md deleted file mode 100644 index 25c2f5ea..00000000 --- a/docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# IntegrationHubEventPayloadLoyaltyProfileBasedNotification - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**profileIntegrationID** | **String** | | | -|**loyaltyProgramID** | **Long** | | | -|**loyaltyProgramName** | **String** | The name of the loyalty program. | | -|**subledgerID** | **String** | | | -|**sourceOfEvent** | **String** | | | -|**currentTier** | **String** | The name of the customer's current tier. | | -|**employeeName** | **String** | | [optional] | -|**userID** | **Long** | | [optional] | -|**currentPoints** | **Float** | | | -|**actions** | [**List<IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction>**](IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md) | | [optional] | -|**publishedAt** | **OffsetDateTime** | Timestamp when the event was published. | | -|**oldTier** | **String** | | [optional] | -|**tierExpirationDate** | **OffsetDateTime** | | [optional] | -|**timestampOfTierChange** | **OffsetDateTime** | | [optional] | -|**pointsRequiredToTheNextTier** | **Float** | | [optional] | -|**nextTier** | **String** | | [optional] | - - - diff --git a/docs/IntegrationHubEventRecord.md b/docs/IntegrationHubEventRecord.md index fdd28b2d..537cb541 100644 --- a/docs/IntegrationHubEventRecord.md +++ b/docs/IntegrationHubEventRecord.md @@ -7,15 +7,17 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**id** | **Long** | | | -|**flowId** | **Long** | | | -|**eventType** | **String** | | | -|**eventData** | **Object** | | | -|**publishedAt** | **OffsetDateTime** | | | -|**processedAt** | **OffsetDateTime** | | [optional] | -|**deliveredAt** | **OffsetDateTime** | | [optional] | -|**processAfter** | **OffsetDateTime** | | | -|**retry** | **Long** | | | +|**id** | **Long** | ID of the event record. | | +|**flowId** | **Long** | ID of the integration hub flow. | | +|**integrationName** | **String** | Name of the integration. | [optional] | +|**instanceName** | **String** | Name of the integration instance. | [optional] | +|**eventType** | **IntegrationHubEventType** | | | +|**publishedAt** | **OffsetDateTime** | Timestamp when the event was published. | | +|**processedAt** | **OffsetDateTime** | Timestamp when the event was processed. | [optional] | +|**deliveredAt** | **OffsetDateTime** | Timestamp when the event was delivered. | [optional] | +|**scheduledTo** | **OffsetDateTime** | Timestamp after which the event is scheduled to be processed. | | +|**retry** | **Long** | Number of delivery retries attempted. | | +|**payload** | **String** | The event payload as a formatted JSON string. | | diff --git a/docs/IntegrationHubEventType.md b/docs/IntegrationHubEventType.md new file mode 100644 index 00000000..84619a44 --- /dev/null +++ b/docs/IntegrationHubEventType.md @@ -0,0 +1,21 @@ + + +# IntegrationHubEventType + +## Enum + + +* `LOYALTY_POINTS_CHANGED` (value: `"LoyaltyPointsChanged"`) + +* `LOYALTY_TIER_DOWNGRADE` (value: `"LoyaltyTierDowngrade"`) + +* `LOYALTY_TIER_UPGRADE` (value: `"LoyaltyTierUpgrade"`) + +* `COUPON_CREATED` (value: `"CouponCreated"`) + +* `COUPON_UPDATED` (value: `"CouponUpdated"`) + +* `COUPON_DELETED` (value: `"CouponDeleted"`) + + + diff --git a/docs/IntegrationHubFlow.md b/docs/IntegrationHubFlow.md index 3b3a890c..cb234cc0 100644 --- a/docs/IntegrationHubFlow.md +++ b/docs/IntegrationHubFlow.md @@ -7,8 +7,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**applicationID** | **Long** | ID of application the flow is registered for. | [optional] | -|**eventType** | **String** | The event type we want to register a flow for. | | +|**applicationID** | **Long** | ID of the application the flow is registered for. | [optional] | +|**loyaltyProgramID** | **Long** | ID of the loyalty program the flow is registered for. | [optional] | +|**eventType** | **IntegrationHubEventType** | | | |**integrationHubFlowUrl** | **String** | The URL of the integration hub flow that we want to trigger for the event. | | diff --git a/docs/IntegrationHubFlowResponse.md b/docs/IntegrationHubFlowResponse.md index 71f2c648..e59132d5 100644 --- a/docs/IntegrationHubFlowResponse.md +++ b/docs/IntegrationHubFlowResponse.md @@ -8,7 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**id** | **Long** | ID of the integration hub flow. | | -|**applicationID** | **Long** | ID of application the flow is registered for. | [optional] | +|**integrationName** | **String** | Name of the integration. | [optional] | +|**instanceName** | **String** | Name of the integration instance. | [optional] | +|**createdAt** | **OffsetDateTime** | Timestamp when the flow was created. | | +|**disabledUntil** | **OffsetDateTime** | Timestamp until which the flow is disabled. Null when the flow is active. | [optional] | +|**applicationId** | **Long** | ID of the application the flow is registered for. | [optional] | +|**loyaltyProgramId** | **Long** | ID of the loyalty program the flow is registered for. | [optional] | |**eventType** | **String** | The event type we want to register a flow for. | | |**integrationHubFlowUrl** | **String** | The URL of the integration hub flow that we want to trigger for the event. | | |**config** | [**IntegrationHubFlowConfigResponse**](IntegrationHubFlowConfigResponse.md) | | | diff --git a/docs/IntegrationHubFlowWithConfig.md b/docs/IntegrationHubFlowWithConfig.md index 99c9b4ce..d3f46099 100644 --- a/docs/IntegrationHubFlowWithConfig.md +++ b/docs/IntegrationHubFlowWithConfig.md @@ -7,8 +7,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**applicationID** | **Long** | ID of application the flow is registered for. | [optional] | -|**eventType** | **String** | The event type we want to register a flow for. | | +|**applicationID** | **Long** | ID of the application the flow is registered for. | [optional] | +|**loyaltyProgramID** | **Long** | ID of the loyalty program the flow is registered for. | [optional] | +|**eventType** | **IntegrationHubEventType** | | | |**integrationHubFlowUrl** | **String** | The URL of the integration hub flow that we want to trigger for the event. | | |**config** | [**IntegrationHubFlowConfig**](IntegrationHubFlowConfig.md) | | | diff --git a/docs/IntegrationHubPaginatedEventPayload.md b/docs/IntegrationHubPaginatedEventPayload.md index 0d209ba3..e808d060 100644 --- a/docs/IntegrationHubPaginatedEventPayload.md +++ b/docs/IntegrationHubPaginatedEventPayload.md @@ -9,21 +9,8 @@ |------------ | ------------- | ------------- | -------------| |**totalResultSize** | **Long** | | | |**batchedAt** | **OffsetDateTime** | Timestamp when the batch was created. | [optional] | -|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | | | +|**eventType** | **IntegrationHubEventType** | | | |**data** | **List<Object>** | | | -## Enum: EventTypeEnum - -| Name | Value | -|---- | -----| -| LOYALTY_POINTS_CHANGED | "LoyaltyPointsChanged" | -| LOYALTY_TIER_DOWNGRADE | "LoyaltyTierDowngrade" | -| LOYALTY_TIER_UPGRADE | "LoyaltyTierUpgrade" | -| COUPON_CREATED | "CouponCreated" | -| COUPON_UPDATED | "CouponUpdated" | -| COUPON_DELETED | "CouponDeleted" | - - - diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md index c6b084f9..eb1cfc0a 100644 --- a/docs/InventoryReferral.md +++ b/docs/InventoryReferral.md @@ -15,7 +15,7 @@ |**campaignId** | **Long** | ID of the campaign from which the referral received the referral code. | | |**advocateProfileIntegrationId** | **String** | The Integration ID of the Advocate's Profile. | | |**friendProfileIntegrationId** | **String** | An optional Integration ID of the Friend's Profile. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**importId** | **Long** | The ID of the Import which created this referral. | [optional] | |**code** | **String** | The referral code. | | |**usageCounter** | **Long** | The number of times this referral code has been successfully used. | | diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index 64f2ab7c..e52489f2 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -138,6 +138,7 @@ All URIs are relative to *https://yourbaseurl.talon.one* | [**importCoupons**](ManagementApi.md#importCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons | | [**importLoyaltyCards**](ManagementApi.md#importLoyaltyCards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards | | [**importLoyaltyCustomersTiers**](ManagementApi.md#importLoyaltyCustomersTiers) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers | +| [**importLoyaltyJoinDates**](ManagementApi.md#importLoyaltyJoinDates) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_join_dates | Import join dates for a loyalty program | | [**importLoyaltyPoints**](ManagementApi.md#importLoyaltyPoints) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points | | [**importPoolGiveaways**](ManagementApi.md#importPoolGiveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool | | [**importReferrals**](ManagementApi.md#importReferrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals | @@ -3562,7 +3563,7 @@ public class Example { # **exportCustomerSessions** -> String exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState) +> String exportCustomerSessions(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState) Export customer sessions @@ -3593,11 +3594,13 @@ public class Example { Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL. OffsetDateTime createdBefore = OffsetDateTime.now(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. OffsetDateTime createdAfter = OffsetDateTime.now(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. + OffsetDateTime updatedBefore = OffsetDateTime.now(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. + OffsetDateTime updatedAfter = OffsetDateTime.now(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. String profileIntegrationId = "profileIntegrationId_example"; // String | Only return sessions for the customer that matches this customer integration ID. String dateFormat = "excel"; // String | Determines the format of dates in the export document. String customerSessionState = "open"; // String | Filter results by state. try { - String result = apiInstance.exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState); + String result = apiInstance.exportCustomerSessions(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ManagementApi#exportCustomerSessions"); @@ -3617,6 +3620,8 @@ public class Example { | **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | | | **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional] | | **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional] | +| **updatedBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional] | +| **updatedAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional] | | **profileIntegrationId** | **String**| Only return sessions for the customer that matches this customer integration ID. | [optional] | | **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] | | **customerSessionState** | **String**| Filter results by state. | [optional] [enum: open, closed, partially_returned, cancelled] | @@ -4099,7 +4104,7 @@ public class Example { Export loyalty cards -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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. +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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. ### Example ```java @@ -6323,7 +6328,7 @@ public class Example { //api_key_v1.setApiKeyPrefix("Token"); ManagementApi apiInstance = new ManagementApi(defaultClient); - String audienceIds = "audienceIds_example"; // String | The IDs of one or more audiences, separated by commas, by which to filter results. + String audienceIds = "audienceIds_example"; // String | The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. 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:** You may not be able to use all fields for sorting. This is due to performance limitations. try { GetAudiencesAnalytics200Response result = apiInstance.getAudiencesAnalytics(audienceIds, sort); @@ -6343,7 +6348,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **audienceIds** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. | | +| **audienceIds** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. | | | **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:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional] | ### Return type @@ -10182,7 +10187,7 @@ public class Example { Import loyalty cards -Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` +Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids,attributes 123-456-789AT,active,Alexa001;UserA,'{\"\"my_attributes\"\": \"\"10_off\"\"}\" ``` ### Example ```java @@ -10323,6 +10328,80 @@ public class Example { | **401** | Unauthorized | - | | **404** | Not found | - | + +# **importLoyaltyJoinDates** +> ModelImport importLoyaltyJoinDates(loyaltyProgramId, upFile) + +Import join dates for a loyalty program + +Upload a CSV file containing customer profile IDs and their join dates for the specified loyalty program. Send the file as multipart data. > [!important] This endpoint only works with profile-based loyalty programs. The CSV file **must** contain the following columns: - `customerprofileid`: The integration ID of the customer profile whose join date you want to update. - `newjoindate`: The new join date for the customer in RFC3339 format. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note**: - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. - If a join date already exists for a profile, the uploaded date replaces it. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv customerprofileid,newjoindate customer1,2024-03-21T07:32:14Z customer2,2025-04-16T21:12:37Z customer3,2026-05-03T11:47:01Z ``` + +### Example +```java +// Import classes: +import one.talon.ApiClient; +import one.talon.ApiException; +import one.talon.Configuration; +import one.talon.auth.*; +import one.talon.models.*; +import one.talon.api.ManagementApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://yourbaseurl.talon.one"); + + // Configure API key authorization: api_key_v1 + ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1"); + api_key_v1.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //api_key_v1.setApiKeyPrefix("Token"); + + ManagementApi apiInstance = new ManagementApi(defaultClient); + Long loyaltyProgramId = 56L; // Long | 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. + File upFile = new File("/path/to/file"); // File | The CSV file containing the data that is being imported. + try { + ModelImport result = apiInstance.importLoyaltyJoinDates(loyaltyProgramId, upFile); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ManagementApi#importLoyaltyJoinDates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **loyaltyProgramId** | **Long**| 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. | | +| **upFile** | **File**| The CSV file containing the data that is being imported. | [optional] | + +### Return type + +[**ModelImport**](ModelImport.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | OK | - | +| **400** | Bad request | - | +| **401** | Unauthorized | - | +| **404** | Not found | - | + # **importLoyaltyPoints** > ModelImport importLoyaltyPoints(loyaltyProgramId, notificationsEnabled, upFile) @@ -10832,7 +10911,7 @@ This endpoint does not need any parameter. # **listApplicationCartItemFilters** -> ListApplicationCartItemFilters200Response listApplicationCartItemFilters(applicationId, pageSize, skip, title) +> ListApplicationCartItemFilters200Response listApplicationCartItemFilters(applicationId, pageSize, skip, name) List Application cart item filters @@ -10863,9 +10942,9 @@ public class Example { Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL. Long pageSize = 50L; // Long | The number of items in the response. Long skip = 56L; // Long | The number of items to skip when paging through large result sets. - String title = "title_example"; // String | Filter by the display name of the Application cart item filter in the Application. **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. + String name = "name_example"; // String | Filter by the display name of the Application cart item filter in the Application. **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. try { - ListApplicationCartItemFilters200Response result = apiInstance.listApplicationCartItemFilters(applicationId, pageSize, skip, title); + ListApplicationCartItemFilters200Response result = apiInstance.listApplicationCartItemFilters(applicationId, pageSize, skip, name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ManagementApi#listApplicationCartItemFilters"); @@ -10885,7 +10964,7 @@ public class Example { | **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | | | **pageSize** | **Long**| The number of items in the response. | [optional] [default to 50] | | **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] | -| **title** | **String**| Filter by the display name of the Application cart item filter in the Application. **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. | [optional] | +| **name** | **String**| Filter by the display name of the Application cart item filter in the Application. **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. | [optional] | ### Return type diff --git a/docs/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index 2dad1263..2ffdc458 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -14,7 +14,7 @@ |**expiryDate** | **OffsetDateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] | |**numberOfCoupons** | **Long** | The number of new coupon codes to generate for the campaign. | | |**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with coupons. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] | diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index 5e6b2ebb..05376a9f 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -15,7 +15,7 @@ |**limits** | [**List<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] | |**numberOfCoupons** | **Long** | The number of new coupon codes to generate for the campaign. Must be at least 1. | | |**uniquePrefix** | **String** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#tag/Coupons/operation/createCouponsAsync) endpoint. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**recipientIntegrationId** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional] | |**validCharacters** | **List<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] | |**couponPattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] | diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index c72e22ce..ceaf8d37 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -12,7 +12,7 @@ |**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional] | |**startDate** | **OffsetDateTime** | Timestamp at which point the coupon becomes valid. | [optional] | |**expiryDate** | **OffsetDateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**recipientsIntegrationIds** | **List<String>** | The integration IDs for recipients. | | |**validCharacters** | **List<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] | |**couponPattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] | diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index 3ff53347..4acc06f8 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -14,7 +14,7 @@ |**cartItems** | [**List<CartItem>**](CartItem.md) | Serialized JSON representation. | [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). | [optional] | |**total** | **BigDecimal** | The total sum of the cart in one session. | [optional] | -|**attributes** | **Object** | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | diff --git a/docs/NewEvent.md b/docs/NewEvent.md index 97338c18..70cf243c 100644 --- a/docs/NewEvent.md +++ b/docs/NewEvent.md @@ -10,7 +10,7 @@ |**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] | |**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] | |**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. | | -|**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | | |**sessionId** | **String** | The ID of the session that this event occurred in. | | diff --git a/docs/NewReferral.md b/docs/NewReferral.md index 1192dba6..30c69d35 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -13,7 +13,7 @@ |**campaignId** | **Long** | ID of the campaign from which the referral received the referral code. | | |**advocateProfileIntegrationId** | **String** | The Integration ID of the Advocate's Profile. | | |**friendProfileIntegrationId** | **String** | An optional Integration ID of the Friend's Profile. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index 1cafb6e9..c7f6ecad 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -12,7 +12,7 @@ |**usageLimit** | **Long** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional] | |**campaignId** | **Long** | The ID of the campaign from which the referral received the referral code. | | |**advocateProfileIntegrationIds** | **List<String>** | An array containing all the respective advocate profiles. | | -|**attributes** | **Object** | Arbitrary properties associated with this referral code. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**validCharacters** | **List<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] | |**referralPattern** | **String** | The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] | diff --git a/docs/RedeemReferralEffectProps.md b/docs/RedeemReferralEffectProps.md index 66967544..f66c920e 100644 --- a/docs/RedeemReferralEffectProps.md +++ b/docs/RedeemReferralEffectProps.md @@ -2,7 +2,7 @@ # RedeemReferralEffectProps -This effect is **deprecated**. The properties specific to the \"redeemReferral\" effect. This gets triggered whenever the referral code is valid, and a rule was triggered that contains a \"redeem referral\" effect. +This effect is **deprecated**. It has been replaced by the `acceptReferral` effect. This effect indicates that the referral code is valid and has been redeemed. ## Properties diff --git a/docs/Referral.md b/docs/Referral.md index 88be0d8f..8d8092f8 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -15,7 +15,7 @@ |**campaignId** | **Long** | ID of the campaign from which the referral received the referral code. | | |**advocateProfileIntegrationId** | **String** | The Integration ID of the Advocate's Profile. | | |**friendProfileIntegrationId** | **String** | An optional Integration ID of the Friend's Profile. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**importId** | **Long** | The ID of the Import which created this referral. | [optional] | |**code** | **String** | The referral code. | | |**usageCounter** | **Long** | The number of times this referral code has been successfully used. | | diff --git a/docs/ReferralCreatedEffectProps.md b/docs/ReferralCreatedEffectProps.md index b063d474..a65ad0a1 100644 --- a/docs/ReferralCreatedEffectProps.md +++ b/docs/ReferralCreatedEffectProps.md @@ -2,13 +2,13 @@ # ReferralCreatedEffectProps -The properties specific to the \"referralCreated\" effect. This gets triggered whenever a validated rule contained a \"create referral\" effect, and a referral code was created for a customer. See \"createdReferrals\" on the response for all details of this referral code. +The `referralCreated` effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effects#couponcreated). If the `friendProfileIntegrationId` parameter is empty, the referral code can be redeemed by anyone. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**value** | **String** | The referral code that was created. | | +|**value** | **String** | The referral code provided in the session. | | diff --git a/docs/RejectCouponEffectProps.md b/docs/RejectCouponEffectProps.md index 5b53d30e..f363d1fa 100644 --- a/docs/RejectCouponEffectProps.md +++ b/docs/RejectCouponEffectProps.md @@ -2,18 +2,18 @@ # RejectCouponEffectProps -The properties specific to the \"rejectCoupon\" effect. This gets triggered whenever the coupon was rejected. See rejectionReason for more info on why. +This effect indicates that the coupon code supplied couldn't be used. You should handle this effect by informing their user the coupon code is invalid. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**value** | **String** | The coupon code that was rejected. | | -|**rejectionReason** | **String** | The reason why this coupon was rejected. | | +|**rejectionReason** | **String** | The reason why the code was rejected. - `CampaignLimitReached`: The campaign-wide coupon code redemption limit has been reached. - `CouponExpired`: The coupon is expired. - `CouponLimitReached`: The coupon redemption limit or a campaign budget was reached. - `CouponNotFound`: The coupon code is incorrect. - `CouponPartOfNotRunningCampaign`: The campaign the coupon belongs to is currently not active. The campaignId field contains the ID of that campaign. - `CouponRecipientDoesNotMatch`: The given coupon value does not match the recipient or the coupon is linked to a `recipientIntegrationID` but there is no profile in the session. - `CouponRejectedByCondition`: Other conditions failed in the rule or all conditions passed but the `Coupon code is valid` condition is not present. - `CouponStartDateInFuture`: The coupon isn't active yet. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` cannot be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific coupon redemption limit has been reached. - `CouponPartOfNotTriggeredCampaign`: The campaign the coupon belongs to was not triggered during evaluation (an exclusive or stackable campaign). The `campaignId` field contains the ID of that campaign. - `CouponReservationRequired`: The coupon's `isReservationMandatory` property is `true`, but the profile does not have a reservation. - `ProfileRequired`: The coupon's `isReservationMandatory` property is `true` or a [campaign profile budget](https://docs.talon.one/docs/product/campaigns/settings/manage-campaign-budgets) was set, but no profile exists in the session. | | |**conditionIndex** | **Long** | The index of the condition that caused the rejection of the coupon. | [optional] | |**effectIndex** | **Long** | The index of the effect that caused the rejection of the coupon. | [optional] | |**details** | **String** | More details about the failure. | [optional] | -|**campaignExclusionReason** | **String** | The reason why the campaign was not applied. | [optional] | +|**campaignExclusionReason** | **String** | The reason why the campaign the coupon belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and coupon conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the coupon is part of an archived campaign. | [optional] | diff --git a/docs/RejectReferralEffectProps.md b/docs/RejectReferralEffectProps.md index 5acb6c1f..a4a31c65 100644 --- a/docs/RejectReferralEffectProps.md +++ b/docs/RejectReferralEffectProps.md @@ -2,18 +2,18 @@ # RejectReferralEffectProps -The properties specific to the \"rejectReferral\" effect. This gets triggered whenever the referral code was rejected. See rejectionReason for more info on why. +This effect indicates that the provided referral code is invalid. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**value** | **String** | The referral code that was rejected. | | -|**rejectionReason** | **String** | The reason why this referral code was rejected. | | +|**value** | **String** | The referral code that was rejected | | +|**rejectionReason** | **String** | The reason why the code was rejected. - `AdvocateNotFound`: The advocate was not found. - `CampaignLimitReached`: The campaign-wide referral code redemption limit has been reached. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` can not be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific referral code redemption limit has been reached. - `ReferralCustomerAlreadyReferred`: The friend is already referred. - `ReferralExpired`: The transferred referral code is expired. - `ReferralLimitReached`: The referral code redemption limit has been reached. - `ReferralNotFound`: The transferred referral code is wrong. - `ReferralPartOfNotRunningCampaign`: The campaign the referral code belongs to is currently not active. The campaign ID field shows the ID of that campaign. - `ReferralRecipientDoesNotMatch`: The given referral code value does not match the recipient. - `ReferralRecipientIdSameAsAdvocate`: The recipient (friend) has the same id as the advocate. - `ReferralRejectedByCondition`: The referral code is valid and in an active campaign, but there were other conditions in that campaign's rules that were not met. - `ReferralStartDateInFuture`: The transferred referral code isn't active yet. - `ReferralPartOfNotTriggeredCampaign`: The campaign the referral code belongs to was not triggered during evaluation (an exclusive or stackable campaign). The campaign ID field shows the ID of that campaign. | | |**conditionIndex** | **Long** | The index of the condition that caused the rejection of the referral. | [optional] | |**effectIndex** | **Long** | The index of the effect that caused the rejection of the referral. | [optional] | |**details** | **String** | More details about the failure. | [optional] | -|**campaignExclusionReason** | **String** | The reason why the campaign was not applied. | [optional] | +|**campaignExclusionReason** | **String** | The reason why the campaign the referral belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and referral conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the referral is part of an archived campaign. | [optional] | diff --git a/docs/RemoveFromAudienceEffectProps.md b/docs/RemoveFromAudienceEffectProps.md index d4cd45a1..fe5af524 100644 --- a/docs/RemoveFromAudienceEffectProps.md +++ b/docs/RemoveFromAudienceEffectProps.md @@ -2,7 +2,7 @@ # RemoveFromAudienceEffectProps -The properties specific to the \"removeFromAudience\" effect. This gets triggered whenever a validated rule contains a \"removeFromAudience\" effect. +This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Remove customer from an audience** selected is validated. It indicates that a customer was removed from an audience and is returned when a customer session is opened, updated, or closed. ## Properties diff --git a/docs/ReserveCouponEffectProps.md b/docs/ReserveCouponEffectProps.md index c1d44d2b..a8292ced 100644 --- a/docs/ReserveCouponEffectProps.md +++ b/docs/ReserveCouponEffectProps.md @@ -2,14 +2,14 @@ # ReserveCouponEffectProps -The properties specific to the \"reserveCoupon\" effect. This gets triggered whenever a validated rule contained a \"reserve coupon\" effect. This reserves the coupon currently on scope to the profile on scope. +This effect indicates that the given coupon code was reserved for the given customer. Talon.One provides soft and hard reservations. For more information, see [Reserve a coupon code](https://docs.talon.one/docs/product/rules/effects/use-effects#reserve-a-coupon-code). ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**couponValue** | **String** | The value of the coupon currently on scope. | | -|**profileIntegrationId** | **String** | The ID of this customer profile in the third-party integration. | | +|**couponValue** | **String** | The coupon code that was created. | | +|**profileIntegrationId** | **String** | The integration identifier of the customer for whom this coupon was reserved. | | |**isNewReservation** | **Boolean** | Indicates whether this is a new coupon reservation or not. | | diff --git a/docs/RoleV2ApplicationDetails.md b/docs/RoleV2ApplicationDetails.md index ba01fb72..285b8194 100644 --- a/docs/RoleV2ApplicationDetails.md +++ b/docs/RoleV2ApplicationDetails.md @@ -11,7 +11,6 @@ |**campaign** | **String** | Name of the campaign-related permission set for the given Application. | [optional] | |**draftCampaign** | **String** | Name of the draft campaign-related permission set for the given Application. | [optional] | |**tools** | **String** | Name of the tools-related permission set. | [optional] | -|**thresholds** | [**RolesV2Thresholds**](RolesV2Thresholds.md) | Support user limits for actions that require admin approval within the given application. | [optional] | diff --git a/docs/RoleV2Permissions.md b/docs/RoleV2Permissions.md index 6972489f..60b04129 100644 --- a/docs/RoleV2Permissions.md +++ b/docs/RoleV2Permissions.md @@ -9,6 +9,7 @@ |------------ | ------------- | ------------- | -------------| |**permissionSets** | [**List<RoleV2PermissionSet>**](RoleV2PermissionSet.md) | List of grouped logical operations referenced by roles. | [optional] | |**roles** | [**RoleV2RolesGroup**](RoleV2RolesGroup.md) | | [optional] | +|**thresholds** | [**List<RolesV2Thresholds>**](RolesV2Thresholds.md) | Support user limits for actions that require admin approval within the given application. | [optional] | diff --git a/docs/RolesV2Thresholds.md b/docs/RolesV2Thresholds.md index 9a054129..22006398 100644 --- a/docs/RolesV2Thresholds.md +++ b/docs/RolesV2Thresholds.md @@ -7,6 +7,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +|**loyaltyProgramId** | **Long** | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | [optional] | |**loyaltyPointsLimit** | **Long** | Maximum number of loyalty points a support user can award without approval. | [optional] | diff --git a/docs/RollbackAddedLoyaltyPointsEffectProps.md b/docs/RollbackAddedLoyaltyPointsEffectProps.md index db3b3c7b..1b6dd3ac 100644 --- a/docs/RollbackAddedLoyaltyPointsEffectProps.md +++ b/docs/RollbackAddedLoyaltyPointsEffectProps.md @@ -2,20 +2,20 @@ # RollbackAddedLoyaltyPointsEffectProps -The properties specific to the \"rollbackAddedLoyaltyPoints\" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is cancelled. +This effect is triggered in the following cases: - A session was cancelled in which loyalty points have been added. - A session was partially returned and loyalty point were added by the returned items. See [returning items](https://docs.talon.one/docs/dev/tutorials/partially-return-a-session). If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which items the loyalty points were rolled back for. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user for whom the loyalty points are rolled back. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points were originally added. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**programId** | **Long** | The ID of the loyalty program where the points were originally added. | | -|**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were originally added. | | +|**programId** | **Long** | The ID of the loyalty program where these points were rolled back. | | +|**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were rolled back. | | |**value** | **BigDecimal** | The amount of points that were rolled back. | | -|**recipientIntegrationId** | **String** | The user for whom these points were originally added. | | -|**transactionUUID** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. | | -|**cartItemPosition** | **BigDecimal** | The index of the item in the cart items for which the loyalty points were rolled back. | [optional] | -|**cartItemSubPosition** | **BigDecimal** | For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back. | [optional] | -|**cardIdentifier** | **String** | The card on which these points were originally added. | [optional] | +|**recipientIntegrationId** | **String** | The user for whom these points were rolled back. | | +|**transactionUUID** | **String** | The identifier of this loyalty point transaction. | | +|**cartItemPosition** | **BigDecimal** | (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were rolled back. | [optional] | +|**cartItemSubPosition** | **BigDecimal** | (_Add points per cart item_ ) The index of the item unit in its line item. | [optional] | +|**cardIdentifier** | **String** | The identifier of the card on which these points were originally added. | [optional] | diff --git a/docs/RollbackCouponEffectProps.md b/docs/RollbackCouponEffectProps.md index 8d3241fa..0931b6d1 100644 --- a/docs/RollbackCouponEffectProps.md +++ b/docs/RollbackCouponEffectProps.md @@ -2,13 +2,13 @@ # RollbackCouponEffectProps -The properties specific to the \"rollbackCoupon\" effect. This gets triggered whenever previously closed session is now cancelled and a coupon redemption was cancelled on our internal usage limit counters. +This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. The effect is triggered when you [cancel](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state) a session where a coupon was accepted. See an example of use in the [cancelling a session tutorial](https://docs.talon.one/docs/dev/tutorials/roll-back-effects). ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**value** | **String** | The coupon code whose usage has been rolled back. | | +|**value** | **String** | The coupon code whose redemption has been rolled back. | | diff --git a/docs/RollbackDeductedLoyaltyPointsEffectProps.md b/docs/RollbackDeductedLoyaltyPointsEffectProps.md index 7e6a8b00..842447b1 100644 --- a/docs/RollbackDeductedLoyaltyPointsEffectProps.md +++ b/docs/RollbackDeductedLoyaltyPointsEffectProps.md @@ -2,7 +2,7 @@ # RollbackDeductedLoyaltyPointsEffectProps -The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This effect is triggered whenever a previously closed session is cancelled and a deductLoyaltyPoints effect was revoked. +This effect is triggered in the following cases: - A session is _cancelled_ and this session deducted loyalty points. The rollback action returns the redeemed loyalty points to the customer. - A session is impacted by a _partial return_. Only added loyalty points that are still **pending** are rolled back. - A session in which loyalty points were spent is reopened. See the [session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). If you set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/profile-based/profile-based-overview), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points are reimbursed. ## Properties @@ -10,12 +10,12 @@ The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This ef |------------ | ------------- | ------------- | -------------| |**programId** | **Long** | The ID of the loyalty program where these points were reimbursed. | | |**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were reimbursed. | | -|**value** | **BigDecimal** | The amount of reimbursed points that were added. | | +|**value** | **BigDecimal** | The amount of points that were reimbursed. | | |**recipientIntegrationId** | **String** | The user for whom these points were reimbursed. | | -|**startDate** | **OffsetDateTime** | Date after which the reimbursed points will be valid. | [optional] | -|**expiryDate** | **OffsetDateTime** | Date after which the reimbursed points will expire. | [optional] | -|**transactionUUID** | **String** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back. | | -|**cardIdentifier** | **String** | The card on which these points were added. | [optional] | +|**startDate** | **OffsetDateTime** | The date after which the reimbursed points will be valid. | [optional] | +|**expiryDate** | **OffsetDateTime** | The date after which the reimbursed points will expire. | [optional] | +|**transactionUUID** | **String** | The identifier of this loyalty point transaction. | | +|**cardIdentifier** | **String** | The identifier of the card from which these points were originally deducted. | [optional] | diff --git a/docs/RollbackDiscountEffectProps.md b/docs/RollbackDiscountEffectProps.md index ce290b90..20524a1d 100644 --- a/docs/RollbackDiscountEffectProps.md +++ b/docs/RollbackDiscountEffectProps.md @@ -2,19 +2,19 @@ # RollbackDiscountEffectProps -The properties specific to the \"rollbackDiscount\" effect. This gets triggered whenever previously closed session is now cancelled or partially returned and a setDiscount effect was cancelled on our internal discount limit counters. +This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you set the status of a session to `cancel` or the status changes to `partially_returned`. If the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the specific item unit in its line item. See the example below. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name of the \"setDiscount\" effect that was rolled back. | | -|**value** | **BigDecimal** | The value of the discount that was rolled back. | | -|**cartItemPosition** | **BigDecimal** | The index of the item in the cart items for which the discount was rolled back. | [optional] | -|**cartItemSubPosition** | **BigDecimal** | For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item. | [optional] | -|**additionalCostId** | **Long** | The ID of the additional cost that was rolled back. | [optional] | -|**additionalCost** | **String** | The name of the additional cost that was rolled back. | [optional] | -|**scope** | **String** | The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` | [optional] | +|**name** | **String** | The name of the discount effect that was rolled back. | | +|**value** | **BigDecimal** | The monetary value of the discount that was rolled back. | | +|**cartItemPosition** | **BigDecimal** | The index of the item in the `cartItem` object whose discount was rolled back, or the unit containing the additional cost whose discount was rolled back. | [optional] | +|**cartItemSubPosition** | **BigDecimal** | The index of the item unit in its line item for which the discount was rolled back. | [optional] | +|**additionalCostId** | **Long** | _Only when rolling back [setDiscountPerAdditionalCost](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcost) and [setDiscountPerAdditionalCostPerItem](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcostperitem)_ The ID of the additional cost to be discounted. | [optional] | +|**additionalCost** | **String** | The API name of the additional cost whose discount was rolled back. | [optional] | +|**scope** | **String** | The scope of the rolled back discount. - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` | [optional] | diff --git a/docs/RollbackIncreasedAchievementProgressEffectProps.md b/docs/RollbackIncreasedAchievementProgressEffectProps.md index 363cff2d..f08136db 100644 --- a/docs/RollbackIncreasedAchievementProgressEffectProps.md +++ b/docs/RollbackIncreasedAchievementProgressEffectProps.md @@ -2,7 +2,7 @@ # RollbackIncreasedAchievementProgressEffectProps -The properties specific to the \"rollbackIncreasedAchievementProgress\" effect. This gets triggered whenever a closed session where the `increaseAchievementProgress` effect was triggered is cancelled. This is applicable only when the customer has not completed the achievement. +This effect indicates that the customer's progress in an achievement was rolled back. The Rule Engine triggers this effect when you cancel or [reopen a customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) that previously validated the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect and triggered the [increaseAchievementProgress](https://docs.talon.one/docs/dev/integration-api/api-effects#increaseachievementprogress) API effect. The effect is also triggered for completed achievements if the **Allow progress rollback for completed achievements** setting is enabled. You can enable this through the [Campaign Manager](https://docs.talon.one/docs/product/campaigns/achievements/manage-achievements) or the [Management API](https://docs.talon.one/management-api#tag/Achievements/operation/createAchievement) by setting the `achievementAllowRollbackAfterCompletion` property to `true`. This setting only applies to one-time and recurring on expiration achievements. ## Properties @@ -11,7 +11,7 @@ The properties specific to the \"rollbackIncreasedAchievementProgress\" effect. |**achievementId** | **Long** | The internal ID of the achievement. | | |**achievementName** | **String** | The name of the achievement. | | |**progressTrackerId** | **Long** | The internal ID of the achievement progress tracker. | | -|**decreaseProgressBy** | **BigDecimal** | The value by which the customer's current progress in the achievement is decreased. | | +|**decreaseProgressBy** | **BigDecimal** | The value by which the customer's current progress in the achievement has decreased. | | |**currentProgress** | **BigDecimal** | The current progress of the customer in the achievement. | | |**target** | **BigDecimal** | The target value to complete the achievement. | | diff --git a/docs/RollbackReferralEffectProps.md b/docs/RollbackReferralEffectProps.md index 39d274ed..165287f1 100644 --- a/docs/RollbackReferralEffectProps.md +++ b/docs/RollbackReferralEffectProps.md @@ -2,13 +2,13 @@ # RollbackReferralEffectProps -The properties specific to the \"rollbackReferral\" effect. This gets triggered whenever previously closed session is now cancelled and a referral redemption was cancelled on our internal usage limit counters. +This effect indicates that the redemption of the referral code has been rolled back. It triggers when a closed session that redeemed a referral is gets cancelled. The code becomes redeemable again. For more information about session states, see [Managing states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**value** | **String** | The referral code whose usage has been rolled back. | | +|**value** | **String** | The referral code to be rolled back. | | diff --git a/docs/ScimServiceProviderConfigResponse.md b/docs/ScimServiceProviderConfigResponse.md index 3ab7b370..a3a2cbf1 100644 --- a/docs/ScimServiceProviderConfigResponse.md +++ b/docs/ScimServiceProviderConfigResponse.md @@ -12,9 +12,9 @@ Service provider configuration details. |**changePassword** | [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponseChangePassword.md) | | [optional] | |**documentationUri** | **String** | The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. | [optional] | |**filter** | [**ScimServiceProviderConfigResponseFilter**](ScimServiceProviderConfigResponseFilter.md) | | [optional] | -|**patch** | [**ScimServiceProviderConfigResponsePatch**](ScimServiceProviderConfigResponsePatch.md) | | [optional] | +|**patch** | [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponseChangePassword.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] | +|**sort** | [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponseChangePassword.md) | | [optional] | diff --git a/docs/ScimServiceProviderConfigResponsePatch.md b/docs/ScimServiceProviderConfigResponsePatch.md deleted file mode 100644 index 4f8c433a..00000000 --- a/docs/ScimServiceProviderConfigResponsePatch.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# ScimServiceProviderConfigResponsePatch - -Configuration settings related to patch operations, which allow partial updates to SCIM resources. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**supported** | **Boolean** | Indicates whether the service provider supports patch operations for modifying resources. | [optional] | - - - diff --git a/docs/ScimServiceProviderConfigResponseSort.md b/docs/ScimServiceProviderConfigResponseSort.md deleted file mode 100644 index 5ecc31f9..00000000 --- a/docs/ScimServiceProviderConfigResponseSort.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# 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/SetDiscountEffectProps.md b/docs/SetDiscountEffectProps.md index c3fe33ba..835d3e65 100644 --- a/docs/SetDiscountEffectProps.md +++ b/docs/SetDiscountEffectProps.md @@ -2,16 +2,16 @@ # SetDiscountEffectProps -The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied on the scope of defined with it. +This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. The discount should overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for **all** effects, effectively overwriting any previous effects. Enabling [partial discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches `0`. Use the `desiredValue` property to identify the original value of the discount. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name / description of this discount | | -|**value** | **BigDecimal** | The total monetary value of the discount. | | -|**scope** | **String** | The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal). | [optional] | -|**desiredValue** | **BigDecimal** | The original value of the discount. | [optional] | +|**name** | **String** | The name or description of this discount. | | +|**value** | **BigDecimal** | The monetary value of the effective discount. | | +|**scope** | **String** | What the discount applies to. Possible values: - `cartItems`: Discount on the price of the items. - `additionalCosts`: Discount on the [additional costs](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the items. - `sessionTotal`: Discount on the total value of the customer session. **Note:** [Cascading discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#cascading-discounts) must be enabled for this property to be returned. | [optional] | +|**desiredValue** | **BigDecimal** | _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. | [optional] | diff --git a/docs/SetDiscountPerAdditionalCostEffectProps.md b/docs/SetDiscountPerAdditionalCostEffectProps.md index 1972fca2..fb2f1c0b 100644 --- a/docs/SetDiscountPerAdditionalCostEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostEffectProps.md @@ -2,17 +2,17 @@ # SetDiscountPerAdditionalCostEffectProps -The properties specific to the \"setDiscountPerAdditionalCost\" effect. This gets triggered whenever a validated rule contained a \"set per additional cost discount\" effect. This is a discount that should be applied on a specific additional cost. +This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a **Discount additional cost** effect is validated. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name / description of this discount | | -|**additionalCostId** | **Long** | The ID of the additional cost. | | -|**additionalCost** | **String** | The name of the additional cost. | | -|**value** | **BigDecimal** | The total monetary value of the discount. | | -|**desiredValue** | **BigDecimal** | The original value of the discount. | [optional] | +|**name** | **String** | The name of the discount. | | +|**additionalCostId** | **Long** | The identifier of the additional cost. | | +|**additionalCost** | **String** | The API name of the additional cost. | | +|**value** | **BigDecimal** | The monetary value of the discount to apply. | | +|**desiredValue** | **BigDecimal** | _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. | [optional] | diff --git a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md index 2367fbb1..f66279de 100644 --- a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md @@ -2,19 +2,19 @@ # SetDiscountPerAdditionalCostPerItemEffectProps -The properties specific to the \"setDiscountPerAdditionalCostPerItem\" effect. This gets triggered whenever a validated rule contained a \"set discount per additional cost per item\" effect. This is a discount that should be applied on a specific additional cost in a specific item. +This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a **Discount additional cost per item** effect is validated. Use this effect when **all** items in the cart have an additional cost. If one of more items do not have an additional cost, the rule will fail. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name / description of this discount | | -|**additionalCostId** | **Long** | The ID of the additional cost. | | -|**value** | **BigDecimal** | The total monetary value of the discount. | | -|**position** | **BigDecimal** | The index of the item in the cart item list containing the additional cost to be discounted. | | -|**subPosition** | **BigDecimal** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional] | -|**additionalCost** | **String** | The name of the additional cost. | | -|**desiredValue** | **BigDecimal** | Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. | [optional] | +|**name** | **String** | The description of this discount. `#number` is appended to the name. It is equal to the `position` property. | | +|**additionalCostId** | **Long** | The identifier of the additional cost to be discounted. | | +|**value** | **BigDecimal** | The monetary value of the effective discount applied to the item's additional cost. | | +|**position** | **BigDecimal** | The index of the item in the `cartItem` object containing the additional cost that this discount applies to. | | +|**subPosition** | **BigDecimal** | The index of the item unit in its line item. | [optional] | +|**additionalCost** | **String** | The API name of the additional cost to be discounted. | | +|**desiredValue** | **BigDecimal** | _[(Partial discounts enabled only)](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts)_. The monetary value of the discount to be applied to the additional cost without considering budget limitations. | [optional] | diff --git a/docs/SetDiscountPerItemEffectProps.md b/docs/SetDiscountPerItemEffectProps.md index 5ddcda54..6549ccd8 100644 --- a/docs/SetDiscountPerItemEffectProps.md +++ b/docs/SetDiscountPerItemEffectProps.md @@ -2,24 +2,24 @@ # SetDiscountPerItemEffectProps -The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a \"set per item discount\" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope. +This effect schema is returned when you use the **Discount individual items**, **Discount individual items pro rata**, or **Discount individual item in bundles** effect in a rule. It indicates that a discount per item should be applied on the specific item specified in the effect. The properties it contains depends on: - Whether you used a pro rata effect or not. - Whether you used an effect with bundles or not. - Whether the partial discount feature is enabled. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. | | -|**value** | **BigDecimal** | The total monetary value of the discount. | | -|**position** | **BigDecimal** | The index of the item in the cart items list on which this discount should be applied. | | -|**subPosition** | **BigDecimal** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional] | -|**desiredValue** | **BigDecimal** | The original value of the discount. | [optional] | -|**scope** | **String** | The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. | [optional] | -|**totalDiscount** | **BigDecimal** | The total discount given if this effect is a result of a prorated discount. | [optional] | -|**desiredTotalDiscount** | **BigDecimal** | The original total discount to give if this effect is a result of a prorated discount. | [optional] | -|**bundleIndex** | **Long** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] | -|**bundleName** | **String** | The name of the bundle definition. | [optional] | -|**targetedItemPosition** | **BigDecimal** | The index of the targeted bundle item on which the applied discount is based. | [optional] | -|**targetedItemSubPosition** | **BigDecimal** | The sub-position of the targeted bundle item on which the applied discount is based. | [optional] | +|**name** | **String** | The description of this discount. `#number` is equal to the `position` property. | | +|**value** | **BigDecimal** | The monetary value of the effective discount applied to the item. | | +|**position** | **BigDecimal** | The index of the item in the `cartItem` object on which this discount should be applied. | | +|**subPosition** | **BigDecimal** | The index of the item unit in its line item. | [optional] | +|**desiredValue** | **BigDecimal** | _(Partial discounts enabled only)_ The monetary value of the discount to be applied to the item without considering budget limitations. | [optional] | +|**scope** | **String** | What the discount applies to. Possible values: - `price`: discount on the price of the item. - `additionalCosts`: discount on the [additional cost](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the item. - `itemTotal`: discount on the sum of price + additional cost of the item. | [optional] | +|**totalDiscount** | **BigDecimal** | _(Pro rata discounts only)_ The monetary value of the total effective discount | [optional] | +|**desiredTotalDiscount** | **BigDecimal** | _(Pro rata discounts only)_ The monetary value of the total discount to be applied without considering budget limitations | [optional] | +|**bundleIndex** | **Long** | _(Discounts with bundles only)_ The position of the specific item bundle in the list of bundles created from the same bundle definition. | [optional] | +|**bundleName** | **String** | _(Discounts with bundles only)_ The name of the bundle definition. | [optional] | +|**targetedItemPosition** | **BigDecimal** | _(Discounting individual item in bundles only)_ The index of the targeted bundle item on which the applied discount is based. | [optional] | +|**targetedItemSubPosition** | **BigDecimal** | _(Discounting individual item in bundles only)_ The sub-position of the targeted bundle item on which the applied discount is based. | [optional] | |**excludedFromPriceHistory** | **Boolean** | When set to `true`, the applied discount is excluded from the item's price history. | [optional] | diff --git a/docs/SetLoyaltyPointsExpiryDateEffectProps.md b/docs/SetLoyaltyPointsExpiryDateEffectProps.md index dfa52ce6..b875652b 100644 --- a/docs/SetLoyaltyPointsExpiryDateEffectProps.md +++ b/docs/SetLoyaltyPointsExpiryDateEffectProps.md @@ -2,7 +2,7 @@ # SetLoyaltyPointsExpiryDateEffectProps -The properties specific to the \"setLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"set expiry date\" effect. The current expiry date gets set to the date given in the effect. +This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date. ## Properties diff --git a/docs/ShowBundleMetadataEffectProps.md b/docs/ShowBundleMetadataEffectProps.md index 42f04ac8..3390805d 100644 --- a/docs/ShowBundleMetadataEffectProps.md +++ b/docs/ShowBundleMetadataEffectProps.md @@ -2,7 +2,7 @@ # ShowBundleMetadataEffectProps -This effect is **deprecated**. The properties specific to the \"ShowBundleMetadata\" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. +This effect is **deprecated**. The `ShowBundleMetadata` effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. ## Properties diff --git a/docs/ShowNotificationEffectProps.md b/docs/ShowNotificationEffectProps.md index 7949b551..82865b02 100644 --- a/docs/ShowNotificationEffectProps.md +++ b/docs/ShowNotificationEffectProps.md @@ -2,15 +2,15 @@ # ShowNotificationEffectProps -The properties specific to the \"showNotification\" effect. This gets triggered whenever a validated rule contained a \"show notification\" effect. +You can use notifications to inform customers of certain events. There are four types of notification messages: - `Info` - `Offer` - `Error` - `Misc` It is up to you to use the Rule Builder to decide why and when to show notifications. Notifications can be used as both rule effects and failure effects. A common use case is to display the notification at the top of the cart view in your web app. You can use the notification type to vary the styling of the notification message. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**notificationType** | **String** | The type of notification that should be shown (e.g. error/warning/info). | | -|**title** | **String** | Title of the notification. | | -|**body** | **String** | Body of the notification. | | +|**notificationType** | **String** | The type of notification. | | +|**title** | **String** | The title of the notification. | | +|**body** | **String** | The body of the notification. | | diff --git a/docs/TemplateArgDef.md b/docs/TemplateArgDef.md index bf5fc05a..9a73f075 100644 --- a/docs/TemplateArgDef.md +++ b/docs/TemplateArgDef.md @@ -10,7 +10,7 @@ |**type** | [**TypeEnum**](#TypeEnum) | The type of value this argument expects. | | |**description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | [optional] | |**title** | **String** | A campaigner friendly name for the argument, this will be shown in the rule editor. | | -|**ui** | **Object** | Arbitrary metadata that may be used to render an input for this argument. | | +|**ui** | **Object** | Arbitrary properties associated with this campaign. | | |**key** | **String** | The identifier for the associated value within the JSON object. | [optional] | |**picklistID** | **Long** | ID of the picklist linked to a template. | [optional] | |**restrictedByPicklist** | **Boolean** | Whether or not this attribute's value is restricted by picklist (`picklist` property) | [optional] | diff --git a/docs/TriggerWebhookEffectProps.md b/docs/TriggerWebhookEffectProps.md index 67da4ba8..c11f8908 100644 --- a/docs/TriggerWebhookEffectProps.md +++ b/docs/TriggerWebhookEffectProps.md @@ -2,14 +2,14 @@ # TriggerWebhookEffectProps -The properties specific to the \"triggerWebhook\" effect. This gets triggered whenever a validated rule contained a \"trigger webhook\" effect. This is communicated as an FYI and should usually not require action on your side. +This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effects#webhooks) is validated. The details are shared with you for your information only. It usually doesn't require an action on your side. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**webhookId** | **BigDecimal** | The ID of the webhook that was triggered. | | -|**webhookName** | **String** | The name of the webhook that was triggered. | | +|**webhookId** | **BigDecimal** | The internal ID of the webhook. | | +|**webhookName** | **String** | The name of the webhook. | | diff --git a/docs/UpdateAttributeEffectProps.md b/docs/UpdateAttributeEffectProps.md index ff57ff84..69a4a393 100644 --- a/docs/UpdateAttributeEffectProps.md +++ b/docs/UpdateAttributeEffectProps.md @@ -2,13 +2,13 @@ # UpdateAttributeEffectProps -The properties specific to the \"updateAttribute\" effect. This gets triggered whenever a validated rule contained an \"update an attribute\" effect. +This effect indicates that a rule containing an [Update attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) or [Update cart item attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) was validated. You should update the value of the attribute in your system based on the content of the returned effect. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**path** | **String** | The exact path of the attribute that was updated. | | +|**path** | **String** | The entity type and the attribute name. | | |**value** | **Object** | | | diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index 649e4027..635af554 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -14,7 +14,7 @@ |**expiryDate** | **OffsetDateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] | |**limits** | [**List<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] | |**recipientIntegrationId** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional] | -|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] | |**implicitlyReserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] | diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 51447342..12cb28fe 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -12,7 +12,7 @@ |**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional] | |**startDate** | **OffsetDateTime** | Timestamp at which point the coupon becomes valid. | [optional] | |**expiryDate** | **OffsetDateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] | -|**attributes** | **Object** | Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. | [optional] | +|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**batchID** | **String** | The ID of the batch the coupon(s) belong to. | [optional] | diff --git a/docs/UpdateCustomerProfileV2409Response.md b/docs/UpdateCustomerProfileV2409Response.md deleted file mode 100644 index dd5e5d09..00000000 --- a/docs/UpdateCustomerProfileV2409Response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# UpdateCustomerProfileV2409Response - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**message** | **String** | | [optional] | -|**errors** | **List<Object>** | | [optional] | -|**statusCode** | **Long** | | [optional] | - - - diff --git a/docs/UpdateRiskNotification.md b/docs/UpdateRiskNotification.md new file mode 100644 index 00000000..a5bf026d --- /dev/null +++ b/docs/UpdateRiskNotification.md @@ -0,0 +1,47 @@ + + +# UpdateRiskNotification + +Data for updating a risk notification. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**entity** | [**EntityEnum**](#EntityEnum) | The entity type to analyze within the given time frame. | | +|**activity** | [**ActivityEnum**](#ActivityEnum) | The activity metric to analyze within the given entity. | | +|**timeFrame** | [**TimeFrameEnum**](#TimeFrameEnum) | The rolling time window for risk evaluation. | | +|**active** | **Boolean** | Indicates whether this risk notification is active. | | + + + +## Enum: EntityEnum + +| Name | Value | +|---- | -----| +| CUSTOMER_PROFILE | "customer_profile" | +| CUSTOMER_SESSION | "customer_session" | + + + +## Enum: ActivityEnum + +| Name | Value | +|---- | -----| +| LOYALTY_POINTS_EARNED | "loyalty_points_earned" | +| DISCOUNTED_AMOUNT | "discounted_amount" | +| COMPLETED_ORDERS | "completed_orders" | +| COUPON_ATTEMPTS | "coupon_attempts" | + + + +## Enum: TimeFrameEnum + +| Name | Value | +|---- | -----| +| _1_DAY | "1_day" | +| _1_WEEK | "1_week" | +| _1_MONTH | "1_month" | + + + diff --git a/docs/User.md b/docs/User.md index 9b5297fd..e01847c1 100644 --- a/docs/User.md +++ b/docs/User.md @@ -19,11 +19,11 @@ |**policy** | **Object** | Access level of the user. | | |**roles** | **List<Long>** | A list of the IDs of the roles assigned to the user. | [optional] | |**authMethod** | **String** | Authentication method for this user. | [optional] | -|**applicationNotificationSubscriptions** | **Object** | Application notifications that the user is subscribed to. | [optional] | +|**applicationNotificationSubscriptions** | **Object** | Arbitrary properties associated with this campaign. | [optional] | |**lastSignedIn** | **OffsetDateTime** | Timestamp when the user last signed in to Talon.One. | [optional] | |**lastAccessed** | **OffsetDateTime** | Timestamp of the user's last activity after signing in to Talon.One. | [optional] | |**latestFeedTimestamp** | **OffsetDateTime** | Timestamp when the user was notified for feed. | [optional] | -|**additionalAttributes** | **Object** | Additional user attributes, created and used by external identity providers. | [optional] | +|**additionalAttributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] | diff --git a/docs/WillAwardGiveawayEffectProps.md b/docs/WillAwardGiveawayEffectProps.md index cd5ae818..aef6db07 100644 --- a/docs/WillAwardGiveawayEffectProps.md +++ b/docs/WillAwardGiveawayEffectProps.md @@ -2,15 +2,15 @@ # WillAwardGiveawayEffectProps -The properties specific to the \"awardGiveaway\" effect when the session is not closed yet. This effect replaces \"awardGiveaway\" only when updating a session with any state other than \"closed\". This is to ensure no giveaway codes are leaked when they are still not guaranteed to be awarded. +The equivalent of the `awardGiveaway` effect but returned when updating a session with any state other than `closed`. This ensures no giveaway codes are leaked when they are still not guaranteed to be awarded. For more information about session states, see [Manage the session's state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state). ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**poolId** | **Long** | The ID of the giveaways pool the code will be taken from. | | -|**poolName** | **String** | The name of the giveaways pool the code will be taken from. | | -|**recipientIntegrationId** | **String** | The integration ID of the profile that will be awarded the giveaway. | | +|**poolId** | **Long** | The internal ID of the giveaway pool. | | +|**poolName** | **String** | The name of the giveaway pool. | | +|**recipientIntegrationId** | **String** | The integration ID of the customer that receives the giveaway. | | diff --git a/pom.xml b/pom.xml index 1168b49d..a617cff0 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ talon-one-client jar talon-one-client - 26.11.0 + 26.12.0 https://github.com/talon-one/talon-one-maven-artifacts 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 939f8665..869d3253 100644 --- a/src/main/java/one/talon/ApiClient.java +++ b/src/main/java/one/talon/ApiClient.java @@ -142,7 +142,7 @@ protected void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/26.11.0/java"); + setUserAgent("OpenAPI-Generator/26.12.0/java"); authentications = new HashMap(); } diff --git a/src/main/java/one/talon/ApiException.java b/src/main/java/one/talon/ApiException.java index 1e9e5bf1..748c15ed 100644 --- a/src/main/java/one/talon/ApiException.java +++ b/src/main/java/one/talon/ApiException.java @@ -21,7 +21,7 @@ *

ApiException class.

*/ @SuppressWarnings("serial") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApiException extends Exception { private static final long serialVersionUID = 1L; diff --git a/src/main/java/one/talon/Configuration.java b/src/main/java/one/talon/Configuration.java index 61a977be..4a3bd1b4 100644 --- a/src/main/java/one/talon/Configuration.java +++ b/src/main/java/one/talon/Configuration.java @@ -17,9 +17,9 @@ import java.util.concurrent.atomic.AtomicReference; import java.util.function.Supplier; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Configuration { - public static final String VERSION = "26.11.0"; + public static final String VERSION = "26.12.0"; private static final AtomicReference defaultApiClient = new AtomicReference<>(); private static volatile Supplier apiClientFactory = ApiClient::new; diff --git a/src/main/java/one/talon/JSON.java b/src/main/java/one/talon/JSON.java index e3b56a10..7909e6ed 100644 --- a/src/main/java/one/talon/JSON.java +++ b/src/main/java/one/talon/JSON.java @@ -209,6 +209,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEditedNotificationItem.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEligibility.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEligibilityDetails.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEligibilityExperiment.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEligibilityFailureDetails.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEntity.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.CampaignEvaluationGroup.CustomTypeAdapterFactory()); @@ -335,6 +336,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EventV3RequestEntity.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Experiment.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentCampaignCopy.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentConfidenceTimeline.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentConfidenceTimelineDataPoint.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentCopy.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentCopyExperiment.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentListResults.CustomTypeAdapterFactory()); @@ -450,7 +453,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubConfig.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadCouponBasedNotifications.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadCouponBasedNotificationsLimits.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedNotification.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.CustomTypeAdapterFactory()); @@ -716,8 +718,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimServiceProviderConfigResponseBulk.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimServiceProviderConfigResponseChangePassword.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimServiceProviderConfigResponseFilter.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimServiceProviderConfigResponsePatch.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimServiceProviderConfigResponseSort.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimUser.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ScimUsersListResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.SecondaryDeployment.CustomTypeAdapterFactory()); @@ -785,7 +785,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateCouponBatch.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateCouponsData.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateCustomEffect.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateCustomerProfileV2409Response.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateCustomerSessionV2409Response.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateExperiment.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateExperimentVariant.CustomTypeAdapterFactory()); @@ -800,6 +799,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateReferral.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateReferralBatch.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateReward.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateRiskNotification.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateRole.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateStore.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new one.talon.model.UpdateSupportRequest.CustomTypeAdapterFactory()); diff --git a/src/main/java/one/talon/Pair.java b/src/main/java/one/talon/Pair.java index ce4949af..95098e20 100644 --- a/src/main/java/one/talon/Pair.java +++ b/src/main/java/one/talon/Pair.java @@ -13,7 +13,7 @@ package one.talon; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Pair { private final String name; private final String value; diff --git a/src/main/java/one/talon/ServerConfiguration.java b/src/main/java/one/talon/ServerConfiguration.java index 2bc68475..b1811fd6 100644 --- a/src/main/java/one/talon/ServerConfiguration.java +++ b/src/main/java/one/talon/ServerConfiguration.java @@ -18,7 +18,7 @@ /** * Representing a Server configuration. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ServerConfiguration { public String URL; public String description; diff --git a/src/main/java/one/talon/ServerVariable.java b/src/main/java/one/talon/ServerVariable.java index 2af0b528..3b8d5fd6 100644 --- a/src/main/java/one/talon/ServerVariable.java +++ b/src/main/java/one/talon/ServerVariable.java @@ -18,7 +18,7 @@ /** * Representing a Server Variable for server URL template substitution. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ServerVariable { public String description; public String defaultValue; diff --git a/src/main/java/one/talon/StringUtil.java b/src/main/java/one/talon/StringUtil.java index 2e47458b..408122e7 100644 --- a/src/main/java/one/talon/StringUtil.java +++ b/src/main/java/one/talon/StringUtil.java @@ -16,7 +16,7 @@ import java.util.Collection; import java.util.Iterator; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/one/talon/api/IntegrationApi.java b/src/main/java/one/talon/api/IntegrationApi.java index 066395fe..700db9a9 100644 --- a/src/main/java/one/talon/api/IntegrationApi.java +++ b/src/main/java/one/talon/api/IntegrationApi.java @@ -44,6 +44,7 @@ import one.talon.model.DeleteLoyaltyTransactionsRequest; import one.talon.model.ErrorResponse; import one.talon.model.ErrorResponseWithStatus; +import one.talon.model.EventV3; import one.talon.model.GenerateLoyaltyCard; import one.talon.model.GetCustomerAchievementHistory200Response; import one.talon.model.GetCustomerAchievements200Response; @@ -55,6 +56,8 @@ import one.talon.model.IntegrationCustomerSessionResponse; import one.talon.model.IntegrationEventV2Request; import one.talon.model.IntegrationEventV2Response; +import one.talon.model.IntegrationEventV3Request; +import one.talon.model.IntegrationEventV3Response; import one.talon.model.IntegrationGetAllCampaigns200Response; import one.talon.model.IntegrationRequest; import one.talon.model.IntegrationStateV2; @@ -72,7 +75,6 @@ import one.talon.model.ReopenSessionResponse; import one.talon.model.ReturnIntegrationRequest; import one.talon.model.UpdateAudience; -import one.talon.model.UpdateCustomerProfileV2409Response; import one.talon.model.UpdateCustomerSessionV2409Response; import java.lang.reflect.Type; @@ -1169,7 +1171,7 @@ private okhttp3.Call deleteAudienceV2ValidateBeforeCall(@javax.annotation.Nonnul /** * Delete audience - * Delete an audience created by a third-party integration. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). + * Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). * @param audienceId The ID of the audience. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1188,7 +1190,7 @@ public void deleteAudienceV2(@javax.annotation.Nonnull Long audienceId) throws A /** * Delete audience - * Delete an audience created by a third-party integration. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). + * Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). * @param audienceId The ID of the audience. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1209,7 +1211,7 @@ public ApiResponse deleteAudienceV2WithHttpInfo(@javax.annotation.Nonnull /** * Delete audience (asynchronously) - * Delete an audience created by a third-party integration. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). + * Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). * @param audienceId The ID of the audience. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2500,6 +2502,137 @@ public okhttp3.Call getCustomerSessionAsync(@javax.annotation.Nonnull String cus localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for getEventV3 + * @param integrationId The unique ID of the advanced event. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
404 Not found -
+ */ + public okhttp3.Call getEventV3Call(@javax.annotation.Nonnull String integrationId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/v3/events/{integrationId}" + .replace("{" + "integrationId" + "}", localVarApiClient.escapeString(integrationId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key_v1" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getEventV3ValidateBeforeCall(@javax.annotation.Nonnull String integrationId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'integrationId' is set + if (integrationId == null) { + throw new ApiException("Missing the required parameter 'integrationId' when calling getEventV3(Async)"); + } + + return getEventV3Call(integrationId, _callback); + + } + + /** + * Get advanced event + * Retrieve an advanced event by its identifier. + * @param integrationId The unique ID of the advanced event. (required) + * @return EventV3 + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
404 Not found -
+ */ + public EventV3 getEventV3(@javax.annotation.Nonnull String integrationId) throws ApiException { + ApiResponse localVarResp = getEventV3WithHttpInfo(integrationId); + return localVarResp.getData(); + } + + /** + * Get advanced event + * Retrieve an advanced event by its identifier. + * @param integrationId The unique ID of the advanced event. (required) + * @return ApiResponse<EventV3> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
404 Not found -
+ */ + public ApiResponse getEventV3WithHttpInfo(@javax.annotation.Nonnull String integrationId) throws ApiException { + okhttp3.Call localVarCall = getEventV3ValidateBeforeCall(integrationId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get advanced event (asynchronously) + * Retrieve an advanced event by its identifier. + * @param integrationId The unique ID of the advanced event. (required) + * @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 + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
404 Not found -
+ */ + public okhttp3.Call getEventV3Async(@javax.annotation.Nonnull String integrationId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getEventV3ValidateBeforeCall(integrationId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } /** * Build call for getLoyaltyBalances * @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) @@ -3277,7 +3410,7 @@ public okhttp3.Call getLoyaltyCardTransactionsAsync(@javax.annotation.Nonnull Lo * @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 status Filter points based on their status. (optional, default to active) - * @param subledgerId The ID of the subledger by which we filter the data. (optional) + * @param subledgerId Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. (optional) * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional) * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional) * @param pageSize The number of items in the response. (optional, default to 50) @@ -3296,7 +3429,7 @@ public okhttp3.Call getLoyaltyCardTransactionsAsync(@javax.annotation.Nonnull Lo 404 Not found - */ - public okhttp3.Call getLoyaltyProgramProfilePointsCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable String subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLoyaltyProgramProfilePointsCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable List subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3328,7 +3461,7 @@ public okhttp3.Call getLoyaltyProgramProfilePointsCall(@javax.annotation.Nonnull } if (subledgerId != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("subledgerId", subledgerId)); + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "subledgerId", subledgerId)); } if (customerSessionIDs != null) { @@ -3371,7 +3504,7 @@ public okhttp3.Call getLoyaltyProgramProfilePointsCall(@javax.annotation.Nonnull } @SuppressWarnings("rawtypes") - private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable String subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable List subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { // verify the required parameter 'loyaltyProgramId' is set if (loyaltyProgramId == null) { throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling getLoyaltyProgramProfilePoints(Async)"); @@ -3392,7 +3525,7 @@ private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(@javax.ann * @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 status Filter points based on their status. (optional, default to active) - * @param subledgerId The ID of the subledger by which we filter the data. (optional) + * @param subledgerId Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. (optional) * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional) * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional) * @param pageSize The number of items in the response. (optional, default to 50) @@ -3410,7 +3543,7 @@ private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(@javax.ann 404 Not found - */ - public GetLoyaltyProgramProfilePoints200Response getLoyaltyProgramProfilePoints(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable String subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort) throws ApiException { + public GetLoyaltyProgramProfilePoints200Response getLoyaltyProgramProfilePoints(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable List subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort) throws ApiException { ApiResponse localVarResp = getLoyaltyProgramProfilePointsWithHttpInfo(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort); return localVarResp.getData(); } @@ -3421,7 +3554,7 @@ public GetLoyaltyProgramProfilePoints200Response getLoyaltyProgramProfilePoints( * @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 status Filter points based on their status. (optional, default to active) - * @param subledgerId The ID of the subledger by which we filter the data. (optional) + * @param subledgerId Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. (optional) * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional) * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional) * @param pageSize The number of items in the response. (optional, default to 50) @@ -3439,7 +3572,7 @@ public GetLoyaltyProgramProfilePoints200Response getLoyaltyProgramProfilePoints( 404 Not found - */ - public ApiResponse getLoyaltyProgramProfilePointsWithHttpInfo(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable String subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort) throws ApiException { + public ApiResponse getLoyaltyProgramProfilePointsWithHttpInfo(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable List subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort) throws ApiException { okhttp3.Call localVarCall = getLoyaltyProgramProfilePointsValidateBeforeCall(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -3451,7 +3584,7 @@ public ApiResponse getLoyaltyProgramP * @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 status Filter points based on their status. (optional, default to active) - * @param subledgerId The ID of the subledger by which we filter the data. (optional) + * @param subledgerId Filter the results by a list of subledger IDs. To include multiple IDs, repeat the parameter for each one, for example, `?subledgerId=id1&subledgerId=id2`. The response contains only data associated with the specified subledgers. (optional) * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional) * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional) * @param pageSize The number of items in the response. (optional, default to 50) @@ -3470,7 +3603,7 @@ public ApiResponse getLoyaltyProgramP 404 Not found - */ - public okhttp3.Call getLoyaltyProgramProfilePointsAsync(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable String subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLoyaltyProgramProfilePointsAsync(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nonnull String integrationId, @javax.annotation.Nullable String status, @javax.annotation.Nullable List subledgerId, @javax.annotation.Nullable List customerSessionIDs, @javax.annotation.Nullable List transactionUUIDs, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLoyaltyProgramProfilePointsValidateBeforeCall(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -4716,7 +4849,7 @@ private okhttp3.Call trackEventV2ValidateBeforeCall(@javax.annotation.Nonnull In /** * Track event - * Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * Trigger a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. * @param integrationEventV2Request body (required) * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) @@ -4741,7 +4874,7 @@ public IntegrationEventV2Response trackEventV2(@javax.annotation.Nonnull Integra /** * Track event - * Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * Trigger a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. * @param integrationEventV2Request body (required) * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) @@ -4767,7 +4900,7 @@ public ApiResponse trackEventV2WithHttpInfo(@javax.a /** * Track event (asynchronously) - * Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * Trigger a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. * @param integrationEventV2Request body (required) * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) @@ -4793,6 +4926,169 @@ public okhttp3.Call trackEventV2Async(@javax.annotation.Nonnull IntegrationEvent localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for trackEventV3 + * @param integrationEventV3Request body (required) + * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) + * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) + * @param forceCompleteEvaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. (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 + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized - Invalid API key -
409 An advanced event already exists, too many requests, or limit reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). -
+ */ + public okhttp3.Call trackEventV3Call(@javax.annotation.Nonnull IntegrationEventV3Request integrationEventV3Request, @javax.annotation.Nullable String silent, @javax.annotation.Nullable Boolean dry, @javax.annotation.Nullable Boolean forceCompleteEvaluation, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = integrationEventV3Request; + + // create path and map variables + String localVarPath = "/v3/events"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (silent != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("silent", silent)); + } + + if (dry != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("dry", dry)); + } + + if (forceCompleteEvaluation != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("forceCompleteEvaluation", forceCompleteEvaluation)); + } + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key_v1" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call trackEventV3ValidateBeforeCall(@javax.annotation.Nonnull IntegrationEventV3Request integrationEventV3Request, @javax.annotation.Nullable String silent, @javax.annotation.Nullable Boolean dry, @javax.annotation.Nullable Boolean forceCompleteEvaluation, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'integrationEventV3Request' is set + if (integrationEventV3Request == null) { + throw new ApiException("Missing the required parameter 'integrationEventV3Request' when calling trackEventV3(Async)"); + } + + return trackEventV3Call(integrationEventV3Request, silent, dry, forceCompleteEvaluation, _callback); + + } + + /** + * Track advanced event + * Trigger an advanced event. Advanced events are idempotent, uniquely identifiable events. They can also reference a previously closed session to add more context for rule evaluation. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * @param integrationEventV3Request body (required) + * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) + * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) + * @param forceCompleteEvaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. (optional, default to false) + * @return IntegrationEventV3Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized - Invalid API key -
409 An advanced event already exists, too many requests, or limit reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). -
+ */ + public IntegrationEventV3Response trackEventV3(@javax.annotation.Nonnull IntegrationEventV3Request integrationEventV3Request, @javax.annotation.Nullable String silent, @javax.annotation.Nullable Boolean dry, @javax.annotation.Nullable Boolean forceCompleteEvaluation) throws ApiException { + ApiResponse localVarResp = trackEventV3WithHttpInfo(integrationEventV3Request, silent, dry, forceCompleteEvaluation); + return localVarResp.getData(); + } + + /** + * Track advanced event + * Trigger an advanced event. Advanced events are idempotent, uniquely identifiable events. They can also reference a previously closed session to add more context for rule evaluation. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * @param integrationEventV3Request body (required) + * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) + * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) + * @param forceCompleteEvaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. (optional, default to false) + * @return ApiResponse<IntegrationEventV3Response> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized - Invalid API key -
409 An advanced event already exists, too many requests, or limit reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). -
+ */ + public ApiResponse trackEventV3WithHttpInfo(@javax.annotation.Nonnull IntegrationEventV3Request integrationEventV3Request, @javax.annotation.Nullable String silent, @javax.annotation.Nullable Boolean dry, @javax.annotation.Nullable Boolean forceCompleteEvaluation) throws ApiException { + okhttp3.Call localVarCall = trackEventV3ValidateBeforeCall(integrationEventV3Request, silent, dry, forceCompleteEvaluation, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Track advanced event (asynchronously) + * Trigger an advanced event. Advanced events are idempotent, uniquely identifiable events. They can also reference a previously closed session to add more context for rule evaluation. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * @param integrationEventV3Request body (required) + * @param silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (optional, default to yes) + * @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional) + * @param forceCompleteEvaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. (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 + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized - Invalid API key -
409 An advanced event already exists, too many requests, or limit reached. Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). -
+ */ + public okhttp3.Call trackEventV3Async(@javax.annotation.Nonnull IntegrationEventV3Request integrationEventV3Request, @javax.annotation.Nullable String silent, @javax.annotation.Nullable Boolean dry, @javax.annotation.Nullable Boolean forceCompleteEvaluation, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = trackEventV3ValidateBeforeCall(integrationEventV3Request, silent, dry, forceCompleteEvaluation, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } /** * Build call for unlinkLoyaltyCardFromProfile * @param loyaltyProgramId The identifier of the card-based loyalty program containing the loyalty card. You can get this ID using the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required) diff --git a/src/main/java/one/talon/api/ManagementApi.java b/src/main/java/one/talon/api/ManagementApi.java index b46483bc..2aa369a2 100644 --- a/src/main/java/one/talon/api/ManagementApi.java +++ b/src/main/java/one/talon/api/ManagementApi.java @@ -6942,6 +6942,8 @@ public okhttp3.Call exportCouponsAsync(@javax.annotation.Nonnull Long applicatio * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param profileIntegrationId Only return sessions for the customer that matches this customer integration ID. (optional) * @param dateFormat Determines the format of dates in the export document. (optional) * @param customerSessionState Filter results by state. (optional) @@ -6955,7 +6957,7 @@ public okhttp3.Call exportCouponsAsync(@javax.annotation.Nonnull Long applicatio 200 OK - */ - public okhttp3.Call exportCustomerSessionsCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { + public okhttp3.Call exportCustomerSessionsCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable OffsetDateTime updatedBefore, @javax.annotation.Nullable OffsetDateTime updatedAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -6989,6 +6991,14 @@ public okhttp3.Call exportCustomerSessionsCall(@javax.annotation.Nonnull Long ap localVarQueryParams.addAll(localVarApiClient.parameterToPair("createdAfter", createdAfter)); } + if (updatedBefore != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("updatedBefore", updatedBefore)); + } + + if (updatedAfter != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("updatedAfter", updatedAfter)); + } + if (profileIntegrationId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("profileIntegrationId", profileIntegrationId)); } @@ -7021,13 +7031,13 @@ public okhttp3.Call exportCustomerSessionsCall(@javax.annotation.Nonnull Long ap } @SuppressWarnings("rawtypes") - private okhttp3.Call exportCustomerSessionsValidateBeforeCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { + private okhttp3.Call exportCustomerSessionsValidateBeforeCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable OffsetDateTime updatedBefore, @javax.annotation.Nullable OffsetDateTime updatedAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { // verify the required parameter 'applicationId' is set if (applicationId == null) { throw new ApiException("Missing the required parameter 'applicationId' when calling exportCustomerSessions(Async)"); } - return exportCustomerSessionsCall(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState, _callback); + return exportCustomerSessionsCall(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState, _callback); } @@ -7037,6 +7047,8 @@ private okhttp3.Call exportCustomerSessionsValidateBeforeCall(@javax.annotation. * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param profileIntegrationId Only return sessions for the customer that matches this customer integration ID. (optional) * @param dateFormat Determines the format of dates in the export document. (optional) * @param customerSessionState Filter results by state. (optional) @@ -7049,8 +7061,8 @@ private okhttp3.Call exportCustomerSessionsValidateBeforeCall(@javax.annotation. 200 OK - */ - public String exportCustomerSessions(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState) throws ApiException { - ApiResponse localVarResp = exportCustomerSessionsWithHttpInfo(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState); + public String exportCustomerSessions(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable OffsetDateTime updatedBefore, @javax.annotation.Nullable OffsetDateTime updatedAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState) throws ApiException { + ApiResponse localVarResp = exportCustomerSessionsWithHttpInfo(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState); return localVarResp.getData(); } @@ -7060,6 +7072,8 @@ public String exportCustomerSessions(@javax.annotation.Nonnull Long applicationI * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param profileIntegrationId Only return sessions for the customer that matches this customer integration ID. (optional) * @param dateFormat Determines the format of dates in the export document. (optional) * @param customerSessionState Filter results by state. (optional) @@ -7072,8 +7086,8 @@ public String exportCustomerSessions(@javax.annotation.Nonnull Long applicationI 200 OK - */ - public ApiResponse exportCustomerSessionsWithHttpInfo(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState) throws ApiException { - okhttp3.Call localVarCall = exportCustomerSessionsValidateBeforeCall(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState, null); + public ApiResponse exportCustomerSessionsWithHttpInfo(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable OffsetDateTime updatedBefore, @javax.annotation.Nullable OffsetDateTime updatedAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState) throws ApiException { + okhttp3.Call localVarCall = exportCustomerSessionsValidateBeforeCall(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -7084,6 +7098,8 @@ public ApiResponse exportCustomerSessionsWithHttpInfo(@javax.annotation. * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) + * @param updatedAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. (optional) * @param profileIntegrationId Only return sessions for the customer that matches this customer integration ID. (optional) * @param dateFormat Determines the format of dates in the export document. (optional) * @param customerSessionState Filter results by state. (optional) @@ -7097,9 +7113,9 @@ public ApiResponse exportCustomerSessionsWithHttpInfo(@javax.annotation. 200 OK - */ - public okhttp3.Call exportCustomerSessionsAsync(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { + public okhttp3.Call exportCustomerSessionsAsync(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable OffsetDateTime createdBefore, @javax.annotation.Nullable OffsetDateTime createdAfter, @javax.annotation.Nullable OffsetDateTime updatedBefore, @javax.annotation.Nullable OffsetDateTime updatedAfter, @javax.annotation.Nullable String profileIntegrationId, @javax.annotation.Nullable String dateFormat, @javax.annotation.Nullable String customerSessionState, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = exportCustomerSessionsValidateBeforeCall(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState, _callback); + okhttp3.Call localVarCall = exportCustomerSessionsValidateBeforeCall(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -8140,7 +8156,7 @@ private okhttp3.Call exportLoyaltyCardsValidateBeforeCall(@javax.annotation.Nonn /** * Export loyalty cards - * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. + * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. * @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 createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional) @@ -8164,7 +8180,7 @@ public String exportLoyaltyCards(@javax.annotation.Nonnull Long loyaltyProgramId /** * Export loyalty cards - * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. + * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. * @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 createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional) @@ -8189,7 +8205,7 @@ public ApiResponse exportLoyaltyCardsWithHttpInfo(@javax.annotation.Nonn /** * Export loyalty cards (asynchronously) - * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. + * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. * @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 createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional) @@ -12561,7 +12577,7 @@ public okhttp3.Call getAudiencesAsync(@javax.annotation.Nullable Long pageSize, } /** * Build call for getAudiencesAnalytics - * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. (required) + * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. (required) * @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:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -12639,7 +12655,7 @@ private okhttp3.Call getAudiencesAnalyticsValidateBeforeCall(@javax.annotation.N /** * List audience analytics * Get a list of audience IDs and their member count. - * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. (required) + * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. (required) * @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:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional) * @return GetAudiencesAnalytics200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -12658,7 +12674,7 @@ public GetAudiencesAnalytics200Response getAudiencesAnalytics(@javax.annotation. /** * List audience analytics * Get a list of audience IDs and their member count. - * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. (required) + * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. (required) * @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:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional) * @return ApiResponse<GetAudiencesAnalytics200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -12678,7 +12694,7 @@ public ApiResponse getAudiencesAnalyticsWithHt /** * List audience analytics (asynchronously) * Get a list of audience IDs and their member count. - * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. (required) + * @param audienceIds The IDs of one or more audiences, separated by commas, by which to filter results. Do not provide more than 1000 audience IDs. (required) * @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:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -20831,7 +20847,7 @@ private okhttp3.Call importLoyaltyCardsValidateBeforeCall(@javax.annotation.Nonn /** * Import loyalty cards - * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` + * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids,attributes 123-456-789AT,active,Alexa001;UserA,'{\"\"my_attributes\"\": \"\"10_off\"\"}\" ``` * @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 upFile The CSV file containing the data that is being imported. (optional) * @return ModelImport @@ -20852,7 +20868,7 @@ public ModelImport importLoyaltyCards(@javax.annotation.Nonnull Long loyaltyProg /** * Import loyalty cards - * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` + * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids,attributes 123-456-789AT,active,Alexa001;UserA,'{\"\"my_attributes\"\": \"\"10_off\"\"}\" ``` * @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 upFile The CSV file containing the data that is being imported. (optional) * @return ApiResponse<ModelImport> @@ -20874,7 +20890,7 @@ public ApiResponse importLoyaltyCardsWithHttpInfo(@javax.annotation /** * Import loyalty cards (asynchronously) - * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` + * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids,attributes 123-456-789AT,active,Alexa001;UserA,'{\"\"my_attributes\"\": \"\"10_off\"\"}\" ``` * @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 upFile The CSV file containing the data that is being imported. (optional) * @param _callback The callback to be executed when the API call finishes @@ -21044,6 +21060,154 @@ public okhttp3.Call importLoyaltyCustomersTiersAsync(@javax.annotation.Nonnull L localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for importLoyaltyJoinDates + * @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 upFile The CSV file containing the data that is being imported. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized -
404 Not found -
+ */ + public okhttp3.Call importLoyaltyJoinDatesCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nullable File upFile, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/v1/loyalty_programs/{loyaltyProgramId}/import_join_dates" + .replace("{" + "loyaltyProgramId" + "}", localVarApiClient.escapeString(loyaltyProgramId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (upFile != null) { + localVarFormParams.put("upFile", upFile); + } + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "multipart/form-data" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key_v1" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call importLoyaltyJoinDatesValidateBeforeCall(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nullable File upFile, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'loyaltyProgramId' is set + if (loyaltyProgramId == null) { + throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling importLoyaltyJoinDates(Async)"); + } + + return importLoyaltyJoinDatesCall(loyaltyProgramId, upFile, _callback); + + } + + /** + * Import join dates for a loyalty program + * Upload a CSV file containing customer profile IDs and their join dates for the specified loyalty program. Send the file as multipart data. > [!important] This endpoint only works with profile-based loyalty programs. The CSV file **must** contain the following columns: - `customerprofileid`: The integration ID of the customer profile whose join date you want to update. - `newjoindate`: The new join date for the customer in RFC3339 format. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note**: - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. - If a join date already exists for a profile, the uploaded date replaces it. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv customerprofileid,newjoindate customer1,2024-03-21T07:32:14Z customer2,2025-04-16T21:12:37Z customer3,2026-05-03T11:47:01Z ``` + * @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 upFile The CSV file containing the data that is being imported. (optional) + * @return ModelImport + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized -
404 Not found -
+ */ + public ModelImport importLoyaltyJoinDates(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nullable File upFile) throws ApiException { + ApiResponse localVarResp = importLoyaltyJoinDatesWithHttpInfo(loyaltyProgramId, upFile); + return localVarResp.getData(); + } + + /** + * Import join dates for a loyalty program + * Upload a CSV file containing customer profile IDs and their join dates for the specified loyalty program. Send the file as multipart data. > [!important] This endpoint only works with profile-based loyalty programs. The CSV file **must** contain the following columns: - `customerprofileid`: The integration ID of the customer profile whose join date you want to update. - `newjoindate`: The new join date for the customer in RFC3339 format. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note**: - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. - If a join date already exists for a profile, the uploaded date replaces it. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv customerprofileid,newjoindate customer1,2024-03-21T07:32:14Z customer2,2025-04-16T21:12:37Z customer3,2026-05-03T11:47:01Z ``` + * @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 upFile The CSV file containing the data that is being imported. (optional) + * @return ApiResponse<ModelImport> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized -
404 Not found -
+ */ + public ApiResponse importLoyaltyJoinDatesWithHttpInfo(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nullable File upFile) throws ApiException { + okhttp3.Call localVarCall = importLoyaltyJoinDatesValidateBeforeCall(loyaltyProgramId, upFile, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Import join dates for a loyalty program (asynchronously) + * Upload a CSV file containing customer profile IDs and their join dates for the specified loyalty program. Send the file as multipart data. > [!important] This endpoint only works with profile-based loyalty programs. The CSV file **must** contain the following columns: - `customerprofileid`: The integration ID of the customer profile whose join date you want to update. - `newjoindate`: The new join date for the customer in RFC3339 format. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note**: - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. - If a join date already exists for a profile, the uploaded date replaces it. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv customerprofileid,newjoindate customer1,2024-03-21T07:32:14Z customer2,2025-04-16T21:12:37Z customer3,2026-05-03T11:47:01Z ``` + * @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 upFile The CSV file containing the data that is being imported. (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 + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 OK -
400 Bad request -
401 Unauthorized -
404 Not found -
+ */ + public okhttp3.Call importLoyaltyJoinDatesAsync(@javax.annotation.Nonnull Long loyaltyProgramId, @javax.annotation.Nullable File upFile, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = importLoyaltyJoinDatesValidateBeforeCall(loyaltyProgramId, upFile, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } /** * Build call for importLoyaltyPoints * @param loyaltyProgramId Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required) @@ -22044,7 +22208,7 @@ public okhttp3.Call listAllRolesV2Async(final ApiCallback 200 OK - */ - public okhttp3.Call listApplicationCartItemFiltersCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String title, final ApiCallback _callback) throws ApiException { + public okhttp3.Call listApplicationCartItemFiltersCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String name, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -22089,8 +22253,8 @@ public okhttp3.Call listApplicationCartItemFiltersCall(@javax.annotation.Nonnull localVarQueryParams.addAll(localVarApiClient.parameterToPair("skip", skip)); } - if (title != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("title", title)); + if (name != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name)); } final String[] localVarAccepts = { @@ -22113,13 +22277,13 @@ public okhttp3.Call listApplicationCartItemFiltersCall(@javax.annotation.Nonnull } @SuppressWarnings("rawtypes") - private okhttp3.Call listApplicationCartItemFiltersValidateBeforeCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String title, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listApplicationCartItemFiltersValidateBeforeCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String name, final ApiCallback _callback) throws ApiException { // verify the required parameter 'applicationId' is set if (applicationId == null) { throw new ApiException("Missing the required parameter 'applicationId' when calling listApplicationCartItemFilters(Async)"); } - return listApplicationCartItemFiltersCall(applicationId, pageSize, skip, title, _callback); + return listApplicationCartItemFiltersCall(applicationId, pageSize, skip, name, _callback); } @@ -22129,7 +22293,7 @@ private okhttp3.Call listApplicationCartItemFiltersValidateBeforeCall(@javax.ann * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param pageSize The number of items in the response. (optional, default to 50) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param title Filter by the display name of the Application cart item filter in the Application. **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. (optional) + * @param name Filter by the display name of the Application cart item filter in the Application. **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. (optional) * @return ListApplicationCartItemFilters200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -22139,8 +22303,8 @@ private okhttp3.Call listApplicationCartItemFiltersValidateBeforeCall(@javax.ann 200 OK - */ - public ListApplicationCartItemFilters200Response listApplicationCartItemFilters(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String title) throws ApiException { - ApiResponse localVarResp = listApplicationCartItemFiltersWithHttpInfo(applicationId, pageSize, skip, title); + public ListApplicationCartItemFilters200Response listApplicationCartItemFilters(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String name) throws ApiException { + ApiResponse localVarResp = listApplicationCartItemFiltersWithHttpInfo(applicationId, pageSize, skip, name); return localVarResp.getData(); } @@ -22150,7 +22314,7 @@ public ListApplicationCartItemFilters200Response listApplicationCartItemFilters( * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param pageSize The number of items in the response. (optional, default to 50) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param title Filter by the display name of the Application cart item filter in the Application. **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. (optional) + * @param name Filter by the display name of the Application cart item filter in the Application. **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. (optional) * @return ApiResponse<ListApplicationCartItemFilters200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -22160,8 +22324,8 @@ public ListApplicationCartItemFilters200Response listApplicationCartItemFilters( 200 OK - */ - public ApiResponse listApplicationCartItemFiltersWithHttpInfo(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String title) throws ApiException { - okhttp3.Call localVarCall = listApplicationCartItemFiltersValidateBeforeCall(applicationId, pageSize, skip, title, null); + public ApiResponse listApplicationCartItemFiltersWithHttpInfo(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String name) throws ApiException { + okhttp3.Call localVarCall = listApplicationCartItemFiltersValidateBeforeCall(applicationId, pageSize, skip, name, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -22172,7 +22336,7 @@ public ApiResponse listApplicationCar * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required) * @param pageSize The number of items in the response. (optional, default to 50) * @param skip The number of items to skip when paging through large result sets. (optional) - * @param title Filter by the display name of the Application cart item filter in the Application. **Note**: If no `title` is provided, all the Application cart item filters in the Application are returned. (optional) + * @param name Filter by the display name of the Application cart item filter in the Application. **Note**: If no `name` is provided, all the Application cart item filters in the Application are returned. (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 @@ -22183,9 +22347,9 @@ public ApiResponse listApplicationCar 200 OK - */ - public okhttp3.Call listApplicationCartItemFiltersAsync(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String title, final ApiCallback _callback) throws ApiException { + public okhttp3.Call listApplicationCartItemFiltersAsync(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nullable Long pageSize, @javax.annotation.Nullable Long skip, @javax.annotation.Nullable String name, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listApplicationCartItemFiltersValidateBeforeCall(applicationId, pageSize, skip, title, _callback); + okhttp3.Call localVarCall = listApplicationCartItemFiltersValidateBeforeCall(applicationId, pageSize, skip, name, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/src/main/java/one/talon/auth/ApiKeyAuth.java b/src/main/java/one/talon/auth/ApiKeyAuth.java index d9ccc3f5..4d2c0d3f 100644 --- a/src/main/java/one/talon/auth/ApiKeyAuth.java +++ b/src/main/java/one/talon/auth/ApiKeyAuth.java @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/one/talon/auth/Authentication.java b/src/main/java/one/talon/auth/Authentication.java index 8a7db79d..573f29d9 100644 --- a/src/main/java/one/talon/auth/Authentication.java +++ b/src/main/java/one/talon/auth/Authentication.java @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public interface Authentication { /** * Apply authentication settings to header and query params. diff --git a/src/main/java/one/talon/auth/HttpBearerAuth.java b/src/main/java/one/talon/auth/HttpBearerAuth.java index b7c010c0..b51082bc 100644 --- a/src/main/java/one/talon/auth/HttpBearerAuth.java +++ b/src/main/java/one/talon/auth/HttpBearerAuth.java @@ -22,7 +22,7 @@ import java.util.Optional; import java.util.function.Supplier; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class HttpBearerAuth implements Authentication { private final String scheme; private Supplier tokenSupplier; diff --git a/src/main/java/one/talon/model/APIError.java b/src/main/java/one/talon/model/APIError.java index 5a673f72..26789f99 100644 --- a/src/main/java/one/talon/model/APIError.java +++ b/src/main/java/one/talon/model/APIError.java @@ -49,7 +49,7 @@ /** * APIError */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class APIError { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/AbstractOpenApiSchema.java b/src/main/java/one/talon/model/AbstractOpenApiSchema.java index 218a4eac..454234df 100644 --- a/src/main/java/one/talon/model/AbstractOpenApiSchema.java +++ b/src/main/java/one/talon/model/AbstractOpenApiSchema.java @@ -21,7 +21,7 @@ /** * Abstract class for oneOf,anyOf schemas defined in OpenAPI spec */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public abstract class AbstractOpenApiSchema { // store the actual instance of the schema/object diff --git a/src/main/java/one/talon/model/AcceptCouponEffectProps.java b/src/main/java/one/talon/model/AcceptCouponEffectProps.java index d4f666d9..bd73eb50 100644 --- a/src/main/java/one/talon/model/AcceptCouponEffectProps.java +++ b/src/main/java/one/talon/model/AcceptCouponEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"acceptCoupon\" effect. This gets triggered whenever the coupon is valid and all other conditions in the rules of its campaign are met. + * This effect indicates that the coupon code supplied was valid. You should handle this effect by clearing any messages from previous `rejectCoupon` effects and informing the user that the coupon is valid. The code is automatically redeemed when you close the session. Other effects, such as [setDiscount](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscount), provide more information about the actual rewards received. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AcceptCouponEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/AcceptReferralEffectProps.java b/src/main/java/one/talon/model/AcceptReferralEffectProps.java index c20b0f12..9b474a1f 100644 --- a/src/main/java/one/talon/model/AcceptReferralEffectProps.java +++ b/src/main/java/one/talon/model/AcceptReferralEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"acceptReferral\" effect. TThis gets triggered whenever the referral code is valid and all other conditions in the rules of its campaign are met. + * This effect indicates that the referral code supplied is valid. You should handle this effect by informing the user that the referral code is valid. The code is automatically redeemed when you close the session. Other effects will provide more information about the actual reward. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AcceptReferralEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -64,7 +64,7 @@ public AcceptReferralEffectProps value(@javax.annotation.Nonnull String value) { } /** - * The referral code that was accepted. + * The referral code provided in the session. * @return value */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/AccessLogEntry.java b/src/main/java/one/talon/model/AccessLogEntry.java index 43cf1544..5781386f 100644 --- a/src/main/java/one/talon/model/AccessLogEntry.java +++ b/src/main/java/one/talon/model/AccessLogEntry.java @@ -49,7 +49,7 @@ /** * Log of application accesses. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccessLogEntry { public static final String SERIALIZED_NAME_UUID = "uuid"; @SerializedName(SERIALIZED_NAME_UUID) diff --git a/src/main/java/one/talon/model/Account.java b/src/main/java/one/talon/model/Account.java index a5d721ff..9c7f7615 100644 --- a/src/main/java/one/talon/model/Account.java +++ b/src/main/java/one/talon/model/Account.java @@ -49,7 +49,7 @@ /** * Account */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Account { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AccountAdditionalCost.java b/src/main/java/one/talon/model/AccountAdditionalCost.java index a2913228..27b405c8 100644 --- a/src/main/java/one/talon/model/AccountAdditionalCost.java +++ b/src/main/java/one/talon/model/AccountAdditionalCost.java @@ -51,7 +51,7 @@ /** * AccountAdditionalCost */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountAdditionalCost { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AccountAnalytics.java b/src/main/java/one/talon/model/AccountAnalytics.java index 9a8bddbd..e29ca776 100644 --- a/src/main/java/one/talon/model/AccountAnalytics.java +++ b/src/main/java/one/talon/model/AccountAnalytics.java @@ -49,7 +49,7 @@ /** * AccountAnalytics */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountAnalytics { public static final String SERIALIZED_NAME_APPLICATIONS = "applications"; @SerializedName(SERIALIZED_NAME_APPLICATIONS) diff --git a/src/main/java/one/talon/model/AccountDashboardStatistic.java b/src/main/java/one/talon/model/AccountDashboardStatistic.java index 2d10f63f..7a457dbf 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatistic.java +++ b/src/main/java/one/talon/model/AccountDashboardStatistic.java @@ -55,7 +55,7 @@ /** * AccountDashboardStatistic */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatistic { public static final String SERIALIZED_NAME_REVENUE = "revenue"; @SerializedName(SERIALIZED_NAME_REVENUE) diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java b/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java index 2e7dbcf2..71acfeed 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java +++ b/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java @@ -48,7 +48,7 @@ /** * AccountDashboardStatisticCampaigns */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatisticCampaigns { public static final String SERIALIZED_NAME_LIVE = "live"; @SerializedName(SERIALIZED_NAME_LIVE) diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java b/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java index 36e04c02..36bf849c 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java +++ b/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java @@ -50,7 +50,7 @@ /** * AccountDashboardStatisticDiscount */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatisticDiscount { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java b/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java index b2298e45..f7935400 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java +++ b/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java @@ -50,7 +50,7 @@ /** * AccountDashboardStatisticLoyaltyPoints */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatisticLoyaltyPoints { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java b/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java index 44cf45fb..ec53c795 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java +++ b/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java @@ -50,7 +50,7 @@ /** * AccountDashboardStatisticReferrals */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatisticReferrals { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java b/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java index 94389398..06a90ae9 100644 --- a/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java +++ b/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java @@ -50,7 +50,7 @@ /** * AccountDashboardStatisticRevenue */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountDashboardStatisticRevenue { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/AccountEntity.java b/src/main/java/one/talon/model/AccountEntity.java index 31765ecf..8703a73a 100644 --- a/src/main/java/one/talon/model/AccountEntity.java +++ b/src/main/java/one/talon/model/AccountEntity.java @@ -48,7 +48,7 @@ /** * AccountEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountEntity { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/AccountLimits.java b/src/main/java/one/talon/model/AccountLimits.java index 18433ba3..2435c643 100644 --- a/src/main/java/one/talon/model/AccountLimits.java +++ b/src/main/java/one/talon/model/AccountLimits.java @@ -50,7 +50,7 @@ /** * AccountLimits */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AccountLimits { public static final String SERIALIZED_NAME_LIVE_APPLICATIONS = "liveApplications"; @SerializedName(SERIALIZED_NAME_LIVE_APPLICATIONS) diff --git a/src/main/java/one/talon/model/Achievement.java b/src/main/java/one/talon/model/Achievement.java index 74267c7a..4f58615b 100644 --- a/src/main/java/one/talon/model/Achievement.java +++ b/src/main/java/one/talon/model/Achievement.java @@ -51,7 +51,7 @@ /** * Achievement */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Achievement { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AchievementAdditionalProperties.java b/src/main/java/one/talon/model/AchievementAdditionalProperties.java index 76032717..d642c7be 100644 --- a/src/main/java/one/talon/model/AchievementAdditionalProperties.java +++ b/src/main/java/one/talon/model/AchievementAdditionalProperties.java @@ -48,7 +48,7 @@ /** * AchievementAdditionalProperties */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementAdditionalProperties { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java b/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java index 36755d07..c610ee1d 100644 --- a/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java +++ b/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java @@ -21,6 +21,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.TimePoint; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,7 +49,7 @@ /** * AchievementAdditionalPropertiesV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementAdditionalPropertiesV2 { public static final String SERIALIZED_NAME_USER_ID = "userId"; @SerializedName(SERIALIZED_NAME_USER_ID) @@ -60,23 +61,27 @@ public class AchievementAdditionalPropertiesV2 { @javax.annotation.Nullable private String createdBy; + public static final String SERIALIZED_NAME_PERIOD_END_OVERRIDE = "periodEndOverride"; + @Deprecated + @SerializedName(SERIALIZED_NAME_PERIOD_END_OVERRIDE) + @javax.annotation.Nullable + private TimePoint periodEndOverride; + public static final String SERIALIZED_NAME_HAS_PROGRESS = "hasProgress"; @SerializedName(SERIALIZED_NAME_HAS_PROGRESS) @javax.annotation.Nullable private Boolean hasProgress; /** - * The status of the achievement. + * The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { - INPROGRESS("inprogress"), + ACTIVE("active"), - EXPIRED("expired"), + SCHEDULED("scheduled"), - NOT_STARTED("not_started"), - - COMPLETED("completed"); + EXPIRED("expired"); private String value; @@ -167,6 +172,29 @@ public void setCreatedBy(@javax.annotation.Nullable String createdBy) { } + @Deprecated + public AchievementAdditionalPropertiesV2 periodEndOverride(@javax.annotation.Nullable TimePoint periodEndOverride) { + this.periodEndOverride = periodEndOverride; + return this; + } + + /** + * Get periodEndOverride + * @return periodEndOverride + * @deprecated + */ + @Deprecated + @javax.annotation.Nullable + public TimePoint getPeriodEndOverride() { + return periodEndOverride; + } + + @Deprecated + public void setPeriodEndOverride(@javax.annotation.Nullable TimePoint periodEndOverride) { + this.periodEndOverride = periodEndOverride; + } + + public AchievementAdditionalPropertiesV2 hasProgress(@javax.annotation.Nullable Boolean hasProgress) { this.hasProgress = hasProgress; return this; @@ -192,7 +220,7 @@ public AchievementAdditionalPropertiesV2 status(@javax.annotation.Nullable Statu } /** - * The status of the achievement. + * The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. * @return status */ @javax.annotation.Nullable @@ -261,6 +289,7 @@ public boolean equals(Object o) { AchievementAdditionalPropertiesV2 achievementAdditionalPropertiesV2 = (AchievementAdditionalPropertiesV2) o; return Objects.equals(this.userId, achievementAdditionalPropertiesV2.userId) && Objects.equals(this.createdBy, achievementAdditionalPropertiesV2.createdBy) && + Objects.equals(this.periodEndOverride, achievementAdditionalPropertiesV2.periodEndOverride) && Objects.equals(this.hasProgress, achievementAdditionalPropertiesV2.hasProgress) && Objects.equals(this.status, achievementAdditionalPropertiesV2.status)&& Objects.equals(this.additionalProperties, achievementAdditionalPropertiesV2.additionalProperties); @@ -268,7 +297,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(userId, createdBy, hasProgress, status, additionalProperties); + return Objects.hash(userId, createdBy, periodEndOverride, hasProgress, status, additionalProperties); } @Override @@ -277,6 +306,7 @@ public String toString() { sb.append("class AchievementAdditionalPropertiesV2 {\n"); sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n"); + sb.append(" periodEndOverride: ").append(toIndentedString(periodEndOverride)).append("\n"); sb.append(" hasProgress: ").append(toIndentedString(hasProgress)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); @@ -298,7 +328,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("userId", "createdBy", "hasProgress", "status")); + openapiFields = new HashSet(Arrays.asList("userId", "createdBy", "periodEndOverride", "hasProgress", "status")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("userId")); @@ -327,6 +357,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("createdBy") != null && !jsonObj.get("createdBy").isJsonNull()) && !jsonObj.get("createdBy").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `createdBy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdBy").toString())); } + // validate the optional field `periodEndOverride` + if (jsonObj.get("periodEndOverride") != null && !jsonObj.get("periodEndOverride").isJsonNull()) { + TimePoint.validateJsonElement(jsonObj.get("periodEndOverride")); + } if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString())); } diff --git a/src/main/java/one/talon/model/AchievementBase.java b/src/main/java/one/talon/model/AchievementBase.java index 0415f52a..ff587823 100644 --- a/src/main/java/one/talon/model/AchievementBase.java +++ b/src/main/java/one/talon/model/AchievementBase.java @@ -51,7 +51,7 @@ /** * AchievementBase */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementBase { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/AchievementBaseV2.java b/src/main/java/one/talon/model/AchievementBaseV2.java index d3d2ba93..35812f79 100644 --- a/src/main/java/one/talon/model/AchievementBaseV2.java +++ b/src/main/java/one/talon/model/AchievementBaseV2.java @@ -52,7 +52,7 @@ /** * AchievementBaseV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementBaseV2 { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/AchievementProgress.java b/src/main/java/one/talon/model/AchievementProgress.java index 688e20ed..e4e300cb 100644 --- a/src/main/java/one/talon/model/AchievementProgress.java +++ b/src/main/java/one/talon/model/AchievementProgress.java @@ -50,7 +50,7 @@ /** * The current progress of the customer in the achievement. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementProgress { /** * The status of the achievement. diff --git a/src/main/java/one/talon/model/AchievementProgressWithDefinition.java b/src/main/java/one/talon/model/AchievementProgressWithDefinition.java index 34ccd2df..0abfa88f 100644 --- a/src/main/java/one/talon/model/AchievementProgressWithDefinition.java +++ b/src/main/java/one/talon/model/AchievementProgressWithDefinition.java @@ -50,7 +50,7 @@ /** * AchievementProgressWithDefinition */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementProgressWithDefinition { /** * The status of the achievement. diff --git a/src/main/java/one/talon/model/AchievementReference.java b/src/main/java/one/talon/model/AchievementReference.java index 0f32075e..5e9fac1d 100644 --- a/src/main/java/one/talon/model/AchievementReference.java +++ b/src/main/java/one/talon/model/AchievementReference.java @@ -48,7 +48,7 @@ /** * AchievementReference */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementReference { public static final String SERIALIZED_NAME_ACHIEVEMENT_ID = "achievementId"; @SerializedName(SERIALIZED_NAME_ACHIEVEMENT_ID) @@ -70,6 +70,11 @@ public class AchievementReference { @javax.annotation.Nonnull private Long campaignId; + public static final String SERIALIZED_NAME_CAMPAIGN_NAME = "campaignName"; + @SerializedName(SERIALIZED_NAME_CAMPAIGN_NAME) + @javax.annotation.Nonnull + private String campaignName; + public AchievementReference() { } @@ -148,6 +153,25 @@ public void setCampaignId(@javax.annotation.Nonnull Long campaignId) { this.campaignId = campaignId; } + + public AchievementReference campaignName(@javax.annotation.Nonnull String campaignName) { + this.campaignName = campaignName; + return this; + } + + /** + * The name of the campaign that references this achievement. + * @return campaignName + */ + @javax.annotation.Nonnull + public String getCampaignName() { + return campaignName; + } + + public void setCampaignName(@javax.annotation.Nonnull String campaignName) { + this.campaignName = campaignName; + } + /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -206,13 +230,14 @@ public boolean equals(Object o) { return Objects.equals(this.achievementId, achievementReference.achievementId) && Objects.equals(this.applicationId, achievementReference.applicationId) && Objects.equals(this.applicationName, achievementReference.applicationName) && - Objects.equals(this.campaignId, achievementReference.campaignId)&& + Objects.equals(this.campaignId, achievementReference.campaignId) && + Objects.equals(this.campaignName, achievementReference.campaignName)&& Objects.equals(this.additionalProperties, achievementReference.additionalProperties); } @Override public int hashCode() { - return Objects.hash(achievementId, applicationId, applicationName, campaignId, additionalProperties); + return Objects.hash(achievementId, applicationId, applicationName, campaignId, campaignName, additionalProperties); } @Override @@ -223,6 +248,7 @@ public String toString() { sb.append(" applicationId: ").append(toIndentedString(applicationId)).append("\n"); sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); sb.append(" campaignId: ").append(toIndentedString(campaignId)).append("\n"); + sb.append(" campaignName: ").append(toIndentedString(campaignName)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -242,10 +268,10 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("achievementId", "applicationId", "applicationName", "campaignId")); + openapiFields = new HashSet(Arrays.asList("achievementId", "applicationId", "applicationName", "campaignId", "campaignName")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("achievementId", "applicationId", "applicationName", "campaignId")); + openapiRequiredFields = new HashSet(Arrays.asList("achievementId", "applicationId", "applicationName", "campaignId", "campaignName")); } /** @@ -271,6 +297,9 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (!jsonObj.get("applicationName").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `applicationName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("applicationName").toString())); } + if (!jsonObj.get("campaignName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `campaignName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("campaignName").toString())); + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/one/talon/model/AchievementStatusEntry.java b/src/main/java/one/talon/model/AchievementStatusEntry.java index 87dcb6fe..a83641cc 100644 --- a/src/main/java/one/talon/model/AchievementStatusEntry.java +++ b/src/main/java/one/talon/model/AchievementStatusEntry.java @@ -52,7 +52,7 @@ /** * AchievementStatusEntry */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementStatusEntry { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AchievementV2.java b/src/main/java/one/talon/model/AchievementV2.java index 4ba56173..41171fca 100644 --- a/src/main/java/one/talon/model/AchievementV2.java +++ b/src/main/java/one/talon/model/AchievementV2.java @@ -25,6 +25,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import one.talon.model.TimePoint; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -52,7 +53,7 @@ /** * AchievementV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AchievementV2 { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -235,23 +236,27 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private String createdBy; + public static final String SERIALIZED_NAME_PERIOD_END_OVERRIDE = "periodEndOverride"; + @Deprecated + @SerializedName(SERIALIZED_NAME_PERIOD_END_OVERRIDE) + @javax.annotation.Nullable + private TimePoint periodEndOverride; + public static final String SERIALIZED_NAME_HAS_PROGRESS = "hasProgress"; @SerializedName(SERIALIZED_NAME_HAS_PROGRESS) @javax.annotation.Nullable private Boolean hasProgress; /** - * The status of the achievement. + * The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { - INPROGRESS("inprogress"), + ACTIVE("active"), - EXPIRED("expired"), + SCHEDULED("scheduled"), - NOT_STARTED("not_started"), - - COMPLETED("completed"); + EXPIRED("expired"); private String value; @@ -607,6 +612,29 @@ public void setCreatedBy(@javax.annotation.Nullable String createdBy) { } + @Deprecated + public AchievementV2 periodEndOverride(@javax.annotation.Nullable TimePoint periodEndOverride) { + this.periodEndOverride = periodEndOverride; + return this; + } + + /** + * Get periodEndOverride + * @return periodEndOverride + * @deprecated + */ + @Deprecated + @javax.annotation.Nullable + public TimePoint getPeriodEndOverride() { + return periodEndOverride; + } + + @Deprecated + public void setPeriodEndOverride(@javax.annotation.Nullable TimePoint periodEndOverride) { + this.periodEndOverride = periodEndOverride; + } + + public AchievementV2 hasProgress(@javax.annotation.Nullable Boolean hasProgress) { this.hasProgress = hasProgress; return this; @@ -632,7 +660,7 @@ public AchievementV2 status(@javax.annotation.Nullable StatusEnum status) { } /** - * The status of the achievement. + * The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. * @return status */ @javax.annotation.Nullable @@ -752,6 +780,7 @@ public boolean equals(Object o) { Objects.equals(this.subscribedApplications, achievementV2.subscribedApplications) && Objects.equals(this.userId, achievementV2.userId) && Objects.equals(this.createdBy, achievementV2.createdBy) && + Objects.equals(this.periodEndOverride, achievementV2.periodEndOverride) && Objects.equals(this.hasProgress, achievementV2.hasProgress) && Objects.equals(this.status, achievementV2.status) && Objects.equals(this.sandbox, achievementV2.sandbox) && @@ -761,7 +790,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(id, created, name, title, description, target, period, recurrencePolicy, activationPolicy, fixedStartDate, endDate, allowRollbackAfterCompletion, subscribedApplications, userId, createdBy, hasProgress, status, sandbox, timezone, additionalProperties); + return Objects.hash(id, created, name, title, description, target, period, recurrencePolicy, activationPolicy, fixedStartDate, endDate, allowRollbackAfterCompletion, subscribedApplications, userId, createdBy, periodEndOverride, hasProgress, status, sandbox, timezone, additionalProperties); } @Override @@ -783,6 +812,7 @@ public String toString() { sb.append(" subscribedApplications: ").append(toIndentedString(subscribedApplications)).append("\n"); sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n"); + sb.append(" periodEndOverride: ").append(toIndentedString(periodEndOverride)).append("\n"); sb.append(" hasProgress: ").append(toIndentedString(hasProgress)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" sandbox: ").append(toIndentedString(sandbox)).append("\n"); @@ -806,7 +836,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("id", "created", "name", "title", "description", "target", "period", "recurrencePolicy", "activationPolicy", "fixedStartDate", "endDate", "allowRollbackAfterCompletion", "subscribedApplications", "userId", "createdBy", "hasProgress", "status", "sandbox", "timezone")); + openapiFields = new HashSet(Arrays.asList("id", "created", "name", "title", "description", "target", "period", "recurrencePolicy", "activationPolicy", "fixedStartDate", "endDate", "allowRollbackAfterCompletion", "subscribedApplications", "userId", "createdBy", "periodEndOverride", "hasProgress", "status", "sandbox", "timezone")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("id", "created", "name", "title", "description", "target", "recurrencePolicy", "activationPolicy", "subscribedApplications", "userId", "sandbox", "timezone")); @@ -863,6 +893,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("createdBy") != null && !jsonObj.get("createdBy").isJsonNull()) && !jsonObj.get("createdBy").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `createdBy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdBy").toString())); } + // validate the optional field `periodEndOverride` + if (jsonObj.get("periodEndOverride") != null && !jsonObj.get("periodEndOverride").isJsonNull()) { + TimePoint.validateJsonElement(jsonObj.get("periodEndOverride")); + } if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString())); } diff --git a/src/main/java/one/talon/model/ActivateLoyaltyPoints.java b/src/main/java/one/talon/model/ActivateLoyaltyPoints.java index b31d43de..f97aab37 100644 --- a/src/main/java/one/talon/model/ActivateLoyaltyPoints.java +++ b/src/main/java/one/talon/model/ActivateLoyaltyPoints.java @@ -51,7 +51,7 @@ /** * Activate loyalty points */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ActivateLoyaltyPoints { public static final String SERIALIZED_NAME_TRANSACTION_U_U_I_DS = "transactionUUIDs"; @SerializedName(SERIALIZED_NAME_TRANSACTION_U_U_I_DS) diff --git a/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java b/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java index 31807b00..bd2ae5c3 100644 --- a/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java +++ b/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java @@ -51,7 +51,7 @@ /** * ActivateLoyaltyPointsResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ActivateLoyaltyPointsResponse { public static final String SERIALIZED_NAME_LEDGER_ENTRIES = "ledgerEntries"; @SerializedName(SERIALIZED_NAME_LEDGER_ENTRIES) diff --git a/src/main/java/one/talon/model/ActivateUserRequest.java b/src/main/java/one/talon/model/ActivateUserRequest.java index 5118cbe0..f39d045a 100644 --- a/src/main/java/one/talon/model/ActivateUserRequest.java +++ b/src/main/java/one/talon/model/ActivateUserRequest.java @@ -48,7 +48,7 @@ /** * ActivateUserRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ActivateUserRequest { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/AddFreeItemEffectProps.java b/src/main/java/one/talon/model/AddFreeItemEffectProps.java index 1ced9c6f..58b9cfbd 100644 --- a/src/main/java/one/talon/model/AddFreeItemEffectProps.java +++ b/src/main/java/one/talon/model/AddFreeItemEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"addFreeItem\" effect. This gets triggered whenever a validated rule contained an \"add free item\" effect. + * This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set its price to `0`. The effect of a successful referral can mean a free item for someone else, such as the referrer. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddFreeItemEffectProps { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) @@ -93,7 +93,7 @@ public AddFreeItemEffectProps name(@javax.annotation.Nonnull String name) { } /** - * The name / description of the effect + * Description of the effect. * @return name */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/AddItemCatalogAction.java b/src/main/java/one/talon/model/AddItemCatalogAction.java index 396c9afb..a0e5e258 100644 --- a/src/main/java/one/talon/model/AddItemCatalogAction.java +++ b/src/main/java/one/talon/model/AddItemCatalogAction.java @@ -50,7 +50,7 @@ /** * The specific properties of the \"ADD\" catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddItemCatalogAction { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/AddLoyaltyPoints.java b/src/main/java/one/talon/model/AddLoyaltyPoints.java index e1b69e3a..fc5922f8 100644 --- a/src/main/java/one/talon/model/AddLoyaltyPoints.java +++ b/src/main/java/one/talon/model/AddLoyaltyPoints.java @@ -50,7 +50,7 @@ /** * Points to add. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddLoyaltyPoints { public static final String SERIALIZED_NAME_POINTS = "points"; @SerializedName(SERIALIZED_NAME_POINTS) diff --git a/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java index 6432208f..9c378b5a 100644 --- a/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java +++ b/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java @@ -48,9 +48,9 @@ import one.talon.JSON; /** - * The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. + * This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card. If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which item to add the loyalty points for. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. See the example below for more information. If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the items for which loyalty points are added. If you have set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card on which these points are added. The points only persist when the session is closed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddLoyaltyPointsEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -141,7 +141,7 @@ public AddLoyaltyPointsEffectProps name(@javax.annotation.Nonnull String name) { } /** - * The name / description of this loyalty point addition. + * The reason of this loyalty point addition. * @return name */ @javax.annotation.Nonnull @@ -217,7 +217,7 @@ public AddLoyaltyPointsEffectProps desiredValue(@javax.annotation.Nullable BigDe } /** - * The original amount of loyalty points to be awarded. + * (Partial rewards enabled only) The amount of loyalty points to be awarded without considering budget limitations. * @return desiredValue */ @javax.annotation.Nullable @@ -255,7 +255,7 @@ public AddLoyaltyPointsEffectProps startDate(@javax.annotation.Nullable OffsetDa } /** - * Date after which points will be valid. + * The date after which the added points will be valid. * @return startDate */ @javax.annotation.Nullable @@ -274,7 +274,7 @@ public AddLoyaltyPointsEffectProps expiryDate(@javax.annotation.Nullable OffsetD } /** - * Date after which points will expire. + * The date after which the added points will expire. * @return expiryDate */ @javax.annotation.Nullable @@ -293,7 +293,7 @@ public AddLoyaltyPointsEffectProps transactionUUID(@javax.annotation.Nonnull Str } /** - * The identifier of this addition in the loyalty ledger. + * The identifier of this loyalty point transaction. * @return transactionUUID */ @javax.annotation.Nonnull @@ -312,7 +312,7 @@ public AddLoyaltyPointsEffectProps cartItemPosition(@javax.annotation.Nullable B } /** - * The index of the item in the cart items list on which the loyal points addition should be applied. + * (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were added. * @return cartItemPosition */ @javax.annotation.Nullable @@ -331,7 +331,7 @@ public AddLoyaltyPointsEffectProps cartItemSubPosition(@javax.annotation.Nullabl } /** - * For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. + * (_Add points per cart item_ ) The index of the item unit in its line item. * @return cartItemSubPosition */ @javax.annotation.Nullable @@ -350,7 +350,7 @@ public AddLoyaltyPointsEffectProps cardIdentifier(@javax.annotation.Nullable Str } /** - * The card on which these points were added. + * The identifier of the card on which these points were added. * @return cardIdentifier */ @javax.annotation.Nullable @@ -369,7 +369,7 @@ public AddLoyaltyPointsEffectProps bundleIndex(@javax.annotation.Nullable Long b } /** - * The position of the bundle in a list of item bundles created from the same bundle definition. + * _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. * @return bundleIndex */ @javax.annotation.Nullable @@ -388,7 +388,7 @@ public AddLoyaltyPointsEffectProps bundleName(@javax.annotation.Nullable String } /** - * The name of the bundle definition. + * _(With bundles only)_ The name of the bundle definition. * @return bundleName */ @javax.annotation.Nullable @@ -407,7 +407,7 @@ public AddLoyaltyPointsEffectProps awaitsActivation(@javax.annotation.Nullable B } /** - * If `true`, the loyalty points remain pending until a specific action is complete. The `startDate` parameter automatically sets to `on_action`. + * Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. * @return awaitsActivation */ @javax.annotation.Nullable @@ -426,7 +426,7 @@ public AddLoyaltyPointsEffectProps validityDuration(@javax.annotation.Nullable S } /** - * The duration for which the points remain active, calculated relative to the activation date. **Note**: This value is returned only if `awaitsActivation` is `true` and `expiryDate` is not set. + * The duration for which the points remain active, calculated relative to their start date. * @return validityDuration */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java b/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java index bd88c768..82b4d89f 100644 --- a/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java +++ b/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java @@ -51,7 +51,7 @@ /** * The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action. **Note:** You can only use this object if the `Beta` **price types** feature is enabled for your Application. To enable it, contact your Technical Account Manager. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddPriceAdjustmentCatalogAction { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/AddToAudienceEffectProps.java b/src/main/java/one/talon/model/AddToAudienceEffectProps.java index 75b8818c..e511cc3e 100644 --- a/src/main/java/one/talon/model/AddToAudienceEffectProps.java +++ b/src/main/java/one/talon/model/AddToAudienceEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect. + * This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Add customer to an audience** selected is validated. It indicates that a customer was added to an audience and is returned when a customer session is opened, updated, or closed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddToAudienceEffectProps { public static final String SERIALIZED_NAME_AUDIENCE_ID = "audienceId"; @SerializedName(SERIALIZED_NAME_AUDIENCE_ID) diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java index 306e4d70..66c61444 100644 --- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java +++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java @@ -51,7 +51,7 @@ /** * AddedDeductedPointsBalancesAction */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddedDeductedPointsBalancesAction { public static final String SERIALIZED_NAME_AMOUNT = "Amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java index 5e66e5b0..d9bb44c1 100644 --- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java +++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java @@ -52,7 +52,7 @@ /** * AddedDeductedPointsBalancesNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddedDeductedPointsBalancesNotification { public static final String SERIALIZED_NAME_EMPLOYEE_NAME = "EmployeeName"; @SerializedName(SERIALIZED_NAME_EMPLOYEE_NAME) diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java index 0478e17c..c9d8b78a 100644 --- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java +++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java @@ -50,7 +50,7 @@ /** * AddedDeductedPointsBalancesNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddedDeductedPointsBalancesNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/AddedDeductedPointsNotification.java b/src/main/java/one/talon/model/AddedDeductedPointsNotification.java index 56e3a12a..1c8414e3 100644 --- a/src/main/java/one/talon/model/AddedDeductedPointsNotification.java +++ b/src/main/java/one/talon/model/AddedDeductedPointsNotification.java @@ -51,7 +51,7 @@ /** * AddedDeductedPointsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddedDeductedPointsNotification { public static final String SERIALIZED_NAME_EMPLOYEE_NAME = "EmployeeName"; @SerializedName(SERIALIZED_NAME_EMPLOYEE_NAME) diff --git a/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java b/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java index 7f087c3f..44187a24 100644 --- a/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java +++ b/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java @@ -50,7 +50,7 @@ /** * AddedDeductedPointsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AddedDeductedPointsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/AdditionalCampaignProperties.java b/src/main/java/one/talon/model/AdditionalCampaignProperties.java index d940dccb..4964fc32 100644 --- a/src/main/java/one/talon/model/AdditionalCampaignProperties.java +++ b/src/main/java/one/talon/model/AdditionalCampaignProperties.java @@ -53,7 +53,7 @@ /** * AdditionalCampaignProperties */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AdditionalCampaignProperties { public static final String SERIALIZED_NAME_BUDGETS = "budgets"; @SerializedName(SERIALIZED_NAME_BUDGETS) diff --git a/src/main/java/one/talon/model/AdditionalCost.java b/src/main/java/one/talon/model/AdditionalCost.java index 4eedd157..5fd97eae 100644 --- a/src/main/java/one/talon/model/AdditionalCost.java +++ b/src/main/java/one/talon/model/AdditionalCost.java @@ -49,7 +49,7 @@ /** * AdditionalCost */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AdditionalCost { public static final String SERIALIZED_NAME_PRICE = "price"; @SerializedName(SERIALIZED_NAME_PRICE) diff --git a/src/main/java/one/talon/model/AdjustmentDetails.java b/src/main/java/one/talon/model/AdjustmentDetails.java index 181fb934..d29dc3ed 100644 --- a/src/main/java/one/talon/model/AdjustmentDetails.java +++ b/src/main/java/one/talon/model/AdjustmentDetails.java @@ -49,7 +49,7 @@ /** * Details about an applied price adjustment. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AdjustmentDetails { public static final String SERIALIZED_NAME_REFERENCE_ID = "referenceId"; @SerializedName(SERIALIZED_NAME_REFERENCE_ID) diff --git a/src/main/java/one/talon/model/AnalyticsDataPoint.java b/src/main/java/one/talon/model/AnalyticsDataPoint.java index fa188c6c..635519d4 100644 --- a/src/main/java/one/talon/model/AnalyticsDataPoint.java +++ b/src/main/java/one/talon/model/AnalyticsDataPoint.java @@ -49,7 +49,7 @@ /** * AnalyticsDataPoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsDataPoint { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java index cd944807..9f981a2d 100644 --- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java +++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java @@ -49,7 +49,7 @@ /** * AnalyticsDataPointWithTrend */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsDataPointWithTrend { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java index c81fe759..0dd1d962 100644 --- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java +++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java @@ -49,7 +49,7 @@ /** * AnalyticsDataPointWithTrendAndInfluencedRate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsDataPointWithTrendAndInfluencedRate { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java index 2de0272b..b6837f7f 100644 --- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java +++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java @@ -49,7 +49,7 @@ /** * AnalyticsDataPointWithTrendAndUplift */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsDataPointWithTrendAndUplift { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/AnalyticsProduct.java b/src/main/java/one/talon/model/AnalyticsProduct.java index 94f6ea88..fdd4d290 100644 --- a/src/main/java/one/talon/model/AnalyticsProduct.java +++ b/src/main/java/one/talon/model/AnalyticsProduct.java @@ -49,7 +49,7 @@ /** * AnalyticsProduct */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsProduct { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AnalyticsSKU.java b/src/main/java/one/talon/model/AnalyticsSKU.java index a5faa17d..b692b8b8 100644 --- a/src/main/java/one/talon/model/AnalyticsSKU.java +++ b/src/main/java/one/talon/model/AnalyticsSKU.java @@ -50,7 +50,7 @@ /** * AnalyticsSKU */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AnalyticsSKU { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Application.java b/src/main/java/one/talon/model/Application.java index d77a9f23..5f40dd20 100644 --- a/src/main/java/one/talon/model/Application.java +++ b/src/main/java/one/talon/model/Application.java @@ -54,7 +54,7 @@ /** * Application */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Application { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ApplicationAPIKey.java b/src/main/java/one/talon/model/ApplicationAPIKey.java index 6601fd27..d5189f97 100644 --- a/src/main/java/one/talon/model/ApplicationAPIKey.java +++ b/src/main/java/one/talon/model/ApplicationAPIKey.java @@ -49,7 +49,7 @@ /** * ApplicationAPIKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationAPIKey { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java b/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java index cb3672df..e00c49ac 100644 --- a/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java +++ b/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java @@ -51,7 +51,7 @@ /** * ApplicationAnalyticsDataPoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationAnalyticsDataPoint { public static final String SERIALIZED_NAME_START_TIME = "startTime"; @SerializedName(SERIALIZED_NAME_START_TIME) diff --git a/src/main/java/one/talon/model/ApplicationApiHealth.java b/src/main/java/one/talon/model/ApplicationApiHealth.java index d68e264e..cc8afa51 100644 --- a/src/main/java/one/talon/model/ApplicationApiHealth.java +++ b/src/main/java/one/talon/model/ApplicationApiHealth.java @@ -49,7 +49,7 @@ /** * Report of health of the API connection of an application. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationApiHealth { /** * One-word summary of the health of the API connection of an application. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 5 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. diff --git a/src/main/java/one/talon/model/ApplicationCIF.java b/src/main/java/one/talon/model/ApplicationCIF.java index a6f7c84b..562e4c48 100644 --- a/src/main/java/one/talon/model/ApplicationCIF.java +++ b/src/main/java/one/talon/model/ApplicationCIF.java @@ -49,7 +49,7 @@ /** * ApplicationCIF */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCIF { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ApplicationCIFExpression.java b/src/main/java/one/talon/model/ApplicationCIFExpression.java index 96f6ec56..96cda42a 100644 --- a/src/main/java/one/talon/model/ApplicationCIFExpression.java +++ b/src/main/java/one/talon/model/ApplicationCIFExpression.java @@ -51,7 +51,7 @@ /** * ApplicationCIFExpression */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCIFExpression { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ApplicationCIFReferences.java b/src/main/java/one/talon/model/ApplicationCIFReferences.java index f2a0fd8f..d0f13464 100644 --- a/src/main/java/one/talon/model/ApplicationCIFReferences.java +++ b/src/main/java/one/talon/model/ApplicationCIFReferences.java @@ -51,7 +51,7 @@ /** * ApplicationCIFReferences */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCIFReferences { public static final String SERIALIZED_NAME_APPLICATION_CART_ITEM_FILTER_ID = "applicationCartItemFilterId"; @SerializedName(SERIALIZED_NAME_APPLICATION_CART_ITEM_FILTER_ID) diff --git a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java index 651d387a..37e26ad4 100644 --- a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java +++ b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java @@ -54,7 +54,7 @@ /** * ApplicationCampaignAnalytics */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCampaignAnalytics { public static final String SERIALIZED_NAME_START_TIME = "startTime"; @SerializedName(SERIALIZED_NAME_START_TIME) diff --git a/src/main/java/one/talon/model/ApplicationCampaignStats.java b/src/main/java/one/talon/model/ApplicationCampaignStats.java index 5a99a8a7..70208f1c 100644 --- a/src/main/java/one/talon/model/ApplicationCampaignStats.java +++ b/src/main/java/one/talon/model/ApplicationCampaignStats.java @@ -48,7 +48,7 @@ /** * Provides statistics regarding an application's campaigns. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCampaignStats { public static final String SERIALIZED_NAME_DISABLED = "disabled"; @SerializedName(SERIALIZED_NAME_DISABLED) diff --git a/src/main/java/one/talon/model/ApplicationCustomer.java b/src/main/java/one/talon/model/ApplicationCustomer.java index bf108298..569ebf47 100644 --- a/src/main/java/one/talon/model/ApplicationCustomer.java +++ b/src/main/java/one/talon/model/ApplicationCustomer.java @@ -56,7 +56,7 @@ /** * ApplicationCustomer */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCustomer { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ApplicationCustomerEntity.java b/src/main/java/one/talon/model/ApplicationCustomerEntity.java index 330e5771..b4e88bc6 100644 --- a/src/main/java/one/talon/model/ApplicationCustomerEntity.java +++ b/src/main/java/one/talon/model/ApplicationCustomerEntity.java @@ -48,7 +48,7 @@ /** * ApplicationCustomerEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationCustomerEntity { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/ApplicationEntity.java b/src/main/java/one/talon/model/ApplicationEntity.java index 3f72f275..f6782f35 100644 --- a/src/main/java/one/talon/model/ApplicationEntity.java +++ b/src/main/java/one/talon/model/ApplicationEntity.java @@ -48,7 +48,7 @@ /** * ApplicationEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationEntity { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/ApplicationEvent.java b/src/main/java/one/talon/model/ApplicationEvent.java index 63b50b64..8738760e 100644 --- a/src/main/java/one/talon/model/ApplicationEvent.java +++ b/src/main/java/one/talon/model/ApplicationEvent.java @@ -53,7 +53,7 @@ /** * ApplicationEvent */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationEvent { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -295,7 +295,7 @@ public ApplicationEvent attributes(@javax.annotation.Nonnull Object attributes) } /** - * Additional JSON serialized data associated with the event. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ApplicationNotification.java b/src/main/java/one/talon/model/ApplicationNotification.java index 61d478ab..2854c720 100644 --- a/src/main/java/one/talon/model/ApplicationNotification.java +++ b/src/main/java/one/talon/model/ApplicationNotification.java @@ -48,7 +48,7 @@ /** * ApplicationNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationNotification { public static final String SERIALIZED_NAME_EVENT = "event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/ApplicationReferee.java b/src/main/java/one/talon/model/ApplicationReferee.java index aab27eab..c8ec60f5 100644 --- a/src/main/java/one/talon/model/ApplicationReferee.java +++ b/src/main/java/one/talon/model/ApplicationReferee.java @@ -49,7 +49,7 @@ /** * ApplicationReferee */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationReferee { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/ApplicationSession.java b/src/main/java/one/talon/model/ApplicationSession.java index b84b0b8d..0f74296e 100644 --- a/src/main/java/one/talon/model/ApplicationSession.java +++ b/src/main/java/one/talon/model/ApplicationSession.java @@ -55,7 +55,7 @@ /** * ApplicationSession */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationSession { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -479,7 +479,7 @@ public ApplicationSession attributes(@javax.annotation.Nullable Object attribute } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/ApplicationSessionEntity.java b/src/main/java/one/talon/model/ApplicationSessionEntity.java index f130986c..2d112ff2 100644 --- a/src/main/java/one/talon/model/ApplicationSessionEntity.java +++ b/src/main/java/one/talon/model/ApplicationSessionEntity.java @@ -48,7 +48,7 @@ /** * ApplicationSessionEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationSessionEntity { public static final String SERIALIZED_NAME_SESSION_ID = "sessionId"; @SerializedName(SERIALIZED_NAME_SESSION_ID) diff --git a/src/main/java/one/talon/model/ApplicationStoreEntity.java b/src/main/java/one/talon/model/ApplicationStoreEntity.java index 3b7dd243..8e8d9f2a 100644 --- a/src/main/java/one/talon/model/ApplicationStoreEntity.java +++ b/src/main/java/one/talon/model/ApplicationStoreEntity.java @@ -48,7 +48,7 @@ /** * ApplicationStoreEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ApplicationStoreEntity { public static final String SERIALIZED_NAME_STORE_ID = "storeId"; @SerializedName(SERIALIZED_NAME_STORE_ID) diff --git a/src/main/java/one/talon/model/AsyncCouponCreationResponse.java b/src/main/java/one/talon/model/AsyncCouponCreationResponse.java index 715d4ac2..c0b1fb0f 100644 --- a/src/main/java/one/talon/model/AsyncCouponCreationResponse.java +++ b/src/main/java/one/talon/model/AsyncCouponCreationResponse.java @@ -48,7 +48,7 @@ /** * AsyncCouponCreationResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AsyncCouponCreationResponse { public static final String SERIALIZED_NAME_BATCH_ID = "batchId"; @SerializedName(SERIALIZED_NAME_BATCH_ID) diff --git a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java index 6fb77c32..8955d569 100644 --- a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java +++ b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java @@ -48,7 +48,7 @@ /** * AsyncCouponDeletionJobResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AsyncCouponDeletionJobResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AsyncCouponsData.java b/src/main/java/one/talon/model/AsyncCouponsData.java index 79a01d9a..4148175a 100644 --- a/src/main/java/one/talon/model/AsyncCouponsData.java +++ b/src/main/java/one/talon/model/AsyncCouponsData.java @@ -48,7 +48,7 @@ /** * AsyncCouponsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AsyncCouponsData { public static final String SERIALIZED_NAME_BATCH_I_D = "BatchID"; @SerializedName(SERIALIZED_NAME_BATCH_I_D) diff --git a/src/main/java/one/talon/model/Attribute.java b/src/main/java/one/talon/model/Attribute.java index 7c4fff06..5bb9939a 100644 --- a/src/main/java/one/talon/model/Attribute.java +++ b/src/main/java/one/talon/model/Attribute.java @@ -51,7 +51,7 @@ /** * Attribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Attribute { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AttributesMandatory.java b/src/main/java/one/talon/model/AttributesMandatory.java index 9c09d1bc..890b9a91 100644 --- a/src/main/java/one/talon/model/AttributesMandatory.java +++ b/src/main/java/one/talon/model/AttributesMandatory.java @@ -50,7 +50,7 @@ /** * Arbitrary settings associated with attributes. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AttributesMandatory { public static final String SERIALIZED_NAME_CAMPAIGNS = "campaigns"; @SerializedName(SERIALIZED_NAME_CAMPAIGNS) diff --git a/src/main/java/one/talon/model/AttributesSettings.java b/src/main/java/one/talon/model/AttributesSettings.java index 89138f3e..2ed44a60 100644 --- a/src/main/java/one/talon/model/AttributesSettings.java +++ b/src/main/java/one/talon/model/AttributesSettings.java @@ -49,7 +49,7 @@ /** * Arbitrary settings associated with attributes. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AttributesSettings { public static final String SERIALIZED_NAME_MANDATORY = "mandatory"; @SerializedName(SERIALIZED_NAME_MANDATORY) diff --git a/src/main/java/one/talon/model/Audience.java b/src/main/java/one/talon/model/Audience.java index 17265a23..88a9e2ed 100644 --- a/src/main/java/one/talon/model/Audience.java +++ b/src/main/java/one/talon/model/Audience.java @@ -51,7 +51,7 @@ /** * Audience */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Audience { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/AudienceAnalytics.java b/src/main/java/one/talon/model/AudienceAnalytics.java index 9cbd4427..e742a8aa 100644 --- a/src/main/java/one/talon/model/AudienceAnalytics.java +++ b/src/main/java/one/talon/model/AudienceAnalytics.java @@ -48,7 +48,7 @@ /** * The audiences and their member count. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AudienceAnalytics { public static final String SERIALIZED_NAME_AUDIENCE_ID = "audienceId"; @SerializedName(SERIALIZED_NAME_AUDIENCE_ID) diff --git a/src/main/java/one/talon/model/AudienceCustomer.java b/src/main/java/one/talon/model/AudienceCustomer.java index 9111135f..97e8ef52 100644 --- a/src/main/java/one/talon/model/AudienceCustomer.java +++ b/src/main/java/one/talon/model/AudienceCustomer.java @@ -56,7 +56,7 @@ /** * AudienceCustomer */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AudienceCustomer { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AudienceIntegrationID.java b/src/main/java/one/talon/model/AudienceIntegrationID.java index ea64f0f8..6c4814cc 100644 --- a/src/main/java/one/talon/model/AudienceIntegrationID.java +++ b/src/main/java/one/talon/model/AudienceIntegrationID.java @@ -48,7 +48,7 @@ /** * AudienceIntegrationID */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AudienceIntegrationID { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/AudienceMembership.java b/src/main/java/one/talon/model/AudienceMembership.java index 03a2ee77..89413286 100644 --- a/src/main/java/one/talon/model/AudienceMembership.java +++ b/src/main/java/one/talon/model/AudienceMembership.java @@ -48,7 +48,7 @@ /** * AudienceMembership */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AudienceMembership { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/AudienceReference.java b/src/main/java/one/talon/model/AudienceReference.java index 5d97d694..f1f0261f 100644 --- a/src/main/java/one/talon/model/AudienceReference.java +++ b/src/main/java/one/talon/model/AudienceReference.java @@ -48,7 +48,7 @@ /** * AudienceReference */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AudienceReference { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/AwardGiveawayEffectProps.java b/src/main/java/one/talon/model/AwardGiveawayEffectProps.java index 6985340f..99c3d2aa 100644 --- a/src/main/java/one/talon/model/AwardGiveawayEffectProps.java +++ b/src/main/java/one/talon/model/AwardGiveawayEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"awardGiveaway\" effect. This effect contains information on the giveaway item, and which profile it was awarded to. + * This effect indicates the awarded giveaway item and to which profile the item was awarded. Learn more about [giveaways](https://docs.talon.one/docs/product/giveaways/overview). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class AwardGiveawayEffectProps { public static final String SERIALIZED_NAME_POOL_ID = "poolId"; @SerializedName(SERIALIZED_NAME_POOL_ID) @@ -84,7 +84,7 @@ public AwardGiveawayEffectProps poolId(@javax.annotation.Nonnull Long poolId) { } /** - * The ID of the giveaways pool the code was taken from. + * The internal ID of the giveaway pool. * @return poolId */ @javax.annotation.Nonnull @@ -103,7 +103,7 @@ public AwardGiveawayEffectProps poolName(@javax.annotation.Nonnull String poolNa } /** - * The name of the giveaways pool the code was taken from. + * The name of the giveaway pool. * @return poolName */ @javax.annotation.Nonnull @@ -122,7 +122,7 @@ public AwardGiveawayEffectProps recipientIntegrationId(@javax.annotation.Nonnull } /** - * The integration ID of the profile that was awarded the giveaway. + * The integration ID of the customer that receives the giveaway. * @return recipientIntegrationId */ @javax.annotation.Nonnull @@ -141,7 +141,7 @@ public AwardGiveawayEffectProps giveawayId(@javax.annotation.Nonnull Long giveaw } /** - * The internal ID for the giveaway that was awarded. + * The internal ID of the giveaway. * @return giveawayId */ @javax.annotation.Nonnull @@ -160,7 +160,7 @@ public AwardGiveawayEffectProps code(@javax.annotation.Nonnull String code) { } /** - * The giveaway code that was awarded. + * The giveaway code to be rewarded. * @return code */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/BaseCampaign.java b/src/main/java/one/talon/model/BaseCampaign.java index 173a7895..5c5d7d6e 100644 --- a/src/main/java/one/talon/model/BaseCampaign.java +++ b/src/main/java/one/talon/model/BaseCampaign.java @@ -53,7 +53,7 @@ /** * BaseCampaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseCampaign { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/BaseLoyaltyProgram.java b/src/main/java/one/talon/model/BaseLoyaltyProgram.java index 009df2ca..658dfab3 100644 --- a/src/main/java/one/talon/model/BaseLoyaltyProgram.java +++ b/src/main/java/one/talon/model/BaseLoyaltyProgram.java @@ -52,7 +52,7 @@ /** * BaseLoyaltyProgram */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseLoyaltyProgram { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/BaseNotification.java b/src/main/java/one/talon/model/BaseNotification.java index 0bb158e4..ce783493 100644 --- a/src/main/java/one/talon/model/BaseNotification.java +++ b/src/main/java/one/talon/model/BaseNotification.java @@ -49,7 +49,7 @@ /** * BaseNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseNotification { public static final String SERIALIZED_NAME_POLICY = "policy"; @SerializedName(SERIALIZED_NAME_POLICY) diff --git a/src/main/java/one/talon/model/BaseNotificationEntity.java b/src/main/java/one/talon/model/BaseNotificationEntity.java index 54f33d57..3d172fcf 100644 --- a/src/main/java/one/talon/model/BaseNotificationEntity.java +++ b/src/main/java/one/talon/model/BaseNotificationEntity.java @@ -48,7 +48,7 @@ /** * BaseNotificationEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseNotificationEntity { public static final String SERIALIZED_NAME_POLICY = "policy"; @SerializedName(SERIALIZED_NAME_POLICY) diff --git a/src/main/java/one/talon/model/BaseNotificationWebhook.java b/src/main/java/one/talon/model/BaseNotificationWebhook.java index 1a0c579d..4bd88adb 100644 --- a/src/main/java/one/talon/model/BaseNotificationWebhook.java +++ b/src/main/java/one/talon/model/BaseNotificationWebhook.java @@ -51,7 +51,7 @@ /** * BaseNotificationWebhook */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseNotificationWebhook { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/BaseNotifications.java b/src/main/java/one/talon/model/BaseNotifications.java index 1245c90a..f5e7996e 100644 --- a/src/main/java/one/talon/model/BaseNotifications.java +++ b/src/main/java/one/talon/model/BaseNotifications.java @@ -51,7 +51,7 @@ /** * BaseNotifications */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseNotifications { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/BaseSamlConnection.java b/src/main/java/one/talon/model/BaseSamlConnection.java index bdcc81ed..32d42f35 100644 --- a/src/main/java/one/talon/model/BaseSamlConnection.java +++ b/src/main/java/one/talon/model/BaseSamlConnection.java @@ -48,7 +48,7 @@ /** * BaseSamlConnection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BaseSamlConnection { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/BestPriorPrice.java b/src/main/java/one/talon/model/BestPriorPrice.java index 023e3db5..8e458aff 100644 --- a/src/main/java/one/talon/model/BestPriorPrice.java +++ b/src/main/java/one/talon/model/BestPriorPrice.java @@ -53,7 +53,7 @@ /** * BestPriorPrice */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BestPriorPrice { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/BestPriorPriceMetadata.java b/src/main/java/one/talon/model/BestPriorPriceMetadata.java index 3147d026..cf6cc75a 100644 --- a/src/main/java/one/talon/model/BestPriorPriceMetadata.java +++ b/src/main/java/one/talon/model/BestPriorPriceMetadata.java @@ -52,7 +52,7 @@ /** * Auxiliary data for found price observation. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BestPriorPriceMetadata { public static final String SERIALIZED_NAME_INFLUENCING_CAMPAIGN_DETAILS = "influencingCampaignDetails"; @SerializedName(SERIALIZED_NAME_INFLUENCING_CAMPAIGN_DETAILS) diff --git a/src/main/java/one/talon/model/BestPriorPriceRequest.java b/src/main/java/one/talon/model/BestPriorPriceRequest.java index 5821ed6e..3734b12d 100644 --- a/src/main/java/one/talon/model/BestPriorPriceRequest.java +++ b/src/main/java/one/talon/model/BestPriorPriceRequest.java @@ -52,7 +52,7 @@ /** * BestPriorPriceRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BestPriorPriceRequest { public static final String SERIALIZED_NAME_SKUS = "skus"; @SerializedName(SERIALIZED_NAME_SKUS) diff --git a/src/main/java/one/talon/model/BestPriorTarget.java b/src/main/java/one/talon/model/BestPriorTarget.java index 1b0fccb0..dfed4256 100644 --- a/src/main/java/one/talon/model/BestPriorTarget.java +++ b/src/main/java/one/talon/model/BestPriorTarget.java @@ -48,7 +48,7 @@ /** * Specifies the target for which the best prior price calculation is taken into consideration. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BestPriorTarget { /** * The type of price target. diff --git a/src/main/java/one/talon/model/Binding.java b/src/main/java/one/talon/model/Binding.java index 2933b480..722c1271 100644 --- a/src/main/java/one/talon/model/Binding.java +++ b/src/main/java/one/talon/model/Binding.java @@ -51,7 +51,7 @@ /** * Binding */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Binding { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/Blueprint.java b/src/main/java/one/talon/model/Blueprint.java index 733eb945..f314622e 100644 --- a/src/main/java/one/talon/model/Blueprint.java +++ b/src/main/java/one/talon/model/Blueprint.java @@ -53,7 +53,7 @@ /** * Blueprint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Blueprint { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/BulkApplicationNotification.java b/src/main/java/one/talon/model/BulkApplicationNotification.java index e237c17f..4833afe4 100644 --- a/src/main/java/one/talon/model/BulkApplicationNotification.java +++ b/src/main/java/one/talon/model/BulkApplicationNotification.java @@ -51,7 +51,7 @@ /** * BulkApplicationNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BulkApplicationNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java index df3f876e..4fc7ec8f 100644 --- a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java +++ b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java @@ -51,7 +51,7 @@ /** * BulkOperationOnCampaigns */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class BulkOperationOnCampaigns { /** * The operation to perform on the specified campaign IDs. diff --git a/src/main/java/one/talon/model/Campaign.java b/src/main/java/one/talon/model/Campaign.java index 26592a4f..236ae264 100644 --- a/src/main/java/one/talon/model/Campaign.java +++ b/src/main/java/one/talon/model/Campaign.java @@ -55,7 +55,7 @@ /** * Campaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Campaign { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignActivationRequest.java b/src/main/java/one/talon/model/CampaignActivationRequest.java index c36f30c1..7ef2c02f 100644 --- a/src/main/java/one/talon/model/CampaignActivationRequest.java +++ b/src/main/java/one/talon/model/CampaignActivationRequest.java @@ -50,7 +50,7 @@ /** * CampaignActivationRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignActivationRequest { public static final String SERIALIZED_NAME_USER_IDS = "userIds"; @SerializedName(SERIALIZED_NAME_USER_IDS) diff --git a/src/main/java/one/talon/model/CampaignAnalytics.java b/src/main/java/one/talon/model/CampaignAnalytics.java index d9f961ca..9d49999e 100644 --- a/src/main/java/one/talon/model/CampaignAnalytics.java +++ b/src/main/java/one/talon/model/CampaignAnalytics.java @@ -50,7 +50,7 @@ /** * CampaignAnalytics */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignAnalytics { public static final String SERIALIZED_NAME_DATE = "date"; @SerializedName(SERIALIZED_NAME_DATE) diff --git a/src/main/java/one/talon/model/CampaignBudget.java b/src/main/java/one/talon/model/CampaignBudget.java index 402e56ce..0f3f17a6 100644 --- a/src/main/java/one/talon/model/CampaignBudget.java +++ b/src/main/java/one/talon/model/CampaignBudget.java @@ -49,7 +49,7 @@ /** * CampaignBudget */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignBudget { public static final String SERIALIZED_NAME_ACTION = "action"; @SerializedName(SERIALIZED_NAME_ACTION) diff --git a/src/main/java/one/talon/model/CampaignCollection.java b/src/main/java/one/talon/model/CampaignCollection.java index 26566e31..f0ec064e 100644 --- a/src/main/java/one/talon/model/CampaignCollection.java +++ b/src/main/java/one/talon/model/CampaignCollection.java @@ -51,7 +51,7 @@ /** * CampaignCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCollection { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java b/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java index b7f1b766..e64bfca0 100644 --- a/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java +++ b/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java @@ -51,7 +51,7 @@ /** * CampaignCollectionEditedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCollectionEditedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java b/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java index 4e027d8c..ad64465f 100644 --- a/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java @@ -54,7 +54,7 @@ /** * CampaignCollectionEditedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCollectionEditedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java index 05866a0b..61fdc2cf 100644 --- a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java +++ b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java @@ -49,7 +49,7 @@ /** * CampaignCollectionWithoutPayload */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCollectionWithoutPayload { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignCopy.java b/src/main/java/one/talon/model/CampaignCopy.java index 7772c244..c03b55c7 100644 --- a/src/main/java/one/talon/model/CampaignCopy.java +++ b/src/main/java/one/talon/model/CampaignCopy.java @@ -51,7 +51,7 @@ /** * CampaignCopy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCopy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CampaignCreatedNotification.java b/src/main/java/one/talon/model/CampaignCreatedNotification.java index 5e5e8a07..762b1303 100644 --- a/src/main/java/one/talon/model/CampaignCreatedNotification.java +++ b/src/main/java/one/talon/model/CampaignCreatedNotification.java @@ -51,7 +51,7 @@ /** * CampaignCreatedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCreatedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java b/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java index ec0b7144..147adf09 100644 --- a/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java @@ -54,7 +54,7 @@ /** * CampaignCreatedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignCreatedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignDeactivationRequest.java b/src/main/java/one/talon/model/CampaignDeactivationRequest.java index e18133da..1cf05d5c 100644 --- a/src/main/java/one/talon/model/CampaignDeactivationRequest.java +++ b/src/main/java/one/talon/model/CampaignDeactivationRequest.java @@ -50,7 +50,7 @@ /** * CampaignDeactivationRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignDeactivationRequest { public static final String SERIALIZED_NAME_USER_IDS = "userIds"; @SerializedName(SERIALIZED_NAME_USER_IDS) diff --git a/src/main/java/one/talon/model/CampaignDeletedNotification.java b/src/main/java/one/talon/model/CampaignDeletedNotification.java index 82def811..b9c5851b 100644 --- a/src/main/java/one/talon/model/CampaignDeletedNotification.java +++ b/src/main/java/one/talon/model/CampaignDeletedNotification.java @@ -51,7 +51,7 @@ /** * CampaignDeletedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignDeletedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java b/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java index 39c669e9..2066a3fd 100644 --- a/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java @@ -50,7 +50,7 @@ /** * CampaignDeletedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignDeletedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignDetail.java b/src/main/java/one/talon/model/CampaignDetail.java index 7caee82f..7016446e 100644 --- a/src/main/java/one/talon/model/CampaignDetail.java +++ b/src/main/java/one/talon/model/CampaignDetail.java @@ -48,7 +48,7 @@ /** * CampaignDetail */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignDetail { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/CampaignEditedNotification.java b/src/main/java/one/talon/model/CampaignEditedNotification.java index 0ef41abe..ce361073 100644 --- a/src/main/java/one/talon/model/CampaignEditedNotification.java +++ b/src/main/java/one/talon/model/CampaignEditedNotification.java @@ -51,7 +51,7 @@ /** * CampaignEditedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEditedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignEditedNotificationItem.java b/src/main/java/one/talon/model/CampaignEditedNotificationItem.java index fe9592eb..2373ae2f 100644 --- a/src/main/java/one/talon/model/CampaignEditedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignEditedNotificationItem.java @@ -53,7 +53,7 @@ /** * CampaignEditedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEditedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignEligibility.java b/src/main/java/one/talon/model/CampaignEligibility.java index b87d9568..53440516 100644 --- a/src/main/java/one/talon/model/CampaignEligibility.java +++ b/src/main/java/one/talon/model/CampaignEligibility.java @@ -25,6 +25,7 @@ import java.util.Arrays; import java.util.List; import one.talon.model.CampaignEligibilityDetails; +import one.talon.model.CampaignEligibilityExperiment; import one.talon.model.RuleMetadataEligibility; import com.google.gson.Gson; @@ -53,7 +54,7 @@ /** * CampaignEligibility */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEligibility { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) @@ -225,6 +226,11 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nonnull private List rules = new ArrayList<>(); + public static final String SERIALIZED_NAME_EXPERIMENT = "experiment"; + @SerializedName(SERIALIZED_NAME_EXPERIMENT) + @javax.annotation.Nullable + private CampaignEligibilityExperiment experiment; + public CampaignEligibility() { } @@ -487,6 +493,25 @@ public void setRules(@javax.annotation.Nonnull List rul this.rules = rules; } + + public CampaignEligibility experiment(@javax.annotation.Nullable CampaignEligibilityExperiment experiment) { + this.experiment = experiment; + return this; + } + + /** + * Get experiment + * @return experiment + */ + @javax.annotation.Nullable + public CampaignEligibilityExperiment getExperiment() { + return experiment; + } + + public void setExperiment(@javax.annotation.Nullable CampaignEligibilityExperiment experiment) { + this.experiment = experiment; + } + /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -553,13 +578,14 @@ public boolean equals(Object o) { Objects.equals(this.tags, campaignEligibility.tags) && Objects.equals(this.features, campaignEligibility.features) && Objects.equals(this.eligibility, campaignEligibility.eligibility) && - Objects.equals(this.rules, campaignEligibility.rules)&& + Objects.equals(this.rules, campaignEligibility.rules) && + Objects.equals(this.experiment, campaignEligibility.experiment)&& Objects.equals(this.additionalProperties, campaignEligibility.additionalProperties); } @Override public int hashCode() { - return Objects.hash(applicationId, id, name, description, startTime, endTime, attributes, state, tags, features, eligibility, rules, additionalProperties); + return Objects.hash(applicationId, id, name, description, startTime, endTime, attributes, state, tags, features, eligibility, rules, experiment, additionalProperties); } @Override @@ -578,6 +604,7 @@ public String toString() { sb.append(" features: ").append(toIndentedString(features)).append("\n"); sb.append(" eligibility: ").append(toIndentedString(eligibility)).append("\n"); sb.append(" rules: ").append(toIndentedString(rules)).append("\n"); + sb.append(" experiment: ").append(toIndentedString(experiment)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -597,7 +624,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("applicationId", "id", "name", "description", "startTime", "endTime", "attributes", "state", "tags", "features", "eligibility", "rules")); + openapiFields = new HashSet(Arrays.asList("applicationId", "id", "name", "description", "startTime", "endTime", "attributes", "state", "tags", "features", "eligibility", "rules", "experiment")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("applicationId", "id", "name", "state", "tags", "features", "eligibility", "rules")); @@ -666,6 +693,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti RuleMetadataEligibility.validateJsonElement(jsonArrayrules.get(i)); } } + // validate the optional field `experiment` + if (jsonObj.get("experiment") != null && !jsonObj.get("experiment").isJsonNull()) { + CampaignEligibilityExperiment.validateJsonElement(jsonObj.get("experiment")); + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/one/talon/model/CampaignEligibilityDetails.java b/src/main/java/one/talon/model/CampaignEligibilityDetails.java index d4cf586d..4e3496d8 100644 --- a/src/main/java/one/talon/model/CampaignEligibilityDetails.java +++ b/src/main/java/one/talon/model/CampaignEligibilityDetails.java @@ -49,7 +49,7 @@ /** * CampaignEligibilityDetails */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEligibilityDetails { public static final String SERIALIZED_NAME_PASSED = "passed"; @SerializedName(SERIALIZED_NAME_PASSED) diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponsePatch.java b/src/main/java/one/talon/model/CampaignEligibilityExperiment.java similarity index 66% rename from src/main/java/one/talon/model/ScimServiceProviderConfigResponsePatch.java rename to src/main/java/one/talon/model/CampaignEligibilityExperiment.java index fe999959..d786d4d3 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponsePatch.java +++ b/src/main/java/one/talon/model/CampaignEligibilityExperiment.java @@ -46,34 +46,58 @@ import one.talon.JSON; /** - * Configuration settings related to patch operations, which allow partial updates to SCIM resources. + * The identifiers for the [experiment](https://docs.talon.one/management-api#tag/Experiments) and the variant assigned to the customer profile. Only returned when the customer profile has been assigned to a variant in an experiment campaign. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") -public class ScimServiceProviderConfigResponsePatch { - public static final String SERIALIZED_NAME_SUPPORTED = "supported"; - @SerializedName(SERIALIZED_NAME_SUPPORTED) - @javax.annotation.Nullable - private Boolean supported; - - public ScimServiceProviderConfigResponsePatch() { +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") +public class CampaignEligibilityExperiment { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + @javax.annotation.Nonnull + private Long id; + + public static final String SERIALIZED_NAME_VARIANT_ID = "variantId"; + @SerializedName(SERIALIZED_NAME_VARIANT_ID) + @javax.annotation.Nonnull + private Long variantId; + + public CampaignEligibilityExperiment() { } - public ScimServiceProviderConfigResponsePatch supported(@javax.annotation.Nullable Boolean supported) { - this.supported = supported; + public CampaignEligibilityExperiment id(@javax.annotation.Nonnull Long id) { + this.id = id; return this; } /** - * Indicates whether the service provider supports patch operations for modifying resources. - * @return supported + * The ID of the experiment. + * @return id */ - @javax.annotation.Nullable - public Boolean getSupported() { - return supported; + @javax.annotation.Nonnull + public Long getId() { + return id; } - public void setSupported(@javax.annotation.Nullable Boolean supported) { - this.supported = supported; + public void setId(@javax.annotation.Nonnull Long id) { + this.id = id; + } + + + public CampaignEligibilityExperiment variantId(@javax.annotation.Nonnull Long variantId) { + this.variantId = variantId; + return this; + } + + /** + * The ID of the variant assigned to the customer profile. + * @return variantId + */ + @javax.annotation.Nonnull + public Long getVariantId() { + return variantId; + } + + public void setVariantId(@javax.annotation.Nonnull Long variantId) { + this.variantId = variantId; } /** @@ -89,9 +113,9 @@ public void setSupported(@javax.annotation.Nullable Boolean supported) { * * @param key name of the property * @param value value of the property - * @return the ScimServiceProviderConfigResponsePatch instance itself + * @return the CampaignEligibilityExperiment instance itself */ - public ScimServiceProviderConfigResponsePatch putAdditionalProperty(String key, Object value) { + public CampaignEligibilityExperiment putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -130,21 +154,23 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - ScimServiceProviderConfigResponsePatch scimServiceProviderConfigResponsePatch = (ScimServiceProviderConfigResponsePatch) o; - return Objects.equals(this.supported, scimServiceProviderConfigResponsePatch.supported)&& - Objects.equals(this.additionalProperties, scimServiceProviderConfigResponsePatch.additionalProperties); + CampaignEligibilityExperiment campaignEligibilityExperiment = (CampaignEligibilityExperiment) o; + return Objects.equals(this.id, campaignEligibilityExperiment.id) && + Objects.equals(this.variantId, campaignEligibilityExperiment.variantId)&& + Objects.equals(this.additionalProperties, campaignEligibilityExperiment.additionalProperties); } @Override public int hashCode() { - return Objects.hash(supported, additionalProperties); + return Objects.hash(id, variantId, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class ScimServiceProviderConfigResponsePatch {\n"); - sb.append(" supported: ").append(toIndentedString(supported)).append("\n"); + sb.append("class CampaignEligibilityExperiment {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" variantId: ").append(toIndentedString(variantId)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -164,22 +190,29 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("supported")); + openapiFields = new HashSet(Arrays.asList("id", "variantId")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); + openapiRequiredFields = new HashSet(Arrays.asList("id", "variantId")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ScimServiceProviderConfigResponsePatch + * @throws IOException if the JSON Element is invalid with respect to CampaignEligibilityExperiment */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!ScimServiceProviderConfigResponsePatch.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in ScimServiceProviderConfigResponsePatch is not found in the empty JSON string", ScimServiceProviderConfigResponsePatch.openapiRequiredFields.toString())); + if (!CampaignEligibilityExperiment.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in CampaignEligibilityExperiment is not found in the empty JSON string", CampaignEligibilityExperiment.openapiRequiredFields.toString())); + } + } + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : CampaignEligibilityExperiment.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -189,16 +222,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!ScimServiceProviderConfigResponsePatch.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ScimServiceProviderConfigResponsePatch' and its subtypes + if (!CampaignEligibilityExperiment.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CampaignEligibilityExperiment' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ScimServiceProviderConfigResponsePatch.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CampaignEligibilityExperiment.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, ScimServiceProviderConfigResponsePatch value) throws IOException { + public void write(JsonWriter out, CampaignEligibilityExperiment value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -226,12 +259,12 @@ else if (entry.getValue() instanceof Character) } @Override - public ScimServiceProviderConfigResponsePatch read(JsonReader in) throws IOException { + public CampaignEligibilityExperiment read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - ScimServiceProviderConfigResponsePatch instance = thisAdapter.fromJsonTree(jsonObj); + CampaignEligibilityExperiment instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -258,18 +291,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of ScimServiceProviderConfigResponsePatch given an JSON string + * Create an instance of CampaignEligibilityExperiment given an JSON string * * @param jsonString JSON string - * @return An instance of ScimServiceProviderConfigResponsePatch - * @throws IOException if the JSON string is invalid with respect to ScimServiceProviderConfigResponsePatch + * @return An instance of CampaignEligibilityExperiment + * @throws IOException if the JSON string is invalid with respect to CampaignEligibilityExperiment */ - public static ScimServiceProviderConfigResponsePatch fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ScimServiceProviderConfigResponsePatch.class); + public static CampaignEligibilityExperiment fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CampaignEligibilityExperiment.class); } /** - * Convert an instance of ScimServiceProviderConfigResponsePatch to an JSON string + * Convert an instance of CampaignEligibilityExperiment to an JSON string * * @return JSON string */ diff --git a/src/main/java/one/talon/model/CampaignEligibilityFailureDetails.java b/src/main/java/one/talon/model/CampaignEligibilityFailureDetails.java index 81033940..895eea09 100644 --- a/src/main/java/one/talon/model/CampaignEligibilityFailureDetails.java +++ b/src/main/java/one/talon/model/CampaignEligibilityFailureDetails.java @@ -48,7 +48,7 @@ /** * The details about why the customer was not eligible for the campaign in the current session. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEligibilityFailureDetails { /** * A code identifying why the customer was not eligible for the campaign. diff --git a/src/main/java/one/talon/model/CampaignEntity.java b/src/main/java/one/talon/model/CampaignEntity.java index ee7e0d93..a1aeb054 100644 --- a/src/main/java/one/talon/model/CampaignEntity.java +++ b/src/main/java/one/talon/model/CampaignEntity.java @@ -48,7 +48,7 @@ /** * CampaignEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEntity { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/CampaignEvaluationGroup.java b/src/main/java/one/talon/model/CampaignEvaluationGroup.java index 5e3533bf..f52cb808 100644 --- a/src/main/java/one/talon/model/CampaignEvaluationGroup.java +++ b/src/main/java/one/talon/model/CampaignEvaluationGroup.java @@ -48,7 +48,7 @@ /** * CampaignEvaluationGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEvaluationGroup { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/CampaignEvaluationPosition.java b/src/main/java/one/talon/model/CampaignEvaluationPosition.java index 1248e76c..f4c8b1e8 100644 --- a/src/main/java/one/talon/model/CampaignEvaluationPosition.java +++ b/src/main/java/one/talon/model/CampaignEvaluationPosition.java @@ -48,7 +48,7 @@ /** * The campaign position within the evaluation tree. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEvaluationPosition { public static final String SERIALIZED_NAME_GROUP_ID = "groupId"; @SerializedName(SERIALIZED_NAME_GROUP_ID) diff --git a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java index a393e26f..39fdf196 100644 --- a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java +++ b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java @@ -51,7 +51,7 @@ /** * CampaignEvaluationTreeChangedMessage */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEvaluationTreeChangedMessage { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java index 328be46c..13fd2da0 100644 --- a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java +++ b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java @@ -49,7 +49,7 @@ /** * Notification about an Application whose campaign evaluation tree changed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignEvaluationTreeChangedNotification { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/CampaignGroup.java b/src/main/java/one/talon/model/CampaignGroup.java index c4bb36bd..15fb3644 100644 --- a/src/main/java/one/talon/model/CampaignGroup.java +++ b/src/main/java/one/talon/model/CampaignGroup.java @@ -51,7 +51,7 @@ /** * CampaignGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignGroup { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignGroupEntity.java b/src/main/java/one/talon/model/CampaignGroupEntity.java index f12db572..1b9ad4d4 100644 --- a/src/main/java/one/talon/model/CampaignGroupEntity.java +++ b/src/main/java/one/talon/model/CampaignGroupEntity.java @@ -50,7 +50,7 @@ /** * CampaignGroupEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignGroupEntity { public static final String SERIALIZED_NAME_CAMPAIGN_GROUPS = "campaignGroups"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_GROUPS) diff --git a/src/main/java/one/talon/model/CampaignLogSummary.java b/src/main/java/one/talon/model/CampaignLogSummary.java index e0fcd4d7..36965a30 100644 --- a/src/main/java/one/talon/model/CampaignLogSummary.java +++ b/src/main/java/one/talon/model/CampaignLogSummary.java @@ -49,7 +49,7 @@ /** * Campaign Log Summary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignLogSummary { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CampaignNotificationBase.java b/src/main/java/one/talon/model/CampaignNotificationBase.java index 16ce8013..8c43cbf9 100644 --- a/src/main/java/one/talon/model/CampaignNotificationBase.java +++ b/src/main/java/one/talon/model/CampaignNotificationBase.java @@ -48,7 +48,7 @@ /** * CampaignNotificationBase */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignNotificationBase { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignNotificationGeneric.java b/src/main/java/one/talon/model/CampaignNotificationGeneric.java index 6ea00ca3..d8520164 100644 --- a/src/main/java/one/talon/model/CampaignNotificationGeneric.java +++ b/src/main/java/one/talon/model/CampaignNotificationGeneric.java @@ -50,7 +50,7 @@ /** * CampaignNotificationGeneric */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignNotificationGeneric { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignNotificationItemBase.java b/src/main/java/one/talon/model/CampaignNotificationItemBase.java index 5a65e817..f248a17f 100644 --- a/src/main/java/one/talon/model/CampaignNotificationItemBase.java +++ b/src/main/java/one/talon/model/CampaignNotificationItemBase.java @@ -48,7 +48,7 @@ /** * CampaignNotificationItemBase */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignNotificationItemBase { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignNotificationPolicy.java b/src/main/java/one/talon/model/CampaignNotificationPolicy.java index 0c042e94..b4533279 100644 --- a/src/main/java/one/talon/model/CampaignNotificationPolicy.java +++ b/src/main/java/one/talon/model/CampaignNotificationPolicy.java @@ -48,7 +48,7 @@ /** * CampaignNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java b/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java index 34a3d05e..dd9c037b 100644 --- a/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java +++ b/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java @@ -51,7 +51,7 @@ /** * CampaignRulesetChangedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignRulesetChangedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java b/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java index 76193cba..27d81f31 100644 --- a/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java @@ -53,7 +53,7 @@ /** * CampaignRulesetChangedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignRulesetChangedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignSearch.java b/src/main/java/one/talon/model/CampaignSearch.java index 67e79ddc..0ede77b3 100644 --- a/src/main/java/one/talon/model/CampaignSearch.java +++ b/src/main/java/one/talon/model/CampaignSearch.java @@ -48,7 +48,7 @@ /** * CampaignSearch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignSearch { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/CampaignSet.java b/src/main/java/one/talon/model/CampaignSet.java index f77e8656..dba68a58 100644 --- a/src/main/java/one/talon/model/CampaignSet.java +++ b/src/main/java/one/talon/model/CampaignSet.java @@ -49,7 +49,7 @@ /** * CampaignSet */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignSet { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/CampaignSetBranchNode.java b/src/main/java/one/talon/model/CampaignSetBranchNode.java index 8de46a95..f14b1827 100644 --- a/src/main/java/one/talon/model/CampaignSetBranchNode.java +++ b/src/main/java/one/talon/model/CampaignSetBranchNode.java @@ -51,7 +51,7 @@ /** * CampaignSetBranchNode */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignSetBranchNode { /** * Indicates the node type. diff --git a/src/main/java/one/talon/model/CampaignSetLeafNode.java b/src/main/java/one/talon/model/CampaignSetLeafNode.java index 03c5bc93..f93d3900 100644 --- a/src/main/java/one/talon/model/CampaignSetLeafNode.java +++ b/src/main/java/one/talon/model/CampaignSetLeafNode.java @@ -48,7 +48,7 @@ /** * CampaignSetLeafNode */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignSetLeafNode { /** * Indicates the node type. diff --git a/src/main/java/one/talon/model/CampaignSetNode.java b/src/main/java/one/talon/model/CampaignSetNode.java index 69c4d0d5..c729724c 100644 --- a/src/main/java/one/talon/model/CampaignSetNode.java +++ b/src/main/java/one/talon/model/CampaignSetNode.java @@ -48,7 +48,7 @@ /** * CampaignSetNode */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignSetNode { public static final String SERIALIZED_NAME_TYPE = "type"; @SerializedName(SERIALIZED_NAME_TYPE) diff --git a/src/main/java/one/talon/model/CampaignStateChangedNotification.java b/src/main/java/one/talon/model/CampaignStateChangedNotification.java index f7e349c9..f659234e 100644 --- a/src/main/java/one/talon/model/CampaignStateChangedNotification.java +++ b/src/main/java/one/talon/model/CampaignStateChangedNotification.java @@ -51,7 +51,7 @@ /** * CampaignStateChangedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignStateChangedNotification { /** * The type of the notification diff --git a/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java b/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java index cafdd685..d11bf588 100644 --- a/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java +++ b/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java @@ -53,7 +53,7 @@ /** * CampaignStateChangedNotificationItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignStateChangedNotificationItem { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/CampaignStoreBudget.java b/src/main/java/one/talon/model/CampaignStoreBudget.java index 2edf1d41..9ce60c2a 100644 --- a/src/main/java/one/talon/model/CampaignStoreBudget.java +++ b/src/main/java/one/talon/model/CampaignStoreBudget.java @@ -52,7 +52,7 @@ /** * CampaignStoreBudget */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignStoreBudget { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java b/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java index af822e7c..83d36ee4 100644 --- a/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java +++ b/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java @@ -51,7 +51,7 @@ /** * CampaignStoreBudgetLimitConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignStoreBudgetLimitConfig { public static final String SERIALIZED_NAME_ACTION = "action"; @SerializedName(SERIALIZED_NAME_ACTION) diff --git a/src/main/java/one/talon/model/CampaignTemplate.java b/src/main/java/one/talon/model/CampaignTemplate.java index 5397ea1c..2067a7e4 100644 --- a/src/main/java/one/talon/model/CampaignTemplate.java +++ b/src/main/java/one/talon/model/CampaignTemplate.java @@ -56,7 +56,7 @@ /** * CampaignTemplate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignTemplate { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CampaignTemplateCollection.java b/src/main/java/one/talon/model/CampaignTemplateCollection.java index 872fa4c7..5ee35527 100644 --- a/src/main/java/one/talon/model/CampaignTemplateCollection.java +++ b/src/main/java/one/talon/model/CampaignTemplateCollection.java @@ -48,7 +48,7 @@ /** * CampaignTemplateCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignTemplateCollection { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java index e64eb74e..41e27841 100644 --- a/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java +++ b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java @@ -48,7 +48,7 @@ /** * CampaignTemplateCouponReservationSettings */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignTemplateCouponReservationSettings { public static final String SERIALIZED_NAME_RESERVATION_LIMIT = "reservationLimit"; @SerializedName(SERIALIZED_NAME_RESERVATION_LIMIT) diff --git a/src/main/java/one/talon/model/CampaignTemplateParams.java b/src/main/java/one/talon/model/CampaignTemplateParams.java index 17887f1d..a273d68f 100644 --- a/src/main/java/one/talon/model/CampaignTemplateParams.java +++ b/src/main/java/one/talon/model/CampaignTemplateParams.java @@ -48,7 +48,7 @@ /** * CampaignTemplateParams */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignTemplateParams { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CampaignVersions.java b/src/main/java/one/talon/model/CampaignVersions.java index 3fb34676..37af9edf 100644 --- a/src/main/java/one/talon/model/CampaignVersions.java +++ b/src/main/java/one/talon/model/CampaignVersions.java @@ -48,7 +48,7 @@ /** * CampaignVersions */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CampaignVersions { /** * The campaign revision state displayed in the Campaign Manager. diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java index 9bacce5c..a5fce770 100644 --- a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java +++ b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java @@ -52,7 +52,7 @@ /** * CardAddedDeductedPointsBalancesNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardAddedDeductedPointsBalancesNotification { public static final String SERIALIZED_NAME_CARD_IDENTIFIER = "CardIdentifier"; @SerializedName(SERIALIZED_NAME_CARD_IDENTIFIER) diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java index ce3e1aee..7a0b31ba 100644 --- a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java +++ b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java @@ -50,7 +50,7 @@ /** * CardAddedDeductedPointsBalancesNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardAddedDeductedPointsBalancesNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java b/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java index e14ce96d..76873598 100644 --- a/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java +++ b/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java @@ -53,7 +53,7 @@ /** * CardAddedDeductedPointsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardAddedDeductedPointsNotification { public static final String SERIALIZED_NAME_CARD_IDENTIFIER = "CardIdentifier"; @SerializedName(SERIALIZED_NAME_CARD_IDENTIFIER) diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java b/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java index 48694e38..a4260f9a 100644 --- a/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java +++ b/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java @@ -50,7 +50,7 @@ /** * CardAddedDeductedPointsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardAddedDeductedPointsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java b/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java index e9c56f1d..433af6e8 100644 --- a/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java +++ b/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java @@ -51,7 +51,7 @@ /** * CardExpiringPointsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardExpiringPointsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java b/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java index eb52fd3b..f8ea5008 100644 --- a/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java +++ b/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java @@ -48,7 +48,7 @@ /** * CardExpiringPointsNotificationTrigger */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardExpiringPointsNotificationTrigger { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java b/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java index 6785040c..9ddea6f0 100644 --- a/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java +++ b/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java @@ -50,7 +50,7 @@ /** * Loyalty card points with start and expiry dates. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardLedgerPointsEntryIntegrationAPI { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java b/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java index 8a804c0b..c0eb9bcf 100644 --- a/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java +++ b/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java @@ -50,7 +50,7 @@ /** * Log entry for a given loyalty card transaction. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardLedgerTransactionLogEntry { public static final String SERIALIZED_NAME_TRANSACTION_U_U_I_D = "transactionUUID"; @SerializedName(SERIALIZED_NAME_TRANSACTION_U_U_I_D) diff --git a/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java b/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java index 45d60cff..18a4cdc0 100644 --- a/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java +++ b/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java @@ -50,7 +50,7 @@ /** * Log entry for a given loyalty card transaction. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CardLedgerTransactionLogEntryIntegrationAPI { public static final String SERIALIZED_NAME_TRANSACTION_U_U_I_D = "transactionUUID"; @SerializedName(SERIALIZED_NAME_TRANSACTION_U_U_I_D) diff --git a/src/main/java/one/talon/model/CartItem.java b/src/main/java/one/talon/model/CartItem.java index acd59370..8eca85bb 100644 --- a/src/main/java/one/talon/model/CartItem.java +++ b/src/main/java/one/talon/model/CartItem.java @@ -56,7 +56,7 @@ /** * CartItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CartItem { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CartItemFilterTemplate.java b/src/main/java/one/talon/model/CartItemFilterTemplate.java index 27c43872..ac3f1c7b 100644 --- a/src/main/java/one/talon/model/CartItemFilterTemplate.java +++ b/src/main/java/one/talon/model/CartItemFilterTemplate.java @@ -50,7 +50,7 @@ /** * A cart item filter template stored in a library entry. Cart item filters in library entries only contain name (no description, as description is at the library entry level). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CartItemFilterTemplate { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/Catalog.java b/src/main/java/one/talon/model/Catalog.java index 847cf35a..360d0499 100644 --- a/src/main/java/one/talon/model/Catalog.java +++ b/src/main/java/one/talon/model/Catalog.java @@ -51,7 +51,7 @@ /** * Catalog */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Catalog { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CatalogAction.java b/src/main/java/one/talon/model/CatalogAction.java index 099fdcda..84e592f0 100644 --- a/src/main/java/one/talon/model/CatalogAction.java +++ b/src/main/java/one/talon/model/CatalogAction.java @@ -48,7 +48,7 @@ /** * Definition of all the properties that are needed for a single catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogAction { /** * The type of sync action. diff --git a/src/main/java/one/talon/model/CatalogActionFilter.java b/src/main/java/one/talon/model/CatalogActionFilter.java index 25858932..70a1e61a 100644 --- a/src/main/java/one/talon/model/CatalogActionFilter.java +++ b/src/main/java/one/talon/model/CatalogActionFilter.java @@ -48,7 +48,7 @@ /** * The properties for a single filtering condition in a catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogActionFilter { public static final String SERIALIZED_NAME_ATTR = "attr"; @SerializedName(SERIALIZED_NAME_ATTR) diff --git a/src/main/java/one/talon/model/CatalogItem.java b/src/main/java/one/talon/model/CatalogItem.java index d2aa822e..5d08ca16 100644 --- a/src/main/java/one/talon/model/CatalogItem.java +++ b/src/main/java/one/talon/model/CatalogItem.java @@ -54,7 +54,7 @@ /** * CatalogItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogItem { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CatalogRule.java b/src/main/java/one/talon/model/CatalogRule.java index 55632784..8daa43fd 100644 --- a/src/main/java/one/talon/model/CatalogRule.java +++ b/src/main/java/one/talon/model/CatalogRule.java @@ -51,7 +51,7 @@ /** * A rule template stored in a catalog entry. Rules in catalog entries only contain title (no description, as description is at the catalog entry level). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogRule { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/CatalogSyncRequest.java b/src/main/java/one/talon/model/CatalogSyncRequest.java index 87fe5c2c..e0c28bda 100644 --- a/src/main/java/one/talon/model/CatalogSyncRequest.java +++ b/src/main/java/one/talon/model/CatalogSyncRequest.java @@ -51,7 +51,7 @@ /** * CatalogSyncRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogSyncRequest { public static final String SERIALIZED_NAME_ACTIONS = "actions"; @SerializedName(SERIALIZED_NAME_ACTIONS) diff --git a/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java b/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java index 020a6b1a..4938303b 100644 --- a/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java +++ b/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java @@ -48,7 +48,7 @@ /** * CatalogsStrikethroughNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CatalogsStrikethroughNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/Change.java b/src/main/java/one/talon/model/Change.java index 4e45cdb9..641fb17a 100644 --- a/src/main/java/one/talon/model/Change.java +++ b/src/main/java/one/talon/model/Change.java @@ -49,7 +49,7 @@ /** * Change */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Change { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -195,7 +195,7 @@ public Change old(@javax.annotation.Nullable Object old) { } /** - * Resource before the change occurred. + * Arbitrary properties associated with this campaign. * @return old */ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public Change _new(@javax.annotation.Nullable Object _new) { } /** - * Resource after the change occurred. + * Arbitrary properties associated with this campaign. * @return _new */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java b/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java index b0034ee6..2660f4c7 100644 --- a/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java +++ b/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an \"addLoyaltyPoints\" effect. + * This effect indicates that a customer's loyalty tier has been upgraded. This effect is generated only when the [Add loyalty points](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points) and the [Add loyalty points per cart item](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points-per-cart-item) effects are triggered for a particular customer, and, as a result, the customer's loyalty tier is upgraded. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ChangeLoyaltyTierLevelEffectProps { public static final String SERIALIZED_NAME_RULE_TITLE = "ruleTitle"; @SerializedName(SERIALIZED_NAME_RULE_TITLE) @@ -109,7 +109,7 @@ public ChangeLoyaltyTierLevelEffectProps programId(@javax.annotation.Nonnull Lon } /** - * The ID of the loyalty program where these points were added. + * The ID of the loyalty program where the points were added. * @return programId */ @javax.annotation.Nonnull @@ -128,7 +128,7 @@ public ChangeLoyaltyTierLevelEffectProps subLedgerId(@javax.annotation.Nonnull S } /** - * The ID of the subledger within the loyalty program where these points were added. + * The ID of the subledger within the loyalty program where the points were added. * @return subLedgerId */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ChangeProfilePassword.java b/src/main/java/one/talon/model/ChangeProfilePassword.java index 0f7e1b00..6b7e933e 100644 --- a/src/main/java/one/talon/model/ChangeProfilePassword.java +++ b/src/main/java/one/talon/model/ChangeProfilePassword.java @@ -48,7 +48,7 @@ /** * ChangeProfilePassword */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ChangeProfilePassword { public static final String SERIALIZED_NAME_PASSWORD = "password"; @SerializedName(SERIALIZED_NAME_PASSWORD) diff --git a/src/main/java/one/talon/model/CodeGeneratorSettings.java b/src/main/java/one/talon/model/CodeGeneratorSettings.java index b3ad9d47..1995ac30 100644 --- a/src/main/java/one/talon/model/CodeGeneratorSettings.java +++ b/src/main/java/one/talon/model/CodeGeneratorSettings.java @@ -50,7 +50,7 @@ /** * CodeGeneratorSettings */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CodeGeneratorSettings { public static final String SERIALIZED_NAME_VALID_CHARACTERS = "validCharacters"; @SerializedName(SERIALIZED_NAME_VALID_CHARACTERS) diff --git a/src/main/java/one/talon/model/Collection.java b/src/main/java/one/talon/model/Collection.java index 4c8b58d0..18b6d803 100644 --- a/src/main/java/one/talon/model/Collection.java +++ b/src/main/java/one/talon/model/Collection.java @@ -51,7 +51,7 @@ /** * Collection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Collection { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CollectionItem.java b/src/main/java/one/talon/model/CollectionItem.java index ce5148e5..27e4b4ae 100644 --- a/src/main/java/one/talon/model/CollectionItem.java +++ b/src/main/java/one/talon/model/CollectionItem.java @@ -48,7 +48,7 @@ /** * CollectionItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CollectionItem { public static final String SERIALIZED_NAME_ITEM = "item"; @SerializedName(SERIALIZED_NAME_ITEM) diff --git a/src/main/java/one/talon/model/CollectionWithoutPayload.java b/src/main/java/one/talon/model/CollectionWithoutPayload.java index 6aca8c1f..a3b67823 100644 --- a/src/main/java/one/talon/model/CollectionWithoutPayload.java +++ b/src/main/java/one/talon/model/CollectionWithoutPayload.java @@ -51,7 +51,7 @@ /** * CollectionWithoutPayload */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CollectionWithoutPayload { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Coupon.java b/src/main/java/one/talon/model/Coupon.java index 745e9fb9..b56e14bc 100644 --- a/src/main/java/one/talon/model/Coupon.java +++ b/src/main/java/one/talon/model/Coupon.java @@ -53,7 +53,7 @@ /** * Coupon */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Coupon { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CouponConstraints.java b/src/main/java/one/talon/model/CouponConstraints.java index 3bbf3f0d..443fbc09 100644 --- a/src/main/java/one/talon/model/CouponConstraints.java +++ b/src/main/java/one/talon/model/CouponConstraints.java @@ -50,7 +50,7 @@ /** * CouponConstraints */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponConstraints { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) diff --git a/src/main/java/one/talon/model/CouponCreatedEffectProps.java b/src/main/java/one/talon/model/CouponCreatedEffectProps.java index 06d515a5..2999a929 100644 --- a/src/main/java/one/talon/model/CouponCreatedEffectProps.java +++ b/src/main/java/one/talon/model/CouponCreatedEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"couponCreated\" effect. This gets triggered whenever a validated rule contained a \"create coupon\" effect, and a coupon was created for a customer. See \"createdCoupons\" on the response for all details of this coupon. + * This effect indicates that a coupon was created. For referrals and retention marketing, a common use case is to generate a coupon that can only be redeemed by one specific customer. Handle this effect by notifying the recipient about their new coupon code. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponCreatedEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/CouponCreationJob.java b/src/main/java/one/talon/model/CouponCreationJob.java index 1c23cb23..53743f65 100644 --- a/src/main/java/one/talon/model/CouponCreationJob.java +++ b/src/main/java/one/talon/model/CouponCreationJob.java @@ -53,7 +53,7 @@ /** * CouponCreationJob */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponCreationJob { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -415,7 +415,7 @@ public CouponCreationJob attributes(@javax.annotation.Nonnull Object attributes) } /** - * Arbitrary properties associated with coupons. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/CouponDeletionFilters.java b/src/main/java/one/talon/model/CouponDeletionFilters.java index 5879714f..2e62d9ea 100644 --- a/src/main/java/one/talon/model/CouponDeletionFilters.java +++ b/src/main/java/one/talon/model/CouponDeletionFilters.java @@ -49,7 +49,7 @@ /** * CouponDeletionFilters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponDeletionFilters { public static final String SERIALIZED_NAME_CREATED_BEFORE = "createdBefore"; @SerializedName(SERIALIZED_NAME_CREATED_BEFORE) diff --git a/src/main/java/one/talon/model/CouponDeletionJob.java b/src/main/java/one/talon/model/CouponDeletionJob.java index c1e2ce32..ced375d8 100644 --- a/src/main/java/one/talon/model/CouponDeletionJob.java +++ b/src/main/java/one/talon/model/CouponDeletionJob.java @@ -52,7 +52,7 @@ /** * CouponDeletionJob */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponDeletionJob { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CouponEntity.java b/src/main/java/one/talon/model/CouponEntity.java index 657b0864..ec423235 100644 --- a/src/main/java/one/talon/model/CouponEntity.java +++ b/src/main/java/one/talon/model/CouponEntity.java @@ -49,7 +49,7 @@ /** * CouponEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponEntity { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CouponFailureSummary.java b/src/main/java/one/talon/model/CouponFailureSummary.java index 56f9ba86..734c8fc2 100644 --- a/src/main/java/one/talon/model/CouponFailureSummary.java +++ b/src/main/java/one/talon/model/CouponFailureSummary.java @@ -49,7 +49,7 @@ /** * Summary of the reasons for coupon redemption failure. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponFailureSummary { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CouponLimitConfigs.java b/src/main/java/one/talon/model/CouponLimitConfigs.java index 1a192af2..659c9a04 100644 --- a/src/main/java/one/talon/model/CouponLimitConfigs.java +++ b/src/main/java/one/talon/model/CouponLimitConfigs.java @@ -51,7 +51,7 @@ /** * CouponLimitConfigs */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponLimitConfigs { public static final String SERIALIZED_NAME_LIMITS = "limits"; @SerializedName(SERIALIZED_NAME_LIMITS) diff --git a/src/main/java/one/talon/model/CouponRejectionReason.java b/src/main/java/one/talon/model/CouponRejectionReason.java index 5fb0d8ac..c2bddecf 100644 --- a/src/main/java/one/talon/model/CouponRejectionReason.java +++ b/src/main/java/one/talon/model/CouponRejectionReason.java @@ -48,7 +48,7 @@ /** * Holds a reference to the campaign, the coupon and the reason for which that coupon was rejected. Should only be present when there is a 'rejectCoupon' effect. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponRejectionReason { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/CouponReservations.java b/src/main/java/one/talon/model/CouponReservations.java index 4cc1d78c..1cf36cea 100644 --- a/src/main/java/one/talon/model/CouponReservations.java +++ b/src/main/java/one/talon/model/CouponReservations.java @@ -50,7 +50,7 @@ /** * CouponReservations */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponReservations { public static final String SERIALIZED_NAME_INTEGRATION_I_DS = "integrationIDs"; @SerializedName(SERIALIZED_NAME_INTEGRATION_I_DS) diff --git a/src/main/java/one/talon/model/CouponSearch.java b/src/main/java/one/talon/model/CouponSearch.java index b73f7efa..493f12f7 100644 --- a/src/main/java/one/talon/model/CouponSearch.java +++ b/src/main/java/one/talon/model/CouponSearch.java @@ -48,7 +48,7 @@ /** * CouponSearch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponSearch { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/CouponValue.java b/src/main/java/one/talon/model/CouponValue.java index 338f59de..fe7d24e0 100644 --- a/src/main/java/one/talon/model/CouponValue.java +++ b/src/main/java/one/talon/model/CouponValue.java @@ -48,7 +48,7 @@ /** * CouponValue */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponValue { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/CouponWithApplication.java b/src/main/java/one/talon/model/CouponWithApplication.java index d3e262d0..a0987275 100644 --- a/src/main/java/one/talon/model/CouponWithApplication.java +++ b/src/main/java/one/talon/model/CouponWithApplication.java @@ -53,7 +53,7 @@ /** * CouponWithApplication */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponWithApplication { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CouponsNotificationData.java b/src/main/java/one/talon/model/CouponsNotificationData.java index c8f11f87..9e44f668 100644 --- a/src/main/java/one/talon/model/CouponsNotificationData.java +++ b/src/main/java/one/talon/model/CouponsNotificationData.java @@ -51,7 +51,7 @@ /** * CouponsNotificationData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponsNotificationData { public static final String SERIALIZED_NAME_TYPE_OF_CHANGE = "TypeOfChange"; @SerializedName(SERIALIZED_NAME_TYPE_OF_CHANGE) diff --git a/src/main/java/one/talon/model/CouponsNotificationPolicy.java b/src/main/java/one/talon/model/CouponsNotificationPolicy.java index 17dbed35..140eb5a8 100644 --- a/src/main/java/one/talon/model/CouponsNotificationPolicy.java +++ b/src/main/java/one/talon/model/CouponsNotificationPolicy.java @@ -50,7 +50,7 @@ /** * CouponsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CouponsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateAchievement.java b/src/main/java/one/talon/model/CreateAchievement.java index 498a6c7b..693d0668 100644 --- a/src/main/java/one/talon/model/CreateAchievement.java +++ b/src/main/java/one/talon/model/CreateAchievement.java @@ -51,7 +51,7 @@ /** * CreateAchievement */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateAchievement { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateAchievementV2.java b/src/main/java/one/talon/model/CreateAchievementV2.java index 8abc3f04..d0513380 100644 --- a/src/main/java/one/talon/model/CreateAchievementV2.java +++ b/src/main/java/one/talon/model/CreateAchievementV2.java @@ -52,7 +52,7 @@ /** * CreateAchievementV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateAchievementV2 { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateApplicationAPIKey.java b/src/main/java/one/talon/model/CreateApplicationAPIKey.java index ea2f38c0..26604fd5 100644 --- a/src/main/java/one/talon/model/CreateApplicationAPIKey.java +++ b/src/main/java/one/talon/model/CreateApplicationAPIKey.java @@ -49,7 +49,7 @@ /** * CreateApplicationAPIKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateApplicationAPIKey { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/CreateCouponData.java b/src/main/java/one/talon/model/CreateCouponData.java index 05808aef..3e2325b8 100644 --- a/src/main/java/one/talon/model/CreateCouponData.java +++ b/src/main/java/one/talon/model/CreateCouponData.java @@ -51,7 +51,7 @@ /** * CreateCouponData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateCouponData { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/CreateCoupons200Response.java b/src/main/java/one/talon/model/CreateCoupons200Response.java index 339b68fa..5dcb2a3c 100644 --- a/src/main/java/one/talon/model/CreateCoupons200Response.java +++ b/src/main/java/one/talon/model/CreateCoupons200Response.java @@ -51,7 +51,7 @@ /** * CreateCoupons200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateCoupons200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/CreateMCPKey.java b/src/main/java/one/talon/model/CreateMCPKey.java index a549ee63..8e04f68f 100644 --- a/src/main/java/one/talon/model/CreateMCPKey.java +++ b/src/main/java/one/talon/model/CreateMCPKey.java @@ -49,7 +49,7 @@ /** * CreateMCPKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateMCPKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateManagementKey.java b/src/main/java/one/talon/model/CreateManagementKey.java index ce7bb562..a3ee7638 100644 --- a/src/main/java/one/talon/model/CreateManagementKey.java +++ b/src/main/java/one/talon/model/CreateManagementKey.java @@ -52,7 +52,7 @@ /** * CreateManagementKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateManagementKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java b/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java index 98b36ce7..ad201499 100644 --- a/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java +++ b/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java @@ -51,7 +51,7 @@ /** * CreateReferralsForMultipleAdvocates201Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateReferralsForMultipleAdvocates201Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/CreateTemplateCampaign.java b/src/main/java/one/talon/model/CreateTemplateCampaign.java index d110c6ac..ee4b3c47 100644 --- a/src/main/java/one/talon/model/CreateTemplateCampaign.java +++ b/src/main/java/one/talon/model/CreateTemplateCampaign.java @@ -52,7 +52,7 @@ /** * CreateTemplateCampaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateTemplateCampaign { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java b/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java index 6e04d534..1fffe2b7 100644 --- a/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java +++ b/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java @@ -53,7 +53,7 @@ /** * CreateTemplateCampaignResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CreateTemplateCampaignResponse { public static final String SERIALIZED_NAME_CAMPAIGN = "campaign"; @SerializedName(SERIALIZED_NAME_CAMPAIGN) diff --git a/src/main/java/one/talon/model/CustomEffect.java b/src/main/java/one/talon/model/CustomEffect.java index 39ed139f..86fc0e44 100644 --- a/src/main/java/one/talon/model/CustomEffect.java +++ b/src/main/java/one/talon/model/CustomEffect.java @@ -52,7 +52,7 @@ /** * CustomEffect */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomEffect { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CustomEffectProps.java b/src/main/java/one/talon/model/CustomEffectProps.java index 7f7a211c..92c93cbb 100644 --- a/src/main/java/one/talon/model/CustomEffectProps.java +++ b/src/main/java/one/talon/model/CustomEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * Effect containing custom payload. + * If you want to return data as an effect but no effect matches your use case, you can [create a custom effect](https://docs.talon.one/docs/dev/tutorials/create-custom-effects). Custom effects can be used as both rule effects and failure effects. The structure of a custom effect depends on your specifications but is always named `customEffect`. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomEffectProps { public static final String SERIALIZED_NAME_EFFECT_ID = "effectId"; @SerializedName(SERIALIZED_NAME_EFFECT_ID) diff --git a/src/main/java/one/talon/model/CustomerActivityReport.java b/src/main/java/one/talon/model/CustomerActivityReport.java index a39f9c64..5ab1d48c 100644 --- a/src/main/java/one/talon/model/CustomerActivityReport.java +++ b/src/main/java/one/talon/model/CustomerActivityReport.java @@ -50,7 +50,7 @@ /** * A summary report of customer activity for a given time range. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerActivityReport { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/CustomerAnalytics.java b/src/main/java/one/talon/model/CustomerAnalytics.java index 277f72af..706f8147 100644 --- a/src/main/java/one/talon/model/CustomerAnalytics.java +++ b/src/main/java/one/talon/model/CustomerAnalytics.java @@ -49,7 +49,7 @@ /** * A summary report of customer activity for a given time range. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerAnalytics { public static final String SERIALIZED_NAME_ACCEPTED_COUPONS = "acceptedCoupons"; @SerializedName(SERIALIZED_NAME_ACCEPTED_COUPONS) diff --git a/src/main/java/one/talon/model/CustomerInventory.java b/src/main/java/one/talon/model/CustomerInventory.java index 17a74e61..5730a7f0 100644 --- a/src/main/java/one/talon/model/CustomerInventory.java +++ b/src/main/java/one/talon/model/CustomerInventory.java @@ -56,7 +56,7 @@ /** * CustomerInventory */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerInventory { public static final String SERIALIZED_NAME_PROFILE = "profile"; @SerializedName(SERIALIZED_NAME_PROFILE) diff --git a/src/main/java/one/talon/model/CustomerProfile.java b/src/main/java/one/talon/model/CustomerProfile.java index 4ca66df1..66b7d657 100644 --- a/src/main/java/one/talon/model/CustomerProfile.java +++ b/src/main/java/one/talon/model/CustomerProfile.java @@ -56,7 +56,7 @@ /** * CustomerProfile */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfile { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java b/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java index 27b953b5..2b330bab 100644 --- a/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java +++ b/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java @@ -51,7 +51,7 @@ /** * CustomerProfileAudienceRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileAudienceRequest { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java b/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java index 3e32f020..f4dcbd8d 100644 --- a/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java +++ b/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java @@ -48,7 +48,7 @@ /** * CustomerProfileAudienceRequestItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileAudienceRequestItem { /** * Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. diff --git a/src/main/java/one/talon/model/CustomerProfileEntity.java b/src/main/java/one/talon/model/CustomerProfileEntity.java index c28de372..eaadb085 100644 --- a/src/main/java/one/talon/model/CustomerProfileEntity.java +++ b/src/main/java/one/talon/model/CustomerProfileEntity.java @@ -49,7 +49,7 @@ /** * CustomerProfileEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileEntity { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java b/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java index f8dbe321..bd4ea14d 100644 --- a/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java +++ b/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java @@ -53,7 +53,7 @@ /** * CustomerProfileIntegrationRequestV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileIntegrationRequestV2 { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java b/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java index a851a186..3eaffac4 100644 --- a/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java +++ b/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java @@ -60,7 +60,7 @@ /** * This is the response type returned by the updateCustomerProfileV2 endpoint. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileIntegrationResponseV2 { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/CustomerProfileSearchQuery.java b/src/main/java/one/talon/model/CustomerProfileSearchQuery.java index ee8c9ccf..b5986053 100644 --- a/src/main/java/one/talon/model/CustomerProfileSearchQuery.java +++ b/src/main/java/one/talon/model/CustomerProfileSearchQuery.java @@ -50,7 +50,7 @@ /** * CustomerProfileSearchQuery */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileSearchQuery { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java b/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java index 0c9e4367..dd784608 100644 --- a/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java +++ b/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java @@ -49,7 +49,7 @@ /** * Contains the updated customer profiles entities. This is the response type returned by the V2 PUT customer_profiles endpoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerProfileUpdateV2Response { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/CustomerSession.java b/src/main/java/one/talon/model/CustomerSession.java index 37fb8331..c9d5ae41 100644 --- a/src/main/java/one/talon/model/CustomerSession.java +++ b/src/main/java/one/talon/model/CustomerSession.java @@ -55,7 +55,7 @@ /** * CustomerSession */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerSession { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) @@ -403,7 +403,7 @@ public CustomerSession attributes(@javax.annotation.Nullable Object attributes) } /** - * A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/CustomerSessionV2.java b/src/main/java/one/talon/model/CustomerSessionV2.java index d23120c9..7766d421 100644 --- a/src/main/java/one/talon/model/CustomerSessionV2.java +++ b/src/main/java/one/talon/model/CustomerSessionV2.java @@ -57,7 +57,7 @@ /** * CustomerSessionV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class CustomerSessionV2 { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/DeactivateUserRequest.java b/src/main/java/one/talon/model/DeactivateUserRequest.java index b252cd34..02dd0d3e 100644 --- a/src/main/java/one/talon/model/DeactivateUserRequest.java +++ b/src/main/java/one/talon/model/DeactivateUserRequest.java @@ -48,7 +48,7 @@ /** * DeactivateUserRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeactivateUserRequest { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/DeductLoyaltyPoints.java b/src/main/java/one/talon/model/DeductLoyaltyPoints.java index a402f37b..aa90f17d 100644 --- a/src/main/java/one/talon/model/DeductLoyaltyPoints.java +++ b/src/main/java/one/talon/model/DeductLoyaltyPoints.java @@ -49,7 +49,7 @@ /** * Points to deduct. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeductLoyaltyPoints { public static final String SERIALIZED_NAME_POINTS = "points"; @SerializedName(SERIALIZED_NAME_POINTS) diff --git a/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java index fbd48936..8261f360 100644 --- a/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java +++ b/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"deductLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained a condition to only trigger when the given number of loyalty points could be deduced. These points are automatically stored and managed inside Talon.One. + * This effect is triggered when a customer redeems loyalty points. The points are deducted from their active point balance. If the loyalty program is card-based, use the `cardIdentifier` property to identify the loyalty card from which these points are deducted. The Rule Engine deducts points in this order: - Points with the earliest expiry date are deducted first, regardless of when they were added. - Points with an unlimited expiry date are deducted last. - For points with an unlimited expiry date, the points awarded first are deducted first. The points only persist when the session is closed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeductLoyaltyPointsEffectProps { public static final String SERIALIZED_NAME_RULE_TITLE = "ruleTitle"; @SerializedName(SERIALIZED_NAME_RULE_TITLE) @@ -114,7 +114,7 @@ public DeductLoyaltyPointsEffectProps programId(@javax.annotation.Nonnull Long p } /** - * The ID of the loyalty program where these points were added. + * The ID of the loyalty program from which these points were deducted. * @return programId */ @javax.annotation.Nonnull @@ -133,7 +133,7 @@ public DeductLoyaltyPointsEffectProps subLedgerId(@javax.annotation.Nonnull Stri } /** - * The ID of the subledger within the loyalty program where these points were added. + * The ID of the subledger within the loyalty program from which these points were deducted. * @return subLedgerId */ @javax.annotation.Nonnull @@ -171,7 +171,7 @@ public DeductLoyaltyPointsEffectProps transactionUUID(@javax.annotation.Nonnull } /** - * The identifier of this deduction in the loyalty ledger. + * The identifier of this loyalty point transaction. * @return transactionUUID */ @javax.annotation.Nonnull @@ -190,7 +190,7 @@ public DeductLoyaltyPointsEffectProps name(@javax.annotation.Nonnull String name } /** - * The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. + * The reason of this loyalty points deduction. * @return name */ @javax.annotation.Nonnull @@ -209,7 +209,7 @@ public DeductLoyaltyPointsEffectProps cardIdentifier(@javax.annotation.Nullable } /** - * The card on which these points were added. + * The identifier of the card from which these points were deducted. * @return cardIdentifier */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/DeleteCouponsData.java b/src/main/java/one/talon/model/DeleteCouponsData.java index dd3c8943..62db3c85 100644 --- a/src/main/java/one/talon/model/DeleteCouponsData.java +++ b/src/main/java/one/talon/model/DeleteCouponsData.java @@ -48,7 +48,7 @@ /** * DeleteCouponsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeleteCouponsData { public static final String SERIALIZED_NAME_TYPE_OF_CHANGE = "TypeOfChange"; @SerializedName(SERIALIZED_NAME_TYPE_OF_CHANGE) diff --git a/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java b/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java index 8861bd74..a1e3396d 100644 --- a/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java +++ b/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java @@ -51,7 +51,7 @@ /** * Request to delete transactions based on the specified scope. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeleteLoyaltyTransactionsRequest { /** * `AllSubledgers` deletes all transactions for the specified customer profile from all ledgers in the loyalty program. `SelectedSubledgers` deletes all transactions for the specified customer profile only from the given ledgers in the loyalty program. diff --git a/src/main/java/one/talon/model/DeleteUserRequest.java b/src/main/java/one/talon/model/DeleteUserRequest.java index 5b9c793d..7bbcbae2 100644 --- a/src/main/java/one/talon/model/DeleteUserRequest.java +++ b/src/main/java/one/talon/model/DeleteUserRequest.java @@ -48,7 +48,7 @@ /** * DeleteUserRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class DeleteUserRequest { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/Effect.java b/src/main/java/one/talon/model/Effect.java index f2c5dd95..13a8a99f 100644 --- a/src/main/java/one/talon/model/Effect.java +++ b/src/main/java/one/talon/model/Effect.java @@ -50,7 +50,7 @@ /** * Effect */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Effect { public static final String SERIALIZED_NAME_EXPERIMENT_ID = "experimentId"; @SerializedName(SERIALIZED_NAME_EXPERIMENT_ID) diff --git a/src/main/java/one/talon/model/EffectEntity.java b/src/main/java/one/talon/model/EffectEntity.java index 175c0dbc..953d7131 100644 --- a/src/main/java/one/talon/model/EffectEntity.java +++ b/src/main/java/one/talon/model/EffectEntity.java @@ -50,7 +50,7 @@ /** * Definition of all properties that are present on all effects, independent of their type. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EffectEntity { public static final String SERIALIZED_NAME_EXPERIMENT_ID = "experimentId"; @SerializedName(SERIALIZED_NAME_EXPERIMENT_ID) diff --git a/src/main/java/one/talon/model/EmailEntity.java b/src/main/java/one/talon/model/EmailEntity.java index 2b8a1a65..93a466e1 100644 --- a/src/main/java/one/talon/model/EmailEntity.java +++ b/src/main/java/one/talon/model/EmailEntity.java @@ -48,7 +48,7 @@ /** * EmailEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EmailEntity { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java b/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java index 8af96988..9a147914 100644 --- a/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java +++ b/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java @@ -49,7 +49,7 @@ /** * EmbeddedAnalyticsConfiguration */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EmbeddedAnalyticsConfiguration { public static final String SERIALIZED_NAME_DASHBOARDS = "dashboards"; @SerializedName(SERIALIZED_NAME_DASHBOARDS) diff --git a/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java b/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java index eb3263a9..85c15934 100644 --- a/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java +++ b/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java @@ -49,7 +49,7 @@ /** * EmbeddedAnalyticsConfigurationDashboards */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EmbeddedAnalyticsConfigurationDashboards { public static final String SERIALIZED_NAME_CAMPAIGN_INSIGHTS = "campaignInsights"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_INSIGHTS) diff --git a/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java b/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java index e920fa25..9f9d708d 100644 --- a/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java +++ b/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java @@ -48,7 +48,7 @@ /** * EmbeddedDashboardConfiguration */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EmbeddedDashboardConfiguration { public static final String SERIALIZED_NAME_WORKSPACE_ID = "workspaceId"; @SerializedName(SERIALIZED_NAME_WORKSPACE_ID) diff --git a/src/main/java/one/talon/model/Endpoint.java b/src/main/java/one/talon/model/Endpoint.java index ebe0f5de..c4005bdc 100644 --- a/src/main/java/one/talon/model/Endpoint.java +++ b/src/main/java/one/talon/model/Endpoint.java @@ -48,7 +48,7 @@ /** * Endpoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Endpoint { public static final String SERIALIZED_NAME_PATH = "path"; @SerializedName(SERIALIZED_NAME_PATH) diff --git a/src/main/java/one/talon/model/Entity.java b/src/main/java/one/talon/model/Entity.java index 5a336fd8..d60590af 100644 --- a/src/main/java/one/talon/model/Entity.java +++ b/src/main/java/one/talon/model/Entity.java @@ -49,7 +49,7 @@ /** * Entity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Entity { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/EntityWithTalangVisibleID.java b/src/main/java/one/talon/model/EntityWithTalangVisibleID.java index 5087cad5..1e479d3f 100644 --- a/src/main/java/one/talon/model/EntityWithTalangVisibleID.java +++ b/src/main/java/one/talon/model/EntityWithTalangVisibleID.java @@ -49,7 +49,7 @@ /** * EntityWithTalangVisibleID */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EntityWithTalangVisibleID { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Environment.java b/src/main/java/one/talon/model/Environment.java index 69174ed7..a36ef691 100644 --- a/src/main/java/one/talon/model/Environment.java +++ b/src/main/java/one/talon/model/Environment.java @@ -63,7 +63,7 @@ /** * Environment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Environment { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ErrorEffectProps.java b/src/main/java/one/talon/model/ErrorEffectProps.java index 741d51b7..15721bc1 100644 --- a/src/main/java/one/talon/model/ErrorEffectProps.java +++ b/src/main/java/one/talon/model/ErrorEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder. + * This effect is triggered whenever an error occurs during rule evaluation. This effect only provides information about what the error is. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ErrorEffectProps { public static final String SERIALIZED_NAME_MESSAGE = "message"; @SerializedName(SERIALIZED_NAME_MESSAGE) diff --git a/src/main/java/one/talon/model/ErrorResponse.java b/src/main/java/one/talon/model/ErrorResponse.java index 17f06a5a..2d2fd94b 100644 --- a/src/main/java/one/talon/model/ErrorResponse.java +++ b/src/main/java/one/talon/model/ErrorResponse.java @@ -51,7 +51,7 @@ /** * ErrorResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ErrorResponse { public static final String SERIALIZED_NAME_MESSAGE = "message"; @SerializedName(SERIALIZED_NAME_MESSAGE) diff --git a/src/main/java/one/talon/model/ErrorResponseWithStatus.java b/src/main/java/one/talon/model/ErrorResponseWithStatus.java index 7a7673e3..9b74626e 100644 --- a/src/main/java/one/talon/model/ErrorResponseWithStatus.java +++ b/src/main/java/one/talon/model/ErrorResponseWithStatus.java @@ -51,7 +51,7 @@ /** * ErrorResponseWithStatus */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ErrorResponseWithStatus { public static final String SERIALIZED_NAME_MESSAGE = "message"; @SerializedName(SERIALIZED_NAME_MESSAGE) diff --git a/src/main/java/one/talon/model/ErrorSource.java b/src/main/java/one/talon/model/ErrorSource.java index f7a9af33..2320e30b 100644 --- a/src/main/java/one/talon/model/ErrorSource.java +++ b/src/main/java/one/talon/model/ErrorSource.java @@ -48,7 +48,7 @@ /** * The source of the current error, exactly one of `pointer`, `parameter` or `line` will be defined. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ErrorSource { public static final String SERIALIZED_NAME_POINTER = "pointer"; @SerializedName(SERIALIZED_NAME_POINTER) diff --git a/src/main/java/one/talon/model/EvaluableCampaignIds.java b/src/main/java/one/talon/model/EvaluableCampaignIds.java index dce3bc84..dd433c70 100644 --- a/src/main/java/one/talon/model/EvaluableCampaignIds.java +++ b/src/main/java/one/talon/model/EvaluableCampaignIds.java @@ -50,7 +50,7 @@ /** * EvaluableCampaignIds */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EvaluableCampaignIds { public static final String SERIALIZED_NAME_EVALUABLE_CAMPAIGN_IDS = "evaluableCampaignIds"; @SerializedName(SERIALIZED_NAME_EVALUABLE_CAMPAIGN_IDS) diff --git a/src/main/java/one/talon/model/Event.java b/src/main/java/one/talon/model/Event.java index c659fa67..5e38b9c5 100644 --- a/src/main/java/one/talon/model/Event.java +++ b/src/main/java/one/talon/model/Event.java @@ -53,7 +53,7 @@ /** * Event */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Event { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -238,7 +238,7 @@ public Event attributes(@javax.annotation.Nonnull Object attributes) { } /** - * Arbitrary additional JSON data associated with the event. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/EventAttributesEntity.java b/src/main/java/one/talon/model/EventAttributesEntity.java index aed14043..16ef77f7 100644 --- a/src/main/java/one/talon/model/EventAttributesEntity.java +++ b/src/main/java/one/talon/model/EventAttributesEntity.java @@ -48,7 +48,7 @@ /** * EventAttributesEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventAttributesEntity { public static final String SERIALIZED_NAME_TYPE = "type"; @SerializedName(SERIALIZED_NAME_TYPE) diff --git a/src/main/java/one/talon/model/EventType.java b/src/main/java/one/talon/model/EventType.java index 85271a30..0a2d2671 100644 --- a/src/main/java/one/talon/model/EventType.java +++ b/src/main/java/one/talon/model/EventType.java @@ -49,7 +49,7 @@ /** * EventType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventType { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/EventV2.java b/src/main/java/one/talon/model/EventV2.java index 68f1a2a1..b25979fd 100644 --- a/src/main/java/one/talon/model/EventV2.java +++ b/src/main/java/one/talon/model/EventV2.java @@ -50,7 +50,7 @@ /** * EventV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventV2 { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/EventV3.java b/src/main/java/one/talon/model/EventV3.java index a11ac1eb..a97c596d 100644 --- a/src/main/java/one/talon/model/EventV3.java +++ b/src/main/java/one/talon/model/EventV3.java @@ -51,7 +51,7 @@ /** * EventV3 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventV3 { public static final String SERIALIZED_NAME_CONNECTED_SESSION_ID = "connectedSessionId"; @SerializedName(SERIALIZED_NAME_CONNECTED_SESSION_ID) @@ -245,7 +245,7 @@ public EventV3 attributes(@javax.annotation.Nonnull Object attributes) { } /** - * Arbitrary additional JSON data associated with the event. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/EventV3Connections.java b/src/main/java/one/talon/model/EventV3Connections.java index bab11545..762c9bdf 100644 --- a/src/main/java/one/talon/model/EventV3Connections.java +++ b/src/main/java/one/talon/model/EventV3Connections.java @@ -48,7 +48,7 @@ /** * EventV3Connections */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventV3Connections { public static final String SERIALIZED_NAME_CONNECTED_SESSION_ID = "connectedSessionId"; @SerializedName(SERIALIZED_NAME_CONNECTED_SESSION_ID) diff --git a/src/main/java/one/talon/model/EventV3Entity.java b/src/main/java/one/talon/model/EventV3Entity.java index 2e3ee69a..7dc8f013 100644 --- a/src/main/java/one/talon/model/EventV3Entity.java +++ b/src/main/java/one/talon/model/EventV3Entity.java @@ -48,7 +48,7 @@ /** * EventV3Entity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventV3Entity { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/EventV3RequestEntity.java b/src/main/java/one/talon/model/EventV3RequestEntity.java index 4d60c0e3..0c2f532e 100644 --- a/src/main/java/one/talon/model/EventV3RequestEntity.java +++ b/src/main/java/one/talon/model/EventV3RequestEntity.java @@ -50,7 +50,7 @@ /** * EventV3RequestEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class EventV3RequestEntity { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/Experiment.java b/src/main/java/one/talon/model/Experiment.java index 64de43f6..82a58648 100644 --- a/src/main/java/one/talon/model/Experiment.java +++ b/src/main/java/one/talon/model/Experiment.java @@ -53,7 +53,7 @@ /** * Experiment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Experiment { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ExperimentCampaignCopy.java b/src/main/java/one/talon/model/ExperimentCampaignCopy.java index 2fb0ec5c..2e346d4b 100644 --- a/src/main/java/one/talon/model/ExperimentCampaignCopy.java +++ b/src/main/java/one/talon/model/ExperimentCampaignCopy.java @@ -51,7 +51,7 @@ /** * ExperimentCampaignCopy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentCampaignCopy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateCustomerProfileV2409Response.java b/src/main/java/one/talon/model/ExperimentConfidenceTimeline.java similarity index 60% rename from src/main/java/one/talon/model/UpdateCustomerProfileV2409Response.java rename to src/main/java/one/talon/model/ExperimentConfidenceTimeline.java index 050c7fdb..95b52e90 100644 --- a/src/main/java/one/talon/model/UpdateCustomerProfileV2409Response.java +++ b/src/main/java/one/talon/model/ExperimentConfidenceTimeline.java @@ -23,6 +23,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import one.talon.model.ExperimentConfidenceTimelineDataPoint; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,90 +49,42 @@ import one.talon.JSON; /** - * UpdateCustomerProfileV2409Response + * ExperimentConfidenceTimeline */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") -public class UpdateCustomerProfileV2409Response { - public static final String SERIALIZED_NAME_MESSAGE = "message"; - @SerializedName(SERIALIZED_NAME_MESSAGE) - @javax.annotation.Nullable - private String message; - - public static final String SERIALIZED_NAME_ERRORS = "errors"; - @SerializedName(SERIALIZED_NAME_ERRORS) - @javax.annotation.Nullable - private List errors; - - public static final String SERIALIZED_NAME_STATUS_CODE = "StatusCode"; - @SerializedName(SERIALIZED_NAME_STATUS_CODE) - @javax.annotation.Nullable - private Long statusCode; - - public UpdateCustomerProfileV2409Response() { +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") +public class ExperimentConfidenceTimeline { + public static final String SERIALIZED_NAME_DATA = "data"; + @SerializedName(SERIALIZED_NAME_DATA) + @javax.annotation.Nonnull + private List data = new ArrayList<>(); + + public ExperimentConfidenceTimeline() { } - public UpdateCustomerProfileV2409Response message(@javax.annotation.Nullable String message) { - this.message = message; + public ExperimentConfidenceTimeline data(@javax.annotation.Nonnull List data) { + this.data = data; return this; } - /** - * Get message - * @return message - */ - @javax.annotation.Nullable - public String getMessage() { - return message; - } - - public void setMessage(@javax.annotation.Nullable String message) { - this.message = message; - } - - - public UpdateCustomerProfileV2409Response errors(@javax.annotation.Nullable List errors) { - this.errors = errors; - return this; - } - - public UpdateCustomerProfileV2409Response addErrorsItem(Object errorsItem) { - if (this.errors == null) { - this.errors = new ArrayList<>(); + public ExperimentConfidenceTimeline addDataItem(ExperimentConfidenceTimelineDataPoint dataItem) { + if (this.data == null) { + this.data = new ArrayList<>(); } - this.errors.add(errorsItem); - return this; - } - - /** - * Get errors - * @return errors - */ - @javax.annotation.Nullable - public List getErrors() { - return errors; - } - - public void setErrors(@javax.annotation.Nullable List errors) { - this.errors = errors; - } - - - public UpdateCustomerProfileV2409Response statusCode(@javax.annotation.Nullable Long statusCode) { - this.statusCode = statusCode; + this.data.add(dataItem); return this; } /** - * Get statusCode - * @return statusCode + * Daily cumulative confidence values ordered chronologically from experiment start to end, or to today if the experiment is still running. Empty if the experiment has no data yet. + * @return data */ - @javax.annotation.Nullable - public Long getStatusCode() { - return statusCode; + @javax.annotation.Nonnull + public List getData() { + return data; } - public void setStatusCode(@javax.annotation.Nullable Long statusCode) { - this.statusCode = statusCode; + public void setData(@javax.annotation.Nonnull List data) { + this.data = data; } /** @@ -147,9 +100,9 @@ public void setStatusCode(@javax.annotation.Nullable Long statusCode) { * * @param key name of the property * @param value value of the property - * @return the UpdateCustomerProfileV2409Response instance itself + * @return the ExperimentConfidenceTimeline instance itself */ - public UpdateCustomerProfileV2409Response putAdditionalProperty(String key, Object value) { + public ExperimentConfidenceTimeline putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -188,25 +141,21 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - UpdateCustomerProfileV2409Response updateCustomerProfileV2409Response = (UpdateCustomerProfileV2409Response) o; - return Objects.equals(this.message, updateCustomerProfileV2409Response.message) && - Objects.equals(this.errors, updateCustomerProfileV2409Response.errors) && - Objects.equals(this.statusCode, updateCustomerProfileV2409Response.statusCode)&& - Objects.equals(this.additionalProperties, updateCustomerProfileV2409Response.additionalProperties); + ExperimentConfidenceTimeline experimentConfidenceTimeline = (ExperimentConfidenceTimeline) o; + return Objects.equals(this.data, experimentConfidenceTimeline.data)&& + Objects.equals(this.additionalProperties, experimentConfidenceTimeline.additionalProperties); } @Override public int hashCode() { - return Objects.hash(message, errors, statusCode, additionalProperties); + return Objects.hash(data, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class UpdateCustomerProfileV2409Response {\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); - sb.append(" statusCode: ").append(toIndentedString(statusCode)).append("\n"); + sb.append("class ExperimentConfidenceTimeline {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -226,31 +175,41 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("message", "errors", "StatusCode")); + openapiFields = new HashSet(Arrays.asList("data")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); + openapiRequiredFields = new HashSet(Arrays.asList("data")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to UpdateCustomerProfileV2409Response + * @throws IOException if the JSON Element is invalid with respect to ExperimentConfidenceTimeline */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!UpdateCustomerProfileV2409Response.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in UpdateCustomerProfileV2409Response is not found in the empty JSON string", UpdateCustomerProfileV2409Response.openapiRequiredFields.toString())); + if (!ExperimentConfidenceTimeline.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in ExperimentConfidenceTimeline is not found in the empty JSON string", ExperimentConfidenceTimeline.openapiRequiredFields.toString())); } } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("message") != null && !jsonObj.get("message").isJsonNull()) && !jsonObj.get("message").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `message` to be a primitive type in the JSON string but got `%s`", jsonObj.get("message").toString())); + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : ExperimentConfidenceTimeline.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); + } } - // ensure the optional json data is an array if present - if (jsonObj.get("errors") != null && !jsonObj.get("errors").isJsonNull() && !jsonObj.get("errors").isJsonArray()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `errors` to be an array in the JSON string but got `%s`", jsonObj.get("errors").toString())); + JsonObject jsonObj = jsonElement.getAsJsonObject(); + if (jsonObj.get("data") != null) { + if (!jsonObj.get("data").isJsonArray()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `data` to be an array in the JSON string but got `%s`", jsonObj.get("data").toString())); + } + JsonArray jsonArraydata = jsonObj.getAsJsonArray("data"); + // validate the required field `data` (array) + for (int i = 0; i < jsonArraydata.size(); i++) { + ExperimentConfidenceTimelineDataPoint.validateJsonElement(jsonArraydata.get(i)); + } } } @@ -258,16 +217,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!UpdateCustomerProfileV2409Response.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'UpdateCustomerProfileV2409Response' and its subtypes + if (!ExperimentConfidenceTimeline.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'ExperimentConfidenceTimeline' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(UpdateCustomerProfileV2409Response.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(ExperimentConfidenceTimeline.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, UpdateCustomerProfileV2409Response value) throws IOException { + public void write(JsonWriter out, ExperimentConfidenceTimeline value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -295,12 +254,12 @@ else if (entry.getValue() instanceof Character) } @Override - public UpdateCustomerProfileV2409Response read(JsonReader in) throws IOException { + public ExperimentConfidenceTimeline read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - UpdateCustomerProfileV2409Response instance = thisAdapter.fromJsonTree(jsonObj); + ExperimentConfidenceTimeline instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -327,18 +286,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of UpdateCustomerProfileV2409Response given an JSON string + * Create an instance of ExperimentConfidenceTimeline given an JSON string * * @param jsonString JSON string - * @return An instance of UpdateCustomerProfileV2409Response - * @throws IOException if the JSON string is invalid with respect to UpdateCustomerProfileV2409Response + * @return An instance of ExperimentConfidenceTimeline + * @throws IOException if the JSON string is invalid with respect to ExperimentConfidenceTimeline */ - public static UpdateCustomerProfileV2409Response fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, UpdateCustomerProfileV2409Response.class); + public static ExperimentConfidenceTimeline fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, ExperimentConfidenceTimeline.class); } /** - * Convert an instance of UpdateCustomerProfileV2409Response to an JSON string + * Convert an instance of ExperimentConfidenceTimeline to an JSON string * * @return JSON string */ diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java b/src/main/java/one/talon/model/ExperimentConfidenceTimelineDataPoint.java similarity index 66% rename from src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java rename to src/main/java/one/talon/model/ExperimentConfidenceTimelineDataPoint.java index 760f2d61..ac69d8ca 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseSort.java +++ b/src/main/java/one/talon/model/ExperimentConfidenceTimelineDataPoint.java @@ -20,7 +20,9 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; +import java.time.OffsetDateTime; import java.util.Arrays; +import one.talon.model.ExperimentVariantResultConfidence; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -46,34 +48,58 @@ import one.talon.JSON; /** - * Configuration settings related to sorting SCIM resources in query responses. + * ExperimentConfidenceTimelineDataPoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") -public class ScimServiceProviderConfigResponseSort { - public static final String SERIALIZED_NAME_SUPPORTED = "supported"; - @SerializedName(SERIALIZED_NAME_SUPPORTED) - @javax.annotation.Nullable - private Boolean supported; - - public ScimServiceProviderConfigResponseSort() { +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") +public class ExperimentConfidenceTimelineDataPoint { + public static final String SERIALIZED_NAME_DATE = "date"; + @SerializedName(SERIALIZED_NAME_DATE) + @javax.annotation.Nonnull + private OffsetDateTime date; + + public static final String SERIALIZED_NAME_CONFIDENCE = "confidence"; + @SerializedName(SERIALIZED_NAME_CONFIDENCE) + @javax.annotation.Nonnull + private ExperimentVariantResultConfidence confidence; + + public ExperimentConfidenceTimelineDataPoint() { } - public ScimServiceProviderConfigResponseSort supported(@javax.annotation.Nullable Boolean supported) { - this.supported = supported; + public ExperimentConfidenceTimelineDataPoint date(@javax.annotation.Nonnull OffsetDateTime date) { + this.date = date; return this; } /** - * Indicates whether the service provider supports sorting operations for ordered query results. - * @return supported + * The date-time this data point represents. + * @return date */ - @javax.annotation.Nullable - public Boolean getSupported() { - return supported; + @javax.annotation.Nonnull + public OffsetDateTime getDate() { + return date; } - public void setSupported(@javax.annotation.Nullable Boolean supported) { - this.supported = supported; + public void setDate(@javax.annotation.Nonnull OffsetDateTime date) { + this.date = date; + } + + + public ExperimentConfidenceTimelineDataPoint confidence(@javax.annotation.Nonnull ExperimentVariantResultConfidence confidence) { + this.confidence = confidence; + return this; + } + + /** + * Get confidence + * @return confidence + */ + @javax.annotation.Nonnull + public ExperimentVariantResultConfidence getConfidence() { + return confidence; + } + + public void setConfidence(@javax.annotation.Nonnull ExperimentVariantResultConfidence confidence) { + this.confidence = confidence; } /** @@ -89,9 +115,9 @@ public void setSupported(@javax.annotation.Nullable Boolean supported) { * * @param key name of the property * @param value value of the property - * @return the ScimServiceProviderConfigResponseSort instance itself + * @return the ExperimentConfidenceTimelineDataPoint instance itself */ - public ScimServiceProviderConfigResponseSort putAdditionalProperty(String key, Object value) { + public ExperimentConfidenceTimelineDataPoint putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -130,21 +156,23 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - ScimServiceProviderConfigResponseSort scimServiceProviderConfigResponseSort = (ScimServiceProviderConfigResponseSort) o; - return Objects.equals(this.supported, scimServiceProviderConfigResponseSort.supported)&& - Objects.equals(this.additionalProperties, scimServiceProviderConfigResponseSort.additionalProperties); + ExperimentConfidenceTimelineDataPoint experimentConfidenceTimelineDataPoint = (ExperimentConfidenceTimelineDataPoint) o; + return Objects.equals(this.date, experimentConfidenceTimelineDataPoint.date) && + Objects.equals(this.confidence, experimentConfidenceTimelineDataPoint.confidence)&& + Objects.equals(this.additionalProperties, experimentConfidenceTimelineDataPoint.additionalProperties); } @Override public int hashCode() { - return Objects.hash(supported, additionalProperties); + return Objects.hash(date, confidence, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class ScimServiceProviderConfigResponseSort {\n"); - sb.append(" supported: ").append(toIndentedString(supported)).append("\n"); + sb.append("class ExperimentConfidenceTimelineDataPoint {\n"); + sb.append(" date: ").append(toIndentedString(date)).append("\n"); + sb.append(" confidence: ").append(toIndentedString(confidence)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -164,41 +192,50 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("supported")); + openapiFields = new HashSet(Arrays.asList("date", "confidence")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); + openapiRequiredFields = new HashSet(Arrays.asList("date", "confidence")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ScimServiceProviderConfigResponseSort + * @throws IOException if the JSON Element is invalid with respect to ExperimentConfidenceTimelineDataPoint */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!ScimServiceProviderConfigResponseSort.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in ScimServiceProviderConfigResponseSort is not found in the empty JSON string", ScimServiceProviderConfigResponseSort.openapiRequiredFields.toString())); + if (!ExperimentConfidenceTimelineDataPoint.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in ExperimentConfidenceTimelineDataPoint is not found in the empty JSON string", ExperimentConfidenceTimelineDataPoint.openapiRequiredFields.toString())); + } + } + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : ExperimentConfidenceTimelineDataPoint.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); + // validate the required field `confidence` + ExperimentVariantResultConfidence.validateJsonElement(jsonObj.get("confidence")); } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!ScimServiceProviderConfigResponseSort.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ScimServiceProviderConfigResponseSort' and its subtypes + if (!ExperimentConfidenceTimelineDataPoint.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'ExperimentConfidenceTimelineDataPoint' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ScimServiceProviderConfigResponseSort.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(ExperimentConfidenceTimelineDataPoint.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, ScimServiceProviderConfigResponseSort value) throws IOException { + public void write(JsonWriter out, ExperimentConfidenceTimelineDataPoint value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -226,12 +263,12 @@ else if (entry.getValue() instanceof Character) } @Override - public ScimServiceProviderConfigResponseSort read(JsonReader in) throws IOException { + public ExperimentConfidenceTimelineDataPoint read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - ScimServiceProviderConfigResponseSort instance = thisAdapter.fromJsonTree(jsonObj); + ExperimentConfidenceTimelineDataPoint instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -258,18 +295,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of ScimServiceProviderConfigResponseSort given an JSON string + * Create an instance of ExperimentConfidenceTimelineDataPoint given an JSON string * * @param jsonString JSON string - * @return An instance of ScimServiceProviderConfigResponseSort - * @throws IOException if the JSON string is invalid with respect to ScimServiceProviderConfigResponseSort + * @return An instance of ExperimentConfidenceTimelineDataPoint + * @throws IOException if the JSON string is invalid with respect to ExperimentConfidenceTimelineDataPoint */ - public static ScimServiceProviderConfigResponseSort fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ScimServiceProviderConfigResponseSort.class); + public static ExperimentConfidenceTimelineDataPoint fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, ExperimentConfidenceTimelineDataPoint.class); } /** - * Convert an instance of ScimServiceProviderConfigResponseSort to an JSON string + * Convert an instance of ExperimentConfidenceTimelineDataPoint to an JSON string * * @return JSON string */ diff --git a/src/main/java/one/talon/model/ExperimentCopy.java b/src/main/java/one/talon/model/ExperimentCopy.java index 915cd3f5..6a80866a 100644 --- a/src/main/java/one/talon/model/ExperimentCopy.java +++ b/src/main/java/one/talon/model/ExperimentCopy.java @@ -49,7 +49,7 @@ /** * ExperimentCopy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentCopy { public static final String SERIALIZED_NAME_TARGET_APPLICATION_ID = "targetApplicationId"; @SerializedName(SERIALIZED_NAME_TARGET_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/ExperimentCopyExperiment.java b/src/main/java/one/talon/model/ExperimentCopyExperiment.java index 4e59e900..cf9c571b 100644 --- a/src/main/java/one/talon/model/ExperimentCopyExperiment.java +++ b/src/main/java/one/talon/model/ExperimentCopyExperiment.java @@ -49,7 +49,7 @@ /** * ExperimentCopyExperiment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentCopyExperiment { public static final String SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL = "isVariantAssignmentExternal"; @SerializedName(SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL) diff --git a/src/main/java/one/talon/model/ExperimentListResults.java b/src/main/java/one/talon/model/ExperimentListResults.java index 23202785..db4e9845 100644 --- a/src/main/java/one/talon/model/ExperimentListResults.java +++ b/src/main/java/one/talon/model/ExperimentListResults.java @@ -51,7 +51,7 @@ /** * ExperimentListResults */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentListResults { public static final String SERIALIZED_NAME_RESULTS = "results"; @SerializedName(SERIALIZED_NAME_RESULTS) diff --git a/src/main/java/one/talon/model/ExperimentListResultsRequest.java b/src/main/java/one/talon/model/ExperimentListResultsRequest.java index 9ef2526d..d8019abf 100644 --- a/src/main/java/one/talon/model/ExperimentListResultsRequest.java +++ b/src/main/java/one/talon/model/ExperimentListResultsRequest.java @@ -50,7 +50,7 @@ /** * ExperimentListResultsRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentListResultsRequest { public static final String SERIALIZED_NAME_EXPERIMENT_IDS = "experimentIds"; @SerializedName(SERIALIZED_NAME_EXPERIMENT_IDS) diff --git a/src/main/java/one/talon/model/ExperimentResult.java b/src/main/java/one/talon/model/ExperimentResult.java index 7446b42f..1ffb744d 100644 --- a/src/main/java/one/talon/model/ExperimentResult.java +++ b/src/main/java/one/talon/model/ExperimentResult.java @@ -52,7 +52,7 @@ /** * ExperimentResult */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentResult { public static final String SERIALIZED_NAME_VARIANTS = "variants"; @SerializedName(SERIALIZED_NAME_VARIANTS) diff --git a/src/main/java/one/talon/model/ExperimentResults.java b/src/main/java/one/talon/model/ExperimentResults.java index a25fb784..459a1058 100644 --- a/src/main/java/one/talon/model/ExperimentResults.java +++ b/src/main/java/one/talon/model/ExperimentResults.java @@ -52,7 +52,7 @@ /** * ExperimentResults */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentResults { public static final String SERIALIZED_NAME_VARIANTS = "variants"; @SerializedName(SERIALIZED_NAME_VARIANTS) diff --git a/src/main/java/one/talon/model/ExperimentSegmentInsight.java b/src/main/java/one/talon/model/ExperimentSegmentInsight.java index 7e6c8183..40d1aadf 100644 --- a/src/main/java/one/talon/model/ExperimentSegmentInsight.java +++ b/src/main/java/one/talon/model/ExperimentSegmentInsight.java @@ -51,7 +51,7 @@ /** * ExperimentSegmentInsight */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentSegmentInsight { /** * The segmentation dimension used to group customers or purchases for analysis. diff --git a/src/main/java/one/talon/model/ExperimentSegmentInsightMetric.java b/src/main/java/one/talon/model/ExperimentSegmentInsightMetric.java index d693c647..f696f762 100644 --- a/src/main/java/one/talon/model/ExperimentSegmentInsightMetric.java +++ b/src/main/java/one/talon/model/ExperimentSegmentInsightMetric.java @@ -51,7 +51,7 @@ /** * ExperimentSegmentInsightMetric */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentSegmentInsightMetric { /** * The metric being measured. diff --git a/src/main/java/one/talon/model/ExperimentSegmentInsightVariant.java b/src/main/java/one/talon/model/ExperimentSegmentInsightVariant.java index 1be8e79f..a554ed71 100644 --- a/src/main/java/one/talon/model/ExperimentSegmentInsightVariant.java +++ b/src/main/java/one/talon/model/ExperimentSegmentInsightVariant.java @@ -48,7 +48,7 @@ /** * ExperimentSegmentInsightVariant */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentSegmentInsightVariant { public static final String SERIALIZED_NAME_VARIANT_ID = "variantId"; @SerializedName(SERIALIZED_NAME_VARIANT_ID) diff --git a/src/main/java/one/talon/model/ExperimentSegmentInsights.java b/src/main/java/one/talon/model/ExperimentSegmentInsights.java index 147c4afc..fbfc36aa 100644 --- a/src/main/java/one/talon/model/ExperimentSegmentInsights.java +++ b/src/main/java/one/talon/model/ExperimentSegmentInsights.java @@ -51,7 +51,7 @@ /** * ExperimentSegmentInsights */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentSegmentInsights { public static final String SERIALIZED_NAME_METRICS = "metrics"; @SerializedName(SERIALIZED_NAME_METRICS) diff --git a/src/main/java/one/talon/model/ExperimentVariant.java b/src/main/java/one/talon/model/ExperimentVariant.java index dbfbec0f..cc440124 100644 --- a/src/main/java/one/talon/model/ExperimentVariant.java +++ b/src/main/java/one/talon/model/ExperimentVariant.java @@ -50,7 +50,7 @@ /** * ExperimentVariant */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVariant { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ExperimentVariantAllocation.java b/src/main/java/one/talon/model/ExperimentVariantAllocation.java index 067d0f4f..e90334a5 100644 --- a/src/main/java/one/talon/model/ExperimentVariantAllocation.java +++ b/src/main/java/one/talon/model/ExperimentVariantAllocation.java @@ -48,7 +48,7 @@ /** * ExperimentVariantAllocation */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVariantAllocation { public static final String SERIALIZED_NAME_EXPERIMENT_I_D = "experimentID"; @SerializedName(SERIALIZED_NAME_EXPERIMENT_I_D) diff --git a/src/main/java/one/talon/model/ExperimentVariantResult.java b/src/main/java/one/talon/model/ExperimentVariantResult.java index 3576af89..ebaab917 100644 --- a/src/main/java/one/talon/model/ExperimentVariantResult.java +++ b/src/main/java/one/talon/model/ExperimentVariantResult.java @@ -49,7 +49,7 @@ /** * ExperimentVariantResult */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVariantResult { public static final String SERIALIZED_NAME_VARIANT_ID = "variantId"; @SerializedName(SERIALIZED_NAME_VARIANT_ID) diff --git a/src/main/java/one/talon/model/ExperimentVariantResultConfidence.java b/src/main/java/one/talon/model/ExperimentVariantResultConfidence.java index c8df433c..1f7d4bc2 100644 --- a/src/main/java/one/talon/model/ExperimentVariantResultConfidence.java +++ b/src/main/java/one/talon/model/ExperimentVariantResultConfidence.java @@ -49,7 +49,7 @@ /** * ExperimentVariantResultConfidence */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVariantResultConfidence { public static final String SERIALIZED_NAME_AVG_SESSION_VALUE = "avgSessionValue"; @SerializedName(SERIALIZED_NAME_AVG_SESSION_VALUE) diff --git a/src/main/java/one/talon/model/ExperimentVerdict.java b/src/main/java/one/talon/model/ExperimentVerdict.java index 0208097a..c0b51673 100644 --- a/src/main/java/one/talon/model/ExperimentVerdict.java +++ b/src/main/java/one/talon/model/ExperimentVerdict.java @@ -50,7 +50,7 @@ /** * ExperimentVerdict */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVerdict { public static final String SERIALIZED_NAME_WINNER_VARIANT_NAME = "winnerVariantName"; @SerializedName(SERIALIZED_NAME_WINNER_VARIANT_NAME) diff --git a/src/main/java/one/talon/model/ExperimentVerdictResponse.java b/src/main/java/one/talon/model/ExperimentVerdictResponse.java index 6f83c3da..43ef3984 100644 --- a/src/main/java/one/talon/model/ExperimentVerdictResponse.java +++ b/src/main/java/one/talon/model/ExperimentVerdictResponse.java @@ -50,7 +50,7 @@ /** * ExperimentVerdictResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExperimentVerdictResponse { public static final String SERIALIZED_NAME_VERDICT = "verdict"; @SerializedName(SERIALIZED_NAME_VERDICT) diff --git a/src/main/java/one/talon/model/ExpiringCardPointsData.java b/src/main/java/one/talon/model/ExpiringCardPointsData.java index 4a31f6b4..6acf9a83 100644 --- a/src/main/java/one/talon/model/ExpiringCardPointsData.java +++ b/src/main/java/one/talon/model/ExpiringCardPointsData.java @@ -52,7 +52,7 @@ /** * ExpiringCardPointsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCardPointsData { public static final String SERIALIZED_NAME_EXPIRY_DATE = "ExpiryDate"; @SerializedName(SERIALIZED_NAME_EXPIRY_DATE) diff --git a/src/main/java/one/talon/model/ExpiringCardPointsNotification.java b/src/main/java/one/talon/model/ExpiringCardPointsNotification.java index 78e49c87..f149a4cd 100644 --- a/src/main/java/one/talon/model/ExpiringCardPointsNotification.java +++ b/src/main/java/one/talon/model/ExpiringCardPointsNotification.java @@ -51,7 +51,7 @@ /** * ExpiringCardPointsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCardPointsNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/ExpiringCouponsData.java b/src/main/java/one/talon/model/ExpiringCouponsData.java index 081d8c1c..24e7fe0e 100644 --- a/src/main/java/one/talon/model/ExpiringCouponsData.java +++ b/src/main/java/one/talon/model/ExpiringCouponsData.java @@ -51,7 +51,7 @@ /** * ExpiringCouponsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCouponsData { public static final String SERIALIZED_NAME_COUPON_VALUE = "CouponValue"; @SerializedName(SERIALIZED_NAME_COUPON_VALUE) diff --git a/src/main/java/one/talon/model/ExpiringCouponsNotification.java b/src/main/java/one/talon/model/ExpiringCouponsNotification.java index 6d94018f..f3810936 100644 --- a/src/main/java/one/talon/model/ExpiringCouponsNotification.java +++ b/src/main/java/one/talon/model/ExpiringCouponsNotification.java @@ -51,7 +51,7 @@ /** * ExpiringCouponsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCouponsNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/ExpiringCouponsNotificationPolicy.java b/src/main/java/one/talon/model/ExpiringCouponsNotificationPolicy.java index 40ed41ff..d4b12c88 100644 --- a/src/main/java/one/talon/model/ExpiringCouponsNotificationPolicy.java +++ b/src/main/java/one/talon/model/ExpiringCouponsNotificationPolicy.java @@ -51,7 +51,7 @@ /** * ExpiringCouponsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCouponsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/ExpiringCouponsNotificationTrigger.java b/src/main/java/one/talon/model/ExpiringCouponsNotificationTrigger.java index fa5ff445..80d29234 100644 --- a/src/main/java/one/talon/model/ExpiringCouponsNotificationTrigger.java +++ b/src/main/java/one/talon/model/ExpiringCouponsNotificationTrigger.java @@ -48,7 +48,7 @@ /** * ExpiringCouponsNotificationTrigger */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringCouponsNotificationTrigger { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/ExpiringPointsData.java b/src/main/java/one/talon/model/ExpiringPointsData.java index 093fac02..1b142d39 100644 --- a/src/main/java/one/talon/model/ExpiringPointsData.java +++ b/src/main/java/one/talon/model/ExpiringPointsData.java @@ -50,7 +50,7 @@ /** * ExpiringPointsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringPointsData { public static final String SERIALIZED_NAME_EXPIRY_DATE = "ExpiryDate"; @SerializedName(SERIALIZED_NAME_EXPIRY_DATE) diff --git a/src/main/java/one/talon/model/ExpiringPointsNotification.java b/src/main/java/one/talon/model/ExpiringPointsNotification.java index 3b0ff8e2..fd5f7088 100644 --- a/src/main/java/one/talon/model/ExpiringPointsNotification.java +++ b/src/main/java/one/talon/model/ExpiringPointsNotification.java @@ -51,7 +51,7 @@ /** * ExpiringPointsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringPointsNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/ExpiringPointsNotificationPolicy.java b/src/main/java/one/talon/model/ExpiringPointsNotificationPolicy.java index cd1bf751..bbd19e8a 100644 --- a/src/main/java/one/talon/model/ExpiringPointsNotificationPolicy.java +++ b/src/main/java/one/talon/model/ExpiringPointsNotificationPolicy.java @@ -51,7 +51,7 @@ /** * ExpiringPointsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringPointsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/ExpiringPointsNotificationTrigger.java b/src/main/java/one/talon/model/ExpiringPointsNotificationTrigger.java index 41cf71f8..e5c6114a 100644 --- a/src/main/java/one/talon/model/ExpiringPointsNotificationTrigger.java +++ b/src/main/java/one/talon/model/ExpiringPointsNotificationTrigger.java @@ -48,7 +48,7 @@ /** * ExpiringPointsNotificationTrigger */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExpiringPointsNotificationTrigger { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/Export.java b/src/main/java/one/talon/model/Export.java index 10b29cef..03acd1f1 100644 --- a/src/main/java/one/talon/model/Export.java +++ b/src/main/java/one/talon/model/Export.java @@ -49,7 +49,7 @@ /** * Export */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Export { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -247,7 +247,7 @@ public Export filter(@javax.annotation.Nonnull Object filter) { } /** - * Map of keys and values that were used to filter the exported rows. + * Arbitrary properties associated with this campaign. * @return filter */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ExtendLoyaltyPointsExpiryDateEffectProps.java b/src/main/java/one/talon/model/ExtendLoyaltyPointsExpiryDateEffectProps.java index ba91395e..0259f6c8 100644 --- a/src/main/java/one/talon/model/ExtendLoyaltyPointsExpiryDateEffectProps.java +++ b/src/main/java/one/talon/model/ExtendLoyaltyPointsExpiryDateEffectProps.java @@ -49,9 +49,9 @@ import one.talon.JSON; /** - * The properties specific to the \"extendLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"extend expiry date\" effect. The current expiry date gets extended by the time frame given in the effect. + * If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExtendLoyaltyPointsExpiryDateEffectProps { public static final String SERIALIZED_NAME_PROGRAM_ID = "programId"; @SerializedName(SERIALIZED_NAME_PROGRAM_ID) @@ -101,7 +101,7 @@ public ExtendLoyaltyPointsExpiryDateEffectProps subLedgerId(@javax.annotation.No } /** - * API name of the loyalty program subledger that contains these points. added. + * API name of the loyalty program subledger that contains these points. * @return subLedgerId */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ExtendedCoupon.java b/src/main/java/one/talon/model/ExtendedCoupon.java index cfb6cbc8..dc32a55e 100644 --- a/src/main/java/one/talon/model/ExtendedCoupon.java +++ b/src/main/java/one/talon/model/ExtendedCoupon.java @@ -53,7 +53,7 @@ /** * ExtendedCoupon */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ExtendedCoupon { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/FeatureFlag.java b/src/main/java/one/talon/model/FeatureFlag.java index a134d1c3..50b67df5 100644 --- a/src/main/java/one/talon/model/FeatureFlag.java +++ b/src/main/java/one/talon/model/FeatureFlag.java @@ -49,7 +49,7 @@ /** * FeatureFlag */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class FeatureFlag { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/FeatureFlagUpdate.java b/src/main/java/one/talon/model/FeatureFlagUpdate.java index 17dd3ff1..fea3fa73 100644 --- a/src/main/java/one/talon/model/FeatureFlagUpdate.java +++ b/src/main/java/one/talon/model/FeatureFlagUpdate.java @@ -48,7 +48,7 @@ /** * FeatureFlagUpdate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class FeatureFlagUpdate { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/FeaturesFeed.java b/src/main/java/one/talon/model/FeaturesFeed.java index 21cb0915..14ec7465 100644 --- a/src/main/java/one/talon/model/FeaturesFeed.java +++ b/src/main/java/one/talon/model/FeaturesFeed.java @@ -48,7 +48,7 @@ /** * FeaturesFeed */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class FeaturesFeed { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/FuncArgDef.java b/src/main/java/one/talon/model/FuncArgDef.java index 408c102d..9b016d69 100644 --- a/src/main/java/one/talon/model/FuncArgDef.java +++ b/src/main/java/one/talon/model/FuncArgDef.java @@ -48,7 +48,7 @@ /** * FuncArgDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class FuncArgDef { /** * The type of value this argument expects. diff --git a/src/main/java/one/talon/model/FunctionDef.java b/src/main/java/one/talon/model/FunctionDef.java index 3b59c262..1200c6b1 100644 --- a/src/main/java/one/talon/model/FunctionDef.java +++ b/src/main/java/one/talon/model/FunctionDef.java @@ -51,7 +51,7 @@ /** * FunctionDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class FunctionDef { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/GenerateAuditLogSummary.java b/src/main/java/one/talon/model/GenerateAuditLogSummary.java index c6faabc7..213bb3ad 100644 --- a/src/main/java/one/talon/model/GenerateAuditLogSummary.java +++ b/src/main/java/one/talon/model/GenerateAuditLogSummary.java @@ -48,7 +48,7 @@ /** * GenerateAuditLogSummary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateAuditLogSummary { public static final String SERIALIZED_NAME_LOG_I_D = "logID"; @SerializedName(SERIALIZED_NAME_LOG_I_D) diff --git a/src/main/java/one/talon/model/GenerateCampaignDescription.java b/src/main/java/one/talon/model/GenerateCampaignDescription.java index 17fe6471..f7933557 100644 --- a/src/main/java/one/talon/model/GenerateCampaignDescription.java +++ b/src/main/java/one/talon/model/GenerateCampaignDescription.java @@ -48,7 +48,7 @@ /** * GenerateCampaignDescription */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCampaignDescription { public static final String SERIALIZED_NAME_CAMPAIGN_I_D = "campaignID"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_I_D) diff --git a/src/main/java/one/talon/model/GenerateCampaignSummary.java b/src/main/java/one/talon/model/GenerateCampaignSummary.java index 1b4bb645..fc80fbc9 100644 --- a/src/main/java/one/talon/model/GenerateCampaignSummary.java +++ b/src/main/java/one/talon/model/GenerateCampaignSummary.java @@ -48,7 +48,7 @@ /** * GenerateCampaignSummary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCampaignSummary { public static final String SERIALIZED_NAME_CAMPAIGN_I_D = "campaignID"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_I_D) diff --git a/src/main/java/one/talon/model/GenerateCampaignTags.java b/src/main/java/one/talon/model/GenerateCampaignTags.java index 98592bd5..935ff14f 100644 --- a/src/main/java/one/talon/model/GenerateCampaignTags.java +++ b/src/main/java/one/talon/model/GenerateCampaignTags.java @@ -48,7 +48,7 @@ /** * GenerateCampaignTags */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCampaignTags { public static final String SERIALIZED_NAME_RULESET_I_D = "rulesetID"; @SerializedName(SERIALIZED_NAME_RULESET_I_D) diff --git a/src/main/java/one/talon/model/GenerateCouponFailureDetailedSummary.java b/src/main/java/one/talon/model/GenerateCouponFailureDetailedSummary.java index a46146eb..24a2fcf9 100644 --- a/src/main/java/one/talon/model/GenerateCouponFailureDetailedSummary.java +++ b/src/main/java/one/talon/model/GenerateCouponFailureDetailedSummary.java @@ -49,7 +49,7 @@ /** * GenerateCouponFailureDetailedSummary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCouponFailureDetailedSummary { public static final String SERIALIZED_NAME_APPLICATION_I_D = "applicationID"; @SerializedName(SERIALIZED_NAME_APPLICATION_I_D) diff --git a/src/main/java/one/talon/model/GenerateCouponFailureSummary.java b/src/main/java/one/talon/model/GenerateCouponFailureSummary.java index 345c7a08..d0abd1b1 100644 --- a/src/main/java/one/talon/model/GenerateCouponFailureSummary.java +++ b/src/main/java/one/talon/model/GenerateCouponFailureSummary.java @@ -48,7 +48,7 @@ /** * GenerateCouponFailureSummary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCouponFailureSummary { public static final String SERIALIZED_NAME_EVENT_I_D = "eventID"; @SerializedName(SERIALIZED_NAME_EVENT_I_D) diff --git a/src/main/java/one/talon/model/GenerateCouponRejections200Response.java b/src/main/java/one/talon/model/GenerateCouponRejections200Response.java index 27ece9fe..74fac590 100644 --- a/src/main/java/one/talon/model/GenerateCouponRejections200Response.java +++ b/src/main/java/one/talon/model/GenerateCouponRejections200Response.java @@ -51,7 +51,7 @@ /** * GenerateCouponRejections200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateCouponRejections200Response { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/GenerateItemFilterDescription.java b/src/main/java/one/talon/model/GenerateItemFilterDescription.java index 6174dbc5..abbb6377 100644 --- a/src/main/java/one/talon/model/GenerateItemFilterDescription.java +++ b/src/main/java/one/talon/model/GenerateItemFilterDescription.java @@ -50,7 +50,7 @@ /** * GenerateItemFilterDescription */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateItemFilterDescription { public static final String SERIALIZED_NAME_ITEM_FILTER = "itemFilter"; @SerializedName(SERIALIZED_NAME_ITEM_FILTER) diff --git a/src/main/java/one/talon/model/GenerateLoyaltyCard.java b/src/main/java/one/talon/model/GenerateLoyaltyCard.java index b9bcd3bf..5760d5b0 100644 --- a/src/main/java/one/talon/model/GenerateLoyaltyCard.java +++ b/src/main/java/one/talon/model/GenerateLoyaltyCard.java @@ -50,7 +50,7 @@ /** * The parameters necessary to generate a loyalty card. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateLoyaltyCard { /** * Status of the loyalty card. diff --git a/src/main/java/one/talon/model/GenerateRuleTitle.java b/src/main/java/one/talon/model/GenerateRuleTitle.java index 0e709705..c4a343a7 100644 --- a/src/main/java/one/talon/model/GenerateRuleTitle.java +++ b/src/main/java/one/talon/model/GenerateRuleTitle.java @@ -49,7 +49,7 @@ /** * GenerateRuleTitle */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateRuleTitle { public static final String SERIALIZED_NAME_RULE = "rule"; @SerializedName(SERIALIZED_NAME_RULE) diff --git a/src/main/java/one/talon/model/GenerateRuleTitleRule.java b/src/main/java/one/talon/model/GenerateRuleTitleRule.java index ba801e3b..59eac8fa 100644 --- a/src/main/java/one/talon/model/GenerateRuleTitleRule.java +++ b/src/main/java/one/talon/model/GenerateRuleTitleRule.java @@ -50,7 +50,7 @@ /** * GenerateRuleTitleRule */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateRuleTitleRule { public static final String SERIALIZED_NAME_EFFECTS = "effects"; @SerializedName(SERIALIZED_NAME_EFFECTS) diff --git a/src/main/java/one/talon/model/GenerateUserSessionSummary.java b/src/main/java/one/talon/model/GenerateUserSessionSummary.java index 4d3d69d5..176d3a14 100644 --- a/src/main/java/one/talon/model/GenerateUserSessionSummary.java +++ b/src/main/java/one/talon/model/GenerateUserSessionSummary.java @@ -49,7 +49,7 @@ /** * GenerateUserSessionSummary */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GenerateUserSessionSummary { public static final String SERIALIZED_NAME_SESSION_I_D = "sessionID"; @SerializedName(SERIALIZED_NAME_SESSION_I_D) diff --git a/src/main/java/one/talon/model/GetAccessLogsWithoutTotalCount200Response.java b/src/main/java/one/talon/model/GetAccessLogsWithoutTotalCount200Response.java index 21586b9a..1c2674a5 100644 --- a/src/main/java/one/talon/model/GetAccessLogsWithoutTotalCount200Response.java +++ b/src/main/java/one/talon/model/GetAccessLogsWithoutTotalCount200Response.java @@ -51,7 +51,7 @@ /** * GetAccessLogsWithoutTotalCount200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAccessLogsWithoutTotalCount200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetAdditionalCosts200Response.java b/src/main/java/one/talon/model/GetAdditionalCosts200Response.java index f706cd20..ac184e7a 100644 --- a/src/main/java/one/talon/model/GetAdditionalCosts200Response.java +++ b/src/main/java/one/talon/model/GetAdditionalCosts200Response.java @@ -51,7 +51,7 @@ /** * GetAdditionalCosts200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAdditionalCosts200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetApplicationCustomerFriends200Response.java b/src/main/java/one/talon/model/GetApplicationCustomerFriends200Response.java index 7da669b8..ec1a10c7 100644 --- a/src/main/java/one/talon/model/GetApplicationCustomerFriends200Response.java +++ b/src/main/java/one/talon/model/GetApplicationCustomerFriends200Response.java @@ -51,7 +51,7 @@ /** * GetApplicationCustomerFriends200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationCustomerFriends200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetApplicationCustomers200Response.java b/src/main/java/one/talon/model/GetApplicationCustomers200Response.java index 4f323543..b0b2a180 100644 --- a/src/main/java/one/talon/model/GetApplicationCustomers200Response.java +++ b/src/main/java/one/talon/model/GetApplicationCustomers200Response.java @@ -51,7 +51,7 @@ /** * GetApplicationCustomers200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationCustomers200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetApplicationCustomersByAttributes200Response.java b/src/main/java/one/talon/model/GetApplicationCustomersByAttributes200Response.java index a8322de0..ce304760 100644 --- a/src/main/java/one/talon/model/GetApplicationCustomersByAttributes200Response.java +++ b/src/main/java/one/talon/model/GetApplicationCustomersByAttributes200Response.java @@ -51,7 +51,7 @@ /** * GetApplicationCustomersByAttributes200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationCustomersByAttributes200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetApplicationEventTypes200Response.java b/src/main/java/one/talon/model/GetApplicationEventTypes200Response.java index 9e5fe713..02e53eb2 100644 --- a/src/main/java/one/talon/model/GetApplicationEventTypes200Response.java +++ b/src/main/java/one/talon/model/GetApplicationEventTypes200Response.java @@ -50,7 +50,7 @@ /** * GetApplicationEventTypes200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationEventTypes200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetApplicationEventsWithoutTotalCount200Response.java b/src/main/java/one/talon/model/GetApplicationEventsWithoutTotalCount200Response.java index 8c2ff706..cf34a684 100644 --- a/src/main/java/one/talon/model/GetApplicationEventsWithoutTotalCount200Response.java +++ b/src/main/java/one/talon/model/GetApplicationEventsWithoutTotalCount200Response.java @@ -51,7 +51,7 @@ /** * GetApplicationEventsWithoutTotalCount200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationEventsWithoutTotalCount200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetApplicationSessions200Response.java b/src/main/java/one/talon/model/GetApplicationSessions200Response.java index cf448fc9..6928b860 100644 --- a/src/main/java/one/talon/model/GetApplicationSessions200Response.java +++ b/src/main/java/one/talon/model/GetApplicationSessions200Response.java @@ -51,7 +51,7 @@ /** * GetApplicationSessions200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplicationSessions200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetApplications200Response.java b/src/main/java/one/talon/model/GetApplications200Response.java index 3e8c9c90..3bcdb781 100644 --- a/src/main/java/one/talon/model/GetApplications200Response.java +++ b/src/main/java/one/talon/model/GetApplications200Response.java @@ -51,7 +51,7 @@ /** * GetApplications200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetApplications200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetAttributes200Response.java b/src/main/java/one/talon/model/GetAttributes200Response.java index e0ea3127..d2dda5e4 100644 --- a/src/main/java/one/talon/model/GetAttributes200Response.java +++ b/src/main/java/one/talon/model/GetAttributes200Response.java @@ -51,7 +51,7 @@ /** * GetAttributes200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAttributes200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetAudienceMemberships200Response.java b/src/main/java/one/talon/model/GetAudienceMemberships200Response.java index 06ed9676..1c5abe5c 100644 --- a/src/main/java/one/talon/model/GetAudienceMemberships200Response.java +++ b/src/main/java/one/talon/model/GetAudienceMemberships200Response.java @@ -51,7 +51,7 @@ /** * GetAudienceMemberships200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAudienceMemberships200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetAudiences200Response.java b/src/main/java/one/talon/model/GetAudiences200Response.java index ed3ac241..e2da6070 100644 --- a/src/main/java/one/talon/model/GetAudiences200Response.java +++ b/src/main/java/one/talon/model/GetAudiences200Response.java @@ -51,7 +51,7 @@ /** * GetAudiences200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAudiences200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetAudiencesAnalytics200Response.java b/src/main/java/one/talon/model/GetAudiencesAnalytics200Response.java index 1d67e96b..1e6b4fb7 100644 --- a/src/main/java/one/talon/model/GetAudiencesAnalytics200Response.java +++ b/src/main/java/one/talon/model/GetAudiencesAnalytics200Response.java @@ -51,7 +51,7 @@ /** * GetAudiencesAnalytics200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetAudiencesAnalytics200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCampaignAnalytics200Response.java b/src/main/java/one/talon/model/GetCampaignAnalytics200Response.java index 47376737..13dcd613 100644 --- a/src/main/java/one/talon/model/GetCampaignAnalytics200Response.java +++ b/src/main/java/one/talon/model/GetCampaignAnalytics200Response.java @@ -51,7 +51,7 @@ /** * GetCampaignAnalytics200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCampaignAnalytics200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetCampaignGroups200Response.java b/src/main/java/one/talon/model/GetCampaignGroups200Response.java index 4ce0a75c..79dc46b5 100644 --- a/src/main/java/one/talon/model/GetCampaignGroups200Response.java +++ b/src/main/java/one/talon/model/GetCampaignGroups200Response.java @@ -51,7 +51,7 @@ /** * GetCampaignGroups200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCampaignGroups200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetCampaignTemplates200Response.java b/src/main/java/one/talon/model/GetCampaignTemplates200Response.java index 2092e8b8..b04c114a 100644 --- a/src/main/java/one/talon/model/GetCampaignTemplates200Response.java +++ b/src/main/java/one/talon/model/GetCampaignTemplates200Response.java @@ -51,7 +51,7 @@ /** * GetCampaignTemplates200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCampaignTemplates200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCampaigns200Response.java b/src/main/java/one/talon/model/GetCampaigns200Response.java index 4308365d..136792ec 100644 --- a/src/main/java/one/talon/model/GetCampaigns200Response.java +++ b/src/main/java/one/talon/model/GetCampaigns200Response.java @@ -51,7 +51,7 @@ /** * GetCampaigns200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCampaigns200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetChanges200Response.java b/src/main/java/one/talon/model/GetChanges200Response.java index 08ef7eb5..0f16449b 100644 --- a/src/main/java/one/talon/model/GetChanges200Response.java +++ b/src/main/java/one/talon/model/GetChanges200Response.java @@ -51,7 +51,7 @@ /** * GetChanges200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetChanges200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetCollectionItems200Response.java b/src/main/java/one/talon/model/GetCollectionItems200Response.java index c1277dcc..f7a5ac0a 100644 --- a/src/main/java/one/talon/model/GetCollectionItems200Response.java +++ b/src/main/java/one/talon/model/GetCollectionItems200Response.java @@ -51,7 +51,7 @@ /** * GetCollectionItems200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCollectionItems200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCouponsWithoutTotalCount200Response.java b/src/main/java/one/talon/model/GetCouponsWithoutTotalCount200Response.java index 7dbc969f..632e2a62 100644 --- a/src/main/java/one/talon/model/GetCouponsWithoutTotalCount200Response.java +++ b/src/main/java/one/talon/model/GetCouponsWithoutTotalCount200Response.java @@ -51,7 +51,7 @@ /** * GetCouponsWithoutTotalCount200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCouponsWithoutTotalCount200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCustomerAchievementHistory200Response.java b/src/main/java/one/talon/model/GetCustomerAchievementHistory200Response.java index 6a8543d0..8e7794a7 100644 --- a/src/main/java/one/talon/model/GetCustomerAchievementHistory200Response.java +++ b/src/main/java/one/talon/model/GetCustomerAchievementHistory200Response.java @@ -51,7 +51,7 @@ /** * GetCustomerAchievementHistory200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomerAchievementHistory200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetCustomerAchievements200Response.java b/src/main/java/one/talon/model/GetCustomerAchievements200Response.java index 94de6b71..9cdf65b9 100644 --- a/src/main/java/one/talon/model/GetCustomerAchievements200Response.java +++ b/src/main/java/one/talon/model/GetCustomerAchievements200Response.java @@ -51,7 +51,7 @@ /** * GetCustomerAchievements200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomerAchievements200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetCustomerActivityReportsWithoutTotalCount200Response.java b/src/main/java/one/talon/model/GetCustomerActivityReportsWithoutTotalCount200Response.java index 999e3665..81f92245 100644 --- a/src/main/java/one/talon/model/GetCustomerActivityReportsWithoutTotalCount200Response.java +++ b/src/main/java/one/talon/model/GetCustomerActivityReportsWithoutTotalCount200Response.java @@ -51,7 +51,7 @@ /** * GetCustomerActivityReportsWithoutTotalCount200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomerActivityReportsWithoutTotalCount200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCustomerProfileAchievementProgress200Response.java b/src/main/java/one/talon/model/GetCustomerProfileAchievementProgress200Response.java index 48a5415b..8fdf0e93 100644 --- a/src/main/java/one/talon/model/GetCustomerProfileAchievementProgress200Response.java +++ b/src/main/java/one/talon/model/GetCustomerProfileAchievementProgress200Response.java @@ -51,7 +51,7 @@ /** * GetCustomerProfileAchievementProgress200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomerProfileAchievementProgress200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCustomerProfiles200Response.java b/src/main/java/one/talon/model/GetCustomerProfiles200Response.java index 680d8f7b..fce36a85 100644 --- a/src/main/java/one/talon/model/GetCustomerProfiles200Response.java +++ b/src/main/java/one/talon/model/GetCustomerProfiles200Response.java @@ -51,7 +51,7 @@ /** * GetCustomerProfiles200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomerProfiles200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetCustomersByAttributes200Response.java b/src/main/java/one/talon/model/GetCustomersByAttributes200Response.java index 7f777a78..7dabb1bc 100644 --- a/src/main/java/one/talon/model/GetCustomersByAttributes200Response.java +++ b/src/main/java/one/talon/model/GetCustomersByAttributes200Response.java @@ -51,7 +51,7 @@ /** * GetCustomersByAttributes200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetCustomersByAttributes200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetDashboardStatistics200Response.java b/src/main/java/one/talon/model/GetDashboardStatistics200Response.java index 0ce0b320..0ef840fa 100644 --- a/src/main/java/one/talon/model/GetDashboardStatistics200Response.java +++ b/src/main/java/one/talon/model/GetDashboardStatistics200Response.java @@ -51,7 +51,7 @@ /** * GetDashboardStatistics200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetDashboardStatistics200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetEventTypes200Response.java b/src/main/java/one/talon/model/GetEventTypes200Response.java index 9d87866d..7dee71b3 100644 --- a/src/main/java/one/talon/model/GetEventTypes200Response.java +++ b/src/main/java/one/talon/model/GetEventTypes200Response.java @@ -51,7 +51,7 @@ /** * GetEventTypes200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetEventTypes200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetExports200Response.java b/src/main/java/one/talon/model/GetExports200Response.java index 4825a053..09cc3abe 100644 --- a/src/main/java/one/talon/model/GetExports200Response.java +++ b/src/main/java/one/talon/model/GetExports200Response.java @@ -51,7 +51,7 @@ /** * GetExports200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetExports200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetIntegrationCouponRequest.java b/src/main/java/one/talon/model/GetIntegrationCouponRequest.java index a726405f..1fd92baa 100644 --- a/src/main/java/one/talon/model/GetIntegrationCouponRequest.java +++ b/src/main/java/one/talon/model/GetIntegrationCouponRequest.java @@ -50,7 +50,7 @@ /** * GetIntegrationCouponRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetIntegrationCouponRequest { public static final String SERIALIZED_NAME_CAMPAIGN_IDS = "campaignIds"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_IDS) diff --git a/src/main/java/one/talon/model/GetLoyaltyCardPoints200Response.java b/src/main/java/one/talon/model/GetLoyaltyCardPoints200Response.java index 2c568ff9..9b37051c 100644 --- a/src/main/java/one/talon/model/GetLoyaltyCardPoints200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyCardPoints200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyCardPoints200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyCardPoints200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyCardTransactionLogs200Response.java b/src/main/java/one/talon/model/GetLoyaltyCardTransactionLogs200Response.java index 4f20ca7a..a377ee4e 100644 --- a/src/main/java/one/talon/model/GetLoyaltyCardTransactionLogs200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyCardTransactionLogs200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyCardTransactionLogs200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyCardTransactionLogs200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyCardTransactions200Response.java b/src/main/java/one/talon/model/GetLoyaltyCardTransactions200Response.java index 8fdcee66..19022753 100644 --- a/src/main/java/one/talon/model/GetLoyaltyCardTransactions200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyCardTransactions200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyCardTransactions200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyCardTransactions200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyCards200Response.java b/src/main/java/one/talon/model/GetLoyaltyCards200Response.java index 629c6085..23b5805a 100644 --- a/src/main/java/one/talon/model/GetLoyaltyCards200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyCards200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyCards200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyCards200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyProgramProfilePoints200Response.java b/src/main/java/one/talon/model/GetLoyaltyProgramProfilePoints200Response.java index 7d6b4ec1..8a12da4d 100644 --- a/src/main/java/one/talon/model/GetLoyaltyProgramProfilePoints200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyProgramProfilePoints200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyProgramProfilePoints200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyProgramProfilePoints200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyProgramProfileTransactions200Response.java b/src/main/java/one/talon/model/GetLoyaltyProgramProfileTransactions200Response.java index 6263a48e..fc4ead98 100644 --- a/src/main/java/one/talon/model/GetLoyaltyProgramProfileTransactions200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyProgramProfileTransactions200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyProgramProfileTransactions200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyProgramProfileTransactions200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyProgramTransactions200Response.java b/src/main/java/one/talon/model/GetLoyaltyProgramTransactions200Response.java index e9bffebe..c24a975c 100644 --- a/src/main/java/one/talon/model/GetLoyaltyProgramTransactions200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyProgramTransactions200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyProgramTransactions200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyProgramTransactions200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetLoyaltyPrograms200Response.java b/src/main/java/one/talon/model/GetLoyaltyPrograms200Response.java index 57e25575..f5504248 100644 --- a/src/main/java/one/talon/model/GetLoyaltyPrograms200Response.java +++ b/src/main/java/one/talon/model/GetLoyaltyPrograms200Response.java @@ -51,7 +51,7 @@ /** * GetLoyaltyPrograms200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetLoyaltyPrograms200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetReferralsWithoutTotalCount200Response.java b/src/main/java/one/talon/model/GetReferralsWithoutTotalCount200Response.java index cc592e08..d0507083 100644 --- a/src/main/java/one/talon/model/GetReferralsWithoutTotalCount200Response.java +++ b/src/main/java/one/talon/model/GetReferralsWithoutTotalCount200Response.java @@ -51,7 +51,7 @@ /** * GetReferralsWithoutTotalCount200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetReferralsWithoutTotalCount200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/GetReservedCustomers200Response.java b/src/main/java/one/talon/model/GetReservedCustomers200Response.java index e8098987..7c9f7abf 100644 --- a/src/main/java/one/talon/model/GetReservedCustomers200Response.java +++ b/src/main/java/one/talon/model/GetReservedCustomers200Response.java @@ -51,7 +51,7 @@ /** * GetReservedCustomers200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetReservedCustomers200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetRulesets200Response.java b/src/main/java/one/talon/model/GetRulesets200Response.java index afc8460d..880e0864 100644 --- a/src/main/java/one/talon/model/GetRulesets200Response.java +++ b/src/main/java/one/talon/model/GetRulesets200Response.java @@ -51,7 +51,7 @@ /** * GetRulesets200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetRulesets200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetUsers200Response.java b/src/main/java/one/talon/model/GetUsers200Response.java index facc9f35..e57cc28d 100644 --- a/src/main/java/one/talon/model/GetUsers200Response.java +++ b/src/main/java/one/talon/model/GetUsers200Response.java @@ -51,7 +51,7 @@ /** * GetUsers200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetUsers200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GetWebhooks200Response.java b/src/main/java/one/talon/model/GetWebhooks200Response.java index e6d86e9e..d7738003 100644 --- a/src/main/java/one/talon/model/GetWebhooks200Response.java +++ b/src/main/java/one/talon/model/GetWebhooks200Response.java @@ -51,7 +51,7 @@ /** * GetWebhooks200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GetWebhooks200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/Giveaway.java b/src/main/java/one/talon/model/Giveaway.java index 1cd20721..c4e0b092 100644 --- a/src/main/java/one/talon/model/Giveaway.java +++ b/src/main/java/one/talon/model/Giveaway.java @@ -49,7 +49,7 @@ /** * Giveaway */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Giveaway { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -229,7 +229,7 @@ public Giveaway attributes(@javax.annotation.Nullable Object attributes) { } /** - * Arbitrary properties associated with this giveaway. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/GiveawayPoolNotification.java b/src/main/java/one/talon/model/GiveawayPoolNotification.java index f892095e..f70cc9c2 100644 --- a/src/main/java/one/talon/model/GiveawayPoolNotification.java +++ b/src/main/java/one/talon/model/GiveawayPoolNotification.java @@ -51,7 +51,7 @@ /** * GiveawayPoolNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GiveawayPoolNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/GiveawayPoolNotificationData.java b/src/main/java/one/talon/model/GiveawayPoolNotificationData.java index 95de5685..62fde272 100644 --- a/src/main/java/one/talon/model/GiveawayPoolNotificationData.java +++ b/src/main/java/one/talon/model/GiveawayPoolNotificationData.java @@ -48,7 +48,7 @@ /** * GiveawayPoolNotificationData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GiveawayPoolNotificationData { public static final String SERIALIZED_NAME_EVENT = "Event"; @SerializedName(SERIALIZED_NAME_EVENT) diff --git a/src/main/java/one/talon/model/GiveawaysPool.java b/src/main/java/one/talon/model/GiveawaysPool.java index 6d057fd9..1f90a282 100644 --- a/src/main/java/one/talon/model/GiveawaysPool.java +++ b/src/main/java/one/talon/model/GiveawaysPool.java @@ -51,7 +51,7 @@ /** * Giveaways pools is an entity for managing multiple similar giveaways. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class GiveawaysPool { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/HiddenConditionsEffects.java b/src/main/java/one/talon/model/HiddenConditionsEffects.java index 002206d3..b81f22e2 100644 --- a/src/main/java/one/talon/model/HiddenConditionsEffects.java +++ b/src/main/java/one/talon/model/HiddenConditionsEffects.java @@ -50,7 +50,7 @@ /** * Contains information about hidden conditions and effects in the Application. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class HiddenConditionsEffects { public static final String SERIALIZED_NAME_BUILT_IN_EFFECTS = "builtInEffects"; @SerializedName(SERIALIZED_NAME_BUILT_IN_EFFECTS) diff --git a/src/main/java/one/talon/model/History.java b/src/main/java/one/talon/model/History.java index 7047627b..a5c2e507 100644 --- a/src/main/java/one/talon/model/History.java +++ b/src/main/java/one/talon/model/History.java @@ -53,7 +53,7 @@ /** * History */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class History { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/IdentifiableEntity.java b/src/main/java/one/talon/model/IdentifiableEntity.java index ec3fb2ab..566e5382 100644 --- a/src/main/java/one/talon/model/IdentifiableEntity.java +++ b/src/main/java/one/talon/model/IdentifiableEntity.java @@ -48,7 +48,7 @@ /** * IdentifiableEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IdentifiableEntity { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ImportEntity.java b/src/main/java/one/talon/model/ImportEntity.java index 6c13c66f..f7630c45 100644 --- a/src/main/java/one/talon/model/ImportEntity.java +++ b/src/main/java/one/talon/model/ImportEntity.java @@ -48,7 +48,7 @@ /** * ImportEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ImportEntity { public static final String SERIALIZED_NAME_IMPORT_ID = "importId"; @SerializedName(SERIALIZED_NAME_IMPORT_ID) diff --git a/src/main/java/one/talon/model/IncreaseAchievementProgressEffectProps.java b/src/main/java/one/talon/model/IncreaseAchievementProgressEffectProps.java index c1eac714..06087b71 100644 --- a/src/main/java/one/talon/model/IncreaseAchievementProgressEffectProps.java +++ b/src/main/java/one/talon/model/IncreaseAchievementProgressEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"increaseAchievementProgress\" effect. This gets triggered whenever a validated rule contained an \"increase customer progress\" effect. + * This effect indicates that the customer's progress in an achievement was updated during the current session. It is triggered when a rule using the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect is successfully validated. For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), any customer progress exceeding the target automatically starts a new iteration. This generates a new `progressTrackerId` for each iteration, and there can be multiple progress updates for the same achievement from a single validation of this effect. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IncreaseAchievementProgressEffectProps { public static final String SERIALIZED_NAME_ACHIEVEMENT_ID = "achievementId"; @SerializedName(SERIALIZED_NAME_ACHIEVEMENT_ID) @@ -133,7 +133,7 @@ public IncreaseAchievementProgressEffectProps progressTrackerId(@javax.annotatio } /** - * The internal ID of the achievement progress tracker. + * The internal ID of the customer progress tracker. For [on-completion achievements](https://docs.talon.one/docs/product/campaigns/achievements/achievements-overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. * @return progressTrackerId */ @javax.annotation.Nullable @@ -152,7 +152,7 @@ public IncreaseAchievementProgressEffectProps delta(@javax.annotation.Nonnull Bi } /** - * The value by which the customer's current progress in the achievement is increased. + * The value by which the customer's current progress in the achievement has increased. * @return delta */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/InfluencingCampaignDetails.java b/src/main/java/one/talon/model/InfluencingCampaignDetails.java index c5b28ac6..dfb90569 100644 --- a/src/main/java/one/talon/model/InfluencingCampaignDetails.java +++ b/src/main/java/one/talon/model/InfluencingCampaignDetails.java @@ -49,7 +49,7 @@ /** * Details about a campaign that influenced the final price. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class InfluencingCampaignDetails { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/IntegrationCampaign.java b/src/main/java/one/talon/model/IntegrationCampaign.java index 69b0d851..08b59aef 100644 --- a/src/main/java/one/talon/model/IntegrationCampaign.java +++ b/src/main/java/one/talon/model/IntegrationCampaign.java @@ -52,7 +52,7 @@ /** * IntegrationCampaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCampaign { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/IntegrationCampaignBase.java b/src/main/java/one/talon/model/IntegrationCampaignBase.java index 5717e627..d34088d1 100644 --- a/src/main/java/one/talon/model/IntegrationCampaignBase.java +++ b/src/main/java/one/talon/model/IntegrationCampaignBase.java @@ -51,7 +51,7 @@ /** * IntegrationCampaignBase */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCampaignBase { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/IntegrationCoupon.java b/src/main/java/one/talon/model/IntegrationCoupon.java index a91d177f..f43ae60e 100644 --- a/src/main/java/one/talon/model/IntegrationCoupon.java +++ b/src/main/java/one/talon/model/IntegrationCoupon.java @@ -53,7 +53,7 @@ /** * IntegrationCoupon */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCoupon { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequest.java b/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequest.java index 823e0349..6882874a 100644 --- a/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequest.java +++ b/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequest.java @@ -51,7 +51,7 @@ /** * IntegrationCustomerProfileAudienceRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCustomerProfileAudienceRequest { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequestItem.java b/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequestItem.java index e752067c..b50e7b72 100644 --- a/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequestItem.java +++ b/src/main/java/one/talon/model/IntegrationCustomerProfileAudienceRequestItem.java @@ -48,7 +48,7 @@ /** * IntegrationCustomerProfileAudienceRequestItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCustomerProfileAudienceRequestItem { /** * Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. diff --git a/src/main/java/one/talon/model/IntegrationCustomerSessionResponse.java b/src/main/java/one/talon/model/IntegrationCustomerSessionResponse.java index 8c0f9e6a..c9e1d9f5 100644 --- a/src/main/java/one/talon/model/IntegrationCustomerSessionResponse.java +++ b/src/main/java/one/talon/model/IntegrationCustomerSessionResponse.java @@ -52,7 +52,7 @@ /** * IntegrationCustomerSessionResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationCustomerSessionResponse { public static final String SERIALIZED_NAME_CUSTOMER_SESSION = "customerSession"; @SerializedName(SERIALIZED_NAME_CUSTOMER_SESSION) diff --git a/src/main/java/one/talon/model/IntegrationEntity.java b/src/main/java/one/talon/model/IntegrationEntity.java index aba7ff92..d5fee365 100644 --- a/src/main/java/one/talon/model/IntegrationEntity.java +++ b/src/main/java/one/talon/model/IntegrationEntity.java @@ -49,7 +49,7 @@ /** * IntegrationEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEntity { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/IntegrationEvent.java b/src/main/java/one/talon/model/IntegrationEvent.java index 16c97997..3f1b9a8a 100644 --- a/src/main/java/one/talon/model/IntegrationEvent.java +++ b/src/main/java/one/talon/model/IntegrationEvent.java @@ -48,7 +48,7 @@ /** * IntegrationEvent */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEvent { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) @@ -136,7 +136,7 @@ public IntegrationEvent attributes(@javax.annotation.Nonnull Object attributes) } /** - * Arbitrary additional JSON data associated with the event. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/IntegrationEventV2Request.java b/src/main/java/one/talon/model/IntegrationEventV2Request.java index fada5436..da573297 100644 --- a/src/main/java/one/talon/model/IntegrationEventV2Request.java +++ b/src/main/java/one/talon/model/IntegrationEventV2Request.java @@ -50,7 +50,7 @@ /** * IntegrationEventV2Request */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEventV2Request { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/IntegrationEventV2Response.java b/src/main/java/one/talon/model/IntegrationEventV2Response.java index 20abd0c3..8a909397 100644 --- a/src/main/java/one/talon/model/IntegrationEventV2Response.java +++ b/src/main/java/one/talon/model/IntegrationEventV2Response.java @@ -60,7 +60,7 @@ /** * IntegrationEventV2Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEventV2Response { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/IntegrationEventV3Request.java b/src/main/java/one/talon/model/IntegrationEventV3Request.java index d14d6167..9b69aee2 100644 --- a/src/main/java/one/talon/model/IntegrationEventV3Request.java +++ b/src/main/java/one/talon/model/IntegrationEventV3Request.java @@ -50,7 +50,7 @@ /** * IntegrationEventV3Request */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEventV3Request { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/IntegrationEventV3Response.java b/src/main/java/one/talon/model/IntegrationEventV3Response.java index 73203679..1d9034b3 100644 --- a/src/main/java/one/talon/model/IntegrationEventV3Response.java +++ b/src/main/java/one/talon/model/IntegrationEventV3Response.java @@ -60,7 +60,7 @@ /** * IntegrationEventV3Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationEventV3Response { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/IntegrationGetAllCampaigns200Response.java b/src/main/java/one/talon/model/IntegrationGetAllCampaigns200Response.java index 363ce1e6..e786f08a 100644 --- a/src/main/java/one/talon/model/IntegrationGetAllCampaigns200Response.java +++ b/src/main/java/one/talon/model/IntegrationGetAllCampaigns200Response.java @@ -51,7 +51,7 @@ /** * IntegrationGetAllCampaigns200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationGetAllCampaigns200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/IntegrationHubConfig.java b/src/main/java/one/talon/model/IntegrationHubConfig.java index 27512907..c2ca981c 100644 --- a/src/main/java/one/talon/model/IntegrationHubConfig.java +++ b/src/main/java/one/talon/model/IntegrationHubConfig.java @@ -48,7 +48,7 @@ /** * Config used for accessing integrations in IntegrationHub */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubConfig { public static final String SERIALIZED_NAME_INTEGRATION_HUB_URL = "integrationHubUrl"; @SerializedName(SERIALIZED_NAME_INTEGRATION_HUB_URL) diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotifications.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotifications.java index 71b422bd..7957bc1e 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotifications.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotifications.java @@ -52,7 +52,7 @@ /** * IntegrationHubEventPayloadCouponBasedNotifications */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadCouponBasedNotifications { public static final String SERIALIZED_NAME_ID = "Id"; @SerializedName(SERIALIZED_NAME_ID) @@ -472,7 +472,7 @@ public IntegrationHubEventPayloadCouponBasedNotifications attributes(@javax.anno } /** - * Get attributes + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimits.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimits.java index 7e36e1f0..45fe9e6a 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimits.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadCouponBasedNotificationsLimits.java @@ -50,7 +50,7 @@ /** * IntegrationHubEventPayloadCouponBasedNotificationsLimits */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadCouponBasedNotificationsLimits { public static final String SERIALIZED_NAME_ACTION = "Action"; @SerializedName(SERIALIZED_NAME_ACTION) diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.java deleted file mode 100644 index c30a822c..00000000 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.java +++ /dev/null @@ -1,727 +0,0 @@ -/* - * 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) 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#tag/Customer-sessions/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 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 java.io.IOException; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import one.talon.JSON; - -/** - * IntegrationHubEventPayloadLoyaltyProfileBasedNotification - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") -public class IntegrationHubEventPayloadLoyaltyProfileBasedNotification { - public static final String SERIALIZED_NAME_PROFILE_INTEGRATION_I_D = "ProfileIntegrationID"; - @SerializedName(SERIALIZED_NAME_PROFILE_INTEGRATION_I_D) - @javax.annotation.Nonnull - private String profileIntegrationID; - - public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_I_D = "LoyaltyProgramID"; - @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_I_D) - @javax.annotation.Nonnull - private Long loyaltyProgramID; - - public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_NAME = "LoyaltyProgramName"; - @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_NAME) - @javax.annotation.Nonnull - private String loyaltyProgramName; - - public static final String SERIALIZED_NAME_SUBLEDGER_I_D = "SubledgerID"; - @SerializedName(SERIALIZED_NAME_SUBLEDGER_I_D) - @javax.annotation.Nonnull - private String subledgerID; - - public static final String SERIALIZED_NAME_SOURCE_OF_EVENT = "SourceOfEvent"; - @SerializedName(SERIALIZED_NAME_SOURCE_OF_EVENT) - @javax.annotation.Nonnull - private String sourceOfEvent; - - public static final String SERIALIZED_NAME_CURRENT_TIER = "CurrentTier"; - @SerializedName(SERIALIZED_NAME_CURRENT_TIER) - @javax.annotation.Nonnull - private String currentTier; - - public static final String SERIALIZED_NAME_EMPLOYEE_NAME = "EmployeeName"; - @SerializedName(SERIALIZED_NAME_EMPLOYEE_NAME) - @javax.annotation.Nullable - private String employeeName; - - public static final String SERIALIZED_NAME_USER_I_D = "UserID"; - @SerializedName(SERIALIZED_NAME_USER_I_D) - @javax.annotation.Nullable - private Long userID; - - public static final String SERIALIZED_NAME_CURRENT_POINTS = "CurrentPoints"; - @SerializedName(SERIALIZED_NAME_CURRENT_POINTS) - @javax.annotation.Nonnull - private Float currentPoints; - - public static final String SERIALIZED_NAME_ACTIONS = "Actions"; - @SerializedName(SERIALIZED_NAME_ACTIONS) - @javax.annotation.Nullable - private List actions; - - public static final String SERIALIZED_NAME_PUBLISHED_AT = "PublishedAt"; - @SerializedName(SERIALIZED_NAME_PUBLISHED_AT) - @javax.annotation.Nonnull - private OffsetDateTime publishedAt; - - public static final String SERIALIZED_NAME_OLD_TIER = "OldTier"; - @SerializedName(SERIALIZED_NAME_OLD_TIER) - @javax.annotation.Nullable - private String oldTier; - - public static final String SERIALIZED_NAME_TIER_EXPIRATION_DATE = "TierExpirationDate"; - @SerializedName(SERIALIZED_NAME_TIER_EXPIRATION_DATE) - @javax.annotation.Nullable - private OffsetDateTime tierExpirationDate; - - public static final String SERIALIZED_NAME_TIMESTAMP_OF_TIER_CHANGE = "TimestampOfTierChange"; - @SerializedName(SERIALIZED_NAME_TIMESTAMP_OF_TIER_CHANGE) - @javax.annotation.Nullable - private OffsetDateTime timestampOfTierChange; - - public static final String SERIALIZED_NAME_POINTS_REQUIRED_TO_THE_NEXT_TIER = "PointsRequiredToTheNextTier"; - @SerializedName(SERIALIZED_NAME_POINTS_REQUIRED_TO_THE_NEXT_TIER) - @javax.annotation.Nullable - private Float pointsRequiredToTheNextTier; - - public static final String SERIALIZED_NAME_NEXT_TIER = "NextTier"; - @SerializedName(SERIALIZED_NAME_NEXT_TIER) - @javax.annotation.Nullable - private String nextTier; - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification() { - } - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification profileIntegrationID(@javax.annotation.Nonnull String profileIntegrationID) { - this.profileIntegrationID = profileIntegrationID; - return this; - } - - /** - * Get profileIntegrationID - * @return profileIntegrationID - */ - @javax.annotation.Nonnull - public String getProfileIntegrationID() { - return profileIntegrationID; - } - - public void setProfileIntegrationID(@javax.annotation.Nonnull String profileIntegrationID) { - this.profileIntegrationID = profileIntegrationID; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification loyaltyProgramID(@javax.annotation.Nonnull Long loyaltyProgramID) { - this.loyaltyProgramID = loyaltyProgramID; - return this; - } - - /** - * Get loyaltyProgramID - * @return loyaltyProgramID - */ - @javax.annotation.Nonnull - public Long getLoyaltyProgramID() { - return loyaltyProgramID; - } - - public void setLoyaltyProgramID(@javax.annotation.Nonnull Long loyaltyProgramID) { - this.loyaltyProgramID = loyaltyProgramID; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification loyaltyProgramName(@javax.annotation.Nonnull String loyaltyProgramName) { - this.loyaltyProgramName = loyaltyProgramName; - return this; - } - - /** - * The name of the loyalty program. - * @return loyaltyProgramName - */ - @javax.annotation.Nonnull - public String getLoyaltyProgramName() { - return loyaltyProgramName; - } - - public void setLoyaltyProgramName(@javax.annotation.Nonnull String loyaltyProgramName) { - this.loyaltyProgramName = loyaltyProgramName; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification subledgerID(@javax.annotation.Nonnull String subledgerID) { - this.subledgerID = subledgerID; - return this; - } - - /** - * Get subledgerID - * @return subledgerID - */ - @javax.annotation.Nonnull - public String getSubledgerID() { - return subledgerID; - } - - public void setSubledgerID(@javax.annotation.Nonnull String subledgerID) { - this.subledgerID = subledgerID; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification sourceOfEvent(@javax.annotation.Nonnull String sourceOfEvent) { - this.sourceOfEvent = sourceOfEvent; - return this; - } - - /** - * Get sourceOfEvent - * @return sourceOfEvent - */ - @javax.annotation.Nonnull - public String getSourceOfEvent() { - return sourceOfEvent; - } - - public void setSourceOfEvent(@javax.annotation.Nonnull String sourceOfEvent) { - this.sourceOfEvent = sourceOfEvent; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification currentTier(@javax.annotation.Nonnull String currentTier) { - this.currentTier = currentTier; - return this; - } - - /** - * The name of the customer's current tier. - * @return currentTier - */ - @javax.annotation.Nonnull - public String getCurrentTier() { - return currentTier; - } - - public void setCurrentTier(@javax.annotation.Nonnull String currentTier) { - this.currentTier = currentTier; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification employeeName(@javax.annotation.Nullable String employeeName) { - this.employeeName = employeeName; - return this; - } - - /** - * Get employeeName - * @return employeeName - */ - @javax.annotation.Nullable - public String getEmployeeName() { - return employeeName; - } - - public void setEmployeeName(@javax.annotation.Nullable String employeeName) { - this.employeeName = employeeName; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification userID(@javax.annotation.Nullable Long userID) { - this.userID = userID; - return this; - } - - /** - * Get userID - * @return userID - */ - @javax.annotation.Nullable - public Long getUserID() { - return userID; - } - - public void setUserID(@javax.annotation.Nullable Long userID) { - this.userID = userID; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification currentPoints(@javax.annotation.Nonnull Float currentPoints) { - this.currentPoints = currentPoints; - return this; - } - - /** - * Get currentPoints - * @return currentPoints - */ - @javax.annotation.Nonnull - public Float getCurrentPoints() { - return currentPoints; - } - - public void setCurrentPoints(@javax.annotation.Nonnull Float currentPoints) { - this.currentPoints = currentPoints; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification actions(@javax.annotation.Nullable List actions) { - this.actions = actions; - return this; - } - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification addActionsItem(IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction actionsItem) { - if (this.actions == null) { - this.actions = new ArrayList<>(); - } - this.actions.add(actionsItem); - return this; - } - - /** - * Get actions - * @return actions - */ - @javax.annotation.Nullable - public List getActions() { - return actions; - } - - public void setActions(@javax.annotation.Nullable List actions) { - this.actions = actions; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification publishedAt(@javax.annotation.Nonnull OffsetDateTime publishedAt) { - this.publishedAt = publishedAt; - return this; - } - - /** - * Timestamp when the event was published. - * @return publishedAt - */ - @javax.annotation.Nonnull - public OffsetDateTime getPublishedAt() { - return publishedAt; - } - - public void setPublishedAt(@javax.annotation.Nonnull OffsetDateTime publishedAt) { - this.publishedAt = publishedAt; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification oldTier(@javax.annotation.Nullable String oldTier) { - this.oldTier = oldTier; - return this; - } - - /** - * Get oldTier - * @return oldTier - */ - @javax.annotation.Nullable - public String getOldTier() { - return oldTier; - } - - public void setOldTier(@javax.annotation.Nullable String oldTier) { - this.oldTier = oldTier; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification tierExpirationDate(@javax.annotation.Nullable OffsetDateTime tierExpirationDate) { - this.tierExpirationDate = tierExpirationDate; - return this; - } - - /** - * Get tierExpirationDate - * @return tierExpirationDate - */ - @javax.annotation.Nullable - public OffsetDateTime getTierExpirationDate() { - return tierExpirationDate; - } - - public void setTierExpirationDate(@javax.annotation.Nullable OffsetDateTime tierExpirationDate) { - this.tierExpirationDate = tierExpirationDate; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification timestampOfTierChange(@javax.annotation.Nullable OffsetDateTime timestampOfTierChange) { - this.timestampOfTierChange = timestampOfTierChange; - return this; - } - - /** - * Get timestampOfTierChange - * @return timestampOfTierChange - */ - @javax.annotation.Nullable - public OffsetDateTime getTimestampOfTierChange() { - return timestampOfTierChange; - } - - public void setTimestampOfTierChange(@javax.annotation.Nullable OffsetDateTime timestampOfTierChange) { - this.timestampOfTierChange = timestampOfTierChange; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification pointsRequiredToTheNextTier(@javax.annotation.Nullable Float pointsRequiredToTheNextTier) { - this.pointsRequiredToTheNextTier = pointsRequiredToTheNextTier; - return this; - } - - /** - * Get pointsRequiredToTheNextTier - * @return pointsRequiredToTheNextTier - */ - @javax.annotation.Nullable - public Float getPointsRequiredToTheNextTier() { - return pointsRequiredToTheNextTier; - } - - public void setPointsRequiredToTheNextTier(@javax.annotation.Nullable Float pointsRequiredToTheNextTier) { - this.pointsRequiredToTheNextTier = pointsRequiredToTheNextTier; - } - - - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification nextTier(@javax.annotation.Nullable String nextTier) { - this.nextTier = nextTier; - return this; - } - - /** - * Get nextTier - * @return nextTier - */ - @javax.annotation.Nullable - public String getNextTier() { - return nextTier; - } - - public void setNextTier(@javax.annotation.Nullable String nextTier) { - this.nextTier = nextTier; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the IntegrationHubEventPayloadLoyaltyProfileBasedNotification instance itself - */ - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - IntegrationHubEventPayloadLoyaltyProfileBasedNotification integrationHubEventPayloadLoyaltyProfileBasedNotification = (IntegrationHubEventPayloadLoyaltyProfileBasedNotification) o; - return Objects.equals(this.profileIntegrationID, integrationHubEventPayloadLoyaltyProfileBasedNotification.profileIntegrationID) && - Objects.equals(this.loyaltyProgramID, integrationHubEventPayloadLoyaltyProfileBasedNotification.loyaltyProgramID) && - Objects.equals(this.loyaltyProgramName, integrationHubEventPayloadLoyaltyProfileBasedNotification.loyaltyProgramName) && - Objects.equals(this.subledgerID, integrationHubEventPayloadLoyaltyProfileBasedNotification.subledgerID) && - Objects.equals(this.sourceOfEvent, integrationHubEventPayloadLoyaltyProfileBasedNotification.sourceOfEvent) && - Objects.equals(this.currentTier, integrationHubEventPayloadLoyaltyProfileBasedNotification.currentTier) && - Objects.equals(this.employeeName, integrationHubEventPayloadLoyaltyProfileBasedNotification.employeeName) && - Objects.equals(this.userID, integrationHubEventPayloadLoyaltyProfileBasedNotification.userID) && - Objects.equals(this.currentPoints, integrationHubEventPayloadLoyaltyProfileBasedNotification.currentPoints) && - Objects.equals(this.actions, integrationHubEventPayloadLoyaltyProfileBasedNotification.actions) && - Objects.equals(this.publishedAt, integrationHubEventPayloadLoyaltyProfileBasedNotification.publishedAt) && - Objects.equals(this.oldTier, integrationHubEventPayloadLoyaltyProfileBasedNotification.oldTier) && - Objects.equals(this.tierExpirationDate, integrationHubEventPayloadLoyaltyProfileBasedNotification.tierExpirationDate) && - Objects.equals(this.timestampOfTierChange, integrationHubEventPayloadLoyaltyProfileBasedNotification.timestampOfTierChange) && - Objects.equals(this.pointsRequiredToTheNextTier, integrationHubEventPayloadLoyaltyProfileBasedNotification.pointsRequiredToTheNextTier) && - Objects.equals(this.nextTier, integrationHubEventPayloadLoyaltyProfileBasedNotification.nextTier)&& - Objects.equals(this.additionalProperties, integrationHubEventPayloadLoyaltyProfileBasedNotification.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(profileIntegrationID, loyaltyProgramID, loyaltyProgramName, subledgerID, sourceOfEvent, currentTier, employeeName, userID, currentPoints, actions, publishedAt, oldTier, tierExpirationDate, timestampOfTierChange, pointsRequiredToTheNextTier, nextTier, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class IntegrationHubEventPayloadLoyaltyProfileBasedNotification {\n"); - sb.append(" profileIntegrationID: ").append(toIndentedString(profileIntegrationID)).append("\n"); - sb.append(" loyaltyProgramID: ").append(toIndentedString(loyaltyProgramID)).append("\n"); - sb.append(" loyaltyProgramName: ").append(toIndentedString(loyaltyProgramName)).append("\n"); - sb.append(" subledgerID: ").append(toIndentedString(subledgerID)).append("\n"); - sb.append(" sourceOfEvent: ").append(toIndentedString(sourceOfEvent)).append("\n"); - sb.append(" currentTier: ").append(toIndentedString(currentTier)).append("\n"); - sb.append(" employeeName: ").append(toIndentedString(employeeName)).append("\n"); - sb.append(" userID: ").append(toIndentedString(userID)).append("\n"); - sb.append(" currentPoints: ").append(toIndentedString(currentPoints)).append("\n"); - sb.append(" actions: ").append(toIndentedString(actions)).append("\n"); - sb.append(" publishedAt: ").append(toIndentedString(publishedAt)).append("\n"); - sb.append(" oldTier: ").append(toIndentedString(oldTier)).append("\n"); - sb.append(" tierExpirationDate: ").append(toIndentedString(tierExpirationDate)).append("\n"); - sb.append(" timestampOfTierChange: ").append(toIndentedString(timestampOfTierChange)).append("\n"); - sb.append(" pointsRequiredToTheNextTier: ").append(toIndentedString(pointsRequiredToTheNextTier)).append("\n"); - sb.append(" nextTier: ").append(toIndentedString(nextTier)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).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(Object o) { - return o == null ? "null" : o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("ProfileIntegrationID", "LoyaltyProgramID", "LoyaltyProgramName", "SubledgerID", "SourceOfEvent", "CurrentTier", "EmployeeName", "UserID", "CurrentPoints", "Actions", "PublishedAt", "OldTier", "TierExpirationDate", "TimestampOfTierChange", "PointsRequiredToTheNextTier", "NextTier")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("ProfileIntegrationID", "LoyaltyProgramID", "LoyaltyProgramName", "SubledgerID", "SourceOfEvent", "CurrentTier", "CurrentPoints", "PublishedAt")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to IntegrationHubEventPayloadLoyaltyProfileBasedNotification - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!IntegrationHubEventPayloadLoyaltyProfileBasedNotification.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in IntegrationHubEventPayloadLoyaltyProfileBasedNotification is not found in the empty JSON string", IntegrationHubEventPayloadLoyaltyProfileBasedNotification.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : IntegrationHubEventPayloadLoyaltyProfileBasedNotification.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("ProfileIntegrationID").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `ProfileIntegrationID` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ProfileIntegrationID").toString())); - } - if (!jsonObj.get("LoyaltyProgramName").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `LoyaltyProgramName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("LoyaltyProgramName").toString())); - } - if (!jsonObj.get("SubledgerID").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `SubledgerID` to be a primitive type in the JSON string but got `%s`", jsonObj.get("SubledgerID").toString())); - } - if (!jsonObj.get("SourceOfEvent").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `SourceOfEvent` to be a primitive type in the JSON string but got `%s`", jsonObj.get("SourceOfEvent").toString())); - } - if (!jsonObj.get("CurrentTier").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `CurrentTier` to be a primitive type in the JSON string but got `%s`", jsonObj.get("CurrentTier").toString())); - } - if ((jsonObj.get("EmployeeName") != null && !jsonObj.get("EmployeeName").isJsonNull()) && !jsonObj.get("EmployeeName").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EmployeeName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EmployeeName").toString())); - } - if (jsonObj.get("Actions") != null && !jsonObj.get("Actions").isJsonNull()) { - JsonArray jsonArrayactions = jsonObj.getAsJsonArray("Actions"); - if (jsonArrayactions != null) { - // ensure the json data is an array - if (!jsonObj.get("Actions").isJsonArray()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `Actions` to be an array in the JSON string but got `%s`", jsonObj.get("Actions").toString())); - } - - // validate the optional field `Actions` (array) - for (int i = 0; i < jsonArrayactions.size(); i++) { - IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.validateJsonElement(jsonArrayactions.get(i)); - }; - } - } - if ((jsonObj.get("OldTier") != null && !jsonObj.get("OldTier").isJsonNull()) && !jsonObj.get("OldTier").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `OldTier` to be a primitive type in the JSON string but got `%s`", jsonObj.get("OldTier").toString())); - } - if ((jsonObj.get("NextTier") != null && !jsonObj.get("NextTier").isJsonNull()) && !jsonObj.get("NextTier").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `NextTier` to be a primitive type in the JSON string but got `%s`", jsonObj.get("NextTier").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!IntegrationHubEventPayloadLoyaltyProfileBasedNotification.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'IntegrationHubEventPayloadLoyaltyProfileBasedNotification' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(IntegrationHubEventPayloadLoyaltyProfileBasedNotification.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, IntegrationHubEventPayloadLoyaltyProfileBasedNotification value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public IntegrationHubEventPayloadLoyaltyProfileBasedNotification read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - IntegrationHubEventPayloadLoyaltyProfileBasedNotification instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of IntegrationHubEventPayloadLoyaltyProfileBasedNotification given an JSON string - * - * @param jsonString JSON string - * @return An instance of IntegrationHubEventPayloadLoyaltyProfileBasedNotification - * @throws IOException if the JSON string is invalid with respect to IntegrationHubEventPayloadLoyaltyProfileBasedNotification - */ - public static IntegrationHubEventPayloadLoyaltyProfileBasedNotification fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, IntegrationHubEventPayloadLoyaltyProfileBasedNotification.class); - } - - /** - * Convert an instance of IntegrationHubEventPayloadLoyaltyProfileBasedNotification to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.java index dfe50eb7..f1527c5c 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.java @@ -52,7 +52,7 @@ /** * IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification { public static final String SERIALIZED_NAME_PROFILE_INTEGRATION_I_D = "ProfileIntegrationID"; @SerializedName(SERIALIZED_NAME_PROFILE_INTEGRATION_I_D) diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.java index cc42f952..22e47045 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.java @@ -50,7 +50,7 @@ /** * IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction { public static final String SERIALIZED_NAME_AMOUNT = "Amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.java index 91234fe4..7a2433e1 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.java @@ -49,7 +49,7 @@ /** * IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification { public static final String SERIALIZED_NAME_PROFILE_INTEGRATION_I_D = "ProfileIntegrationID"; @SerializedName(SERIALIZED_NAME_PROFILE_INTEGRATION_I_D) diff --git a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.java b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.java index 39118f55..0cceab41 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.java +++ b/src/main/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.java @@ -49,7 +49,7 @@ /** * IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification { public static final String SERIALIZED_NAME_PROFILE_INTEGRATION_I_D = "ProfileIntegrationID"; @SerializedName(SERIALIZED_NAME_PROFILE_INTEGRATION_I_D) diff --git a/src/main/java/one/talon/model/IntegrationHubEventRecord.java b/src/main/java/one/talon/model/IntegrationHubEventRecord.java index 92a5cc65..1a0a15be 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventRecord.java +++ b/src/main/java/one/talon/model/IntegrationHubEventRecord.java @@ -22,6 +22,7 @@ import java.io.IOException; import java.time.OffsetDateTime; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -49,53 +50,63 @@ /** * IntegrationHubEventRecord */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventRecord { - public static final String SERIALIZED_NAME_ID = "Id"; + public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @javax.annotation.Nonnull private Long id; - public static final String SERIALIZED_NAME_FLOW_ID = "FlowId"; + public static final String SERIALIZED_NAME_FLOW_ID = "flowId"; @SerializedName(SERIALIZED_NAME_FLOW_ID) @javax.annotation.Nonnull private Long flowId; - public static final String SERIALIZED_NAME_EVENT_TYPE = "EventType"; - @SerializedName(SERIALIZED_NAME_EVENT_TYPE) - @javax.annotation.Nonnull - private String eventType; + public static final String SERIALIZED_NAME_INTEGRATION_NAME = "integrationName"; + @SerializedName(SERIALIZED_NAME_INTEGRATION_NAME) + @javax.annotation.Nullable + private String integrationName; - public static final String SERIALIZED_NAME_EVENT_DATA = "EventData"; - @SerializedName(SERIALIZED_NAME_EVENT_DATA) + public static final String SERIALIZED_NAME_INSTANCE_NAME = "instanceName"; + @SerializedName(SERIALIZED_NAME_INSTANCE_NAME) @javax.annotation.Nullable - private Object eventData = null; + private String instanceName; + + public static final String SERIALIZED_NAME_EVENT_TYPE = "eventType"; + @SerializedName(SERIALIZED_NAME_EVENT_TYPE) + @javax.annotation.Nonnull + private IntegrationHubEventType eventType; - public static final String SERIALIZED_NAME_PUBLISHED_AT = "PublishedAt"; + public static final String SERIALIZED_NAME_PUBLISHED_AT = "publishedAt"; @SerializedName(SERIALIZED_NAME_PUBLISHED_AT) @javax.annotation.Nonnull private OffsetDateTime publishedAt; - public static final String SERIALIZED_NAME_PROCESSED_AT = "ProcessedAt"; + public static final String SERIALIZED_NAME_PROCESSED_AT = "processedAt"; @SerializedName(SERIALIZED_NAME_PROCESSED_AT) @javax.annotation.Nullable private OffsetDateTime processedAt; - public static final String SERIALIZED_NAME_DELIVERED_AT = "DeliveredAt"; + public static final String SERIALIZED_NAME_DELIVERED_AT = "deliveredAt"; @SerializedName(SERIALIZED_NAME_DELIVERED_AT) @javax.annotation.Nullable private OffsetDateTime deliveredAt; - public static final String SERIALIZED_NAME_PROCESS_AFTER = "ProcessAfter"; - @SerializedName(SERIALIZED_NAME_PROCESS_AFTER) + public static final String SERIALIZED_NAME_SCHEDULED_TO = "scheduledTo"; + @SerializedName(SERIALIZED_NAME_SCHEDULED_TO) @javax.annotation.Nonnull - private OffsetDateTime processAfter; + private OffsetDateTime scheduledTo; - public static final String SERIALIZED_NAME_RETRY = "Retry"; + public static final String SERIALIZED_NAME_RETRY = "retry"; @SerializedName(SERIALIZED_NAME_RETRY) @javax.annotation.Nonnull private Long retry; + public static final String SERIALIZED_NAME_PAYLOAD = "payload"; + @SerializedName(SERIALIZED_NAME_PAYLOAD) + @javax.annotation.Nonnull + private String payload; + public IntegrationHubEventRecord() { } @@ -105,7 +116,7 @@ public IntegrationHubEventRecord id(@javax.annotation.Nonnull Long id) { } /** - * Get id + * ID of the event record. * @return id */ @javax.annotation.Nonnull @@ -124,7 +135,7 @@ public IntegrationHubEventRecord flowId(@javax.annotation.Nonnull Long flowId) { } /** - * Get flowId + * ID of the integration hub flow. * @return flowId */ @javax.annotation.Nonnull @@ -137,41 +148,60 @@ public void setFlowId(@javax.annotation.Nonnull Long flowId) { } - public IntegrationHubEventRecord eventType(@javax.annotation.Nonnull String eventType) { - this.eventType = eventType; + public IntegrationHubEventRecord integrationName(@javax.annotation.Nullable String integrationName) { + this.integrationName = integrationName; return this; } /** - * Get eventType - * @return eventType + * Name of the integration. + * @return integrationName */ - @javax.annotation.Nonnull - public String getEventType() { - return eventType; + @javax.annotation.Nullable + public String getIntegrationName() { + return integrationName; } - public void setEventType(@javax.annotation.Nonnull String eventType) { - this.eventType = eventType; + public void setIntegrationName(@javax.annotation.Nullable String integrationName) { + this.integrationName = integrationName; } - public IntegrationHubEventRecord eventData(@javax.annotation.Nullable Object eventData) { - this.eventData = eventData; + public IntegrationHubEventRecord instanceName(@javax.annotation.Nullable String instanceName) { + this.instanceName = instanceName; return this; } /** - * Get eventData - * @return eventData + * Name of the integration instance. + * @return instanceName */ @javax.annotation.Nullable - public Object getEventData() { - return eventData; + public String getInstanceName() { + return instanceName; + } + + public void setInstanceName(@javax.annotation.Nullable String instanceName) { + this.instanceName = instanceName; + } + + + public IntegrationHubEventRecord eventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { + this.eventType = eventType; + return this; } - public void setEventData(@javax.annotation.Nullable Object eventData) { - this.eventData = eventData; + /** + * Get eventType + * @return eventType + */ + @javax.annotation.Nonnull + public IntegrationHubEventType getEventType() { + return eventType; + } + + public void setEventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { + this.eventType = eventType; } @@ -181,7 +211,7 @@ public IntegrationHubEventRecord publishedAt(@javax.annotation.Nonnull OffsetDat } /** - * Get publishedAt + * Timestamp when the event was published. * @return publishedAt */ @javax.annotation.Nonnull @@ -200,7 +230,7 @@ public IntegrationHubEventRecord processedAt(@javax.annotation.Nullable OffsetDa } /** - * Get processedAt + * Timestamp when the event was processed. * @return processedAt */ @javax.annotation.Nullable @@ -219,7 +249,7 @@ public IntegrationHubEventRecord deliveredAt(@javax.annotation.Nullable OffsetDa } /** - * Get deliveredAt + * Timestamp when the event was delivered. * @return deliveredAt */ @javax.annotation.Nullable @@ -232,22 +262,22 @@ public void setDeliveredAt(@javax.annotation.Nullable OffsetDateTime deliveredAt } - public IntegrationHubEventRecord processAfter(@javax.annotation.Nonnull OffsetDateTime processAfter) { - this.processAfter = processAfter; + public IntegrationHubEventRecord scheduledTo(@javax.annotation.Nonnull OffsetDateTime scheduledTo) { + this.scheduledTo = scheduledTo; return this; } /** - * Get processAfter - * @return processAfter + * Timestamp after which the event is scheduled to be processed. + * @return scheduledTo */ @javax.annotation.Nonnull - public OffsetDateTime getProcessAfter() { - return processAfter; + public OffsetDateTime getScheduledTo() { + return scheduledTo; } - public void setProcessAfter(@javax.annotation.Nonnull OffsetDateTime processAfter) { - this.processAfter = processAfter; + public void setScheduledTo(@javax.annotation.Nonnull OffsetDateTime scheduledTo) { + this.scheduledTo = scheduledTo; } @@ -257,7 +287,7 @@ public IntegrationHubEventRecord retry(@javax.annotation.Nonnull Long retry) { } /** - * Get retry + * Number of delivery retries attempted. * @return retry */ @javax.annotation.Nonnull @@ -269,6 +299,25 @@ public void setRetry(@javax.annotation.Nonnull Long retry) { this.retry = retry; } + + public IntegrationHubEventRecord payload(@javax.annotation.Nonnull String payload) { + this.payload = payload; + return this; + } + + /** + * The event payload as a formatted JSON string. + * @return payload + */ + @javax.annotation.Nonnull + public String getPayload() { + return payload; + } + + public void setPayload(@javax.annotation.Nonnull String payload) { + this.payload = payload; + } + /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -326,19 +375,21 @@ public boolean equals(Object o) { IntegrationHubEventRecord integrationHubEventRecord = (IntegrationHubEventRecord) o; return Objects.equals(this.id, integrationHubEventRecord.id) && Objects.equals(this.flowId, integrationHubEventRecord.flowId) && + Objects.equals(this.integrationName, integrationHubEventRecord.integrationName) && + Objects.equals(this.instanceName, integrationHubEventRecord.instanceName) && Objects.equals(this.eventType, integrationHubEventRecord.eventType) && - Objects.equals(this.eventData, integrationHubEventRecord.eventData) && Objects.equals(this.publishedAt, integrationHubEventRecord.publishedAt) && Objects.equals(this.processedAt, integrationHubEventRecord.processedAt) && Objects.equals(this.deliveredAt, integrationHubEventRecord.deliveredAt) && - Objects.equals(this.processAfter, integrationHubEventRecord.processAfter) && - Objects.equals(this.retry, integrationHubEventRecord.retry)&& + Objects.equals(this.scheduledTo, integrationHubEventRecord.scheduledTo) && + Objects.equals(this.retry, integrationHubEventRecord.retry) && + Objects.equals(this.payload, integrationHubEventRecord.payload)&& Objects.equals(this.additionalProperties, integrationHubEventRecord.additionalProperties); } @Override public int hashCode() { - return Objects.hash(id, flowId, eventType, eventData, publishedAt, processedAt, deliveredAt, processAfter, retry, additionalProperties); + return Objects.hash(id, flowId, integrationName, instanceName, eventType, publishedAt, processedAt, deliveredAt, scheduledTo, retry, payload, additionalProperties); } @Override @@ -347,13 +398,15 @@ public String toString() { sb.append("class IntegrationHubEventRecord {\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" flowId: ").append(toIndentedString(flowId)).append("\n"); + sb.append(" integrationName: ").append(toIndentedString(integrationName)).append("\n"); + sb.append(" instanceName: ").append(toIndentedString(instanceName)).append("\n"); sb.append(" eventType: ").append(toIndentedString(eventType)).append("\n"); - sb.append(" eventData: ").append(toIndentedString(eventData)).append("\n"); sb.append(" publishedAt: ").append(toIndentedString(publishedAt)).append("\n"); sb.append(" processedAt: ").append(toIndentedString(processedAt)).append("\n"); sb.append(" deliveredAt: ").append(toIndentedString(deliveredAt)).append("\n"); - sb.append(" processAfter: ").append(toIndentedString(processAfter)).append("\n"); + sb.append(" scheduledTo: ").append(toIndentedString(scheduledTo)).append("\n"); sb.append(" retry: ").append(toIndentedString(retry)).append("\n"); + sb.append(" payload: ").append(toIndentedString(payload)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -373,10 +426,10 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("Id", "FlowId", "EventType", "EventData", "PublishedAt", "ProcessedAt", "DeliveredAt", "ProcessAfter", "Retry")); + openapiFields = new HashSet(Arrays.asList("id", "flowId", "integrationName", "instanceName", "eventType", "publishedAt", "processedAt", "deliveredAt", "scheduledTo", "retry", "payload")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("Id", "FlowId", "EventType", "EventData", "PublishedAt", "ProcessAfter", "Retry")); + openapiRequiredFields = new HashSet(Arrays.asList("id", "flowId", "eventType", "publishedAt", "scheduledTo", "retry", "payload")); } /** @@ -399,8 +452,16 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("EventType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EventType").toString())); + if ((jsonObj.get("integrationName") != null && !jsonObj.get("integrationName").isJsonNull()) && !jsonObj.get("integrationName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `integrationName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("integrationName").toString())); + } + if ((jsonObj.get("instanceName") != null && !jsonObj.get("instanceName").isJsonNull()) && !jsonObj.get("instanceName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `instanceName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("instanceName").toString())); + } + // validate the required field `eventType` + IntegrationHubEventType.validateJsonElement(jsonObj.get("eventType")); + if (!jsonObj.get("payload").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `payload` to be a primitive type in the JSON string but got `%s`", jsonObj.get("payload").toString())); } } diff --git a/src/main/java/one/talon/model/IntegrationHubEventStatusUpdate.java b/src/main/java/one/talon/model/IntegrationHubEventStatusUpdate.java index 9cb9a0d5..7c9f4159 100644 --- a/src/main/java/one/talon/model/IntegrationHubEventStatusUpdate.java +++ b/src/main/java/one/talon/model/IntegrationHubEventStatusUpdate.java @@ -48,7 +48,7 @@ /** * IntegrationHubEventStatusUpdate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubEventStatusUpdate { public static final String SERIALIZED_NAME_EVENT_ID = "EventId"; @SerializedName(SERIALIZED_NAME_EVENT_ID) diff --git a/src/main/java/one/talon/model/IntegrationHubEventType.java b/src/main/java/one/talon/model/IntegrationHubEventType.java new file mode 100644 index 00000000..cd3d3cc4 --- /dev/null +++ b/src/main/java/one/talon/model/IntegrationHubEventType.java @@ -0,0 +1,86 @@ +/* + * 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) 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#tag/Customer-sessions/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 com.google.gson.annotations.SerializedName; + +import java.io.IOException; +import com.google.gson.TypeAdapter; +import com.google.gson.JsonElement; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; + +/** + * The type of integration hub event. + */ +@JsonAdapter(IntegrationHubEventType.Adapter.class) +public enum IntegrationHubEventType { + + LOYALTY_POINTS_CHANGED("LoyaltyPointsChanged"), + + LOYALTY_TIER_DOWNGRADE("LoyaltyTierDowngrade"), + + LOYALTY_TIER_UPGRADE("LoyaltyTierUpgrade"), + + COUPON_CREATED("CouponCreated"), + + COUPON_UPDATED("CouponUpdated"), + + COUPON_DELETED("CouponDeleted"); + + private String value; + + IntegrationHubEventType(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static IntegrationHubEventType fromValue(String value) { + for (IntegrationHubEventType b : IntegrationHubEventType.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 IntegrationHubEventType enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public IntegrationHubEventType read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return IntegrationHubEventType.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + IntegrationHubEventType.fromValue(value); + } +} + diff --git a/src/main/java/one/talon/model/IntegrationHubFlow.java b/src/main/java/one/talon/model/IntegrationHubFlow.java index 2c4e5a12..e1e75094 100644 --- a/src/main/java/one/talon/model/IntegrationHubFlow.java +++ b/src/main/java/one/talon/model/IntegrationHubFlow.java @@ -21,6 +21,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,17 +49,22 @@ /** * IntegrationHubFlow */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubFlow { public static final String SERIALIZED_NAME_APPLICATION_I_D = "ApplicationID"; @SerializedName(SERIALIZED_NAME_APPLICATION_I_D) @javax.annotation.Nullable private Long applicationID; + public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_I_D = "LoyaltyProgramID"; + @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_I_D) + @javax.annotation.Nullable + private Long loyaltyProgramID; + public static final String SERIALIZED_NAME_EVENT_TYPE = "EventType"; @SerializedName(SERIALIZED_NAME_EVENT_TYPE) @javax.annotation.Nonnull - private String eventType; + private IntegrationHubEventType eventType; public static final String SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL = "IntegrationHubFlowUrl"; @SerializedName(SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL) @@ -74,7 +80,7 @@ public IntegrationHubFlow applicationID(@javax.annotation.Nullable Long applicat } /** - * ID of application the flow is registered for. + * ID of the application the flow is registered for. * @return applicationID */ @javax.annotation.Nullable @@ -87,21 +93,40 @@ public void setApplicationID(@javax.annotation.Nullable Long applicationID) { } - public IntegrationHubFlow eventType(@javax.annotation.Nonnull String eventType) { + public IntegrationHubFlow loyaltyProgramID(@javax.annotation.Nullable Long loyaltyProgramID) { + this.loyaltyProgramID = loyaltyProgramID; + return this; + } + + /** + * ID of the loyalty program the flow is registered for. + * @return loyaltyProgramID + */ + @javax.annotation.Nullable + public Long getLoyaltyProgramID() { + return loyaltyProgramID; + } + + public void setLoyaltyProgramID(@javax.annotation.Nullable Long loyaltyProgramID) { + this.loyaltyProgramID = loyaltyProgramID; + } + + + public IntegrationHubFlow eventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; return this; } /** - * The event type we want to register a flow for. + * Get eventType * @return eventType */ @javax.annotation.Nonnull - public String getEventType() { + public IntegrationHubEventType getEventType() { return eventType; } - public void setEventType(@javax.annotation.Nonnull String eventType) { + public void setEventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; } @@ -180,6 +205,7 @@ public boolean equals(Object o) { } IntegrationHubFlow integrationHubFlow = (IntegrationHubFlow) o; return Objects.equals(this.applicationID, integrationHubFlow.applicationID) && + Objects.equals(this.loyaltyProgramID, integrationHubFlow.loyaltyProgramID) && Objects.equals(this.eventType, integrationHubFlow.eventType) && Objects.equals(this.integrationHubFlowUrl, integrationHubFlow.integrationHubFlowUrl)&& Objects.equals(this.additionalProperties, integrationHubFlow.additionalProperties); @@ -187,7 +213,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(applicationID, eventType, integrationHubFlowUrl, additionalProperties); + return Objects.hash(applicationID, loyaltyProgramID, eventType, integrationHubFlowUrl, additionalProperties); } @Override @@ -195,6 +221,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class IntegrationHubFlow {\n"); sb.append(" applicationID: ").append(toIndentedString(applicationID)).append("\n"); + sb.append(" loyaltyProgramID: ").append(toIndentedString(loyaltyProgramID)).append("\n"); sb.append(" eventType: ").append(toIndentedString(eventType)).append("\n"); sb.append(" integrationHubFlowUrl: ").append(toIndentedString(integrationHubFlowUrl)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); @@ -216,7 +243,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("ApplicationID", "EventType", "IntegrationHubFlowUrl")); + openapiFields = new HashSet(Arrays.asList("ApplicationID", "LoyaltyProgramID", "EventType", "IntegrationHubFlowUrl")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("EventType", "IntegrationHubFlowUrl")); @@ -242,9 +269,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("EventType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EventType").toString())); - } + // validate the required field `EventType` + IntegrationHubEventType.validateJsonElement(jsonObj.get("EventType")); if (!jsonObj.get("IntegrationHubFlowUrl").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `IntegrationHubFlowUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("IntegrationHubFlowUrl").toString())); } diff --git a/src/main/java/one/talon/model/IntegrationHubFlowConfig.java b/src/main/java/one/talon/model/IntegrationHubFlowConfig.java index 652b1775..04c8cdbc 100644 --- a/src/main/java/one/talon/model/IntegrationHubFlowConfig.java +++ b/src/main/java/one/talon/model/IntegrationHubFlowConfig.java @@ -48,7 +48,7 @@ /** * IntegrationHubFlowConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubFlowConfig { public static final String SERIALIZED_NAME_API_KEY = "ApiKey"; @SerializedName(SERIALIZED_NAME_API_KEY) diff --git a/src/main/java/one/talon/model/IntegrationHubFlowConfigResponse.java b/src/main/java/one/talon/model/IntegrationHubFlowConfigResponse.java index 5bad8721..a029ad56 100644 --- a/src/main/java/one/talon/model/IntegrationHubFlowConfigResponse.java +++ b/src/main/java/one/talon/model/IntegrationHubFlowConfigResponse.java @@ -48,7 +48,7 @@ /** * IntegrationHubFlowConfigResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubFlowConfigResponse { public static final String SERIALIZED_NAME_WORKER_COUNT = "WorkerCount"; @SerializedName(SERIALIZED_NAME_WORKER_COUNT) diff --git a/src/main/java/one/talon/model/IntegrationHubFlowResponse.java b/src/main/java/one/talon/model/IntegrationHubFlowResponse.java index 227829f0..71dfd041 100644 --- a/src/main/java/one/talon/model/IntegrationHubFlowResponse.java +++ b/src/main/java/one/talon/model/IntegrationHubFlowResponse.java @@ -20,8 +20,10 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; +import java.time.OffsetDateTime; import java.util.Arrays; import one.talon.model.IntegrationHubFlowConfigResponse; +import org.openapitools.jackson.nullable.JsonNullable; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -49,29 +51,54 @@ /** * IntegrationHubFlowResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubFlowResponse { - public static final String SERIALIZED_NAME_ID = "Id"; + public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @javax.annotation.Nonnull private Long id; - public static final String SERIALIZED_NAME_APPLICATION_I_D = "ApplicationID"; - @SerializedName(SERIALIZED_NAME_APPLICATION_I_D) + public static final String SERIALIZED_NAME_INTEGRATION_NAME = "integrationName"; + @SerializedName(SERIALIZED_NAME_INTEGRATION_NAME) @javax.annotation.Nullable - private Long applicationID; + private String integrationName; - public static final String SERIALIZED_NAME_EVENT_TYPE = "EventType"; + public static final String SERIALIZED_NAME_INSTANCE_NAME = "instanceName"; + @SerializedName(SERIALIZED_NAME_INSTANCE_NAME) + @javax.annotation.Nullable + private String instanceName; + + public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; + @SerializedName(SERIALIZED_NAME_CREATED_AT) + @javax.annotation.Nonnull + private OffsetDateTime createdAt; + + public static final String SERIALIZED_NAME_DISABLED_UNTIL = "disabledUntil"; + @SerializedName(SERIALIZED_NAME_DISABLED_UNTIL) + @javax.annotation.Nullable + private OffsetDateTime disabledUntil; + + public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; + @SerializedName(SERIALIZED_NAME_APPLICATION_ID) + @javax.annotation.Nullable + private Long applicationId; + + public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_ID = "loyaltyProgramId"; + @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_ID) + @javax.annotation.Nullable + private Long loyaltyProgramId; + + public static final String SERIALIZED_NAME_EVENT_TYPE = "eventType"; @SerializedName(SERIALIZED_NAME_EVENT_TYPE) @javax.annotation.Nonnull private String eventType; - public static final String SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL = "IntegrationHubFlowUrl"; + public static final String SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL = "integrationHubFlowUrl"; @SerializedName(SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL) @javax.annotation.Nonnull private String integrationHubFlowUrl; - public static final String SERIALIZED_NAME_CONFIG = "Config"; + public static final String SERIALIZED_NAME_CONFIG = "config"; @SerializedName(SERIALIZED_NAME_CONFIG) @javax.annotation.Nonnull private IntegrationHubFlowConfigResponse config; @@ -98,22 +125,117 @@ public void setId(@javax.annotation.Nonnull Long id) { } - public IntegrationHubFlowResponse applicationID(@javax.annotation.Nullable Long applicationID) { - this.applicationID = applicationID; + public IntegrationHubFlowResponse integrationName(@javax.annotation.Nullable String integrationName) { + this.integrationName = integrationName; + return this; + } + + /** + * Name of the integration. + * @return integrationName + */ + @javax.annotation.Nullable + public String getIntegrationName() { + return integrationName; + } + + public void setIntegrationName(@javax.annotation.Nullable String integrationName) { + this.integrationName = integrationName; + } + + + public IntegrationHubFlowResponse instanceName(@javax.annotation.Nullable String instanceName) { + this.instanceName = instanceName; + return this; + } + + /** + * Name of the integration instance. + * @return instanceName + */ + @javax.annotation.Nullable + public String getInstanceName() { + return instanceName; + } + + public void setInstanceName(@javax.annotation.Nullable String instanceName) { + this.instanceName = instanceName; + } + + + public IntegrationHubFlowResponse createdAt(@javax.annotation.Nonnull OffsetDateTime createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + * Timestamp when the flow was created. + * @return createdAt + */ + @javax.annotation.Nonnull + public OffsetDateTime getCreatedAt() { + return createdAt; + } + + public void setCreatedAt(@javax.annotation.Nonnull OffsetDateTime createdAt) { + this.createdAt = createdAt; + } + + + public IntegrationHubFlowResponse disabledUntil(@javax.annotation.Nullable OffsetDateTime disabledUntil) { + this.disabledUntil = disabledUntil; + return this; + } + + /** + * Timestamp until which the flow is disabled. Null when the flow is active. + * @return disabledUntil + */ + @javax.annotation.Nullable + public OffsetDateTime getDisabledUntil() { + return disabledUntil; + } + + public void setDisabledUntil(@javax.annotation.Nullable OffsetDateTime disabledUntil) { + this.disabledUntil = disabledUntil; + } + + + public IntegrationHubFlowResponse applicationId(@javax.annotation.Nullable Long applicationId) { + this.applicationId = applicationId; return this; } /** - * ID of application the flow is registered for. - * @return applicationID + * ID of the application the flow is registered for. + * @return applicationId */ @javax.annotation.Nullable - public Long getApplicationID() { - return applicationID; + public Long getApplicationId() { + return applicationId; } - public void setApplicationID(@javax.annotation.Nullable Long applicationID) { - this.applicationID = applicationID; + public void setApplicationId(@javax.annotation.Nullable Long applicationId) { + this.applicationId = applicationId; + } + + + public IntegrationHubFlowResponse loyaltyProgramId(@javax.annotation.Nullable Long loyaltyProgramId) { + this.loyaltyProgramId = loyaltyProgramId; + return this; + } + + /** + * ID of the loyalty program the flow is registered for. + * @return loyaltyProgramId + */ + @javax.annotation.Nullable + public Long getLoyaltyProgramId() { + return loyaltyProgramId; + } + + public void setLoyaltyProgramId(@javax.annotation.Nullable Long loyaltyProgramId) { + this.loyaltyProgramId = loyaltyProgramId; } @@ -229,16 +351,32 @@ public boolean equals(Object o) { } IntegrationHubFlowResponse integrationHubFlowResponse = (IntegrationHubFlowResponse) o; return Objects.equals(this.id, integrationHubFlowResponse.id) && - Objects.equals(this.applicationID, integrationHubFlowResponse.applicationID) && + Objects.equals(this.integrationName, integrationHubFlowResponse.integrationName) && + Objects.equals(this.instanceName, integrationHubFlowResponse.instanceName) && + Objects.equals(this.createdAt, integrationHubFlowResponse.createdAt) && + Objects.equals(this.disabledUntil, integrationHubFlowResponse.disabledUntil) && + Objects.equals(this.applicationId, integrationHubFlowResponse.applicationId) && + Objects.equals(this.loyaltyProgramId, integrationHubFlowResponse.loyaltyProgramId) && Objects.equals(this.eventType, integrationHubFlowResponse.eventType) && Objects.equals(this.integrationHubFlowUrl, integrationHubFlowResponse.integrationHubFlowUrl) && Objects.equals(this.config, integrationHubFlowResponse.config)&& Objects.equals(this.additionalProperties, integrationHubFlowResponse.additionalProperties); } + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + @Override public int hashCode() { - return Objects.hash(id, applicationID, eventType, integrationHubFlowUrl, config, additionalProperties); + return Objects.hash(id, integrationName, instanceName, createdAt, disabledUntil, applicationId, loyaltyProgramId, eventType, integrationHubFlowUrl, config, additionalProperties); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override @@ -246,7 +384,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class IntegrationHubFlowResponse {\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" applicationID: ").append(toIndentedString(applicationID)).append("\n"); + sb.append(" integrationName: ").append(toIndentedString(integrationName)).append("\n"); + sb.append(" instanceName: ").append(toIndentedString(instanceName)).append("\n"); + sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); + sb.append(" disabledUntil: ").append(toIndentedString(disabledUntil)).append("\n"); + sb.append(" applicationId: ").append(toIndentedString(applicationId)).append("\n"); + sb.append(" loyaltyProgramId: ").append(toIndentedString(loyaltyProgramId)).append("\n"); sb.append(" eventType: ").append(toIndentedString(eventType)).append("\n"); sb.append(" integrationHubFlowUrl: ").append(toIndentedString(integrationHubFlowUrl)).append("\n"); sb.append(" config: ").append(toIndentedString(config)).append("\n"); @@ -269,10 +412,10 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("Id", "ApplicationID", "EventType", "IntegrationHubFlowUrl", "Config")); + openapiFields = new HashSet(Arrays.asList("id", "integrationName", "instanceName", "createdAt", "disabledUntil", "applicationId", "loyaltyProgramId", "eventType", "integrationHubFlowUrl", "config")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("Id", "EventType", "IntegrationHubFlowUrl", "Config")); + openapiRequiredFields = new HashSet(Arrays.asList("id", "createdAt", "eventType", "integrationHubFlowUrl", "config")); } /** @@ -295,14 +438,20 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("EventType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EventType").toString())); + if ((jsonObj.get("integrationName") != null && !jsonObj.get("integrationName").isJsonNull()) && !jsonObj.get("integrationName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `integrationName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("integrationName").toString())); + } + if ((jsonObj.get("instanceName") != null && !jsonObj.get("instanceName").isJsonNull()) && !jsonObj.get("instanceName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `instanceName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("instanceName").toString())); + } + if (!jsonObj.get("eventType").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `eventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("eventType").toString())); } - if (!jsonObj.get("IntegrationHubFlowUrl").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `IntegrationHubFlowUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("IntegrationHubFlowUrl").toString())); + if (!jsonObj.get("integrationHubFlowUrl").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `integrationHubFlowUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("integrationHubFlowUrl").toString())); } - // validate the required field `Config` - IntegrationHubFlowConfigResponse.validateJsonElement(jsonObj.get("Config")); + // validate the required field `config` + IntegrationHubFlowConfigResponse.validateJsonElement(jsonObj.get("config")); } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/one/talon/model/IntegrationHubFlowWithConfig.java b/src/main/java/one/talon/model/IntegrationHubFlowWithConfig.java index 437f7119..e79a5cab 100644 --- a/src/main/java/one/talon/model/IntegrationHubFlowWithConfig.java +++ b/src/main/java/one/talon/model/IntegrationHubFlowWithConfig.java @@ -21,6 +21,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import one.talon.model.IntegrationHubFlowConfig; import com.google.gson.Gson; @@ -49,17 +50,22 @@ /** * IntegrationHubFlowWithConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubFlowWithConfig { public static final String SERIALIZED_NAME_APPLICATION_I_D = "ApplicationID"; @SerializedName(SERIALIZED_NAME_APPLICATION_I_D) @javax.annotation.Nullable private Long applicationID; + public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_I_D = "LoyaltyProgramID"; + @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_I_D) + @javax.annotation.Nullable + private Long loyaltyProgramID; + public static final String SERIALIZED_NAME_EVENT_TYPE = "EventType"; @SerializedName(SERIALIZED_NAME_EVENT_TYPE) @javax.annotation.Nonnull - private String eventType; + private IntegrationHubEventType eventType; public static final String SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL = "IntegrationHubFlowUrl"; @SerializedName(SERIALIZED_NAME_INTEGRATION_HUB_FLOW_URL) @@ -80,7 +86,7 @@ public IntegrationHubFlowWithConfig applicationID(@javax.annotation.Nullable Lon } /** - * ID of application the flow is registered for. + * ID of the application the flow is registered for. * @return applicationID */ @javax.annotation.Nullable @@ -93,21 +99,40 @@ public void setApplicationID(@javax.annotation.Nullable Long applicationID) { } - public IntegrationHubFlowWithConfig eventType(@javax.annotation.Nonnull String eventType) { + public IntegrationHubFlowWithConfig loyaltyProgramID(@javax.annotation.Nullable Long loyaltyProgramID) { + this.loyaltyProgramID = loyaltyProgramID; + return this; + } + + /** + * ID of the loyalty program the flow is registered for. + * @return loyaltyProgramID + */ + @javax.annotation.Nullable + public Long getLoyaltyProgramID() { + return loyaltyProgramID; + } + + public void setLoyaltyProgramID(@javax.annotation.Nullable Long loyaltyProgramID) { + this.loyaltyProgramID = loyaltyProgramID; + } + + + public IntegrationHubFlowWithConfig eventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; return this; } /** - * The event type we want to register a flow for. + * Get eventType * @return eventType */ @javax.annotation.Nonnull - public String getEventType() { + public IntegrationHubEventType getEventType() { return eventType; } - public void setEventType(@javax.annotation.Nonnull String eventType) { + public void setEventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; } @@ -205,6 +230,7 @@ public boolean equals(Object o) { } IntegrationHubFlowWithConfig integrationHubFlowWithConfig = (IntegrationHubFlowWithConfig) o; return Objects.equals(this.applicationID, integrationHubFlowWithConfig.applicationID) && + Objects.equals(this.loyaltyProgramID, integrationHubFlowWithConfig.loyaltyProgramID) && Objects.equals(this.eventType, integrationHubFlowWithConfig.eventType) && Objects.equals(this.integrationHubFlowUrl, integrationHubFlowWithConfig.integrationHubFlowUrl) && Objects.equals(this.config, integrationHubFlowWithConfig.config)&& @@ -213,7 +239,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(applicationID, eventType, integrationHubFlowUrl, config, additionalProperties); + return Objects.hash(applicationID, loyaltyProgramID, eventType, integrationHubFlowUrl, config, additionalProperties); } @Override @@ -221,6 +247,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class IntegrationHubFlowWithConfig {\n"); sb.append(" applicationID: ").append(toIndentedString(applicationID)).append("\n"); + sb.append(" loyaltyProgramID: ").append(toIndentedString(loyaltyProgramID)).append("\n"); sb.append(" eventType: ").append(toIndentedString(eventType)).append("\n"); sb.append(" integrationHubFlowUrl: ").append(toIndentedString(integrationHubFlowUrl)).append("\n"); sb.append(" config: ").append(toIndentedString(config)).append("\n"); @@ -243,7 +270,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("ApplicationID", "EventType", "IntegrationHubFlowUrl", "Config")); + openapiFields = new HashSet(Arrays.asList("ApplicationID", "LoyaltyProgramID", "EventType", "IntegrationHubFlowUrl", "Config")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("EventType", "IntegrationHubFlowUrl", "Config")); @@ -269,9 +296,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("EventType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EventType").toString())); - } + // validate the required field `EventType` + IntegrationHubEventType.validateJsonElement(jsonObj.get("EventType")); if (!jsonObj.get("IntegrationHubFlowUrl").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `IntegrationHubFlowUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("IntegrationHubFlowUrl").toString())); } diff --git a/src/main/java/one/talon/model/IntegrationHubPaginatedEventPayload.java b/src/main/java/one/talon/model/IntegrationHubPaginatedEventPayload.java index 886924ed..6f3ae600 100644 --- a/src/main/java/one/talon/model/IntegrationHubPaginatedEventPayload.java +++ b/src/main/java/one/talon/model/IntegrationHubPaginatedEventPayload.java @@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import one.talon.model.IntegrationHubEventType; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -51,7 +52,7 @@ /** * IntegrationHubPaginatedEventPayload */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationHubPaginatedEventPayload { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) @@ -63,70 +64,10 @@ public class IntegrationHubPaginatedEventPayload { @javax.annotation.Nullable private OffsetDateTime batchedAt; - /** - * Gets or Sets eventType - */ - @JsonAdapter(EventTypeEnum.Adapter.class) - public enum EventTypeEnum { - LOYALTY_POINTS_CHANGED("LoyaltyPointsChanged"), - - LOYALTY_TIER_DOWNGRADE("LoyaltyTierDowngrade"), - - LOYALTY_TIER_UPGRADE("LoyaltyTierUpgrade"), - - COUPON_CREATED("CouponCreated"), - - COUPON_UPDATED("CouponUpdated"), - - COUPON_DELETED("CouponDeleted"); - - private String value; - - EventTypeEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static EventTypeEnum fromValue(String value) { - for (EventTypeEnum b : EventTypeEnum.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 EventTypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public EventTypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return EventTypeEnum.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - EventTypeEnum.fromValue(value); - } - } - public static final String SERIALIZED_NAME_EVENT_TYPE = "EventType"; @SerializedName(SERIALIZED_NAME_EVENT_TYPE) @javax.annotation.Nonnull - private EventTypeEnum eventType; + private IntegrationHubEventType eventType; public static final String SERIALIZED_NAME_DATA = "Data"; @SerializedName(SERIALIZED_NAME_DATA) @@ -174,7 +115,7 @@ public void setBatchedAt(@javax.annotation.Nullable OffsetDateTime batchedAt) { } - public IntegrationHubPaginatedEventPayload eventType(@javax.annotation.Nonnull EventTypeEnum eventType) { + public IntegrationHubPaginatedEventPayload eventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; return this; } @@ -184,11 +125,11 @@ public IntegrationHubPaginatedEventPayload eventType(@javax.annotation.Nonnull E * @return eventType */ @javax.annotation.Nonnull - public EventTypeEnum getEventType() { + public IntegrationHubEventType getEventType() { return eventType; } - public void setEventType(@javax.annotation.Nonnull EventTypeEnum eventType) { + public void setEventType(@javax.annotation.Nonnull IntegrationHubEventType eventType) { this.eventType = eventType; } @@ -339,11 +280,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("EventType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `EventType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("EventType").toString())); - } // validate the required field `EventType` - EventTypeEnum.validateJsonElement(jsonObj.get("EventType")); + IntegrationHubEventType.validateJsonElement(jsonObj.get("EventType")); // ensure the required json array is present if (jsonObj.get("Data") == null) { throw new IllegalArgumentException("Expected the field `linkedContent` to be an array in the JSON string but got `null`"); diff --git a/src/main/java/one/talon/model/IntegrationProfileEntity.java b/src/main/java/one/talon/model/IntegrationProfileEntity.java index 9cdff473..91c32ccb 100644 --- a/src/main/java/one/talon/model/IntegrationProfileEntity.java +++ b/src/main/java/one/talon/model/IntegrationProfileEntity.java @@ -48,7 +48,7 @@ /** * IntegrationProfileEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationProfileEntity { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/IntegrationProfileEntityV3.java b/src/main/java/one/talon/model/IntegrationProfileEntityV3.java index f395eab5..9e5708cd 100644 --- a/src/main/java/one/talon/model/IntegrationProfileEntityV3.java +++ b/src/main/java/one/talon/model/IntegrationProfileEntityV3.java @@ -48,7 +48,7 @@ /** * IntegrationProfileEntityV3 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationProfileEntityV3 { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/IntegrationRequest.java b/src/main/java/one/talon/model/IntegrationRequest.java index 0277ea2f..b71f34a1 100644 --- a/src/main/java/one/talon/model/IntegrationRequest.java +++ b/src/main/java/one/talon/model/IntegrationRequest.java @@ -51,7 +51,7 @@ /** * The body of a V2 integration API request (customer session update). Next to the customer session details, this contains an optional listing of extra properties that should be returned in the response. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationRequest { public static final String SERIALIZED_NAME_CUSTOMER_SESSION = "customerSession"; @SerializedName(SERIALIZED_NAME_CUSTOMER_SESSION) diff --git a/src/main/java/one/talon/model/IntegrationResponse.java b/src/main/java/one/talon/model/IntegrationResponse.java index d5d714d5..5a925dd7 100644 --- a/src/main/java/one/talon/model/IntegrationResponse.java +++ b/src/main/java/one/talon/model/IntegrationResponse.java @@ -59,7 +59,7 @@ /** * Contains entities that might be valuable in Talon.One integrations. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationResponse { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/IntegrationState.java b/src/main/java/one/talon/model/IntegrationState.java index 536e4ed7..a02714c3 100644 --- a/src/main/java/one/talon/model/IntegrationState.java +++ b/src/main/java/one/talon/model/IntegrationState.java @@ -53,7 +53,7 @@ /** * Contains all state that might interest application integration plugins. This is the response type returned by all of the Integration API operations. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationState { public static final String SERIALIZED_NAME_SESSION = "session"; @SerializedName(SERIALIZED_NAME_SESSION) diff --git a/src/main/java/one/talon/model/IntegrationStateV2.java b/src/main/java/one/talon/model/IntegrationStateV2.java index 040d36ac..f89b4f5a 100644 --- a/src/main/java/one/talon/model/IntegrationStateV2.java +++ b/src/main/java/one/talon/model/IntegrationStateV2.java @@ -65,7 +65,7 @@ /** * IntegrationStateV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationStateV2 { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE = "customerProfile"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE) diff --git a/src/main/java/one/talon/model/IntegrationStoreEntity.java b/src/main/java/one/talon/model/IntegrationStoreEntity.java index 410a4da0..be4f41f8 100644 --- a/src/main/java/one/talon/model/IntegrationStoreEntity.java +++ b/src/main/java/one/talon/model/IntegrationStoreEntity.java @@ -48,7 +48,7 @@ /** * IntegrationStoreEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class IntegrationStoreEntity { public static final String SERIALIZED_NAME_STORE_INTEGRATION_ID = "storeIntegrationId"; @SerializedName(SERIALIZED_NAME_STORE_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/InventoryCoupon.java b/src/main/java/one/talon/model/InventoryCoupon.java index 6e505056..e8c9a51d 100644 --- a/src/main/java/one/talon/model/InventoryCoupon.java +++ b/src/main/java/one/talon/model/InventoryCoupon.java @@ -53,7 +53,7 @@ /** * InventoryCoupon */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class InventoryCoupon { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/InventoryReferral.java b/src/main/java/one/talon/model/InventoryReferral.java index 91d78684..0c83de05 100644 --- a/src/main/java/one/talon/model/InventoryReferral.java +++ b/src/main/java/one/talon/model/InventoryReferral.java @@ -51,7 +51,7 @@ /** * InventoryReferral */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class InventoryReferral { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -286,7 +286,7 @@ public InventoryReferral attributes(@javax.annotation.Nullable Object attributes } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/ItemAttribute.java b/src/main/java/one/talon/model/ItemAttribute.java index 68e86a3c..b00c9ba8 100644 --- a/src/main/java/one/talon/model/ItemAttribute.java +++ b/src/main/java/one/talon/model/ItemAttribute.java @@ -48,7 +48,7 @@ /** * ItemAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ItemAttribute { public static final String SERIALIZED_NAME_ATTRIBUTEID = "attributeid"; @SerializedName(SERIALIZED_NAME_ATTRIBUTEID) diff --git a/src/main/java/one/talon/model/LabelTargetAudience.java b/src/main/java/one/talon/model/LabelTargetAudience.java index bd79896f..25116668 100644 --- a/src/main/java/one/talon/model/LabelTargetAudience.java +++ b/src/main/java/one/talon/model/LabelTargetAudience.java @@ -49,7 +49,7 @@ /** * Represents the targeted audience. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LabelTargetAudience { /** * Gets or Sets type diff --git a/src/main/java/one/talon/model/LabelTargetNone.java b/src/main/java/one/talon/model/LabelTargetNone.java index 70c3b690..9b308138 100644 --- a/src/main/java/one/talon/model/LabelTargetNone.java +++ b/src/main/java/one/talon/model/LabelTargetNone.java @@ -48,7 +48,7 @@ /** * Represents the target type when no entity is selected. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LabelTargetNone { /** * Gets or Sets type diff --git a/src/main/java/one/talon/model/LedgerEntry.java b/src/main/java/one/talon/model/LedgerEntry.java index a7262419..cdc69dbd 100644 --- a/src/main/java/one/talon/model/LedgerEntry.java +++ b/src/main/java/one/talon/model/LedgerEntry.java @@ -49,7 +49,7 @@ /** * LedgerEntry */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LedgerEntry { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LedgerInfo.java b/src/main/java/one/talon/model/LedgerInfo.java index 3a16f08c..f48ddd28 100644 --- a/src/main/java/one/talon/model/LedgerInfo.java +++ b/src/main/java/one/talon/model/LedgerInfo.java @@ -50,7 +50,7 @@ /** * LedgerInfo */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LedgerInfo { public static final String SERIALIZED_NAME_CURRENT_BALANCE = "currentBalance"; @SerializedName(SERIALIZED_NAME_CURRENT_BALANCE) diff --git a/src/main/java/one/talon/model/LedgerPointsEntryIntegrationAPI.java b/src/main/java/one/talon/model/LedgerPointsEntryIntegrationAPI.java index 74f71271..9ecb5f37 100644 --- a/src/main/java/one/talon/model/LedgerPointsEntryIntegrationAPI.java +++ b/src/main/java/one/talon/model/LedgerPointsEntryIntegrationAPI.java @@ -50,7 +50,7 @@ /** * Loyalty profile points with start and expiry dates. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LedgerPointsEntryIntegrationAPI { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LedgerTransactionLogEntryIntegrationAPI.java b/src/main/java/one/talon/model/LedgerTransactionLogEntryIntegrationAPI.java index 16303acf..1fbff880 100644 --- a/src/main/java/one/talon/model/LedgerTransactionLogEntryIntegrationAPI.java +++ b/src/main/java/one/talon/model/LedgerTransactionLogEntryIntegrationAPI.java @@ -51,7 +51,7 @@ /** * Log entry for a given loyalty profile transaction. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LedgerTransactionLogEntryIntegrationAPI { public static final String SERIALIZED_NAME_TRANSACTION_U_U_I_D = "transactionUUID"; @SerializedName(SERIALIZED_NAME_TRANSACTION_U_U_I_D) diff --git a/src/main/java/one/talon/model/LibraryAttribute.java b/src/main/java/one/talon/model/LibraryAttribute.java index a96dc3fc..55392e30 100644 --- a/src/main/java/one/talon/model/LibraryAttribute.java +++ b/src/main/java/one/talon/model/LibraryAttribute.java @@ -50,7 +50,7 @@ /** * LibraryAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LibraryAttribute { /** * The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. diff --git a/src/main/java/one/talon/model/LimitConfig.java b/src/main/java/one/talon/model/LimitConfig.java index a79bfd98..55dcc006 100644 --- a/src/main/java/one/talon/model/LimitConfig.java +++ b/src/main/java/one/talon/model/LimitConfig.java @@ -51,7 +51,7 @@ /** * LimitConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LimitConfig { public static final String SERIALIZED_NAME_ACTION = "action"; @SerializedName(SERIALIZED_NAME_ACTION) diff --git a/src/main/java/one/talon/model/LimitCounter.java b/src/main/java/one/talon/model/LimitCounter.java index 5316d0ab..4e4ac4c9 100644 --- a/src/main/java/one/talon/model/LimitCounter.java +++ b/src/main/java/one/talon/model/LimitCounter.java @@ -49,7 +49,7 @@ /** * LimitCounter */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LimitCounter { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/ListAccountCollections200Response.java b/src/main/java/one/talon/model/ListAccountCollections200Response.java index d6fd2576..c7c9b937 100644 --- a/src/main/java/one/talon/model/ListAccountCollections200Response.java +++ b/src/main/java/one/talon/model/ListAccountCollections200Response.java @@ -51,7 +51,7 @@ /** * ListAccountCollections200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListAccountCollections200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/ListAchievements200Response.java b/src/main/java/one/talon/model/ListAchievements200Response.java index 27241c4b..5776dde4 100644 --- a/src/main/java/one/talon/model/ListAchievements200Response.java +++ b/src/main/java/one/talon/model/ListAchievements200Response.java @@ -51,7 +51,7 @@ /** * ListAchievements200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListAchievements200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/ListAllRolesV2200Response.java b/src/main/java/one/talon/model/ListAllRolesV2200Response.java index fb493fe4..c882dfee 100644 --- a/src/main/java/one/talon/model/ListAllRolesV2200Response.java +++ b/src/main/java/one/talon/model/ListAllRolesV2200Response.java @@ -51,7 +51,7 @@ /** * ListAllRolesV2200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListAllRolesV2200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/ListApplicationCartItemFilters200Response.java b/src/main/java/one/talon/model/ListApplicationCartItemFilters200Response.java index 4aaab2d8..f948f996 100644 --- a/src/main/java/one/talon/model/ListApplicationCartItemFilters200Response.java +++ b/src/main/java/one/talon/model/ListApplicationCartItemFilters200Response.java @@ -51,7 +51,7 @@ /** * ListApplicationCartItemFilters200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListApplicationCartItemFilters200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/ListCampaignStoreBudgetLimits200Response.java b/src/main/java/one/talon/model/ListCampaignStoreBudgetLimits200Response.java index 34bee522..5b1213ec 100644 --- a/src/main/java/one/talon/model/ListCampaignStoreBudgetLimits200Response.java +++ b/src/main/java/one/talon/model/ListCampaignStoreBudgetLimits200Response.java @@ -51,7 +51,7 @@ /** * ListCampaignStoreBudgetLimits200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListCampaignStoreBudgetLimits200Response { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/ListCampaignStoreBudgets.java b/src/main/java/one/talon/model/ListCampaignStoreBudgets.java index b0fb2454..69e77b73 100644 --- a/src/main/java/one/talon/model/ListCampaignStoreBudgets.java +++ b/src/main/java/one/talon/model/ListCampaignStoreBudgets.java @@ -49,7 +49,7 @@ /** * ListCampaignStoreBudgets */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListCampaignStoreBudgets { public static final String SERIALIZED_NAME_STORE = "store"; @SerializedName(SERIALIZED_NAME_STORE) diff --git a/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java b/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java index dd7cf823..c8d42562 100644 --- a/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java +++ b/src/main/java/one/talon/model/ListCampaignStoreBudgetsStore.java @@ -48,7 +48,7 @@ /** * ListCampaignStoreBudgetsStore */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListCampaignStoreBudgetsStore { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ListCatalogItems200Response.java b/src/main/java/one/talon/model/ListCatalogItems200Response.java index 332c71b1..0a14d5c2 100644 --- a/src/main/java/one/talon/model/ListCatalogItems200Response.java +++ b/src/main/java/one/talon/model/ListCatalogItems200Response.java @@ -51,7 +51,7 @@ /** * ListCatalogItems200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListCatalogItems200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/ListExperiments200Response.java b/src/main/java/one/talon/model/ListExperiments200Response.java index a6598e5a..d3069c47 100644 --- a/src/main/java/one/talon/model/ListExperiments200Response.java +++ b/src/main/java/one/talon/model/ListExperiments200Response.java @@ -51,7 +51,7 @@ /** * ListExperiments200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListExperiments200Response { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "totalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/ListStores200Response.java b/src/main/java/one/talon/model/ListStores200Response.java index b95d454b..35029ef7 100644 --- a/src/main/java/one/talon/model/ListStores200Response.java +++ b/src/main/java/one/talon/model/ListStores200Response.java @@ -51,7 +51,7 @@ /** * ListStores200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ListStores200Response { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/LoginParams.java b/src/main/java/one/talon/model/LoginParams.java index dc418baa..d0e1d556 100644 --- a/src/main/java/one/talon/model/LoginParams.java +++ b/src/main/java/one/talon/model/LoginParams.java @@ -48,7 +48,7 @@ /** * LoginParams */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoginParams { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/Loyalty.java b/src/main/java/one/talon/model/Loyalty.java index 2276fda2..4ebbbf4f 100644 --- a/src/main/java/one/talon/model/Loyalty.java +++ b/src/main/java/one/talon/model/Loyalty.java @@ -54,7 +54,7 @@ /** * Customer-specific information about loyalty points. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Loyalty { public static final String SERIALIZED_NAME_CARDS = "cards"; @SerializedName(SERIALIZED_NAME_CARDS) diff --git a/src/main/java/one/talon/model/LoyaltyBalance.java b/src/main/java/one/talon/model/LoyaltyBalance.java index 06f2175e..28cff60a 100644 --- a/src/main/java/one/talon/model/LoyaltyBalance.java +++ b/src/main/java/one/talon/model/LoyaltyBalance.java @@ -49,7 +49,7 @@ /** * Point balance of a ledger in the Loyalty Program. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyBalance { public static final String SERIALIZED_NAME_ACTIVE_POINTS = "activePoints"; @SerializedName(SERIALIZED_NAME_ACTIVE_POINTS) diff --git a/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java b/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java index b0835554..a25216a6 100644 --- a/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java +++ b/src/main/java/one/talon/model/LoyaltyBalanceWithTier.java @@ -51,7 +51,7 @@ /** * LoyaltyBalanceWithTier */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyBalanceWithTier { public static final String SERIALIZED_NAME_ACTIVE_POINTS = "activePoints"; @SerializedName(SERIALIZED_NAME_ACTIVE_POINTS) diff --git a/src/main/java/one/talon/model/LoyaltyBalances.java b/src/main/java/one/talon/model/LoyaltyBalances.java index 7e2f6413..c54097a2 100644 --- a/src/main/java/one/talon/model/LoyaltyBalances.java +++ b/src/main/java/one/talon/model/LoyaltyBalances.java @@ -51,7 +51,7 @@ /** * List of loyalty balances for a ledger and its subledgers. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyBalances { public static final String SERIALIZED_NAME_BALANCE = "balance"; @SerializedName(SERIALIZED_NAME_BALANCE) diff --git a/src/main/java/one/talon/model/LoyaltyBalancesWithTiers.java b/src/main/java/one/talon/model/LoyaltyBalancesWithTiers.java index 7fe03603..9f85904a 100644 --- a/src/main/java/one/talon/model/LoyaltyBalancesWithTiers.java +++ b/src/main/java/one/talon/model/LoyaltyBalancesWithTiers.java @@ -51,7 +51,7 @@ /** * List of loyalty balances for a ledger and its subledgers. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyBalancesWithTiers { public static final String SERIALIZED_NAME_BALANCE = "balance"; @SerializedName(SERIALIZED_NAME_BALANCE) diff --git a/src/main/java/one/talon/model/LoyaltyCard.java b/src/main/java/one/talon/model/LoyaltyCard.java index 207d00d5..17b3bc0b 100644 --- a/src/main/java/one/talon/model/LoyaltyCard.java +++ b/src/main/java/one/talon/model/LoyaltyCard.java @@ -55,7 +55,7 @@ /** * LoyaltyCard */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCard { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LoyaltyCardBalances.java b/src/main/java/one/talon/model/LoyaltyCardBalances.java index cd497b27..9b5e1ec8 100644 --- a/src/main/java/one/talon/model/LoyaltyCardBalances.java +++ b/src/main/java/one/talon/model/LoyaltyCardBalances.java @@ -54,7 +54,7 @@ /** * LoyaltyCardBalances */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCardBalances { public static final String SERIALIZED_NAME_BALANCE = "balance"; @SerializedName(SERIALIZED_NAME_BALANCE) diff --git a/src/main/java/one/talon/model/LoyaltyCardBatch.java b/src/main/java/one/talon/model/LoyaltyCardBatch.java index 44135d27..dce7601d 100644 --- a/src/main/java/one/talon/model/LoyaltyCardBatch.java +++ b/src/main/java/one/talon/model/LoyaltyCardBatch.java @@ -49,7 +49,7 @@ /** * LoyaltyCardBatch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCardBatch { public static final String SERIALIZED_NAME_NUMBER_OF_CARDS = "numberOfCards"; @SerializedName(SERIALIZED_NAME_NUMBER_OF_CARDS) diff --git a/src/main/java/one/talon/model/LoyaltyCardBatchResponse.java b/src/main/java/one/talon/model/LoyaltyCardBatchResponse.java index 118919f2..d1e4257a 100644 --- a/src/main/java/one/talon/model/LoyaltyCardBatchResponse.java +++ b/src/main/java/one/talon/model/LoyaltyCardBatchResponse.java @@ -48,7 +48,7 @@ /** * LoyaltyCardBatchResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCardBatchResponse { public static final String SERIALIZED_NAME_NUMBER_OF_CARDS_GENERATED = "numberOfCardsGenerated"; @SerializedName(SERIALIZED_NAME_NUMBER_OF_CARDS_GENERATED) diff --git a/src/main/java/one/talon/model/LoyaltyCardProfileRegistration.java b/src/main/java/one/talon/model/LoyaltyCardProfileRegistration.java index 63106c5c..72a59f09 100644 --- a/src/main/java/one/talon/model/LoyaltyCardProfileRegistration.java +++ b/src/main/java/one/talon/model/LoyaltyCardProfileRegistration.java @@ -49,7 +49,7 @@ /** * LoyaltyCardProfileRegistration */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCardProfileRegistration { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/LoyaltyCardRegistration.java b/src/main/java/one/talon/model/LoyaltyCardRegistration.java index 09422503..9a5abfea 100644 --- a/src/main/java/one/talon/model/LoyaltyCardRegistration.java +++ b/src/main/java/one/talon/model/LoyaltyCardRegistration.java @@ -48,7 +48,7 @@ /** * LoyaltyCardRegistration */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyCardRegistration { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/LoyaltyDashboardData.java b/src/main/java/one/talon/model/LoyaltyDashboardData.java index b0366af9..9e842c8c 100644 --- a/src/main/java/one/talon/model/LoyaltyDashboardData.java +++ b/src/main/java/one/talon/model/LoyaltyDashboardData.java @@ -51,7 +51,7 @@ /** * Datapoint for the graphs and cards on a loyalty program dashboard. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyDashboardData { public static final String SERIALIZED_NAME_DATE = "date"; @SerializedName(SERIALIZED_NAME_DATE) diff --git a/src/main/java/one/talon/model/LoyaltyDashboardPointsBreakdown.java b/src/main/java/one/talon/model/LoyaltyDashboardPointsBreakdown.java index 45610597..7364bf22 100644 --- a/src/main/java/one/talon/model/LoyaltyDashboardPointsBreakdown.java +++ b/src/main/java/one/talon/model/LoyaltyDashboardPointsBreakdown.java @@ -49,7 +49,7 @@ /** * LoyaltyDashboardPointsBreakdown */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyDashboardPointsBreakdown { public static final String SERIALIZED_NAME_CREATED_MANUALLY = "createdManually"; @SerializedName(SERIALIZED_NAME_CREATED_MANUALLY) diff --git a/src/main/java/one/talon/model/LoyaltyLedger.java b/src/main/java/one/talon/model/LoyaltyLedger.java index d87513c6..adf94fc1 100644 --- a/src/main/java/one/talon/model/LoyaltyLedger.java +++ b/src/main/java/one/talon/model/LoyaltyLedger.java @@ -51,7 +51,7 @@ /** * Ledger of Balance in Loyalty Program for a Customer. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyLedger { public static final String SERIALIZED_NAME_LEDGER = "ledger"; @SerializedName(SERIALIZED_NAME_LEDGER) diff --git a/src/main/java/one/talon/model/LoyaltyLedgerEntry.java b/src/main/java/one/talon/model/LoyaltyLedgerEntry.java index 9cc37303..d57ea48d 100644 --- a/src/main/java/one/talon/model/LoyaltyLedgerEntry.java +++ b/src/main/java/one/talon/model/LoyaltyLedgerEntry.java @@ -51,7 +51,7 @@ /** * A single row of the ledger, describing one addition or deduction. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyLedgerEntry { public static final String SERIALIZED_NAME_CREATED = "created"; @SerializedName(SERIALIZED_NAME_CREATED) diff --git a/src/main/java/one/talon/model/LoyaltyLedgerEntryExpiryDateChange.java b/src/main/java/one/talon/model/LoyaltyLedgerEntryExpiryDateChange.java index 51a1275e..ce142893 100644 --- a/src/main/java/one/talon/model/LoyaltyLedgerEntryExpiryDateChange.java +++ b/src/main/java/one/talon/model/LoyaltyLedgerEntryExpiryDateChange.java @@ -50,7 +50,7 @@ /** * The properties specific to effects for changing the expiry dates of loyalty ledger entries. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyLedgerEntryExpiryDateChange { public static final String SERIALIZED_NAME_TRANSACTION_U_U_I_D = "transactionUUID"; @SerializedName(SERIALIZED_NAME_TRANSACTION_U_U_I_D) diff --git a/src/main/java/one/talon/model/LoyaltyLedgerEntryFlags.java b/src/main/java/one/talon/model/LoyaltyLedgerEntryFlags.java index 26846902..b14e2807 100644 --- a/src/main/java/one/talon/model/LoyaltyLedgerEntryFlags.java +++ b/src/main/java/one/talon/model/LoyaltyLedgerEntryFlags.java @@ -48,7 +48,7 @@ /** * A map of flags providing additional details about the entry. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyLedgerEntryFlags { public static final String SERIALIZED_NAME_CREATES_NEGATIVE_BALANCE = "createsNegativeBalance"; @SerializedName(SERIALIZED_NAME_CREATES_NEGATIVE_BALANCE) diff --git a/src/main/java/one/talon/model/LoyaltyLedgerTransactions.java b/src/main/java/one/talon/model/LoyaltyLedgerTransactions.java index 64673856..346fea90 100644 --- a/src/main/java/one/talon/model/LoyaltyLedgerTransactions.java +++ b/src/main/java/one/talon/model/LoyaltyLedgerTransactions.java @@ -51,7 +51,7 @@ /** * List of loyalty ledger transactions. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyLedgerTransactions { public static final String SERIALIZED_NAME_HAS_MORE = "hasMore"; @SerializedName(SERIALIZED_NAME_HAS_MORE) diff --git a/src/main/java/one/talon/model/LoyaltyMembership.java b/src/main/java/one/talon/model/LoyaltyMembership.java index 006123ad..f605400e 100644 --- a/src/main/java/one/talon/model/LoyaltyMembership.java +++ b/src/main/java/one/talon/model/LoyaltyMembership.java @@ -49,7 +49,7 @@ /** * LoyaltyMembership */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyMembership { public static final String SERIALIZED_NAME_JOINED = "joined"; @SerializedName(SERIALIZED_NAME_JOINED) diff --git a/src/main/java/one/talon/model/LoyaltyProgram.java b/src/main/java/one/talon/model/LoyaltyProgram.java index 79378d76..a8a0e5b0 100644 --- a/src/main/java/one/talon/model/LoyaltyProgram.java +++ b/src/main/java/one/talon/model/LoyaltyProgram.java @@ -53,7 +53,7 @@ /** * LoyaltyProgram */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyProgram { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LoyaltyProgramBalance.java b/src/main/java/one/talon/model/LoyaltyProgramBalance.java index bf515dcd..4d518368 100644 --- a/src/main/java/one/talon/model/LoyaltyProgramBalance.java +++ b/src/main/java/one/talon/model/LoyaltyProgramBalance.java @@ -49,7 +49,7 @@ /** * The balance in a Loyalty Program for some Customer. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyProgramBalance { public static final String SERIALIZED_NAME_CURRENT_BALANCE = "currentBalance"; @SerializedName(SERIALIZED_NAME_CURRENT_BALANCE) diff --git a/src/main/java/one/talon/model/LoyaltyProgramEntity.java b/src/main/java/one/talon/model/LoyaltyProgramEntity.java index 8e19009b..cce6771d 100644 --- a/src/main/java/one/talon/model/LoyaltyProgramEntity.java +++ b/src/main/java/one/talon/model/LoyaltyProgramEntity.java @@ -48,7 +48,7 @@ /** * LoyaltyProgramEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyProgramEntity { public static final String SERIALIZED_NAME_PROGRAM_I_D = "programID"; @SerializedName(SERIALIZED_NAME_PROGRAM_I_D) diff --git a/src/main/java/one/talon/model/LoyaltyProgramLedgers.java b/src/main/java/one/talon/model/LoyaltyProgramLedgers.java index 99e147e1..cd34db07 100644 --- a/src/main/java/one/talon/model/LoyaltyProgramLedgers.java +++ b/src/main/java/one/talon/model/LoyaltyProgramLedgers.java @@ -52,7 +52,7 @@ /** * Customer-specific information about loyalty points. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyProgramLedgers { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LoyaltyProgramTransaction.java b/src/main/java/one/talon/model/LoyaltyProgramTransaction.java index e2b9c639..86df9dfb 100644 --- a/src/main/java/one/talon/model/LoyaltyProgramTransaction.java +++ b/src/main/java/one/talon/model/LoyaltyProgramTransaction.java @@ -51,7 +51,7 @@ /** * LoyaltyProgramTransaction */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyProgramTransaction { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/LoyaltySubLedger.java b/src/main/java/one/talon/model/LoyaltySubLedger.java index 49ddbc2f..fc35df30 100644 --- a/src/main/java/one/talon/model/LoyaltySubLedger.java +++ b/src/main/java/one/talon/model/LoyaltySubLedger.java @@ -53,7 +53,7 @@ /** * Ledger of Balance in Loyalty Program for a Customer. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltySubLedger { public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) diff --git a/src/main/java/one/talon/model/LoyaltyTier.java b/src/main/java/one/talon/model/LoyaltyTier.java index ebf19d7a..0f72ff77 100644 --- a/src/main/java/one/talon/model/LoyaltyTier.java +++ b/src/main/java/one/talon/model/LoyaltyTier.java @@ -50,7 +50,7 @@ /** * LoyaltyTier */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class LoyaltyTier { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/MCPKey.java b/src/main/java/one/talon/model/MCPKey.java index 16e4ba8a..9bbf5b28 100644 --- a/src/main/java/one/talon/model/MCPKey.java +++ b/src/main/java/one/talon/model/MCPKey.java @@ -49,7 +49,7 @@ /** * MCPKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MCPKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/ManagementKey.java b/src/main/java/one/talon/model/ManagementKey.java index b3c1413e..0c23b3f4 100644 --- a/src/main/java/one/talon/model/ManagementKey.java +++ b/src/main/java/one/talon/model/ManagementKey.java @@ -52,7 +52,7 @@ /** * ManagementKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ManagementKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/ManagerConfig.java b/src/main/java/one/talon/model/ManagerConfig.java index d2944134..9b7581b1 100644 --- a/src/main/java/one/talon/model/ManagerConfig.java +++ b/src/main/java/one/talon/model/ManagerConfig.java @@ -48,7 +48,7 @@ /** * ManagerConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ManagerConfig { public static final String SERIALIZED_NAME_SCHEMA_VERSION = "schemaVersion"; @SerializedName(SERIALIZED_NAME_SCHEMA_VERSION) diff --git a/src/main/java/one/talon/model/MessageLogEntries.java b/src/main/java/one/talon/model/MessageLogEntries.java index 08fc1b29..ccda71dc 100644 --- a/src/main/java/one/talon/model/MessageLogEntries.java +++ b/src/main/java/one/talon/model/MessageLogEntries.java @@ -51,7 +51,7 @@ /** * MessageLogEntries */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MessageLogEntries { public static final String SERIALIZED_NAME_NEXT_CURSOR = "nextCursor"; @SerializedName(SERIALIZED_NAME_NEXT_CURSOR) diff --git a/src/main/java/one/talon/model/MessageLogEntry.java b/src/main/java/one/talon/model/MessageLogEntry.java index 0b5861ce..90a35783 100644 --- a/src/main/java/one/talon/model/MessageLogEntry.java +++ b/src/main/java/one/talon/model/MessageLogEntry.java @@ -51,7 +51,7 @@ /** * Message Log. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MessageLogEntry { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/MessageLogRequest.java b/src/main/java/one/talon/model/MessageLogRequest.java index 4a0403b9..f1110433 100644 --- a/src/main/java/one/talon/model/MessageLogRequest.java +++ b/src/main/java/one/talon/model/MessageLogRequest.java @@ -49,7 +49,7 @@ /** * Details of the request. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MessageLogRequest { public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; @SerializedName(SERIALIZED_NAME_CREATED_AT) diff --git a/src/main/java/one/talon/model/MessageLogResponse.java b/src/main/java/one/talon/model/MessageLogResponse.java index 0b112587..916d1897 100644 --- a/src/main/java/one/talon/model/MessageLogResponse.java +++ b/src/main/java/one/talon/model/MessageLogResponse.java @@ -49,7 +49,7 @@ /** * Details of the response. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MessageLogResponse { public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; @SerializedName(SERIALIZED_NAME_CREATED_AT) diff --git a/src/main/java/one/talon/model/MessageTest.java b/src/main/java/one/talon/model/MessageTest.java index 20d18580..b6c6bd85 100644 --- a/src/main/java/one/talon/model/MessageTest.java +++ b/src/main/java/one/talon/model/MessageTest.java @@ -48,7 +48,7 @@ /** * MessageTest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MessageTest { public static final String SERIALIZED_NAME_HTTP_RESPONSE = "httpResponse"; @SerializedName(SERIALIZED_NAME_HTTP_RESPONSE) diff --git a/src/main/java/one/talon/model/Meta.java b/src/main/java/one/talon/model/Meta.java index 82a238dd..2163e59c 100644 --- a/src/main/java/one/talon/model/Meta.java +++ b/src/main/java/one/talon/model/Meta.java @@ -50,7 +50,7 @@ /** * Meta */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Meta { public static final String SERIALIZED_NAME_CAMPAIGNS = "campaigns"; @SerializedName(SERIALIZED_NAME_CAMPAIGNS) diff --git a/src/main/java/one/talon/model/ModelImport.java b/src/main/java/one/talon/model/ModelImport.java index a7bce25f..33b7f6bb 100644 --- a/src/main/java/one/talon/model/ModelImport.java +++ b/src/main/java/one/talon/model/ModelImport.java @@ -49,7 +49,7 @@ /** * ModelImport */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ModelImport { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ModelReturn.java b/src/main/java/one/talon/model/ModelReturn.java index cb811064..d9d591d4 100644 --- a/src/main/java/one/talon/model/ModelReturn.java +++ b/src/main/java/one/talon/model/ModelReturn.java @@ -52,7 +52,7 @@ /** * ModelReturn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ModelReturn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/MultiApplicationEntity.java b/src/main/java/one/talon/model/MultiApplicationEntity.java index 5dd7dec2..42cd695d 100644 --- a/src/main/java/one/talon/model/MultiApplicationEntity.java +++ b/src/main/java/one/talon/model/MultiApplicationEntity.java @@ -50,7 +50,7 @@ /** * MultiApplicationEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultiApplicationEntity { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; @SerializedName(SERIALIZED_NAME_APPLICATION_IDS) diff --git a/src/main/java/one/talon/model/MultipleAttribute.java b/src/main/java/one/talon/model/MultipleAttribute.java index b7377991..f0014050 100644 --- a/src/main/java/one/talon/model/MultipleAttribute.java +++ b/src/main/java/one/talon/model/MultipleAttribute.java @@ -51,7 +51,7 @@ /** * MultipleAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleAttribute { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/MultipleAudiences.java b/src/main/java/one/talon/model/MultipleAudiences.java index 36888a9f..b4fea600 100644 --- a/src/main/java/one/talon/model/MultipleAudiences.java +++ b/src/main/java/one/talon/model/MultipleAudiences.java @@ -51,7 +51,7 @@ /** * MultipleAudiences */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleAudiences { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/MultipleAudiencesItem.java b/src/main/java/one/talon/model/MultipleAudiencesItem.java index 38173f06..6986d494 100644 --- a/src/main/java/one/talon/model/MultipleAudiencesItem.java +++ b/src/main/java/one/talon/model/MultipleAudiencesItem.java @@ -51,7 +51,7 @@ /** * MultipleAudiencesItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleAudiencesItem { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequest.java b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequest.java index e8ebce9d..01a32b95 100644 --- a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequest.java +++ b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequest.java @@ -51,7 +51,7 @@ /** * MultipleCustomerProfileIntegrationRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleCustomerProfileIntegrationRequest { public static final String SERIALIZED_NAME_CUSTOMER_PROFILES = "customerProfiles"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILES) diff --git a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequestItem.java b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequestItem.java index dad67046..37f007c9 100644 --- a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequestItem.java +++ b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationRequestItem.java @@ -50,7 +50,7 @@ /** * MultipleCustomerProfileIntegrationRequestItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleCustomerProfileIntegrationRequestItem { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationResponseV2.java b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationResponseV2.java index bd1c8609..5a4008a1 100644 --- a/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationResponseV2.java +++ b/src/main/java/one/talon/model/MultipleCustomerProfileIntegrationResponseV2.java @@ -51,7 +51,7 @@ /** * MultipleCustomerProfileIntegrationResponseV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleCustomerProfileIntegrationResponseV2 { public static final String SERIALIZED_NAME_INTEGRATION_STATES = "integrationStates"; @SerializedName(SERIALIZED_NAME_INTEGRATION_STATES) diff --git a/src/main/java/one/talon/model/MultipleNewAttribute.java b/src/main/java/one/talon/model/MultipleNewAttribute.java index 606a4bf1..1e3d97fa 100644 --- a/src/main/java/one/talon/model/MultipleNewAttribute.java +++ b/src/main/java/one/talon/model/MultipleNewAttribute.java @@ -51,7 +51,7 @@ /** * MultipleNewAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleNewAttribute { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/MultipleNewAudiences.java b/src/main/java/one/talon/model/MultipleNewAudiences.java index 688fb60a..c09fd421 100644 --- a/src/main/java/one/talon/model/MultipleNewAudiences.java +++ b/src/main/java/one/talon/model/MultipleNewAudiences.java @@ -51,7 +51,7 @@ /** * MultipleNewAudiences */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MultipleNewAudiences { public static final String SERIALIZED_NAME_AUDIENCES = "audiences"; @SerializedName(SERIALIZED_NAME_AUDIENCES) diff --git a/src/main/java/one/talon/model/MutableEntity.java b/src/main/java/one/talon/model/MutableEntity.java index 0897bea4..fbf2a2d4 100644 --- a/src/main/java/one/talon/model/MutableEntity.java +++ b/src/main/java/one/talon/model/MutableEntity.java @@ -49,7 +49,7 @@ /** * MutableEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class MutableEntity { public static final String SERIALIZED_NAME_MODIFIED = "modified"; @SerializedName(SERIALIZED_NAME_MODIFIED) diff --git a/src/main/java/one/talon/model/NewAccount.java b/src/main/java/one/talon/model/NewAccount.java index 7deb7a98..158bebd0 100644 --- a/src/main/java/one/talon/model/NewAccount.java +++ b/src/main/java/one/talon/model/NewAccount.java @@ -48,7 +48,7 @@ /** * NewAccount */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAccount { public static final String SERIALIZED_NAME_COMPANY_NAME = "companyName"; @SerializedName(SERIALIZED_NAME_COMPANY_NAME) diff --git a/src/main/java/one/talon/model/NewAccountSignUp.java b/src/main/java/one/talon/model/NewAccountSignUp.java index a788ca7c..886a04ac 100644 --- a/src/main/java/one/talon/model/NewAccountSignUp.java +++ b/src/main/java/one/talon/model/NewAccountSignUp.java @@ -48,7 +48,7 @@ /** * NewAccountSignUp */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAccountSignUp { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/NewAdditionalCost.java b/src/main/java/one/talon/model/NewAdditionalCost.java index 36bb354a..4e9794dd 100644 --- a/src/main/java/one/talon/model/NewAdditionalCost.java +++ b/src/main/java/one/talon/model/NewAdditionalCost.java @@ -50,7 +50,7 @@ /** * NewAdditionalCost */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAdditionalCost { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewAppWideCouponDeletionJob.java b/src/main/java/one/talon/model/NewAppWideCouponDeletionJob.java index 271f26d2..3c4b3e1a 100644 --- a/src/main/java/one/talon/model/NewAppWideCouponDeletionJob.java +++ b/src/main/java/one/talon/model/NewAppWideCouponDeletionJob.java @@ -51,7 +51,7 @@ /** * NewAppWideCouponDeletionJob */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAppWideCouponDeletionJob { public static final String SERIALIZED_NAME_FILTERS = "filters"; @SerializedName(SERIALIZED_NAME_FILTERS) diff --git a/src/main/java/one/talon/model/NewApplication.java b/src/main/java/one/talon/model/NewApplication.java index ff3a236d..48774f62 100644 --- a/src/main/java/one/talon/model/NewApplication.java +++ b/src/main/java/one/talon/model/NewApplication.java @@ -52,7 +52,7 @@ /** * NewApplication */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewApplication { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewApplicationAPIKey.java b/src/main/java/one/talon/model/NewApplicationAPIKey.java index 9fae7cf5..f2abbc67 100644 --- a/src/main/java/one/talon/model/NewApplicationAPIKey.java +++ b/src/main/java/one/talon/model/NewApplicationAPIKey.java @@ -49,7 +49,7 @@ /** * NewApplicationAPIKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewApplicationAPIKey { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewApplicationCIF.java b/src/main/java/one/talon/model/NewApplicationCIF.java index b862a9ed..abc98ee5 100644 --- a/src/main/java/one/talon/model/NewApplicationCIF.java +++ b/src/main/java/one/talon/model/NewApplicationCIF.java @@ -49,7 +49,7 @@ /** * NewApplicationCIF */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewApplicationCIF { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewApplicationCIFExpression.java b/src/main/java/one/talon/model/NewApplicationCIFExpression.java index e5fb00c0..7079eeb1 100644 --- a/src/main/java/one/talon/model/NewApplicationCIFExpression.java +++ b/src/main/java/one/talon/model/NewApplicationCIFExpression.java @@ -50,7 +50,7 @@ /** * NewApplicationCIFExpression */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewApplicationCIFExpression { public static final String SERIALIZED_NAME_CART_ITEM_FILTER_ID = "cartItemFilterId"; @SerializedName(SERIALIZED_NAME_CART_ITEM_FILTER_ID) diff --git a/src/main/java/one/talon/model/NewAttribute.java b/src/main/java/one/talon/model/NewAttribute.java index d74f52f8..7f1aa94d 100644 --- a/src/main/java/one/talon/model/NewAttribute.java +++ b/src/main/java/one/talon/model/NewAttribute.java @@ -50,7 +50,7 @@ /** * NewAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAttribute { /** * The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. diff --git a/src/main/java/one/talon/model/NewAudience.java b/src/main/java/one/talon/model/NewAudience.java index 5556e043..c75cf15a 100644 --- a/src/main/java/one/talon/model/NewAudience.java +++ b/src/main/java/one/talon/model/NewAudience.java @@ -51,7 +51,7 @@ /** * NewAudience */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewAudience { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewBaseNotification.java b/src/main/java/one/talon/model/NewBaseNotification.java index 4ec65c4d..ee28b712 100644 --- a/src/main/java/one/talon/model/NewBaseNotification.java +++ b/src/main/java/one/talon/model/NewBaseNotification.java @@ -49,7 +49,7 @@ /** * NewBaseNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewBaseNotification { public static final String SERIALIZED_NAME_POLICY = "policy"; @SerializedName(SERIALIZED_NAME_POLICY) diff --git a/src/main/java/one/talon/model/NewBlueprint.java b/src/main/java/one/talon/model/NewBlueprint.java index 6489e031..da38ff2f 100644 --- a/src/main/java/one/talon/model/NewBlueprint.java +++ b/src/main/java/one/talon/model/NewBlueprint.java @@ -52,7 +52,7 @@ /** * NewBlueprint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewBlueprint { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewCampaign.java b/src/main/java/one/talon/model/NewCampaign.java index 5e33c739..b5846e71 100644 --- a/src/main/java/one/talon/model/NewCampaign.java +++ b/src/main/java/one/talon/model/NewCampaign.java @@ -53,7 +53,7 @@ /** * NewCampaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaign { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewCampaignCollection.java b/src/main/java/one/talon/model/NewCampaignCollection.java index 9cff280e..eb54941f 100644 --- a/src/main/java/one/talon/model/NewCampaignCollection.java +++ b/src/main/java/one/talon/model/NewCampaignCollection.java @@ -48,7 +48,7 @@ /** * NewCampaignCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/NewCampaignEvaluationGroup.java b/src/main/java/one/talon/model/NewCampaignEvaluationGroup.java index f959b629..727cfa1c 100644 --- a/src/main/java/one/talon/model/NewCampaignEvaluationGroup.java +++ b/src/main/java/one/talon/model/NewCampaignEvaluationGroup.java @@ -48,7 +48,7 @@ /** * NewCampaignEvaluationGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignEvaluationGroup { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewCampaignGroup.java b/src/main/java/one/talon/model/NewCampaignGroup.java index 75188e47..f8f2d7c7 100644 --- a/src/main/java/one/talon/model/NewCampaignGroup.java +++ b/src/main/java/one/talon/model/NewCampaignGroup.java @@ -50,7 +50,7 @@ /** * NewCampaignGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignGroup { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewCampaignSet.java b/src/main/java/one/talon/model/NewCampaignSet.java index 77b8b0e7..77a9ba1b 100644 --- a/src/main/java/one/talon/model/NewCampaignSet.java +++ b/src/main/java/one/talon/model/NewCampaignSet.java @@ -49,7 +49,7 @@ /** * NewCampaignSet */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignSet { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/NewCampaignStoreBudget.java b/src/main/java/one/talon/model/NewCampaignStoreBudget.java index f2fdaad3..c8a00715 100644 --- a/src/main/java/one/talon/model/NewCampaignStoreBudget.java +++ b/src/main/java/one/talon/model/NewCampaignStoreBudget.java @@ -51,7 +51,7 @@ /** * NewCampaignStoreBudget */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignStoreBudget { /** * Gets or Sets action diff --git a/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java b/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java index fea5a1fd..f4d02e93 100644 --- a/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java +++ b/src/main/java/one/talon/model/NewCampaignStoreBudgetStoreLimit.java @@ -49,7 +49,7 @@ /** * NewCampaignStoreBudgetStoreLimit */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignStoreBudgetStoreLimit { public static final String SERIALIZED_NAME_STORE_ID = "storeId"; @SerializedName(SERIALIZED_NAME_STORE_ID) diff --git a/src/main/java/one/talon/model/NewCampaignTemplate.java b/src/main/java/one/talon/model/NewCampaignTemplate.java index f6d0270e..ae7a6758 100644 --- a/src/main/java/one/talon/model/NewCampaignTemplate.java +++ b/src/main/java/one/talon/model/NewCampaignTemplate.java @@ -55,7 +55,7 @@ /** * NewCampaignTemplate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCampaignTemplate { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewCatalog.java b/src/main/java/one/talon/model/NewCatalog.java index eddad639..c4e668e1 100644 --- a/src/main/java/one/talon/model/NewCatalog.java +++ b/src/main/java/one/talon/model/NewCatalog.java @@ -50,7 +50,7 @@ /** * NewCatalog */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCatalog { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewCollection.java b/src/main/java/one/talon/model/NewCollection.java index 6a7945b2..8536e240 100644 --- a/src/main/java/one/talon/model/NewCollection.java +++ b/src/main/java/one/talon/model/NewCollection.java @@ -50,7 +50,7 @@ /** * NewCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/NewCouponCreationJob.java b/src/main/java/one/talon/model/NewCouponCreationJob.java index 4a106718..f5a21c03 100644 --- a/src/main/java/one/talon/model/NewCouponCreationJob.java +++ b/src/main/java/one/talon/model/NewCouponCreationJob.java @@ -51,7 +51,7 @@ /** * NewCouponCreationJob */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCouponCreationJob { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) @@ -248,7 +248,7 @@ public NewCouponCreationJob attributes(@javax.annotation.Nonnull Object attribut } /** - * Arbitrary properties associated with coupons. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/NewCouponDeletionJob.java b/src/main/java/one/talon/model/NewCouponDeletionJob.java index d6b41ebf..50748233 100644 --- a/src/main/java/one/talon/model/NewCouponDeletionJob.java +++ b/src/main/java/one/talon/model/NewCouponDeletionJob.java @@ -49,7 +49,7 @@ /** * NewCouponDeletionJob */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCouponDeletionJob { public static final String SERIALIZED_NAME_FILTERS = "filters"; @SerializedName(SERIALIZED_NAME_FILTERS) diff --git a/src/main/java/one/talon/model/NewCoupons.java b/src/main/java/one/talon/model/NewCoupons.java index c3766d47..1ae55754 100644 --- a/src/main/java/one/talon/model/NewCoupons.java +++ b/src/main/java/one/talon/model/NewCoupons.java @@ -53,7 +53,7 @@ /** * NewCoupons */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCoupons { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) @@ -300,7 +300,7 @@ public NewCoupons attributes(@javax.annotation.Nullable Object attributes) { } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java b/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java index d783660d..b3c2c354 100644 --- a/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java +++ b/src/main/java/one/talon/model/NewCouponsForMultipleRecipients.java @@ -52,7 +52,7 @@ /** * NewCouponsForMultipleRecipients */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCouponsForMultipleRecipients { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) @@ -209,7 +209,7 @@ public NewCouponsForMultipleRecipients attributes(@javax.annotation.Nullable Obj } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/NewCustomEffect.java b/src/main/java/one/talon/model/NewCustomEffect.java index 8ae32766..e3262c41 100644 --- a/src/main/java/one/talon/model/NewCustomEffect.java +++ b/src/main/java/one/talon/model/NewCustomEffect.java @@ -51,7 +51,7 @@ /** * NewCustomEffect */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCustomEffect { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; @SerializedName(SERIALIZED_NAME_APPLICATION_IDS) diff --git a/src/main/java/one/talon/model/NewCustomerProfile.java b/src/main/java/one/talon/model/NewCustomerProfile.java index 65dece14..c79fdfe4 100644 --- a/src/main/java/one/talon/model/NewCustomerProfile.java +++ b/src/main/java/one/talon/model/NewCustomerProfile.java @@ -50,7 +50,7 @@ /** * NewCustomerProfile */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCustomerProfile { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/NewCustomerSession.java b/src/main/java/one/talon/model/NewCustomerSession.java index 067f5c85..685d1235 100644 --- a/src/main/java/one/talon/model/NewCustomerSession.java +++ b/src/main/java/one/talon/model/NewCustomerSession.java @@ -52,7 +52,7 @@ /** * NewCustomerSession */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCustomerSession { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) @@ -308,7 +308,7 @@ public NewCustomerSession attributes(@javax.annotation.Nullable Object attribute } /** - * A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/NewCustomerSessionV2.java b/src/main/java/one/talon/model/NewCustomerSessionV2.java index 6291cbf0..5a2caa47 100644 --- a/src/main/java/one/talon/model/NewCustomerSessionV2.java +++ b/src/main/java/one/talon/model/NewCustomerSessionV2.java @@ -55,7 +55,7 @@ /** * The representation of the customer session. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewCustomerSessionV2 { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) diff --git a/src/main/java/one/talon/model/NewEvent.java b/src/main/java/one/talon/model/NewEvent.java index 4440a45f..eea83b39 100644 --- a/src/main/java/one/talon/model/NewEvent.java +++ b/src/main/java/one/talon/model/NewEvent.java @@ -48,7 +48,7 @@ /** * NewEvent */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewEvent { public static final String SERIALIZED_NAME_PROFILE_ID = "profileId"; @SerializedName(SERIALIZED_NAME_PROFILE_ID) @@ -141,7 +141,7 @@ public NewEvent attributes(@javax.annotation.Nonnull Object attributes) { } /** - * Arbitrary additional JSON data associated with the event. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/NewEventType.java b/src/main/java/one/talon/model/NewEventType.java index 106acf73..088bbbe3 100644 --- a/src/main/java/one/talon/model/NewEventType.java +++ b/src/main/java/one/talon/model/NewEventType.java @@ -48,7 +48,7 @@ /** * NewEventType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewEventType { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewEventV3Entity.java b/src/main/java/one/talon/model/NewEventV3Entity.java index 76830fcd..1a9a1a2a 100644 --- a/src/main/java/one/talon/model/NewEventV3Entity.java +++ b/src/main/java/one/talon/model/NewEventV3Entity.java @@ -48,7 +48,7 @@ /** * NewEventV3Entity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewEventV3Entity { public static final String SERIALIZED_NAME_INTEGRATION_ID = "integrationId"; @SerializedName(SERIALIZED_NAME_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/NewExperiment.java b/src/main/java/one/talon/model/NewExperiment.java index 0f4dd26d..082712f9 100644 --- a/src/main/java/one/talon/model/NewExperiment.java +++ b/src/main/java/one/talon/model/NewExperiment.java @@ -49,7 +49,7 @@ /** * NewExperiment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewExperiment { public static final String SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL = "isVariantAssignmentExternal"; @SerializedName(SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL) diff --git a/src/main/java/one/talon/model/NewExperimentVariant.java b/src/main/java/one/talon/model/NewExperimentVariant.java index 61e39501..f886182a 100644 --- a/src/main/java/one/talon/model/NewExperimentVariant.java +++ b/src/main/java/one/talon/model/NewExperimentVariant.java @@ -49,7 +49,7 @@ /** * NewExperimentVariant */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewExperimentVariant { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewExperimentVariantArray.java b/src/main/java/one/talon/model/NewExperimentVariantArray.java index 798d5afb..2dabdbf9 100644 --- a/src/main/java/one/talon/model/NewExperimentVariantArray.java +++ b/src/main/java/one/talon/model/NewExperimentVariantArray.java @@ -51,7 +51,7 @@ /** * NewExperimentVariantArray */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewExperimentVariantArray { public static final String SERIALIZED_NAME_VARIANTS = "variants"; @SerializedName(SERIALIZED_NAME_VARIANTS) diff --git a/src/main/java/one/talon/model/NewExternalInvitation.java b/src/main/java/one/talon/model/NewExternalInvitation.java index c1ee5311..22432fbb 100644 --- a/src/main/java/one/talon/model/NewExternalInvitation.java +++ b/src/main/java/one/talon/model/NewExternalInvitation.java @@ -50,7 +50,7 @@ /** * Parameters for inviting a new user from an external identity provider. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewExternalInvitation { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewGiveawaysPool.java b/src/main/java/one/talon/model/NewGiveawaysPool.java index cc5073dc..36da8ffc 100644 --- a/src/main/java/one/talon/model/NewGiveawaysPool.java +++ b/src/main/java/one/talon/model/NewGiveawaysPool.java @@ -50,7 +50,7 @@ /** * NewGiveawaysPool */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewGiveawaysPool { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewInternalAudience.java b/src/main/java/one/talon/model/NewInternalAudience.java index ed437cc4..01331621 100644 --- a/src/main/java/one/talon/model/NewInternalAudience.java +++ b/src/main/java/one/talon/model/NewInternalAudience.java @@ -50,7 +50,7 @@ /** * NewInternalAudience */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewInternalAudience { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewInvitation.java b/src/main/java/one/talon/model/NewInvitation.java index 7c38abf4..29ca3eeb 100644 --- a/src/main/java/one/talon/model/NewInvitation.java +++ b/src/main/java/one/talon/model/NewInvitation.java @@ -50,7 +50,7 @@ /** * Parameters for inviting a new user. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewInvitation { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewInviteEmail.java b/src/main/java/one/talon/model/NewInviteEmail.java index 1c580d81..9a864c70 100644 --- a/src/main/java/one/talon/model/NewInviteEmail.java +++ b/src/main/java/one/talon/model/NewInviteEmail.java @@ -48,7 +48,7 @@ /** * NewInviteEmail */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewInviteEmail { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/NewLoyaltyProgram.java b/src/main/java/one/talon/model/NewLoyaltyProgram.java index a952a4f6..6db0b8ca 100644 --- a/src/main/java/one/talon/model/NewLoyaltyProgram.java +++ b/src/main/java/one/talon/model/NewLoyaltyProgram.java @@ -53,7 +53,7 @@ /** * NewLoyaltyProgram */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewLoyaltyProgram { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewLoyaltyTier.java b/src/main/java/one/talon/model/NewLoyaltyTier.java index f7ed5dd5..9d319683 100644 --- a/src/main/java/one/talon/model/NewLoyaltyTier.java +++ b/src/main/java/one/talon/model/NewLoyaltyTier.java @@ -49,7 +49,7 @@ /** * A tier in a loyalty program. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewLoyaltyTier { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewMCPKey.java b/src/main/java/one/talon/model/NewMCPKey.java index 353751f1..aa9d13dd 100644 --- a/src/main/java/one/talon/model/NewMCPKey.java +++ b/src/main/java/one/talon/model/NewMCPKey.java @@ -49,7 +49,7 @@ /** * NewMCPKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewMCPKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewManagementKey.java b/src/main/java/one/talon/model/NewManagementKey.java index a5007802..bad43f7a 100644 --- a/src/main/java/one/talon/model/NewManagementKey.java +++ b/src/main/java/one/talon/model/NewManagementKey.java @@ -52,7 +52,7 @@ /** * NewManagementKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewManagementKey { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewMessageTest.java b/src/main/java/one/talon/model/NewMessageTest.java index 04072391..648ea83e 100644 --- a/src/main/java/one/talon/model/NewMessageTest.java +++ b/src/main/java/one/talon/model/NewMessageTest.java @@ -53,7 +53,7 @@ /** * NewMessageTest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewMessageTest { public static final String SERIALIZED_NAME_HEADERS = "headers"; @SerializedName(SERIALIZED_NAME_HEADERS) diff --git a/src/main/java/one/talon/model/NewMultipleAudiencesItem.java b/src/main/java/one/talon/model/NewMultipleAudiencesItem.java index 5e10c5b5..696ab4fb 100644 --- a/src/main/java/one/talon/model/NewMultipleAudiencesItem.java +++ b/src/main/java/one/talon/model/NewMultipleAudiencesItem.java @@ -50,7 +50,7 @@ /** * NewMultipleAudiencesItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewMultipleAudiencesItem { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewNotificationWebhook.java b/src/main/java/one/talon/model/NewNotificationWebhook.java index a1a5689c..c5f7ac19 100644 --- a/src/main/java/one/talon/model/NewNotificationWebhook.java +++ b/src/main/java/one/talon/model/NewNotificationWebhook.java @@ -50,7 +50,7 @@ /** * NewNotificationWebhook */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewNotificationWebhook { public static final String SERIALIZED_NAME_URL = "url"; @SerializedName(SERIALIZED_NAME_URL) diff --git a/src/main/java/one/talon/model/NewOutgoingIntegrationWebhook.java b/src/main/java/one/talon/model/NewOutgoingIntegrationWebhook.java index 997a46bd..8362af53 100644 --- a/src/main/java/one/talon/model/NewOutgoingIntegrationWebhook.java +++ b/src/main/java/one/talon/model/NewOutgoingIntegrationWebhook.java @@ -50,7 +50,7 @@ /** * NewOutgoingIntegrationWebhook */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewOutgoingIntegrationWebhook { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewPassword.java b/src/main/java/one/talon/model/NewPassword.java index 356828cb..ad033a91 100644 --- a/src/main/java/one/talon/model/NewPassword.java +++ b/src/main/java/one/talon/model/NewPassword.java @@ -48,7 +48,7 @@ /** * NewPassword */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewPassword { public static final String SERIALIZED_NAME_PASSWORD = "password"; @SerializedName(SERIALIZED_NAME_PASSWORD) diff --git a/src/main/java/one/talon/model/NewPasswordEmail.java b/src/main/java/one/talon/model/NewPasswordEmail.java index 6d4fb1ed..2b24cebf 100644 --- a/src/main/java/one/talon/model/NewPasswordEmail.java +++ b/src/main/java/one/talon/model/NewPasswordEmail.java @@ -48,7 +48,7 @@ /** * NewPasswordEmail */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewPasswordEmail { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/NewPicklist.java b/src/main/java/one/talon/model/NewPicklist.java index 57e5c401..3dc22e9a 100644 --- a/src/main/java/one/talon/model/NewPicklist.java +++ b/src/main/java/one/talon/model/NewPicklist.java @@ -50,7 +50,7 @@ /** * NewPicklist */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewPicklist { /** * The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. diff --git a/src/main/java/one/talon/model/NewPriceAdjustment.java b/src/main/java/one/talon/model/NewPriceAdjustment.java index 90c729df..89bc8de6 100644 --- a/src/main/java/one/talon/model/NewPriceAdjustment.java +++ b/src/main/java/one/talon/model/NewPriceAdjustment.java @@ -51,7 +51,7 @@ /** * NewPriceAdjustment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewPriceAdjustment { public static final String SERIALIZED_NAME_PRICE_TYPE = "priceType"; @SerializedName(SERIALIZED_NAME_PRICE_TYPE) diff --git a/src/main/java/one/talon/model/NewPriceType.java b/src/main/java/one/talon/model/NewPriceType.java index 9ddce784..d3d3c1c5 100644 --- a/src/main/java/one/talon/model/NewPriceType.java +++ b/src/main/java/one/talon/model/NewPriceType.java @@ -50,7 +50,7 @@ /** * NewPriceType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewPriceType { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewReferral.java b/src/main/java/one/talon/model/NewReferral.java index 2ab49d74..2e136834 100644 --- a/src/main/java/one/talon/model/NewReferral.java +++ b/src/main/java/one/talon/model/NewReferral.java @@ -49,7 +49,7 @@ /** * NewReferral */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewReferral { public static final String SERIALIZED_NAME_START_DATE = "startDate"; @SerializedName(SERIALIZED_NAME_START_DATE) @@ -211,7 +211,7 @@ public NewReferral attributes(@javax.annotation.Nullable Object attributes) { } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/NewReferralsForMultipleAdvocates.java b/src/main/java/one/talon/model/NewReferralsForMultipleAdvocates.java index 8b5b2422..40dc716e 100644 --- a/src/main/java/one/talon/model/NewReferralsForMultipleAdvocates.java +++ b/src/main/java/one/talon/model/NewReferralsForMultipleAdvocates.java @@ -51,7 +51,7 @@ /** * NewReferralsForMultipleAdvocates */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewReferralsForMultipleAdvocates { public static final String SERIALIZED_NAME_START_DATE = "startDate"; @SerializedName(SERIALIZED_NAME_START_DATE) @@ -207,7 +207,7 @@ public NewReferralsForMultipleAdvocates attributes(@javax.annotation.Nullable Ob } /** - * Arbitrary properties associated with this referral code. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/NewReturn.java b/src/main/java/one/talon/model/NewReturn.java index 7914f7d7..d4bf9f1e 100644 --- a/src/main/java/one/talon/model/NewReturn.java +++ b/src/main/java/one/talon/model/NewReturn.java @@ -51,7 +51,7 @@ /** * NewReturn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewReturn { public static final String SERIALIZED_NAME_RETURNED_CART_ITEMS = "returnedCartItems"; @SerializedName(SERIALIZED_NAME_RETURNED_CART_ITEMS) diff --git a/src/main/java/one/talon/model/NewRevisionVersion.java b/src/main/java/one/talon/model/NewRevisionVersion.java index c7314b83..7a9ddff1 100644 --- a/src/main/java/one/talon/model/NewRevisionVersion.java +++ b/src/main/java/one/talon/model/NewRevisionVersion.java @@ -54,7 +54,7 @@ /** * NewRevisionVersion */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewRevisionVersion { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewReward.java b/src/main/java/one/talon/model/NewReward.java index 7d40520d..9f5d2775 100644 --- a/src/main/java/one/talon/model/NewReward.java +++ b/src/main/java/one/talon/model/NewReward.java @@ -50,7 +50,7 @@ /** * NewReward */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewReward { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewRiskNotification.java b/src/main/java/one/talon/model/NewRiskNotification.java index 2b87006a..b17394b9 100644 --- a/src/main/java/one/talon/model/NewRiskNotification.java +++ b/src/main/java/one/talon/model/NewRiskNotification.java @@ -48,7 +48,7 @@ /** * Data for creating a new risk notification. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewRiskNotification { /** * The entity type to analyze within the given time frame. diff --git a/src/main/java/one/talon/model/NewRole.java b/src/main/java/one/talon/model/NewRole.java index cc9e5dfe..6daea4e9 100644 --- a/src/main/java/one/talon/model/NewRole.java +++ b/src/main/java/one/talon/model/NewRole.java @@ -50,7 +50,7 @@ /** * NewRole */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewRole { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewRoleV2.java b/src/main/java/one/talon/model/NewRoleV2.java index 18fe37ec..d8b8acaf 100644 --- a/src/main/java/one/talon/model/NewRoleV2.java +++ b/src/main/java/one/talon/model/NewRoleV2.java @@ -51,7 +51,7 @@ /** * NewRoleV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewRoleV2 { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewRuleset.java b/src/main/java/one/talon/model/NewRuleset.java index d6727ca2..173b88ec 100644 --- a/src/main/java/one/talon/model/NewRuleset.java +++ b/src/main/java/one/talon/model/NewRuleset.java @@ -52,7 +52,7 @@ /** * NewRuleset */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewRuleset { public static final String SERIALIZED_NAME_RULES = "rules"; @SerializedName(SERIALIZED_NAME_RULES) diff --git a/src/main/java/one/talon/model/NewSamlConnection.java b/src/main/java/one/talon/model/NewSamlConnection.java index 8a5f33cb..e4d9b2d5 100644 --- a/src/main/java/one/talon/model/NewSamlConnection.java +++ b/src/main/java/one/talon/model/NewSamlConnection.java @@ -48,7 +48,7 @@ /** * NewSamlConnection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewSamlConnection { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/NewSecondaryDeployment.java b/src/main/java/one/talon/model/NewSecondaryDeployment.java index 738a880f..9fdf9159 100644 --- a/src/main/java/one/talon/model/NewSecondaryDeployment.java +++ b/src/main/java/one/talon/model/NewSecondaryDeployment.java @@ -48,7 +48,7 @@ /** * NewSecondaryDeployment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewSecondaryDeployment { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewStore.java b/src/main/java/one/talon/model/NewStore.java index f2e7e75e..31907d0d 100644 --- a/src/main/java/one/talon/model/NewStore.java +++ b/src/main/java/one/talon/model/NewStore.java @@ -48,7 +48,7 @@ /** * NewStore */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewStore { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/NewTemplateDef.java b/src/main/java/one/talon/model/NewTemplateDef.java index 777cc119..c04b03bd 100644 --- a/src/main/java/one/talon/model/NewTemplateDef.java +++ b/src/main/java/one/talon/model/NewTemplateDef.java @@ -51,7 +51,7 @@ /** * NewTemplateDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewTemplateDef { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/NewUser.java b/src/main/java/one/talon/model/NewUser.java index e46fcd64..89b33603 100644 --- a/src/main/java/one/talon/model/NewUser.java +++ b/src/main/java/one/talon/model/NewUser.java @@ -48,7 +48,7 @@ /** * NewUser */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewUser { public static final String SERIALIZED_NAME_EMAIL = "email"; @SerializedName(SERIALIZED_NAME_EMAIL) diff --git a/src/main/java/one/talon/model/NewWebhook.java b/src/main/java/one/talon/model/NewWebhook.java index 01758c06..d95ae217 100644 --- a/src/main/java/one/talon/model/NewWebhook.java +++ b/src/main/java/one/talon/model/NewWebhook.java @@ -51,7 +51,7 @@ /** * NewWebhook */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NewWebhook { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; @SerializedName(SERIALIZED_NAME_APPLICATION_IDS) diff --git a/src/main/java/one/talon/model/Notification.java b/src/main/java/one/talon/model/Notification.java index e86a8a0e..3b8e9976 100644 --- a/src/main/java/one/talon/model/Notification.java +++ b/src/main/java/one/talon/model/Notification.java @@ -48,7 +48,7 @@ /** * Notification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Notification { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/NotificationActivation.java b/src/main/java/one/talon/model/NotificationActivation.java index 0a311d24..73dd7643 100644 --- a/src/main/java/one/talon/model/NotificationActivation.java +++ b/src/main/java/one/talon/model/NotificationActivation.java @@ -48,7 +48,7 @@ /** * NotificationActivation */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NotificationActivation { public static final String SERIALIZED_NAME_ENABLED = "enabled"; @SerializedName(SERIALIZED_NAME_ENABLED) diff --git a/src/main/java/one/talon/model/NotificationListItem.java b/src/main/java/one/talon/model/NotificationListItem.java index fd8f790c..d1e87070 100644 --- a/src/main/java/one/talon/model/NotificationListItem.java +++ b/src/main/java/one/talon/model/NotificationListItem.java @@ -48,7 +48,7 @@ /** * NotificationListItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class NotificationListItem { public static final String SERIALIZED_NAME_NOTIFICATION_ID = "notificationId"; @SerializedName(SERIALIZED_NAME_NOTIFICATION_ID) diff --git a/src/main/java/one/talon/model/OktaEvent.java b/src/main/java/one/talon/model/OktaEvent.java index ba4bc3f1..91b0027a 100644 --- a/src/main/java/one/talon/model/OktaEvent.java +++ b/src/main/java/one/talon/model/OktaEvent.java @@ -51,7 +51,7 @@ /** * Single event definition in the event data emitted by Okta. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OktaEvent { public static final String SERIALIZED_NAME_EVENT_TYPE = "eventType"; @SerializedName(SERIALIZED_NAME_EVENT_TYPE) diff --git a/src/main/java/one/talon/model/OktaEventPayload.java b/src/main/java/one/talon/model/OktaEventPayload.java index dee18d33..e2b34753 100644 --- a/src/main/java/one/talon/model/OktaEventPayload.java +++ b/src/main/java/one/talon/model/OktaEventPayload.java @@ -49,7 +49,7 @@ /** * Payload containing provisioning event details from Okta. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OktaEventPayload { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/OktaEventPayloadData.java b/src/main/java/one/talon/model/OktaEventPayloadData.java index 6ce6a507..dce5ed9b 100644 --- a/src/main/java/one/talon/model/OktaEventPayloadData.java +++ b/src/main/java/one/talon/model/OktaEventPayloadData.java @@ -51,7 +51,7 @@ /** * Data part of the event emitted by Okta. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OktaEventPayloadData { public static final String SERIALIZED_NAME_EVENTS = "events"; @SerializedName(SERIALIZED_NAME_EVENTS) diff --git a/src/main/java/one/talon/model/OktaEventTarget.java b/src/main/java/one/talon/model/OktaEventTarget.java index aeff4e64..b89f5cbb 100644 --- a/src/main/java/one/talon/model/OktaEventTarget.java +++ b/src/main/java/one/talon/model/OktaEventTarget.java @@ -48,7 +48,7 @@ /** * Target of the specific Okta event. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OktaEventTarget { public static final String SERIALIZED_NAME_TYPE = "type"; @SerializedName(SERIALIZED_NAME_TYPE) diff --git a/src/main/java/one/talon/model/OneTimeCode.java b/src/main/java/one/talon/model/OneTimeCode.java index c366954f..1385413a 100644 --- a/src/main/java/one/talon/model/OneTimeCode.java +++ b/src/main/java/one/talon/model/OneTimeCode.java @@ -48,7 +48,7 @@ /** * OneTimeCode */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OneTimeCode { public static final String SERIALIZED_NAME_USER_ID = "userId"; @SerializedName(SERIALIZED_NAME_USER_ID) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationBrazePolicy.java b/src/main/java/one/talon/model/OutgoingIntegrationBrazePolicy.java index 97fb2491..31c8d113 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationBrazePolicy.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationBrazePolicy.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationBrazePolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationBrazePolicy { public static final String SERIALIZED_NAME_BASE_URL = "baseUrl"; @SerializedName(SERIALIZED_NAME_BASE_URL) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationCleverTapPolicy.java b/src/main/java/one/talon/model/OutgoingIntegrationCleverTapPolicy.java index f97f1ce1..b0e5b03e 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationCleverTapPolicy.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationCleverTapPolicy.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationCleverTapPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationCleverTapPolicy { public static final String SERIALIZED_NAME_BASE_URL = "baseUrl"; @SerializedName(SERIALIZED_NAME_BASE_URL) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationConfiguration.java b/src/main/java/one/talon/model/OutgoingIntegrationConfiguration.java index 43fc61d3..396022f1 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationConfiguration.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationConfiguration.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationConfiguration */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationConfiguration { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationIterablePolicy.java b/src/main/java/one/talon/model/OutgoingIntegrationIterablePolicy.java index 10c956c2..b7c17b05 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationIterablePolicy.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationIterablePolicy.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationIterablePolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationIterablePolicy { public static final String SERIALIZED_NAME_BASE_URL = "baseUrl"; @SerializedName(SERIALIZED_NAME_BASE_URL) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationMoEngagePolicy.java b/src/main/java/one/talon/model/OutgoingIntegrationMoEngagePolicy.java index 4cbc2254..fc2b98fd 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationMoEngagePolicy.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationMoEngagePolicy.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationMoEngagePolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationMoEngagePolicy { public static final String SERIALIZED_NAME_BASE_URL = "baseUrl"; @SerializedName(SERIALIZED_NAME_BASE_URL) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationTemplate.java b/src/main/java/one/talon/model/OutgoingIntegrationTemplate.java index a8af1deb..f1a263ff 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationTemplate.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationTemplate.java @@ -50,7 +50,7 @@ /** * OutgoingIntegrationTemplate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationTemplate { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java b/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java index 651d6c88..48503be8 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationTemplateWithConfigurationDetails.java @@ -50,7 +50,7 @@ /** * OutgoingIntegrationTemplateWithConfigurationDetails */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationTemplateWithConfigurationDetails { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationTemplates.java b/src/main/java/one/talon/model/OutgoingIntegrationTemplates.java index c947b04b..7369aee8 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationTemplates.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationTemplates.java @@ -51,7 +51,7 @@ /** * OutgoingIntegrationTemplates */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationTemplates { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationType.java b/src/main/java/one/talon/model/OutgoingIntegrationType.java index 013b18f5..c921c7bd 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationType.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationType.java @@ -48,7 +48,7 @@ /** * OutgoingIntegrationType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationType { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/OutgoingIntegrationTypes.java b/src/main/java/one/talon/model/OutgoingIntegrationTypes.java index 31795f37..8d84b1fc 100644 --- a/src/main/java/one/talon/model/OutgoingIntegrationTypes.java +++ b/src/main/java/one/talon/model/OutgoingIntegrationTypes.java @@ -51,7 +51,7 @@ /** * OutgoingIntegrationTypes */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class OutgoingIntegrationTypes { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/PatchItemCatalogAction.java b/src/main/java/one/talon/model/PatchItemCatalogAction.java index 84ad5926..161a1f9d 100644 --- a/src/main/java/one/talon/model/PatchItemCatalogAction.java +++ b/src/main/java/one/talon/model/PatchItemCatalogAction.java @@ -50,7 +50,7 @@ /** * The specific properties of the \"PATCH\" catalog sync action. **Note:** - If you do not provide a new `price` value, the existing `price` value is retained. - If you do not provide a new `product` value, the `product` value is set to `null`. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PatchItemCatalogAction { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/PatchManyItemsCatalogAction.java b/src/main/java/one/talon/model/PatchManyItemsCatalogAction.java index 74252d8c..33841b3b 100644 --- a/src/main/java/one/talon/model/PatchManyItemsCatalogAction.java +++ b/src/main/java/one/talon/model/PatchManyItemsCatalogAction.java @@ -52,7 +52,7 @@ /** * The specific properties of the \"PATCH_MANY\" catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PatchManyItemsCatalogAction { public static final String SERIALIZED_NAME_PRICE = "price"; @SerializedName(SERIALIZED_NAME_PRICE) diff --git a/src/main/java/one/talon/model/PendingActivePointsData.java b/src/main/java/one/talon/model/PendingActivePointsData.java index a206b17f..2496675c 100644 --- a/src/main/java/one/talon/model/PendingActivePointsData.java +++ b/src/main/java/one/talon/model/PendingActivePointsData.java @@ -50,7 +50,7 @@ /** * PendingActivePointsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PendingActivePointsData { public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_I_D = "LoyaltyProgramID"; @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_I_D) diff --git a/src/main/java/one/talon/model/PendingActivePointsNotification.java b/src/main/java/one/talon/model/PendingActivePointsNotification.java index c78701b3..5155d31f 100644 --- a/src/main/java/one/talon/model/PendingActivePointsNotification.java +++ b/src/main/java/one/talon/model/PendingActivePointsNotification.java @@ -51,7 +51,7 @@ /** * PendingActivePointsNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PendingActivePointsNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/PendingPointsNotificationPolicy.java b/src/main/java/one/talon/model/PendingPointsNotificationPolicy.java index 81cdb147..8e6ca892 100644 --- a/src/main/java/one/talon/model/PendingPointsNotificationPolicy.java +++ b/src/main/java/one/talon/model/PendingPointsNotificationPolicy.java @@ -48,7 +48,7 @@ /** * PendingPointsNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PendingPointsNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/Picklist.java b/src/main/java/one/talon/model/Picklist.java index f681573d..756efd24 100644 --- a/src/main/java/one/talon/model/Picklist.java +++ b/src/main/java/one/talon/model/Picklist.java @@ -51,7 +51,7 @@ /** * Picklist */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Picklist { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/PlaceholderDetails.java b/src/main/java/one/talon/model/PlaceholderDetails.java index 86bc6b29..6114ef25 100644 --- a/src/main/java/one/talon/model/PlaceholderDetails.java +++ b/src/main/java/one/talon/model/PlaceholderDetails.java @@ -50,7 +50,7 @@ /** * PlaceholderDetails */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PlaceholderDetails { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/PriceDetail.java b/src/main/java/one/talon/model/PriceDetail.java index 09430ec6..a5bb604b 100644 --- a/src/main/java/one/talon/model/PriceDetail.java +++ b/src/main/java/one/talon/model/PriceDetail.java @@ -50,7 +50,7 @@ /** * PriceDetail */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceDetail { public static final String SERIALIZED_NAME_PRICE = "price"; @SerializedName(SERIALIZED_NAME_PRICE) diff --git a/src/main/java/one/talon/model/PriceHistoryRequest.java b/src/main/java/one/talon/model/PriceHistoryRequest.java index 3b536f86..f46700f1 100644 --- a/src/main/java/one/talon/model/PriceHistoryRequest.java +++ b/src/main/java/one/talon/model/PriceHistoryRequest.java @@ -49,7 +49,7 @@ /** * PriceHistoryRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceHistoryRequest { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/PriceHistoryResponse.java b/src/main/java/one/talon/model/PriceHistoryResponse.java index f7b620cc..a9641f25 100644 --- a/src/main/java/one/talon/model/PriceHistoryResponse.java +++ b/src/main/java/one/talon/model/PriceHistoryResponse.java @@ -51,7 +51,7 @@ /** * PriceHistoryResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceHistoryResponse { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/PriceType.java b/src/main/java/one/talon/model/PriceType.java index 9703101d..b11c7ddb 100644 --- a/src/main/java/one/talon/model/PriceType.java +++ b/src/main/java/one/talon/model/PriceType.java @@ -51,7 +51,7 @@ /** * PriceType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceType { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/PriceTypeReferenceDetail.java b/src/main/java/one/talon/model/PriceTypeReferenceDetail.java index 7e233aaf..faef888b 100644 --- a/src/main/java/one/talon/model/PriceTypeReferenceDetail.java +++ b/src/main/java/one/talon/model/PriceTypeReferenceDetail.java @@ -48,7 +48,7 @@ /** * PriceTypeReferenceDetail */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceTypeReferenceDetail { /** * The entity type that references the price type. For example, a campaign or an Application cart item filter. diff --git a/src/main/java/one/talon/model/PriceTypeReferences.java b/src/main/java/one/talon/model/PriceTypeReferences.java index 28b98983..07ba1fa9 100644 --- a/src/main/java/one/talon/model/PriceTypeReferences.java +++ b/src/main/java/one/talon/model/PriceTypeReferences.java @@ -51,7 +51,7 @@ /** * PriceTypeReferences */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PriceTypeReferences { public static final String SERIALIZED_NAME_PRICE_TYPE_ID = "priceTypeId"; @SerializedName(SERIALIZED_NAME_PRICE_TYPE_ID) diff --git a/src/main/java/one/talon/model/Product.java b/src/main/java/one/talon/model/Product.java index 991023fd..440403ff 100644 --- a/src/main/java/one/talon/model/Product.java +++ b/src/main/java/one/talon/model/Product.java @@ -48,7 +48,7 @@ /** * The specific properties of the product this item belongs to, if available. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Product { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/ProductSearchMatch.java b/src/main/java/one/talon/model/ProductSearchMatch.java index 1e38e505..6f1b3a5a 100644 --- a/src/main/java/one/talon/model/ProductSearchMatch.java +++ b/src/main/java/one/talon/model/ProductSearchMatch.java @@ -48,7 +48,7 @@ /** * ProductSearchMatch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProductSearchMatch { public static final String SERIALIZED_NAME_PRODUCT_ID = "productId"; @SerializedName(SERIALIZED_NAME_PRODUCT_ID) diff --git a/src/main/java/one/talon/model/ProductUnitAnalytics.java b/src/main/java/one/talon/model/ProductUnitAnalytics.java index 1d0f16ca..d9d7f678 100644 --- a/src/main/java/one/talon/model/ProductUnitAnalytics.java +++ b/src/main/java/one/talon/model/ProductUnitAnalytics.java @@ -52,7 +52,7 @@ /** * ProductUnitAnalytics */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProductUnitAnalytics { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/ProductUnitAnalyticsDataPoint.java b/src/main/java/one/talon/model/ProductUnitAnalyticsDataPoint.java index 6fcb3295..824fb2da 100644 --- a/src/main/java/one/talon/model/ProductUnitAnalyticsDataPoint.java +++ b/src/main/java/one/talon/model/ProductUnitAnalyticsDataPoint.java @@ -50,7 +50,7 @@ /** * ProductUnitAnalyticsDataPoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProductUnitAnalyticsDataPoint { public static final String SERIALIZED_NAME_START_TIME = "startTime"; @SerializedName(SERIALIZED_NAME_START_TIME) diff --git a/src/main/java/one/talon/model/ProductUnitAnalyticsTotals.java b/src/main/java/one/talon/model/ProductUnitAnalyticsTotals.java index 046846fe..53dcd198 100644 --- a/src/main/java/one/talon/model/ProductUnitAnalyticsTotals.java +++ b/src/main/java/one/talon/model/ProductUnitAnalyticsTotals.java @@ -49,7 +49,7 @@ /** * ProductUnitAnalyticsTotals */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProductUnitAnalyticsTotals { public static final String SERIALIZED_NAME_UNITS_SOLD = "unitsSold"; @SerializedName(SERIALIZED_NAME_UNITS_SOLD) diff --git a/src/main/java/one/talon/model/ProfileAudiencesChanges.java b/src/main/java/one/talon/model/ProfileAudiencesChanges.java index e6d43c0e..7e71b1af 100644 --- a/src/main/java/one/talon/model/ProfileAudiencesChanges.java +++ b/src/main/java/one/talon/model/ProfileAudiencesChanges.java @@ -50,7 +50,7 @@ /** * ProfileAudiencesChanges */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProfileAudiencesChanges { public static final String SERIALIZED_NAME_ADDS = "adds"; @SerializedName(SERIALIZED_NAME_ADDS) diff --git a/src/main/java/one/talon/model/ProjectedTier.java b/src/main/java/one/talon/model/ProjectedTier.java index 695f334d..bfda61a1 100644 --- a/src/main/java/one/talon/model/ProjectedTier.java +++ b/src/main/java/one/talon/model/ProjectedTier.java @@ -49,7 +49,7 @@ /** * ProjectedTier */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ProjectedTier { public static final String SERIALIZED_NAME_PROJECTED_ACTIVE_POINTS = "projectedActivePoints"; @SerializedName(SERIALIZED_NAME_PROJECTED_ACTIVE_POINTS) diff --git a/src/main/java/one/talon/model/PromoteExperiment.java b/src/main/java/one/talon/model/PromoteExperiment.java index 687cf7ac..0640d28c 100644 --- a/src/main/java/one/talon/model/PromoteExperiment.java +++ b/src/main/java/one/talon/model/PromoteExperiment.java @@ -49,7 +49,7 @@ /** * PromoteExperiment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class PromoteExperiment { public static final String SERIALIZED_NAME_TARGET_APPLICATION_ID = "targetApplicationId"; @SerializedName(SERIALIZED_NAME_TARGET_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/RedeemReferralEffectProps.java b/src/main/java/one/talon/model/RedeemReferralEffectProps.java index 060eb387..b46b3878 100644 --- a/src/main/java/one/talon/model/RedeemReferralEffectProps.java +++ b/src/main/java/one/talon/model/RedeemReferralEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * This effect is **deprecated**. The properties specific to the \"redeemReferral\" effect. This gets triggered whenever the referral code is valid, and a rule was triggered that contains a \"redeem referral\" effect. + * This effect is **deprecated**. It has been replaced by the `acceptReferral` effect. This effect indicates that the referral code is valid and has been redeemed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RedeemReferralEffectProps { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Referral.java b/src/main/java/one/talon/model/Referral.java index 05444e85..b4444625 100644 --- a/src/main/java/one/talon/model/Referral.java +++ b/src/main/java/one/talon/model/Referral.java @@ -49,7 +49,7 @@ /** * Referral */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Referral { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -279,7 +279,7 @@ public Referral attributes(@javax.annotation.Nullable Object attributes) { } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/ReferralConstraints.java b/src/main/java/one/talon/model/ReferralConstraints.java index 41bba22d..df8edd14 100644 --- a/src/main/java/one/talon/model/ReferralConstraints.java +++ b/src/main/java/one/talon/model/ReferralConstraints.java @@ -49,7 +49,7 @@ /** * ReferralConstraints */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReferralConstraints { public static final String SERIALIZED_NAME_START_DATE = "startDate"; @SerializedName(SERIALIZED_NAME_START_DATE) diff --git a/src/main/java/one/talon/model/ReferralCreatedEffectProps.java b/src/main/java/one/talon/model/ReferralCreatedEffectProps.java index 27786d80..c8a42d89 100644 --- a/src/main/java/one/talon/model/ReferralCreatedEffectProps.java +++ b/src/main/java/one/talon/model/ReferralCreatedEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"referralCreated\" effect. This gets triggered whenever a validated rule contained a \"create referral\" effect, and a referral code was created for a customer. See \"createdReferrals\" on the response for all details of this referral code. + * The `referralCreated` effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effects#couponcreated). If the `friendProfileIntegrationId` parameter is empty, the referral code can be redeemed by anyone. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReferralCreatedEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -64,7 +64,7 @@ public ReferralCreatedEffectProps value(@javax.annotation.Nonnull String value) } /** - * The referral code that was created. + * The referral code provided in the session. * @return value */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ReferralRejectionReason.java b/src/main/java/one/talon/model/ReferralRejectionReason.java index 12979393..22e3eea6 100644 --- a/src/main/java/one/talon/model/ReferralRejectionReason.java +++ b/src/main/java/one/talon/model/ReferralRejectionReason.java @@ -48,7 +48,7 @@ /** * Holds a reference to the campaign, the referral and the reason for which that referral was rejected. Should only be present when there is a 'rejectReferral' effect. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReferralRejectionReason { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/RejectCouponEffectProps.java b/src/main/java/one/talon/model/RejectCouponEffectProps.java index dffee1ac..978e71fc 100644 --- a/src/main/java/one/talon/model/RejectCouponEffectProps.java +++ b/src/main/java/one/talon/model/RejectCouponEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rejectCoupon\" effect. This gets triggered whenever the coupon was rejected. See rejectionReason for more info on why. + * This effect indicates that the coupon code supplied couldn't be used. You should handle this effect by informing their user the coupon code is invalid. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RejectCouponEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -108,7 +108,7 @@ public RejectCouponEffectProps rejectionReason(@javax.annotation.Nonnull String } /** - * The reason why this coupon was rejected. + * The reason why the code was rejected. - `CampaignLimitReached`: The campaign-wide coupon code redemption limit has been reached. - `CouponExpired`: The coupon is expired. - `CouponLimitReached`: The coupon redemption limit or a campaign budget was reached. - `CouponNotFound`: The coupon code is incorrect. - `CouponPartOfNotRunningCampaign`: The campaign the coupon belongs to is currently not active. The campaignId field contains the ID of that campaign. - `CouponRecipientDoesNotMatch`: The given coupon value does not match the recipient or the coupon is linked to a `recipientIntegrationID` but there is no profile in the session. - `CouponRejectedByCondition`: Other conditions failed in the rule or all conditions passed but the `Coupon code is valid` condition is not present. - `CouponStartDateInFuture`: The coupon isn't active yet. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` cannot be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific coupon redemption limit has been reached. - `CouponPartOfNotTriggeredCampaign`: The campaign the coupon belongs to was not triggered during evaluation (an exclusive or stackable campaign). The `campaignId` field contains the ID of that campaign. - `CouponReservationRequired`: The coupon's `isReservationMandatory` property is `true`, but the profile does not have a reservation. - `ProfileRequired`: The coupon's `isReservationMandatory` property is `true` or a [campaign profile budget](https://docs.talon.one/docs/product/campaigns/settings/manage-campaign-budgets) was set, but no profile exists in the session. * @return rejectionReason */ @javax.annotation.Nonnull @@ -184,7 +184,7 @@ public RejectCouponEffectProps campaignExclusionReason(@javax.annotation.Nullabl } /** - * The reason why the campaign was not applied. + * The reason why the campaign the coupon belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and coupon conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the coupon is part of an archived campaign. * @return campaignExclusionReason */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/RejectReferralEffectProps.java b/src/main/java/one/talon/model/RejectReferralEffectProps.java index 5bdb1600..87fd2c32 100644 --- a/src/main/java/one/talon/model/RejectReferralEffectProps.java +++ b/src/main/java/one/talon/model/RejectReferralEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rejectReferral\" effect. This gets triggered whenever the referral code was rejected. See rejectionReason for more info on why. + * This effect indicates that the provided referral code is invalid. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RejectReferralEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -89,7 +89,7 @@ public RejectReferralEffectProps value(@javax.annotation.Nonnull String value) { } /** - * The referral code that was rejected. + * The referral code that was rejected * @return value */ @javax.annotation.Nonnull @@ -108,7 +108,7 @@ public RejectReferralEffectProps rejectionReason(@javax.annotation.Nonnull Strin } /** - * The reason why this referral code was rejected. + * The reason why the code was rejected. - `AdvocateNotFound`: The advocate was not found. - `CampaignLimitReached`: The campaign-wide referral code redemption limit has been reached. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` can not be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific referral code redemption limit has been reached. - `ReferralCustomerAlreadyReferred`: The friend is already referred. - `ReferralExpired`: The transferred referral code is expired. - `ReferralLimitReached`: The referral code redemption limit has been reached. - `ReferralNotFound`: The transferred referral code is wrong. - `ReferralPartOfNotRunningCampaign`: The campaign the referral code belongs to is currently not active. The campaign ID field shows the ID of that campaign. - `ReferralRecipientDoesNotMatch`: The given referral code value does not match the recipient. - `ReferralRecipientIdSameAsAdvocate`: The recipient (friend) has the same id as the advocate. - `ReferralRejectedByCondition`: The referral code is valid and in an active campaign, but there were other conditions in that campaign's rules that were not met. - `ReferralStartDateInFuture`: The transferred referral code isn't active yet. - `ReferralPartOfNotTriggeredCampaign`: The campaign the referral code belongs to was not triggered during evaluation (an exclusive or stackable campaign). The campaign ID field shows the ID of that campaign. * @return rejectionReason */ @javax.annotation.Nonnull @@ -184,7 +184,7 @@ public RejectReferralEffectProps campaignExclusionReason(@javax.annotation.Nulla } /** - * The reason why the campaign was not applied. + * The reason why the campaign the referral belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and referral conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the referral is part of an archived campaign. * @return campaignExclusionReason */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/RemoveFromAudienceEffectProps.java b/src/main/java/one/talon/model/RemoveFromAudienceEffectProps.java index 6f19094d..aa06a4ca 100644 --- a/src/main/java/one/talon/model/RemoveFromAudienceEffectProps.java +++ b/src/main/java/one/talon/model/RemoveFromAudienceEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"removeFromAudience\" effect. This gets triggered whenever a validated rule contains a \"removeFromAudience\" effect. + * This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Remove customer from an audience** selected is validated. It indicates that a customer was removed from an audience and is returned when a customer session is opened, updated, or closed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RemoveFromAudienceEffectProps { public static final String SERIALIZED_NAME_AUDIENCE_ID = "audienceId"; @SerializedName(SERIALIZED_NAME_AUDIENCE_ID) diff --git a/src/main/java/one/talon/model/RemoveItemCatalogAction.java b/src/main/java/one/talon/model/RemoveItemCatalogAction.java index 5600781f..2c57a4fe 100644 --- a/src/main/java/one/talon/model/RemoveItemCatalogAction.java +++ b/src/main/java/one/talon/model/RemoveItemCatalogAction.java @@ -48,7 +48,7 @@ /** * The specific properties of the \"REMOVE\" catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RemoveItemCatalogAction { public static final String SERIALIZED_NAME_SKU = "sku"; @SerializedName(SERIALIZED_NAME_SKU) diff --git a/src/main/java/one/talon/model/RemoveManyItemsCatalogAction.java b/src/main/java/one/talon/model/RemoveManyItemsCatalogAction.java index 03595c9e..dd0b1608 100644 --- a/src/main/java/one/talon/model/RemoveManyItemsCatalogAction.java +++ b/src/main/java/one/talon/model/RemoveManyItemsCatalogAction.java @@ -51,7 +51,7 @@ /** * The specific properties of the \"REMOVE_MANY\" catalog sync action. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RemoveManyItemsCatalogAction { public static final String SERIALIZED_NAME_FILTERS = "filters"; @SerializedName(SERIALIZED_NAME_FILTERS) diff --git a/src/main/java/one/talon/model/ReopenSessionResponse.java b/src/main/java/one/talon/model/ReopenSessionResponse.java index 5f45a3fa..6745e2ff 100644 --- a/src/main/java/one/talon/model/ReopenSessionResponse.java +++ b/src/main/java/one/talon/model/ReopenSessionResponse.java @@ -51,7 +51,7 @@ /** * This is the response type returned by the Reopen customer sessions endpoint. It contains the rolled back effects. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReopenSessionResponse { public static final String SERIALIZED_NAME_EFFECTS = "effects"; @SerializedName(SERIALIZED_NAME_EFFECTS) diff --git a/src/main/java/one/talon/model/ReserveCouponEffectProps.java b/src/main/java/one/talon/model/ReserveCouponEffectProps.java index 75aea390..7b4cb3e0 100644 --- a/src/main/java/one/talon/model/ReserveCouponEffectProps.java +++ b/src/main/java/one/talon/model/ReserveCouponEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"reserveCoupon\" effect. This gets triggered whenever a validated rule contained a \"reserve coupon\" effect. This reserves the coupon currently on scope to the profile on scope. + * This effect indicates that the given coupon code was reserved for the given customer. Talon.One provides soft and hard reservations. For more information, see [Reserve a coupon code](https://docs.talon.one/docs/product/rules/effects/use-effects#reserve-a-coupon-code). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReserveCouponEffectProps { public static final String SERIALIZED_NAME_COUPON_VALUE = "couponValue"; @SerializedName(SERIALIZED_NAME_COUPON_VALUE) @@ -74,7 +74,7 @@ public ReserveCouponEffectProps couponValue(@javax.annotation.Nonnull String cou } /** - * The value of the coupon currently on scope. + * The coupon code that was created. * @return couponValue */ @javax.annotation.Nonnull @@ -93,7 +93,7 @@ public ReserveCouponEffectProps profileIntegrationId(@javax.annotation.Nonnull S } /** - * The ID of this customer profile in the third-party integration. + * The integration identifier of the customer for whom this coupon was reserved. * @return profileIntegrationId */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/ResponseContentObject.java b/src/main/java/one/talon/model/ResponseContentObject.java index 46497e93..a341558e 100644 --- a/src/main/java/one/talon/model/ResponseContentObject.java +++ b/src/main/java/one/talon/model/ResponseContentObject.java @@ -50,7 +50,7 @@ /** * ResponseContentObject */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ResponseContentObject { /** * Gets or Sets responseContent diff --git a/src/main/java/one/talon/model/ReturnIntegrationRequest.java b/src/main/java/one/talon/model/ReturnIntegrationRequest.java index 7dda3514..ad7b70e3 100644 --- a/src/main/java/one/talon/model/ReturnIntegrationRequest.java +++ b/src/main/java/one/talon/model/ReturnIntegrationRequest.java @@ -51,7 +51,7 @@ /** * The body of a return integration API request. Next to the cart items details, this contains an optional listing of extra properties that should be returned in the response. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReturnIntegrationRequest { public static final String SERIALIZED_NAME_RETURN = "return"; @SerializedName(SERIALIZED_NAME_RETURN) diff --git a/src/main/java/one/talon/model/ReturnedCartItem.java b/src/main/java/one/talon/model/ReturnedCartItem.java index dbf046ca..1aabb7db 100644 --- a/src/main/java/one/talon/model/ReturnedCartItem.java +++ b/src/main/java/one/talon/model/ReturnedCartItem.java @@ -48,7 +48,7 @@ /** * ReturnedCartItem */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ReturnedCartItem { public static final String SERIALIZED_NAME_POSITION = "position"; @SerializedName(SERIALIZED_NAME_POSITION) diff --git a/src/main/java/one/talon/model/Revision.java b/src/main/java/one/talon/model/Revision.java index a4ba7d49..d2790433 100644 --- a/src/main/java/one/talon/model/Revision.java +++ b/src/main/java/one/talon/model/Revision.java @@ -50,7 +50,7 @@ /** * Revision */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Revision { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RevisionActivation.java b/src/main/java/one/talon/model/RevisionActivation.java index 0a9d9b49..3989b44f 100644 --- a/src/main/java/one/talon/model/RevisionActivation.java +++ b/src/main/java/one/talon/model/RevisionActivation.java @@ -49,7 +49,7 @@ /** * RevisionActivation */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RevisionActivation { public static final String SERIALIZED_NAME_ACTIVATE_AT = "activateAt"; @SerializedName(SERIALIZED_NAME_ACTIVATE_AT) diff --git a/src/main/java/one/talon/model/RevisionActivationRequest.java b/src/main/java/one/talon/model/RevisionActivationRequest.java index 9a0efe09..4b607d39 100644 --- a/src/main/java/one/talon/model/RevisionActivationRequest.java +++ b/src/main/java/one/talon/model/RevisionActivationRequest.java @@ -51,7 +51,7 @@ /** * RevisionActivationRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RevisionActivationRequest { public static final String SERIALIZED_NAME_USER_IDS = "userIds"; @SerializedName(SERIALIZED_NAME_USER_IDS) diff --git a/src/main/java/one/talon/model/RevisionVersion.java b/src/main/java/one/talon/model/RevisionVersion.java index 258594ef..157a5b53 100644 --- a/src/main/java/one/talon/model/RevisionVersion.java +++ b/src/main/java/one/talon/model/RevisionVersion.java @@ -53,7 +53,7 @@ /** * RevisionVersion */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RevisionVersion { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Reward.java b/src/main/java/one/talon/model/Reward.java index c60adc45..5207eee6 100644 --- a/src/main/java/one/talon/model/Reward.java +++ b/src/main/java/one/talon/model/Reward.java @@ -54,7 +54,7 @@ /** * Reward */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Reward { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RewardPointsRequired.java b/src/main/java/one/talon/model/RewardPointsRequired.java index e18feecb..b3d82f23 100644 --- a/src/main/java/one/talon/model/RewardPointsRequired.java +++ b/src/main/java/one/talon/model/RewardPointsRequired.java @@ -49,7 +49,7 @@ /** * The loyalty points required to activate a reward. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RewardPointsRequired { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RiskNotification.java b/src/main/java/one/talon/model/RiskNotification.java index 1c2cc9e0..5c5111c1 100644 --- a/src/main/java/one/talon/model/RiskNotification.java +++ b/src/main/java/one/talon/model/RiskNotification.java @@ -49,7 +49,7 @@ /** * A risk notification configuration rule. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RiskNotification { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Role.java b/src/main/java/one/talon/model/Role.java index 3201036c..536804bb 100644 --- a/src/main/java/one/talon/model/Role.java +++ b/src/main/java/one/talon/model/Role.java @@ -51,7 +51,7 @@ /** * Role */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Role { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RoleAssign.java b/src/main/java/one/talon/model/RoleAssign.java index 2f477caa..477902db 100644 --- a/src/main/java/one/talon/model/RoleAssign.java +++ b/src/main/java/one/talon/model/RoleAssign.java @@ -50,7 +50,7 @@ /** * RoleAssign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleAssign { public static final String SERIALIZED_NAME_USERS = "users"; @SerializedName(SERIALIZED_NAME_USERS) diff --git a/src/main/java/one/talon/model/RoleMembership.java b/src/main/java/one/talon/model/RoleMembership.java index bfa7f86c..28683a72 100644 --- a/src/main/java/one/talon/model/RoleMembership.java +++ b/src/main/java/one/talon/model/RoleMembership.java @@ -48,7 +48,7 @@ /** * RoleMembership */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleMembership { public static final String SERIALIZED_NAME_ROLE_I_D = "RoleID"; @SerializedName(SERIALIZED_NAME_ROLE_I_D) diff --git a/src/main/java/one/talon/model/RoleV2.java b/src/main/java/one/talon/model/RoleV2.java index 3707a199..d21bbfb1 100644 --- a/src/main/java/one/talon/model/RoleV2.java +++ b/src/main/java/one/talon/model/RoleV2.java @@ -52,7 +52,7 @@ /** * RoleV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2 { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RoleV2ApplicationDetails.java b/src/main/java/one/talon/model/RoleV2ApplicationDetails.java index f2dce4d1..ebb6c3a8 100644 --- a/src/main/java/one/talon/model/RoleV2ApplicationDetails.java +++ b/src/main/java/one/talon/model/RoleV2ApplicationDetails.java @@ -21,7 +21,6 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; -import one.talon.model.RolesV2Thresholds; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -49,7 +48,7 @@ /** * RoleV2ApplicationDetails */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2ApplicationDetails { public static final String SERIALIZED_NAME_APPLICATION = "application"; @SerializedName(SERIALIZED_NAME_APPLICATION) @@ -71,11 +70,6 @@ public class RoleV2ApplicationDetails { @javax.annotation.Nullable private String tools; - public static final String SERIALIZED_NAME_THRESHOLDS = "thresholds"; - @SerializedName(SERIALIZED_NAME_THRESHOLDS) - @javax.annotation.Nullable - private RolesV2Thresholds thresholds; - public RoleV2ApplicationDetails() { } @@ -154,25 +148,6 @@ public void setTools(@javax.annotation.Nullable String tools) { this.tools = tools; } - - public RoleV2ApplicationDetails thresholds(@javax.annotation.Nullable RolesV2Thresholds thresholds) { - this.thresholds = thresholds; - return this; - } - - /** - * Support user limits for actions that require admin approval within the given application. - * @return thresholds - */ - @javax.annotation.Nullable - public RolesV2Thresholds getThresholds() { - return thresholds; - } - - public void setThresholds(@javax.annotation.Nullable RolesV2Thresholds thresholds) { - this.thresholds = thresholds; - } - /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -231,14 +206,13 @@ public boolean equals(Object o) { return Objects.equals(this.application, roleV2ApplicationDetails.application) && Objects.equals(this.campaign, roleV2ApplicationDetails.campaign) && Objects.equals(this.draftCampaign, roleV2ApplicationDetails.draftCampaign) && - Objects.equals(this.tools, roleV2ApplicationDetails.tools) && - Objects.equals(this.thresholds, roleV2ApplicationDetails.thresholds)&& + Objects.equals(this.tools, roleV2ApplicationDetails.tools)&& Objects.equals(this.additionalProperties, roleV2ApplicationDetails.additionalProperties); } @Override public int hashCode() { - return Objects.hash(application, campaign, draftCampaign, tools, thresholds, additionalProperties); + return Objects.hash(application, campaign, draftCampaign, tools, additionalProperties); } @Override @@ -249,7 +223,6 @@ public String toString() { sb.append(" campaign: ").append(toIndentedString(campaign)).append("\n"); sb.append(" draftCampaign: ").append(toIndentedString(draftCampaign)).append("\n"); sb.append(" tools: ").append(toIndentedString(tools)).append("\n"); - sb.append(" thresholds: ").append(toIndentedString(thresholds)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -269,7 +242,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("application", "campaign", "draftCampaign", "tools", "thresholds")); + openapiFields = new HashSet(Arrays.asList("application", "campaign", "draftCampaign", "tools")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -300,10 +273,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("tools") != null && !jsonObj.get("tools").isJsonNull()) && !jsonObj.get("tools").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `tools` to be a primitive type in the JSON string but got `%s`", jsonObj.get("tools").toString())); } - // validate the optional field `thresholds` - if (jsonObj.get("thresholds") != null && !jsonObj.get("thresholds").isJsonNull()) { - RolesV2Thresholds.validateJsonElement(jsonObj.get("thresholds")); - } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/one/talon/model/RoleV2Base.java b/src/main/java/one/talon/model/RoleV2Base.java index d9192196..9c29efe0 100644 --- a/src/main/java/one/talon/model/RoleV2Base.java +++ b/src/main/java/one/talon/model/RoleV2Base.java @@ -51,7 +51,7 @@ /** * RoleV2Base */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2Base { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/RoleV2PermissionSet.java b/src/main/java/one/talon/model/RoleV2PermissionSet.java index 5bb1383f..4a71b337 100644 --- a/src/main/java/one/talon/model/RoleV2PermissionSet.java +++ b/src/main/java/one/talon/model/RoleV2PermissionSet.java @@ -50,7 +50,7 @@ /** * RoleV2PermissionSet */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2PermissionSet { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/RoleV2Permissions.java b/src/main/java/one/talon/model/RoleV2Permissions.java index 4f722580..6cf3a8ac 100644 --- a/src/main/java/one/talon/model/RoleV2Permissions.java +++ b/src/main/java/one/talon/model/RoleV2Permissions.java @@ -25,6 +25,7 @@ import java.util.List; import one.talon.model.RoleV2PermissionSet; import one.talon.model.RoleV2RolesGroup; +import one.talon.model.RolesV2Thresholds; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -52,7 +53,7 @@ /** * RoleV2Permissions */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2Permissions { public static final String SERIALIZED_NAME_PERMISSION_SETS = "permissionSets"; @SerializedName(SERIALIZED_NAME_PERMISSION_SETS) @@ -64,6 +65,11 @@ public class RoleV2Permissions { @javax.annotation.Nullable private RoleV2RolesGroup roles; + public static final String SERIALIZED_NAME_THRESHOLDS = "thresholds"; + @SerializedName(SERIALIZED_NAME_THRESHOLDS) + @javax.annotation.Nullable + private List thresholds; + public RoleV2Permissions() { } @@ -112,6 +118,33 @@ public void setRoles(@javax.annotation.Nullable RoleV2RolesGroup roles) { this.roles = roles; } + + public RoleV2Permissions thresholds(@javax.annotation.Nullable List thresholds) { + this.thresholds = thresholds; + return this; + } + + public RoleV2Permissions addThresholdsItem(RolesV2Thresholds thresholdsItem) { + if (this.thresholds == null) { + this.thresholds = new ArrayList<>(); + } + this.thresholds.add(thresholdsItem); + return this; + } + + /** + * Support user limits for actions that require admin approval within the given application. + * @return thresholds + */ + @javax.annotation.Nullable + public List getThresholds() { + return thresholds; + } + + public void setThresholds(@javax.annotation.Nullable List thresholds) { + this.thresholds = thresholds; + } + /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -168,13 +201,14 @@ public boolean equals(Object o) { } RoleV2Permissions roleV2Permissions = (RoleV2Permissions) o; return Objects.equals(this.permissionSets, roleV2Permissions.permissionSets) && - Objects.equals(this.roles, roleV2Permissions.roles)&& + Objects.equals(this.roles, roleV2Permissions.roles) && + Objects.equals(this.thresholds, roleV2Permissions.thresholds)&& Objects.equals(this.additionalProperties, roleV2Permissions.additionalProperties); } @Override public int hashCode() { - return Objects.hash(permissionSets, roles, additionalProperties); + return Objects.hash(permissionSets, roles, thresholds, additionalProperties); } @Override @@ -183,6 +217,7 @@ public String toString() { sb.append("class RoleV2Permissions {\n"); sb.append(" permissionSets: ").append(toIndentedString(permissionSets)).append("\n"); sb.append(" roles: ").append(toIndentedString(roles)).append("\n"); + sb.append(" thresholds: ").append(toIndentedString(thresholds)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -202,7 +237,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("permissionSets", "roles")); + openapiFields = new HashSet(Arrays.asList("permissionSets", "roles", "thresholds")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -239,6 +274,20 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("roles") != null && !jsonObj.get("roles").isJsonNull()) { RoleV2RolesGroup.validateJsonElement(jsonObj.get("roles")); } + if (jsonObj.get("thresholds") != null && !jsonObj.get("thresholds").isJsonNull()) { + JsonArray jsonArraythresholds = jsonObj.getAsJsonArray("thresholds"); + if (jsonArraythresholds != null) { + // ensure the json data is an array + if (!jsonObj.get("thresholds").isJsonArray()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `thresholds` to be an array in the JSON string but got `%s`", jsonObj.get("thresholds").toString())); + } + + // validate the optional field `thresholds` (array) + for (int i = 0; i < jsonArraythresholds.size(); i++) { + RolesV2Thresholds.validateJsonElement(jsonArraythresholds.get(i)); + }; + } + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/one/talon/model/RoleV2Readonly.java b/src/main/java/one/talon/model/RoleV2Readonly.java index e9580300..ede37e81 100644 --- a/src/main/java/one/talon/model/RoleV2Readonly.java +++ b/src/main/java/one/talon/model/RoleV2Readonly.java @@ -48,7 +48,7 @@ /** * RoleV2Readonly */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2Readonly { public static final String SERIALIZED_NAME_IS_READONLY = "isReadonly"; @SerializedName(SERIALIZED_NAME_IS_READONLY) diff --git a/src/main/java/one/talon/model/RoleV2RolesGroup.java b/src/main/java/one/talon/model/RoleV2RolesGroup.java index 09fdb554..d311abe8 100644 --- a/src/main/java/one/talon/model/RoleV2RolesGroup.java +++ b/src/main/java/one/talon/model/RoleV2RolesGroup.java @@ -51,7 +51,7 @@ /** * RoleV2RolesGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RoleV2RolesGroup { public static final String SERIALIZED_NAME_APPLICATIONS = "applications"; @SerializedName(SERIALIZED_NAME_APPLICATIONS) diff --git a/src/main/java/one/talon/model/RolesV2Thresholds.java b/src/main/java/one/talon/model/RolesV2Thresholds.java index c4921dd0..1088fcaf 100644 --- a/src/main/java/one/talon/model/RolesV2Thresholds.java +++ b/src/main/java/one/talon/model/RolesV2Thresholds.java @@ -48,8 +48,13 @@ /** * RolesV2Thresholds */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RolesV2Thresholds { + public static final String SERIALIZED_NAME_LOYALTY_PROGRAM_ID = "loyaltyProgramId"; + @SerializedName(SERIALIZED_NAME_LOYALTY_PROGRAM_ID) + @javax.annotation.Nullable + private Long loyaltyProgramId; + public static final String SERIALIZED_NAME_LOYALTY_POINTS_LIMIT = "loyaltyPointsLimit"; @SerializedName(SERIALIZED_NAME_LOYALTY_POINTS_LIMIT) @javax.annotation.Nullable @@ -58,6 +63,25 @@ public class RolesV2Thresholds { public RolesV2Thresholds() { } + public RolesV2Thresholds loyaltyProgramId(@javax.annotation.Nullable Long loyaltyProgramId) { + this.loyaltyProgramId = loyaltyProgramId; + return this; + } + + /** + * Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + * @return loyaltyProgramId + */ + @javax.annotation.Nullable + public Long getLoyaltyProgramId() { + return loyaltyProgramId; + } + + public void setLoyaltyProgramId(@javax.annotation.Nullable Long loyaltyProgramId) { + this.loyaltyProgramId = loyaltyProgramId; + } + + public RolesV2Thresholds loyaltyPointsLimit(@javax.annotation.Nullable Long loyaltyPointsLimit) { this.loyaltyPointsLimit = loyaltyPointsLimit; return this; @@ -131,19 +155,21 @@ public boolean equals(Object o) { return false; } RolesV2Thresholds rolesV2Thresholds = (RolesV2Thresholds) o; - return Objects.equals(this.loyaltyPointsLimit, rolesV2Thresholds.loyaltyPointsLimit)&& + return Objects.equals(this.loyaltyProgramId, rolesV2Thresholds.loyaltyProgramId) && + Objects.equals(this.loyaltyPointsLimit, rolesV2Thresholds.loyaltyPointsLimit)&& Objects.equals(this.additionalProperties, rolesV2Thresholds.additionalProperties); } @Override public int hashCode() { - return Objects.hash(loyaltyPointsLimit, additionalProperties); + return Objects.hash(loyaltyProgramId, loyaltyPointsLimit, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class RolesV2Thresholds {\n"); + sb.append(" loyaltyProgramId: ").append(toIndentedString(loyaltyProgramId)).append("\n"); sb.append(" loyaltyPointsLimit: ").append(toIndentedString(loyaltyPointsLimit)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -164,7 +190,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("loyaltyPointsLimit")); + openapiFields = new HashSet(Arrays.asList("loyaltyProgramId", "loyaltyPointsLimit")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); diff --git a/src/main/java/one/talon/model/RollbackAddedLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/RollbackAddedLoyaltyPointsEffectProps.java index 86940768..b142540b 100644 --- a/src/main/java/one/talon/model/RollbackAddedLoyaltyPointsEffectProps.java +++ b/src/main/java/one/talon/model/RollbackAddedLoyaltyPointsEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackAddedLoyaltyPoints\" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is cancelled. + * This effect is triggered in the following cases: - A session was cancelled in which loyalty points have been added. - A session was partially returned and loyalty point were added by the returned items. See [returning items](https://docs.talon.one/docs/dev/tutorials/partially-return-a-session). If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which items the loyalty points were rolled back for. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user for whom the loyalty points are rolled back. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points were originally added. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackAddedLoyaltyPointsEffectProps { public static final String SERIALIZED_NAME_PROGRAM_ID = "programId"; @SerializedName(SERIALIZED_NAME_PROGRAM_ID) @@ -100,7 +100,7 @@ public RollbackAddedLoyaltyPointsEffectProps programId(@javax.annotation.Nonnull } /** - * The ID of the loyalty program where the points were originally added. + * The ID of the loyalty program where these points were rolled back. * @return programId */ @javax.annotation.Nonnull @@ -119,7 +119,7 @@ public RollbackAddedLoyaltyPointsEffectProps subLedgerId(@javax.annotation.Nonnu } /** - * The ID of the subledger within the loyalty program where these points were originally added. + * The ID of the subledger within the loyalty program where these points were rolled back. * @return subLedgerId */ @javax.annotation.Nonnull @@ -157,7 +157,7 @@ public RollbackAddedLoyaltyPointsEffectProps recipientIntegrationId(@javax.annot } /** - * The user for whom these points were originally added. + * The user for whom these points were rolled back. * @return recipientIntegrationId */ @javax.annotation.Nonnull @@ -176,7 +176,7 @@ public RollbackAddedLoyaltyPointsEffectProps transactionUUID(@javax.annotation.N } /** - * The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. + * The identifier of this loyalty point transaction. * @return transactionUUID */ @javax.annotation.Nonnull @@ -195,7 +195,7 @@ public RollbackAddedLoyaltyPointsEffectProps cartItemPosition(@javax.annotation. } /** - * The index of the item in the cart items for which the loyalty points were rolled back. + * (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were rolled back. * @return cartItemPosition */ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public RollbackAddedLoyaltyPointsEffectProps cartItemSubPosition(@javax.annotati } /** - * For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back. + * (_Add points per cart item_ ) The index of the item unit in its line item. * @return cartItemSubPosition */ @javax.annotation.Nullable @@ -233,7 +233,7 @@ public RollbackAddedLoyaltyPointsEffectProps cardIdentifier(@javax.annotation.Nu } /** - * The card on which these points were originally added. + * The identifier of the card on which these points were originally added. * @return cardIdentifier */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/RollbackCouponEffectProps.java b/src/main/java/one/talon/model/RollbackCouponEffectProps.java index 5235e7dc..09829006 100644 --- a/src/main/java/one/talon/model/RollbackCouponEffectProps.java +++ b/src/main/java/one/talon/model/RollbackCouponEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackCoupon\" effect. This gets triggered whenever previously closed session is now cancelled and a coupon redemption was cancelled on our internal usage limit counters. + * This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. The effect is triggered when you [cancel](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state) a session where a coupon was accepted. See an example of use in the [cancelling a session tutorial](https://docs.talon.one/docs/dev/tutorials/roll-back-effects). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackCouponEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -64,7 +64,7 @@ public RollbackCouponEffectProps value(@javax.annotation.Nonnull String value) { } /** - * The coupon code whose usage has been rolled back. + * The coupon code whose redemption has been rolled back. * @return value */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectProps.java index 3b2b315d..9358f4c6 100644 --- a/src/main/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectProps.java +++ b/src/main/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectProps.java @@ -48,9 +48,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This effect is triggered whenever a previously closed session is cancelled and a deductLoyaltyPoints effect was revoked. + * This effect is triggered in the following cases: - A session is _cancelled_ and this session deducted loyalty points. The rollback action returns the redeemed loyalty points to the customer. - A session is impacted by a _partial return_. Only added loyalty points that are still **pending** are rolled back. - A session in which loyalty points were spent is reopened. See the [session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). If you set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/profile-based/profile-based-overview), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points are reimbursed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackDeductedLoyaltyPointsEffectProps { public static final String SERIALIZED_NAME_PROGRAM_ID = "programId"; @SerializedName(SERIALIZED_NAME_PROGRAM_ID) @@ -139,7 +139,7 @@ public RollbackDeductedLoyaltyPointsEffectProps value(@javax.annotation.Nonnull } /** - * The amount of reimbursed points that were added. + * The amount of points that were reimbursed. * @return value */ @javax.annotation.Nonnull @@ -177,7 +177,7 @@ public RollbackDeductedLoyaltyPointsEffectProps startDate(@javax.annotation.Null } /** - * Date after which the reimbursed points will be valid. + * The date after which the reimbursed points will be valid. * @return startDate */ @javax.annotation.Nullable @@ -196,7 +196,7 @@ public RollbackDeductedLoyaltyPointsEffectProps expiryDate(@javax.annotation.Nul } /** - * Date after which the reimbursed points will expire. + * The date after which the reimbursed points will expire. * @return expiryDate */ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public RollbackDeductedLoyaltyPointsEffectProps transactionUUID(@javax.annotatio } /** - * The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back. + * The identifier of this loyalty point transaction. * @return transactionUUID */ @javax.annotation.Nonnull @@ -234,7 +234,7 @@ public RollbackDeductedLoyaltyPointsEffectProps cardIdentifier(@javax.annotation } /** - * The card on which these points were added. + * The identifier of the card from which these points were originally deducted. * @return cardIdentifier */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/RollbackDiscountEffectProps.java b/src/main/java/one/talon/model/RollbackDiscountEffectProps.java index f24b8b05..d0adee44 100644 --- a/src/main/java/one/talon/model/RollbackDiscountEffectProps.java +++ b/src/main/java/one/talon/model/RollbackDiscountEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackDiscount\" effect. This gets triggered whenever previously closed session is now cancelled or partially returned and a setDiscount effect was cancelled on our internal discount limit counters. + * This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you set the status of a session to `cancel` or the status changes to `partially_returned`. If the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the specific item unit in its line item. See the example below. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackDiscountEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -95,7 +95,7 @@ public RollbackDiscountEffectProps name(@javax.annotation.Nonnull String name) { } /** - * The name of the \"setDiscount\" effect that was rolled back. + * The name of the discount effect that was rolled back. * @return name */ @javax.annotation.Nonnull @@ -114,7 +114,7 @@ public RollbackDiscountEffectProps value(@javax.annotation.Nonnull BigDecimal va } /** - * The value of the discount that was rolled back. + * The monetary value of the discount that was rolled back. * @return value */ @javax.annotation.Nonnull @@ -133,7 +133,7 @@ public RollbackDiscountEffectProps cartItemPosition(@javax.annotation.Nullable B } /** - * The index of the item in the cart items for which the discount was rolled back. + * The index of the item in the `cartItem` object whose discount was rolled back, or the unit containing the additional cost whose discount was rolled back. * @return cartItemPosition */ @javax.annotation.Nullable @@ -152,7 +152,7 @@ public RollbackDiscountEffectProps cartItemSubPosition(@javax.annotation.Nullabl } /** - * For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item. + * The index of the item unit in its line item for which the discount was rolled back. * @return cartItemSubPosition */ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public RollbackDiscountEffectProps additionalCostId(@javax.annotation.Nullable L } /** - * The ID of the additional cost that was rolled back. + * _Only when rolling back [setDiscountPerAdditionalCost](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcost) and [setDiscountPerAdditionalCostPerItem](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcostperitem)_ The ID of the additional cost to be discounted. * @return additionalCostId */ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public RollbackDiscountEffectProps additionalCost(@javax.annotation.Nullable Str } /** - * The name of the additional cost that was rolled back. + * The API name of the additional cost whose discount was rolled back. * @return additionalCost */ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public RollbackDiscountEffectProps scope(@javax.annotation.Nullable String scope } /** - * The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` + * The scope of the rolled back discount. - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` * @return scope */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/RollbackIncreasedAchievementProgressEffectProps.java b/src/main/java/one/talon/model/RollbackIncreasedAchievementProgressEffectProps.java index 61c3ce3f..c555aff5 100644 --- a/src/main/java/one/talon/model/RollbackIncreasedAchievementProgressEffectProps.java +++ b/src/main/java/one/talon/model/RollbackIncreasedAchievementProgressEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackIncreasedAchievementProgress\" effect. This gets triggered whenever a closed session where the `increaseAchievementProgress` effect was triggered is cancelled. This is applicable only when the customer has not completed the achievement. + * This effect indicates that the customer's progress in an achievement was rolled back. The Rule Engine triggers this effect when you cancel or [reopen a customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) that previously validated the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect and triggered the [increaseAchievementProgress](https://docs.talon.one/docs/dev/integration-api/api-effects#increaseachievementprogress) API effect. The effect is also triggered for completed achievements if the **Allow progress rollback for completed achievements** setting is enabled. You can enable this through the [Campaign Manager](https://docs.talon.one/docs/product/campaigns/achievements/manage-achievements) or the [Management API](https://docs.talon.one/management-api#tag/Achievements/operation/createAchievement) by setting the `achievementAllowRollbackAfterCompletion` property to `true`. This setting only applies to one-time and recurring on expiration achievements. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackIncreasedAchievementProgressEffectProps { public static final String SERIALIZED_NAME_ACHIEVEMENT_ID = "achievementId"; @SerializedName(SERIALIZED_NAME_ACHIEVEMENT_ID) @@ -147,7 +147,7 @@ public RollbackIncreasedAchievementProgressEffectProps decreaseProgressBy(@javax } /** - * The value by which the customer's current progress in the achievement is decreased. + * The value by which the customer's current progress in the achievement has decreased. * @return decreaseProgressBy */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/RollbackReferralEffectProps.java b/src/main/java/one/talon/model/RollbackReferralEffectProps.java index e289a763..ea9697ef 100644 --- a/src/main/java/one/talon/model/RollbackReferralEffectProps.java +++ b/src/main/java/one/talon/model/RollbackReferralEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"rollbackReferral\" effect. This gets triggered whenever previously closed session is now cancelled and a referral redemption was cancelled on our internal usage limit counters. + * This effect indicates that the redemption of the referral code has been rolled back. It triggers when a closed session that redeemed a referral is gets cancelled. The code becomes redeemable again. For more information about session states, see [Managing states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RollbackReferralEffectProps { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) @@ -64,7 +64,7 @@ public RollbackReferralEffectProps value(@javax.annotation.Nonnull String value) } /** - * The referral code whose usage has been rolled back. + * The referral code to be rolled back. * @return value */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/Rule.java b/src/main/java/one/talon/model/Rule.java index 2cd94efc..fc952e01 100644 --- a/src/main/java/one/talon/model/Rule.java +++ b/src/main/java/one/talon/model/Rule.java @@ -52,7 +52,7 @@ /** * Rule */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Rule { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/RuleEligibility.java b/src/main/java/one/talon/model/RuleEligibility.java index f954d866..cffdb3f7 100644 --- a/src/main/java/one/talon/model/RuleEligibility.java +++ b/src/main/java/one/talon/model/RuleEligibility.java @@ -49,7 +49,7 @@ /** * The customer's eligibility for a rule in the current session, based on whether all of the rule's conditions were met. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RuleEligibility { public static final String SERIALIZED_NAME_PASSED = "passed"; @SerializedName(SERIALIZED_NAME_PASSED) diff --git a/src/main/java/one/talon/model/RuleEligibilityFailureDetails.java b/src/main/java/one/talon/model/RuleEligibilityFailureDetails.java index 57a4205f..eed69c79 100644 --- a/src/main/java/one/talon/model/RuleEligibilityFailureDetails.java +++ b/src/main/java/one/talon/model/RuleEligibilityFailureDetails.java @@ -48,7 +48,7 @@ /** * The details about why the customer was not eligible for the rule in the current session. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RuleEligibilityFailureDetails { /** * A code identifying why the customer was not eligible for the rule in the current session. diff --git a/src/main/java/one/talon/model/RuleFailureReason.java b/src/main/java/one/talon/model/RuleFailureReason.java index 406c7915..8901a313 100644 --- a/src/main/java/one/talon/model/RuleFailureReason.java +++ b/src/main/java/one/talon/model/RuleFailureReason.java @@ -48,7 +48,7 @@ /** * Details about why a rule failed. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RuleFailureReason { public static final String SERIALIZED_NAME_CAMPAIGN_I_D = "campaignID"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_I_D) diff --git a/src/main/java/one/talon/model/RuleMetadata.java b/src/main/java/one/talon/model/RuleMetadata.java index a9ab3be7..898544f1 100644 --- a/src/main/java/one/talon/model/RuleMetadata.java +++ b/src/main/java/one/talon/model/RuleMetadata.java @@ -48,7 +48,7 @@ /** * RuleMetadata */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RuleMetadata { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/RuleMetadataEligibility.java b/src/main/java/one/talon/model/RuleMetadataEligibility.java index e3538392..0f3a6506 100644 --- a/src/main/java/one/talon/model/RuleMetadataEligibility.java +++ b/src/main/java/one/talon/model/RuleMetadataEligibility.java @@ -51,7 +51,7 @@ /** * RuleMetadataEligibility */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class RuleMetadataEligibility { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/Ruleset.java b/src/main/java/one/talon/model/Ruleset.java index 1c4af503..e0570926 100644 --- a/src/main/java/one/talon/model/Ruleset.java +++ b/src/main/java/one/talon/model/Ruleset.java @@ -53,7 +53,7 @@ /** * Ruleset */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Ruleset { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/SSOConfig.java b/src/main/java/one/talon/model/SSOConfig.java index a489f92e..0ba8dc29 100644 --- a/src/main/java/one/talon/model/SSOConfig.java +++ b/src/main/java/one/talon/model/SSOConfig.java @@ -48,7 +48,7 @@ /** * SSOConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SSOConfig { public static final String SERIALIZED_NAME_ENFORCED = "enforced"; @SerializedName(SERIALIZED_NAME_ENFORCED) diff --git a/src/main/java/one/talon/model/SamlConnection.java b/src/main/java/one/talon/model/SamlConnection.java index 19dd676b..28fbe7a6 100644 --- a/src/main/java/one/talon/model/SamlConnection.java +++ b/src/main/java/one/talon/model/SamlConnection.java @@ -49,7 +49,7 @@ /** * SamlConnection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SamlConnection { public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId"; @SerializedName(SERIALIZED_NAME_ACCOUNT_ID) diff --git a/src/main/java/one/talon/model/SamlConnectionInternal.java b/src/main/java/one/talon/model/SamlConnectionInternal.java index 01d5fe43..45250db1 100644 --- a/src/main/java/one/talon/model/SamlConnectionInternal.java +++ b/src/main/java/one/talon/model/SamlConnectionInternal.java @@ -48,7 +48,7 @@ /** * SamlConnectionInternal */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SamlConnectionInternal { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/SamlConnectionMetadata.java b/src/main/java/one/talon/model/SamlConnectionMetadata.java index 4d51ad65..09668469 100644 --- a/src/main/java/one/talon/model/SamlConnectionMetadata.java +++ b/src/main/java/one/talon/model/SamlConnectionMetadata.java @@ -49,7 +49,7 @@ /** * SamlConnectionMetadata */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SamlConnectionMetadata { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/SamlLoginEndpoint.java b/src/main/java/one/talon/model/SamlLoginEndpoint.java index 37477445..2c459426 100644 --- a/src/main/java/one/talon/model/SamlLoginEndpoint.java +++ b/src/main/java/one/talon/model/SamlLoginEndpoint.java @@ -48,7 +48,7 @@ /** * SamlLoginEndpoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SamlLoginEndpoint { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ScimBaseGroup.java b/src/main/java/one/talon/model/ScimBaseGroup.java index 2e0badb1..3cf73536 100644 --- a/src/main/java/one/talon/model/ScimBaseGroup.java +++ b/src/main/java/one/talon/model/ScimBaseGroup.java @@ -51,7 +51,7 @@ /** * Define the schema for base fields in a group using the SCIM provisioning protocol. Talon.One uses this schema to create roles. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimBaseGroup { public static final String SERIALIZED_NAME_DISPLAY_NAME = "displayName"; @SerializedName(SERIALIZED_NAME_DISPLAY_NAME) diff --git a/src/main/java/one/talon/model/ScimBaseUser.java b/src/main/java/one/talon/model/ScimBaseUser.java index 449b5df9..87d7b18f 100644 --- a/src/main/java/one/talon/model/ScimBaseUser.java +++ b/src/main/java/one/talon/model/ScimBaseUser.java @@ -49,7 +49,7 @@ /** * Schema definition for base user fields, provisioned using the SCIM protocol and used by Talon.One. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimBaseUser { public static final String SERIALIZED_NAME_ACTIVE = "active"; @SerializedName(SERIALIZED_NAME_ACTIVE) diff --git a/src/main/java/one/talon/model/ScimBaseUserName.java b/src/main/java/one/talon/model/ScimBaseUserName.java index 799eb568..3d0eec7d 100644 --- a/src/main/java/one/talon/model/ScimBaseUserName.java +++ b/src/main/java/one/talon/model/ScimBaseUserName.java @@ -48,7 +48,7 @@ /** * The components of the user’s real name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimBaseUserName { public static final String SERIALIZED_NAME_FORMATTED = "formatted"; @SerializedName(SERIALIZED_NAME_FORMATTED) diff --git a/src/main/java/one/talon/model/ScimGroup.java b/src/main/java/one/talon/model/ScimGroup.java index eb442a83..55ebf1cf 100644 --- a/src/main/java/one/talon/model/ScimGroup.java +++ b/src/main/java/one/talon/model/ScimGroup.java @@ -51,7 +51,7 @@ /** * Define the schema for groups created using the SCIM provisioning protocol. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimGroup { public static final String SERIALIZED_NAME_DISPLAY_NAME = "displayName"; @SerializedName(SERIALIZED_NAME_DISPLAY_NAME) diff --git a/src/main/java/one/talon/model/ScimGroupMember.java b/src/main/java/one/talon/model/ScimGroupMember.java index 26d994af..5b755796 100644 --- a/src/main/java/one/talon/model/ScimGroupMember.java +++ b/src/main/java/one/talon/model/ScimGroupMember.java @@ -48,7 +48,7 @@ /** * Member of the SCIM group. In Talon.One, the member is a [user](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to a specific role. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimGroupMember { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) diff --git a/src/main/java/one/talon/model/ScimGroupsListResponse.java b/src/main/java/one/talon/model/ScimGroupsListResponse.java index 0fe1ee2d..bfaae077 100644 --- a/src/main/java/one/talon/model/ScimGroupsListResponse.java +++ b/src/main/java/one/talon/model/ScimGroupsListResponse.java @@ -51,7 +51,7 @@ /** * List of groups created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimGroupsListResponse { public static final String SERIALIZED_NAME_RESOURCES = "Resources"; @SerializedName(SERIALIZED_NAME_RESOURCES) diff --git a/src/main/java/one/talon/model/ScimNewUser.java b/src/main/java/one/talon/model/ScimNewUser.java index ad007773..7213b2d9 100644 --- a/src/main/java/one/talon/model/ScimNewUser.java +++ b/src/main/java/one/talon/model/ScimNewUser.java @@ -49,7 +49,7 @@ /** * Payload for users that are created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimNewUser { public static final String SERIALIZED_NAME_ACTIVE = "active"; @SerializedName(SERIALIZED_NAME_ACTIVE) diff --git a/src/main/java/one/talon/model/ScimPatchOperation.java b/src/main/java/one/talon/model/ScimPatchOperation.java index da0b1c78..5e508a1d 100644 --- a/src/main/java/one/talon/model/ScimPatchOperation.java +++ b/src/main/java/one/talon/model/ScimPatchOperation.java @@ -48,7 +48,7 @@ /** * Patch operation that is used to update the information. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimPatchOperation { /** * The method that should be used in the operation. diff --git a/src/main/java/one/talon/model/ScimPatchRequest.java b/src/main/java/one/talon/model/ScimPatchRequest.java index 60131cc1..28193ab3 100644 --- a/src/main/java/one/talon/model/ScimPatchRequest.java +++ b/src/main/java/one/talon/model/ScimPatchRequest.java @@ -51,7 +51,7 @@ /** * SCIM Patch request */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimPatchRequest { public static final String SERIALIZED_NAME_SCHEMAS = "schemas"; @SerializedName(SERIALIZED_NAME_SCHEMAS) diff --git a/src/main/java/one/talon/model/ScimResource.java b/src/main/java/one/talon/model/ScimResource.java index 9889dea5..06dd207f 100644 --- a/src/main/java/one/talon/model/ScimResource.java +++ b/src/main/java/one/talon/model/ScimResource.java @@ -48,7 +48,7 @@ /** * Resource definition for the SCIM provisioning protocol. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimResource { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ScimResourceTypesListResponse.java b/src/main/java/one/talon/model/ScimResourceTypesListResponse.java index 53126abe..505e8c9c 100644 --- a/src/main/java/one/talon/model/ScimResourceTypesListResponse.java +++ b/src/main/java/one/talon/model/ScimResourceTypesListResponse.java @@ -51,7 +51,7 @@ /** * List of resource types supported by the SCIM provisioning protocol. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimResourceTypesListResponse { public static final String SERIALIZED_NAME_RESOURCES = "Resources"; @SerializedName(SERIALIZED_NAME_RESOURCES) diff --git a/src/main/java/one/talon/model/ScimSchemaResource.java b/src/main/java/one/talon/model/ScimSchemaResource.java index 76bd5b95..24cc512b 100644 --- a/src/main/java/one/talon/model/ScimSchemaResource.java +++ b/src/main/java/one/talon/model/ScimSchemaResource.java @@ -50,7 +50,7 @@ /** * Resource schema definition for the SCIM provisioning protocol. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimSchemaResource { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/ScimSchemasListResponse.java b/src/main/java/one/talon/model/ScimSchemasListResponse.java index 9ec61395..3cb52e6c 100644 --- a/src/main/java/one/talon/model/ScimSchemasListResponse.java +++ b/src/main/java/one/talon/model/ScimSchemasListResponse.java @@ -51,7 +51,7 @@ /** * List of resource schemas supported by the SCIM provisioning protocol. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimSchemasListResponse { public static final String SERIALIZED_NAME_RESOURCES = "Resources"; @SerializedName(SERIALIZED_NAME_RESOURCES) diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java index a8b3c8d1..14b58e52 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponse.java @@ -26,8 +26,6 @@ import one.talon.model.ScimServiceProviderConfigResponseBulk; import one.talon.model.ScimServiceProviderConfigResponseChangePassword; import one.talon.model.ScimServiceProviderConfigResponseFilter; -import one.talon.model.ScimServiceProviderConfigResponsePatch; -import one.talon.model.ScimServiceProviderConfigResponseSort; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -55,7 +53,7 @@ /** * Service provider configuration details. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimServiceProviderConfigResponse { public static final String SERIALIZED_NAME_BULK = "bulk"; @SerializedName(SERIALIZED_NAME_BULK) @@ -80,7 +78,7 @@ public class ScimServiceProviderConfigResponse { public static final String SERIALIZED_NAME_PATCH = "patch"; @SerializedName(SERIALIZED_NAME_PATCH) @javax.annotation.Nullable - private ScimServiceProviderConfigResponsePatch patch; + private ScimServiceProviderConfigResponseChangePassword patch; public static final String SERIALIZED_NAME_SCHEMAS = "schemas"; @SerializedName(SERIALIZED_NAME_SCHEMAS) @@ -90,7 +88,7 @@ public class ScimServiceProviderConfigResponse { public static final String SERIALIZED_NAME_SORT = "sort"; @SerializedName(SERIALIZED_NAME_SORT) @javax.annotation.Nullable - private ScimServiceProviderConfigResponseSort sort; + private ScimServiceProviderConfigResponseChangePassword sort; public ScimServiceProviderConfigResponse() { } @@ -171,7 +169,7 @@ public void setFilter(@javax.annotation.Nullable ScimServiceProviderConfigRespon } - public ScimServiceProviderConfigResponse patch(@javax.annotation.Nullable ScimServiceProviderConfigResponsePatch patch) { + public ScimServiceProviderConfigResponse patch(@javax.annotation.Nullable ScimServiceProviderConfigResponseChangePassword patch) { this.patch = patch; return this; } @@ -181,11 +179,11 @@ public ScimServiceProviderConfigResponse patch(@javax.annotation.Nullable ScimSe * @return patch */ @javax.annotation.Nullable - public ScimServiceProviderConfigResponsePatch getPatch() { + public ScimServiceProviderConfigResponseChangePassword getPatch() { return patch; } - public void setPatch(@javax.annotation.Nullable ScimServiceProviderConfigResponsePatch patch) { + public void setPatch(@javax.annotation.Nullable ScimServiceProviderConfigResponseChangePassword patch) { this.patch = patch; } @@ -217,7 +215,7 @@ public void setSchemas(@javax.annotation.Nullable List schemas) { } - public ScimServiceProviderConfigResponse sort(@javax.annotation.Nullable ScimServiceProviderConfigResponseSort sort) { + public ScimServiceProviderConfigResponse sort(@javax.annotation.Nullable ScimServiceProviderConfigResponseChangePassword sort) { this.sort = sort; return this; } @@ -227,11 +225,11 @@ public ScimServiceProviderConfigResponse sort(@javax.annotation.Nullable ScimSer * @return sort */ @javax.annotation.Nullable - public ScimServiceProviderConfigResponseSort getSort() { + public ScimServiceProviderConfigResponseChangePassword getSort() { return sort; } - public void setSort(@javax.annotation.Nullable ScimServiceProviderConfigResponseSort sort) { + public void setSort(@javax.annotation.Nullable ScimServiceProviderConfigResponseChangePassword sort) { this.sort = sort; } @@ -371,7 +369,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } // validate the optional field `patch` if (jsonObj.get("patch") != null && !jsonObj.get("patch").isJsonNull()) { - ScimServiceProviderConfigResponsePatch.validateJsonElement(jsonObj.get("patch")); + ScimServiceProviderConfigResponseChangePassword.validateJsonElement(jsonObj.get("patch")); } // ensure the optional json data is an array if present if (jsonObj.get("schemas") != null && !jsonObj.get("schemas").isJsonNull() && !jsonObj.get("schemas").isJsonArray()) { @@ -379,7 +377,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } // validate the optional field `sort` if (jsonObj.get("sort") != null && !jsonObj.get("sort").isJsonNull()) { - ScimServiceProviderConfigResponseSort.validateJsonElement(jsonObj.get("sort")); + ScimServiceProviderConfigResponseChangePassword.validateJsonElement(jsonObj.get("sort")); } } diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseBulk.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseBulk.java index 1bba2d83..4a3c55b5 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseBulk.java +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseBulk.java @@ -48,7 +48,7 @@ /** * Configuration related to bulk operations, which allow multiple SCIM requests to be processed in a single HTTP request. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimServiceProviderConfigResponseBulk { public static final String SERIALIZED_NAME_MAX_OPERATIONS = "maxOperations"; @SerializedName(SERIALIZED_NAME_MAX_OPERATIONS) diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseChangePassword.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseChangePassword.java index c33d27f0..bb83269e 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseChangePassword.java +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseChangePassword.java @@ -48,7 +48,7 @@ /** * Configuration settings related to the ability to change user passwords. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimServiceProviderConfigResponseChangePassword { public static final String SERIALIZED_NAME_SUPPORTED = "supported"; @SerializedName(SERIALIZED_NAME_SUPPORTED) diff --git a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseFilter.java b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseFilter.java index a1e1609d..d308247c 100644 --- a/src/main/java/one/talon/model/ScimServiceProviderConfigResponseFilter.java +++ b/src/main/java/one/talon/model/ScimServiceProviderConfigResponseFilter.java @@ -48,7 +48,7 @@ /** * Configuration settings related to filtering SCIM resources based on specific criteria. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimServiceProviderConfigResponseFilter { public static final String SERIALIZED_NAME_MAX_RESULTS = "maxResults"; @SerializedName(SERIALIZED_NAME_MAX_RESULTS) diff --git a/src/main/java/one/talon/model/ScimUser.java b/src/main/java/one/talon/model/ScimUser.java index 180fb0b5..af716af5 100644 --- a/src/main/java/one/talon/model/ScimUser.java +++ b/src/main/java/one/talon/model/ScimUser.java @@ -49,7 +49,7 @@ /** * Schema definition for users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimUser { public static final String SERIALIZED_NAME_ACTIVE = "active"; @SerializedName(SERIALIZED_NAME_ACTIVE) diff --git a/src/main/java/one/talon/model/ScimUsersListResponse.java b/src/main/java/one/talon/model/ScimUsersListResponse.java index 09e90d74..c8acd0d2 100644 --- a/src/main/java/one/talon/model/ScimUsersListResponse.java +++ b/src/main/java/one/talon/model/ScimUsersListResponse.java @@ -51,7 +51,7 @@ /** * List of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ScimUsersListResponse { public static final String SERIALIZED_NAME_RESOURCES = "Resources"; @SerializedName(SERIALIZED_NAME_RESOURCES) diff --git a/src/main/java/one/talon/model/SecondaryDeployment.java b/src/main/java/one/talon/model/SecondaryDeployment.java index f650e7a2..f490b096 100644 --- a/src/main/java/one/talon/model/SecondaryDeployment.java +++ b/src/main/java/one/talon/model/SecondaryDeployment.java @@ -49,7 +49,7 @@ /** * SecondaryDeployment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SecondaryDeployment { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Session.java b/src/main/java/one/talon/model/Session.java index a42774b0..dbabdf27 100644 --- a/src/main/java/one/talon/model/Session.java +++ b/src/main/java/one/talon/model/Session.java @@ -49,7 +49,7 @@ /** * Session */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Session { public static final String SERIALIZED_NAME_USER_ID = "userId"; @SerializedName(SERIALIZED_NAME_USER_ID) diff --git a/src/main/java/one/talon/model/SetDiscountEffectProps.java b/src/main/java/one/talon/model/SetDiscountEffectProps.java index bcc03fcf..02c96cf0 100644 --- a/src/main/java/one/talon/model/SetDiscountEffectProps.java +++ b/src/main/java/one/talon/model/SetDiscountEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied on the scope of defined with it. + * This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. The discount should overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for **all** effects, effectively overwriting any previous effects. Enabling [partial discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches `0`. Use the `desiredValue` property to identify the original value of the discount. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SetDiscountEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -80,7 +80,7 @@ public SetDiscountEffectProps name(@javax.annotation.Nonnull String name) { } /** - * The name / description of this discount + * The name or description of this discount. * @return name */ @javax.annotation.Nonnull @@ -99,7 +99,7 @@ public SetDiscountEffectProps value(@javax.annotation.Nonnull BigDecimal value) } /** - * The total monetary value of the discount. + * The monetary value of the effective discount. * @return value */ @javax.annotation.Nonnull @@ -118,7 +118,7 @@ public SetDiscountEffectProps scope(@javax.annotation.Nullable String scope) { } /** - * The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal). + * What the discount applies to. Possible values: - `cartItems`: Discount on the price of the items. - `additionalCosts`: Discount on the [additional costs](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the items. - `sessionTotal`: Discount on the total value of the customer session. **Note:** [Cascading discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#cascading-discounts) must be enabled for this property to be returned. * @return scope */ @javax.annotation.Nullable @@ -137,7 +137,7 @@ public SetDiscountEffectProps desiredValue(@javax.annotation.Nullable BigDecimal } /** - * The original value of the discount. + * _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. * @return desiredValue */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/SetDiscountPerAdditionalCostEffectProps.java b/src/main/java/one/talon/model/SetDiscountPerAdditionalCostEffectProps.java index 1ad8d8ad..6e1e1042 100644 --- a/src/main/java/one/talon/model/SetDiscountPerAdditionalCostEffectProps.java +++ b/src/main/java/one/talon/model/SetDiscountPerAdditionalCostEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"setDiscountPerAdditionalCost\" effect. This gets triggered whenever a validated rule contained a \"set per additional cost discount\" effect. This is a discount that should be applied on a specific additional cost. + * This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a **Discount additional cost** effect is validated. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SetDiscountPerAdditionalCostEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -85,7 +85,7 @@ public SetDiscountPerAdditionalCostEffectProps name(@javax.annotation.Nonnull St } /** - * The name / description of this discount + * The name of the discount. * @return name */ @javax.annotation.Nonnull @@ -104,7 +104,7 @@ public SetDiscountPerAdditionalCostEffectProps additionalCostId(@javax.annotatio } /** - * The ID of the additional cost. + * The identifier of the additional cost. * @return additionalCostId */ @javax.annotation.Nonnull @@ -123,7 +123,7 @@ public SetDiscountPerAdditionalCostEffectProps additionalCost(@javax.annotation. } /** - * The name of the additional cost. + * The API name of the additional cost. * @return additionalCost */ @javax.annotation.Nonnull @@ -142,7 +142,7 @@ public SetDiscountPerAdditionalCostEffectProps value(@javax.annotation.Nonnull B } /** - * The total monetary value of the discount. + * The monetary value of the discount to apply. * @return value */ @javax.annotation.Nonnull @@ -161,7 +161,7 @@ public SetDiscountPerAdditionalCostEffectProps desiredValue(@javax.annotation.Nu } /** - * The original value of the discount. + * _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. * @return desiredValue */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/SetDiscountPerAdditionalCostPerItemEffectProps.java b/src/main/java/one/talon/model/SetDiscountPerAdditionalCostPerItemEffectProps.java index 6e7f2ad1..fcf8f033 100644 --- a/src/main/java/one/talon/model/SetDiscountPerAdditionalCostPerItemEffectProps.java +++ b/src/main/java/one/talon/model/SetDiscountPerAdditionalCostPerItemEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"setDiscountPerAdditionalCostPerItem\" effect. This gets triggered whenever a validated rule contained a \"set discount per additional cost per item\" effect. This is a discount that should be applied on a specific additional cost in a specific item. + * This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a **Discount additional cost per item** effect is validated. Use this effect when **all** items in the cart have an additional cost. If one of more items do not have an additional cost, the rule will fail. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SetDiscountPerAdditionalCostPerItemEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -95,7 +95,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps name(@javax.annotation.Non } /** - * The name / description of this discount + * The description of this discount. `#number` is appended to the name. It is equal to the `position` property. * @return name */ @javax.annotation.Nonnull @@ -114,7 +114,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps additionalCostId(@javax.an } /** - * The ID of the additional cost. + * The identifier of the additional cost to be discounted. * @return additionalCostId */ @javax.annotation.Nonnull @@ -133,7 +133,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps value(@javax.annotation.No } /** - * The total monetary value of the discount. + * The monetary value of the effective discount applied to the item's additional cost. * @return value */ @javax.annotation.Nonnull @@ -152,7 +152,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps position(@javax.annotation } /** - * The index of the item in the cart item list containing the additional cost to be discounted. + * The index of the item in the `cartItem` object containing the additional cost that this discount applies to. * @return position */ @javax.annotation.Nonnull @@ -171,7 +171,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps subPosition(@javax.annotat } /** - * For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. + * The index of the item unit in its line item. * @return subPosition */ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps additionalCost(@javax.anno } /** - * The name of the additional cost. + * The API name of the additional cost to be discounted. * @return additionalCost */ @javax.annotation.Nonnull @@ -209,7 +209,7 @@ public SetDiscountPerAdditionalCostPerItemEffectProps desiredValue(@javax.annota } /** - * Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. + * _[(Partial discounts enabled only)](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts)_. The monetary value of the discount to be applied to the additional cost without considering budget limitations. * @return desiredValue */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/SetDiscountPerItemEffectProps.java b/src/main/java/one/talon/model/SetDiscountPerItemEffectProps.java index c6e8edfc..313947b0 100644 --- a/src/main/java/one/talon/model/SetDiscountPerItemEffectProps.java +++ b/src/main/java/one/talon/model/SetDiscountPerItemEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a \"set per item discount\" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope. + * This effect schema is returned when you use the **Discount individual items**, **Discount individual items pro rata**, or **Discount individual item in bundles** effect in a rule. It indicates that a discount per item should be applied on the specific item specified in the effect. The properties it contains depends on: - Whether you used a pro rata effect or not. - Whether you used an effect with bundles or not. - Whether the partial discount feature is enabled. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SetDiscountPerItemEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -125,7 +125,7 @@ public SetDiscountPerItemEffectProps name(@javax.annotation.Nonnull String name) } /** - * The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. + * The description of this discount. `#number` is equal to the `position` property. * @return name */ @javax.annotation.Nonnull @@ -144,7 +144,7 @@ public SetDiscountPerItemEffectProps value(@javax.annotation.Nonnull BigDecimal } /** - * The total monetary value of the discount. + * The monetary value of the effective discount applied to the item. * @return value */ @javax.annotation.Nonnull @@ -163,7 +163,7 @@ public SetDiscountPerItemEffectProps position(@javax.annotation.Nonnull BigDecim } /** - * The index of the item in the cart items list on which this discount should be applied. + * The index of the item in the `cartItem` object on which this discount should be applied. * @return position */ @javax.annotation.Nonnull @@ -182,7 +182,7 @@ public SetDiscountPerItemEffectProps subPosition(@javax.annotation.Nullable BigD } /** - * For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. + * The index of the item unit in its line item. * @return subPosition */ @javax.annotation.Nullable @@ -201,7 +201,7 @@ public SetDiscountPerItemEffectProps desiredValue(@javax.annotation.Nullable Big } /** - * The original value of the discount. + * _(Partial discounts enabled only)_ The monetary value of the discount to be applied to the item without considering budget limitations. * @return desiredValue */ @javax.annotation.Nullable @@ -220,7 +220,7 @@ public SetDiscountPerItemEffectProps scope(@javax.annotation.Nullable String sco } /** - * The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. + * What the discount applies to. Possible values: - `price`: discount on the price of the item. - `additionalCosts`: discount on the [additional cost](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the item. - `itemTotal`: discount on the sum of price + additional cost of the item. * @return scope */ @javax.annotation.Nullable @@ -239,7 +239,7 @@ public SetDiscountPerItemEffectProps totalDiscount(@javax.annotation.Nullable Bi } /** - * The total discount given if this effect is a result of a prorated discount. + * _(Pro rata discounts only)_ The monetary value of the total effective discount * @return totalDiscount */ @javax.annotation.Nullable @@ -258,7 +258,7 @@ public SetDiscountPerItemEffectProps desiredTotalDiscount(@javax.annotation.Null } /** - * The original total discount to give if this effect is a result of a prorated discount. + * _(Pro rata discounts only)_ The monetary value of the total discount to be applied without considering budget limitations * @return desiredTotalDiscount */ @javax.annotation.Nullable @@ -277,7 +277,7 @@ public SetDiscountPerItemEffectProps bundleIndex(@javax.annotation.Nullable Long } /** - * The position of the bundle in a list of item bundles created from the same bundle definition. + * _(Discounts with bundles only)_ The position of the specific item bundle in the list of bundles created from the same bundle definition. * @return bundleIndex */ @javax.annotation.Nullable @@ -296,7 +296,7 @@ public SetDiscountPerItemEffectProps bundleName(@javax.annotation.Nullable Strin } /** - * The name of the bundle definition. + * _(Discounts with bundles only)_ The name of the bundle definition. * @return bundleName */ @javax.annotation.Nullable @@ -315,7 +315,7 @@ public SetDiscountPerItemEffectProps targetedItemPosition(@javax.annotation.Null } /** - * The index of the targeted bundle item on which the applied discount is based. + * _(Discounting individual item in bundles only)_ The index of the targeted bundle item on which the applied discount is based. * @return targetedItemPosition */ @javax.annotation.Nullable @@ -334,7 +334,7 @@ public SetDiscountPerItemEffectProps targetedItemSubPosition(@javax.annotation.N } /** - * The sub-position of the targeted bundle item on which the applied discount is based. + * _(Discounting individual item in bundles only)_ The sub-position of the targeted bundle item on which the applied discount is based. * @return targetedItemSubPosition */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/SetLoyaltyPointsExpiryDateEffectProps.java b/src/main/java/one/talon/model/SetLoyaltyPointsExpiryDateEffectProps.java index f84ddbd9..0732a65a 100644 --- a/src/main/java/one/talon/model/SetLoyaltyPointsExpiryDateEffectProps.java +++ b/src/main/java/one/talon/model/SetLoyaltyPointsExpiryDateEffectProps.java @@ -50,9 +50,9 @@ import one.talon.JSON; /** - * The properties specific to the \"setLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"set expiry date\" effect. The current expiry date gets set to the date given in the effect. + * This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SetLoyaltyPointsExpiryDateEffectProps { public static final String SERIALIZED_NAME_PROGRAM_ID = "programId"; @SerializedName(SERIALIZED_NAME_PROGRAM_ID) diff --git a/src/main/java/one/talon/model/ShowBundleMetadataEffectProps.java b/src/main/java/one/talon/model/ShowBundleMetadataEffectProps.java index 1c418692..afc0e881 100644 --- a/src/main/java/one/talon/model/ShowBundleMetadataEffectProps.java +++ b/src/main/java/one/talon/model/ShowBundleMetadataEffectProps.java @@ -49,9 +49,9 @@ import one.talon.JSON; /** - * This effect is **deprecated**. The properties specific to the \"ShowBundleMetadata\" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. + * This effect is **deprecated**. The `ShowBundleMetadata` effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ShowBundleMetadataEffectProps { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/ShowNotificationEffectProps.java b/src/main/java/one/talon/model/ShowNotificationEffectProps.java index 52421173..a0520994 100644 --- a/src/main/java/one/talon/model/ShowNotificationEffectProps.java +++ b/src/main/java/one/talon/model/ShowNotificationEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"showNotification\" effect. This gets triggered whenever a validated rule contained a \"show notification\" effect. + * You can use notifications to inform customers of certain events. There are four types of notification messages: - `Info` - `Offer` - `Error` - `Misc` It is up to you to use the Rule Builder to decide why and when to show notifications. Notifications can be used as both rule effects and failure effects. A common use case is to display the notification at the top of the cart view in your web app. You can use the notification type to vary the styling of the notification message. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ShowNotificationEffectProps { public static final String SERIALIZED_NAME_NOTIFICATION_TYPE = "notificationType"; @SerializedName(SERIALIZED_NAME_NOTIFICATION_TYPE) @@ -74,7 +74,7 @@ public ShowNotificationEffectProps notificationType(@javax.annotation.Nonnull St } /** - * The type of notification that should be shown (e.g. error/warning/info). + * The type of notification. * @return notificationType */ @javax.annotation.Nonnull @@ -93,7 +93,7 @@ public ShowNotificationEffectProps title(@javax.annotation.Nonnull String title) } /** - * Title of the notification. + * The title of the notification. * @return title */ @javax.annotation.Nonnull @@ -112,7 +112,7 @@ public ShowNotificationEffectProps body(@javax.annotation.Nonnull String body) { } /** - * Body of the notification. + * The body of the notification. * @return body */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/SkuUnitAnalytics.java b/src/main/java/one/talon/model/SkuUnitAnalytics.java index 32f3271b..08b9e234 100644 --- a/src/main/java/one/talon/model/SkuUnitAnalytics.java +++ b/src/main/java/one/talon/model/SkuUnitAnalytics.java @@ -52,7 +52,7 @@ /** * SkuUnitAnalytics */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SkuUnitAnalytics { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/SkuUnitAnalyticsDataPoint.java b/src/main/java/one/talon/model/SkuUnitAnalyticsDataPoint.java index 2f0dccf0..17e970d0 100644 --- a/src/main/java/one/talon/model/SkuUnitAnalyticsDataPoint.java +++ b/src/main/java/one/talon/model/SkuUnitAnalyticsDataPoint.java @@ -50,7 +50,7 @@ /** * SkuUnitAnalyticsDataPoint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SkuUnitAnalyticsDataPoint { public static final String SERIALIZED_NAME_START_TIME = "startTime"; @SerializedName(SERIALIZED_NAME_START_TIME) diff --git a/src/main/java/one/talon/model/SlotDef.java b/src/main/java/one/talon/model/SlotDef.java index ec18301c..85a46627 100644 --- a/src/main/java/one/talon/model/SlotDef.java +++ b/src/main/java/one/talon/model/SlotDef.java @@ -48,7 +48,7 @@ /** * SlotDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SlotDef { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/Store.java b/src/main/java/one/talon/model/Store.java index 5f7c9618..2a352bd7 100644 --- a/src/main/java/one/talon/model/Store.java +++ b/src/main/java/one/talon/model/Store.java @@ -51,7 +51,7 @@ /** * Store */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Store { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/StrikethroughChangedItem.java b/src/main/java/one/talon/model/StrikethroughChangedItem.java index 14602d28..cb5dcbda 100644 --- a/src/main/java/one/talon/model/StrikethroughChangedItem.java +++ b/src/main/java/one/talon/model/StrikethroughChangedItem.java @@ -56,7 +56,7 @@ /** * The information of affected items. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughChangedItem { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/StrikethroughCustomEffectPerItemProps.java b/src/main/java/one/talon/model/StrikethroughCustomEffectPerItemProps.java index 2224df21..4e234e06 100644 --- a/src/main/java/one/talon/model/StrikethroughCustomEffectPerItemProps.java +++ b/src/main/java/one/talon/model/StrikethroughCustomEffectPerItemProps.java @@ -48,7 +48,7 @@ /** * customEffectPerItem effect in strikethrough pricing payload. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughCustomEffectPerItemProps { public static final String SERIALIZED_NAME_EFFECT_ID = "effectId"; @SerializedName(SERIALIZED_NAME_EFFECT_ID) diff --git a/src/main/java/one/talon/model/StrikethroughDebugResponse.java b/src/main/java/one/talon/model/StrikethroughDebugResponse.java index ee5d4578..13776196 100644 --- a/src/main/java/one/talon/model/StrikethroughDebugResponse.java +++ b/src/main/java/one/talon/model/StrikethroughDebugResponse.java @@ -51,7 +51,7 @@ /** * StrikethroughDebugResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughDebugResponse { public static final String SERIALIZED_NAME_CAMPAIGNS_I_DS = "campaignsIDs"; @SerializedName(SERIALIZED_NAME_CAMPAIGNS_I_DS) diff --git a/src/main/java/one/talon/model/StrikethroughEffect.java b/src/main/java/one/talon/model/StrikethroughEffect.java index 8eefed8f..2c41e528 100644 --- a/src/main/java/one/talon/model/StrikethroughEffect.java +++ b/src/main/java/one/talon/model/StrikethroughEffect.java @@ -52,7 +52,7 @@ /** * The effect produced for the catalog item. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughEffect { public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId"; @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID) diff --git a/src/main/java/one/talon/model/StrikethroughLabelingNotification.java b/src/main/java/one/talon/model/StrikethroughLabelingNotification.java index 5699fadc..f0d1307a 100644 --- a/src/main/java/one/talon/model/StrikethroughLabelingNotification.java +++ b/src/main/java/one/talon/model/StrikethroughLabelingNotification.java @@ -53,7 +53,7 @@ /** * The strikethrough labels notification for an application. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughLabelingNotification { /** * The version of the strikethrough pricing notification. Set for **scheduled** strikethrough pricing updates only. diff --git a/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemEffectProps.java b/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemEffectProps.java index 7668b9e6..704d64a8 100644 --- a/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemEffectProps.java +++ b/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemEffectProps.java @@ -48,7 +48,7 @@ /** * setDiscountPerItem effect in strikethrough pricing payload. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughSetDiscountPerItemEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemMemberEffectProps.java b/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemMemberEffectProps.java index e06da416..992218ee 100644 --- a/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemMemberEffectProps.java +++ b/src/main/java/one/talon/model/StrikethroughSetDiscountPerItemMemberEffectProps.java @@ -48,7 +48,7 @@ /** * setDiscountPerItem member effect in strikethrough pricing payload. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughSetDiscountPerItemMemberEffectProps { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/StrikethroughTrigger.java b/src/main/java/one/talon/model/StrikethroughTrigger.java index e6b0b623..392fdd23 100644 --- a/src/main/java/one/talon/model/StrikethroughTrigger.java +++ b/src/main/java/one/talon/model/StrikethroughTrigger.java @@ -49,7 +49,7 @@ /** * Information about the event that triggered the strikethrough labeling. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class StrikethroughTrigger { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/SummarizeCampaignStoreBudget200Response.java b/src/main/java/one/talon/model/SummarizeCampaignStoreBudget200Response.java index 9d9ed846..1e269adb 100644 --- a/src/main/java/one/talon/model/SummarizeCampaignStoreBudget200Response.java +++ b/src/main/java/one/talon/model/SummarizeCampaignStoreBudget200Response.java @@ -51,7 +51,7 @@ /** * SummarizeCampaignStoreBudget200Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SummarizeCampaignStoreBudget200Response { public static final String SERIALIZED_NAME_DATA = "data"; @SerializedName(SERIALIZED_NAME_DATA) diff --git a/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java b/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java index 5adad0ae..bab7f53e 100644 --- a/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java +++ b/src/main/java/one/talon/model/SummaryCampaignStoreBudget.java @@ -48,7 +48,7 @@ /** * SummaryCampaignStoreBudget */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SummaryCampaignStoreBudget { /** * Gets or Sets action diff --git a/src/main/java/one/talon/model/SupportRequest.java b/src/main/java/one/talon/model/SupportRequest.java index 35a86dc7..1a954c0a 100644 --- a/src/main/java/one/talon/model/SupportRequest.java +++ b/src/main/java/one/talon/model/SupportRequest.java @@ -49,7 +49,7 @@ /** * Summary of a support request created by a customer support agent. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SupportRequest { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/SupportRequestInput.java b/src/main/java/one/talon/model/SupportRequestInput.java index 059acf97..30ecf896 100644 --- a/src/main/java/one/talon/model/SupportRequestInput.java +++ b/src/main/java/one/talon/model/SupportRequestInput.java @@ -48,7 +48,7 @@ /** * SupportRequestInput */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class SupportRequestInput { public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId"; @SerializedName(SERIALIZED_NAME_APPLICATION_ID) diff --git a/src/main/java/one/talon/model/TalangAttribute.java b/src/main/java/one/talon/model/TalangAttribute.java index e90a5bf8..03ecc331 100644 --- a/src/main/java/one/talon/model/TalangAttribute.java +++ b/src/main/java/one/talon/model/TalangAttribute.java @@ -50,7 +50,7 @@ /** * TalangAttribute */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TalangAttribute { /** * The name of the entity of the attribute. diff --git a/src/main/java/one/talon/model/TalangAttributeVisibility.java b/src/main/java/one/talon/model/TalangAttributeVisibility.java index 853569be..ba7d7e9d 100644 --- a/src/main/java/one/talon/model/TalangAttributeVisibility.java +++ b/src/main/java/one/talon/model/TalangAttributeVisibility.java @@ -50,7 +50,7 @@ /** * TalangAttributeVisibility */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TalangAttributeVisibility { public static final String SERIALIZED_NAME_INVISIBLE = "invisible"; @SerializedName(SERIALIZED_NAME_INVISIBLE) diff --git a/src/main/java/one/talon/model/TemplateArgDef.java b/src/main/java/one/talon/model/TemplateArgDef.java index 44f60069..dd4d0be5 100644 --- a/src/main/java/one/talon/model/TemplateArgDef.java +++ b/src/main/java/one/talon/model/TemplateArgDef.java @@ -48,7 +48,7 @@ /** * TemplateArgDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TemplateArgDef { /** * The type of value this argument expects. @@ -211,7 +211,7 @@ public TemplateArgDef ui(@javax.annotation.Nonnull Object ui) { } /** - * Arbitrary metadata that may be used to render an input for this argument. + * Arbitrary properties associated with this campaign. * @return ui */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/TemplateDef.java b/src/main/java/one/talon/model/TemplateDef.java index d3d88b23..562eb41c 100644 --- a/src/main/java/one/talon/model/TemplateDef.java +++ b/src/main/java/one/talon/model/TemplateDef.java @@ -52,7 +52,7 @@ /** * TemplateDef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TemplateDef { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/TemplateLimitConfig.java b/src/main/java/one/talon/model/TemplateLimitConfig.java index 15db5069..13e0a22f 100644 --- a/src/main/java/one/talon/model/TemplateLimitConfig.java +++ b/src/main/java/one/talon/model/TemplateLimitConfig.java @@ -51,7 +51,7 @@ /** * TemplateLimitConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TemplateLimitConfig { public static final String SERIALIZED_NAME_ACTION = "action"; @SerializedName(SERIALIZED_NAME_ACTION) diff --git a/src/main/java/one/talon/model/Tier.java b/src/main/java/one/talon/model/Tier.java index f03b1f7e..0a45bc02 100644 --- a/src/main/java/one/talon/model/Tier.java +++ b/src/main/java/one/talon/model/Tier.java @@ -49,7 +49,7 @@ /** * Tier */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Tier { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/TierDowngradeData.java b/src/main/java/one/talon/model/TierDowngradeData.java index 5f6f3d88..b447729b 100644 --- a/src/main/java/one/talon/model/TierDowngradeData.java +++ b/src/main/java/one/talon/model/TierDowngradeData.java @@ -50,7 +50,7 @@ /** * TierDowngradeData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierDowngradeData { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE_I_D = "CustomerProfileID"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE_I_D) diff --git a/src/main/java/one/talon/model/TierDowngradeNotification.java b/src/main/java/one/talon/model/TierDowngradeNotification.java index 58bedf9b..24ba6a08 100644 --- a/src/main/java/one/talon/model/TierDowngradeNotification.java +++ b/src/main/java/one/talon/model/TierDowngradeNotification.java @@ -51,7 +51,7 @@ /** * TierDowngradeNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierDowngradeNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/TierDowngradeNotificationPolicy.java b/src/main/java/one/talon/model/TierDowngradeNotificationPolicy.java index 2052a802..2eb432fc 100644 --- a/src/main/java/one/talon/model/TierDowngradeNotificationPolicy.java +++ b/src/main/java/one/talon/model/TierDowngradeNotificationPolicy.java @@ -48,7 +48,7 @@ /** * TierDowngradeNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierDowngradeNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/TierUpgradeData.java b/src/main/java/one/talon/model/TierUpgradeData.java index 94e07c77..23d4c7dc 100644 --- a/src/main/java/one/talon/model/TierUpgradeData.java +++ b/src/main/java/one/talon/model/TierUpgradeData.java @@ -50,7 +50,7 @@ /** * TierUpgradeData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierUpgradeData { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE_I_D = "CustomerProfileID"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE_I_D) diff --git a/src/main/java/one/talon/model/TierUpgradeNotification.java b/src/main/java/one/talon/model/TierUpgradeNotification.java index bb4b53f3..54944672 100644 --- a/src/main/java/one/talon/model/TierUpgradeNotification.java +++ b/src/main/java/one/talon/model/TierUpgradeNotification.java @@ -51,7 +51,7 @@ /** * TierUpgradeNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierUpgradeNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/TierUpgradeNotificationPolicy.java b/src/main/java/one/talon/model/TierUpgradeNotificationPolicy.java index fc03e8f1..96adce01 100644 --- a/src/main/java/one/talon/model/TierUpgradeNotificationPolicy.java +++ b/src/main/java/one/talon/model/TierUpgradeNotificationPolicy.java @@ -48,7 +48,7 @@ /** * TierUpgradeNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierUpgradeNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/TierWillDowngradeData.java b/src/main/java/one/talon/model/TierWillDowngradeData.java index dea3375a..eca3c306 100644 --- a/src/main/java/one/talon/model/TierWillDowngradeData.java +++ b/src/main/java/one/talon/model/TierWillDowngradeData.java @@ -50,7 +50,7 @@ /** * TierWillDowngradeData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierWillDowngradeData { public static final String SERIALIZED_NAME_CUSTOMER_PROFILE_I_D = "CustomerProfileID"; @SerializedName(SERIALIZED_NAME_CUSTOMER_PROFILE_I_D) diff --git a/src/main/java/one/talon/model/TierWillDowngradeNotification.java b/src/main/java/one/talon/model/TierWillDowngradeNotification.java index 141c19d8..38e27e08 100644 --- a/src/main/java/one/talon/model/TierWillDowngradeNotification.java +++ b/src/main/java/one/talon/model/TierWillDowngradeNotification.java @@ -51,7 +51,7 @@ /** * TierWillDowngradeNotification */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierWillDowngradeNotification { public static final String SERIALIZED_NAME_TOTAL_RESULT_SIZE = "TotalResultSize"; @SerializedName(SERIALIZED_NAME_TOTAL_RESULT_SIZE) diff --git a/src/main/java/one/talon/model/TierWillDowngradeNotificationPolicy.java b/src/main/java/one/talon/model/TierWillDowngradeNotificationPolicy.java index dd0a4a6b..9da66715 100644 --- a/src/main/java/one/talon/model/TierWillDowngradeNotificationPolicy.java +++ b/src/main/java/one/talon/model/TierWillDowngradeNotificationPolicy.java @@ -51,7 +51,7 @@ /** * TierWillDowngradeNotificationPolicy */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierWillDowngradeNotificationPolicy { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/TierWillDowngradeNotificationTrigger.java b/src/main/java/one/talon/model/TierWillDowngradeNotificationTrigger.java index 6adf3d45..6c54dde7 100644 --- a/src/main/java/one/talon/model/TierWillDowngradeNotificationTrigger.java +++ b/src/main/java/one/talon/model/TierWillDowngradeNotificationTrigger.java @@ -48,7 +48,7 @@ /** * TierWillDowngradeNotificationTrigger */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TierWillDowngradeNotificationTrigger { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @SerializedName(SERIALIZED_NAME_AMOUNT) diff --git a/src/main/java/one/talon/model/TimePoint.java b/src/main/java/one/talon/model/TimePoint.java index 1def14bd..088bcffe 100644 --- a/src/main/java/one/talon/model/TimePoint.java +++ b/src/main/java/one/talon/model/TimePoint.java @@ -48,7 +48,7 @@ /** * The absolute duration after which the achievement ends and resets for a particular customer profile. **Note**: The duration follows the time zone of the Application this achievement belongs to. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TimePoint { public static final String SERIALIZED_NAME_MONTH = "month"; @SerializedName(SERIALIZED_NAME_MONTH) diff --git a/src/main/java/one/talon/model/TransferLoyaltyCard.java b/src/main/java/one/talon/model/TransferLoyaltyCard.java index 9ddae4b0..14bf5a5b 100644 --- a/src/main/java/one/talon/model/TransferLoyaltyCard.java +++ b/src/main/java/one/talon/model/TransferLoyaltyCard.java @@ -48,7 +48,7 @@ /** * TransferLoyaltyCard */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TransferLoyaltyCard { public static final String SERIALIZED_NAME_NEW_CARD_IDENTIFIER = "newCardIdentifier"; @SerializedName(SERIALIZED_NAME_NEW_CARD_IDENTIFIER) diff --git a/src/main/java/one/talon/model/TriggerWebhookEffectProps.java b/src/main/java/one/talon/model/TriggerWebhookEffectProps.java index 426a29d0..e975dece 100644 --- a/src/main/java/one/talon/model/TriggerWebhookEffectProps.java +++ b/src/main/java/one/talon/model/TriggerWebhookEffectProps.java @@ -47,9 +47,9 @@ import one.talon.JSON; /** - * The properties specific to the \"triggerWebhook\" effect. This gets triggered whenever a validated rule contained a \"trigger webhook\" effect. This is communicated as an FYI and should usually not require action on your side. + * This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effects#webhooks) is validated. The details are shared with you for your information only. It usually doesn't require an action on your side. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TriggerWebhookEffectProps { public static final String SERIALIZED_NAME_WEBHOOK_ID = "webhookId"; @SerializedName(SERIALIZED_NAME_WEBHOOK_ID) @@ -70,7 +70,7 @@ public TriggerWebhookEffectProps webhookId(@javax.annotation.Nonnull BigDecimal } /** - * The ID of the webhook that was triggered. + * The internal ID of the webhook. * @return webhookId */ @javax.annotation.Nonnull @@ -89,7 +89,7 @@ public TriggerWebhookEffectProps webhookName(@javax.annotation.Nonnull String we } /** - * The name of the webhook that was triggered. + * The name of the webhook. * @return webhookName */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/TwoFAConfig.java b/src/main/java/one/talon/model/TwoFAConfig.java index 3750514a..83c7b58f 100644 --- a/src/main/java/one/talon/model/TwoFAConfig.java +++ b/src/main/java/one/talon/model/TwoFAConfig.java @@ -48,7 +48,7 @@ /** * TwoFAConfig */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class TwoFAConfig { public static final String SERIALIZED_NAME_ENABLED = "enabled"; @SerializedName(SERIALIZED_NAME_ENABLED) diff --git a/src/main/java/one/talon/model/UpdateAccount.java b/src/main/java/one/talon/model/UpdateAccount.java index 40b03a97..a3cec6e5 100644 --- a/src/main/java/one/talon/model/UpdateAccount.java +++ b/src/main/java/one/talon/model/UpdateAccount.java @@ -49,7 +49,7 @@ /** * UpdateAccount */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateAccount { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/UpdateAchievement.java b/src/main/java/one/talon/model/UpdateAchievement.java index 3f9227c1..3c10be04 100644 --- a/src/main/java/one/talon/model/UpdateAchievement.java +++ b/src/main/java/one/talon/model/UpdateAchievement.java @@ -51,7 +51,7 @@ /** * UpdateAchievement */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateAchievement { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateAchievementV2.java b/src/main/java/one/talon/model/UpdateAchievementV2.java index 3a94a461..fcb9a6c4 100644 --- a/src/main/java/one/talon/model/UpdateAchievementV2.java +++ b/src/main/java/one/talon/model/UpdateAchievementV2.java @@ -52,7 +52,7 @@ /** * UpdateAchievementV2 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateAchievementV2 { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateApplication.java b/src/main/java/one/talon/model/UpdateApplication.java index 0493623a..9e177eac 100644 --- a/src/main/java/one/talon/model/UpdateApplication.java +++ b/src/main/java/one/talon/model/UpdateApplication.java @@ -52,7 +52,7 @@ /** * UpdateApplication */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateApplication { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateApplicationAPIKey.java b/src/main/java/one/talon/model/UpdateApplicationAPIKey.java index 8f2019a1..022a2253 100644 --- a/src/main/java/one/talon/model/UpdateApplicationAPIKey.java +++ b/src/main/java/one/talon/model/UpdateApplicationAPIKey.java @@ -48,7 +48,7 @@ /** * UpdateApplicationAPIKey */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateApplicationAPIKey { public static final String SERIALIZED_NAME_TIME_OFFSET = "timeOffset"; @SerializedName(SERIALIZED_NAME_TIME_OFFSET) diff --git a/src/main/java/one/talon/model/UpdateApplicationCIF.java b/src/main/java/one/talon/model/UpdateApplicationCIF.java index 7b6ba565..1503f066 100644 --- a/src/main/java/one/talon/model/UpdateApplicationCIF.java +++ b/src/main/java/one/talon/model/UpdateApplicationCIF.java @@ -49,7 +49,7 @@ /** * UpdateApplicationCIF */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateApplicationCIF { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/UpdateAttributeEffectProps.java b/src/main/java/one/talon/model/UpdateAttributeEffectProps.java index 6e8b4fcc..a2e17474 100644 --- a/src/main/java/one/talon/model/UpdateAttributeEffectProps.java +++ b/src/main/java/one/talon/model/UpdateAttributeEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"updateAttribute\" effect. This gets triggered whenever a validated rule contained an \"update an attribute\" effect. + * This effect indicates that a rule containing an [Update attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) or [Update cart item attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) was validated. You should update the value of the attribute in your system based on the content of the returned effect. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateAttributeEffectProps { public static final String SERIALIZED_NAME_PATH = "path"; @SerializedName(SERIALIZED_NAME_PATH) @@ -69,7 +69,7 @@ public UpdateAttributeEffectProps path(@javax.annotation.Nonnull String path) { } /** - * The exact path of the attribute that was updated. + * The entity type and the attribute name. * @return path */ @javax.annotation.Nonnull diff --git a/src/main/java/one/talon/model/UpdateAudience.java b/src/main/java/one/talon/model/UpdateAudience.java index 4d2cbcc6..25b04a51 100644 --- a/src/main/java/one/talon/model/UpdateAudience.java +++ b/src/main/java/one/talon/model/UpdateAudience.java @@ -50,7 +50,7 @@ /** * UpdateAudience */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateAudience { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateBlueprint.java b/src/main/java/one/talon/model/UpdateBlueprint.java index a0f030a6..7fab129d 100644 --- a/src/main/java/one/talon/model/UpdateBlueprint.java +++ b/src/main/java/one/talon/model/UpdateBlueprint.java @@ -52,7 +52,7 @@ /** * UpdateBlueprint */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateBlueprint { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/UpdateCampaign.java b/src/main/java/one/talon/model/UpdateCampaign.java index 808171cb..d45343e5 100644 --- a/src/main/java/one/talon/model/UpdateCampaign.java +++ b/src/main/java/one/talon/model/UpdateCampaign.java @@ -53,7 +53,7 @@ /** * UpdateCampaign */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCampaign { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateCampaignCollection.java b/src/main/java/one/talon/model/UpdateCampaignCollection.java index 5e65be0d..9e91247d 100644 --- a/src/main/java/one/talon/model/UpdateCampaignCollection.java +++ b/src/main/java/one/talon/model/UpdateCampaignCollection.java @@ -48,7 +48,7 @@ /** * UpdateCampaignCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCampaignCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java b/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java index 6e291212..dfeb7cdf 100644 --- a/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java +++ b/src/main/java/one/talon/model/UpdateCampaignEvaluationGroup.java @@ -48,7 +48,7 @@ /** * UpdateCampaignEvaluationGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCampaignEvaluationGroup { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateCampaignGroup.java b/src/main/java/one/talon/model/UpdateCampaignGroup.java index eeeef0b5..b7d8b3aa 100644 --- a/src/main/java/one/talon/model/UpdateCampaignGroup.java +++ b/src/main/java/one/talon/model/UpdateCampaignGroup.java @@ -50,7 +50,7 @@ /** * UpdateCampaignGroup */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCampaignGroup { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateCampaignTemplate.java b/src/main/java/one/talon/model/UpdateCampaignTemplate.java index 84af8d30..207ff409 100644 --- a/src/main/java/one/talon/model/UpdateCampaignTemplate.java +++ b/src/main/java/one/talon/model/UpdateCampaignTemplate.java @@ -55,7 +55,7 @@ /** * UpdateCampaignTemplate */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCampaignTemplate { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateCatalog.java b/src/main/java/one/talon/model/UpdateCatalog.java index a3a638a9..4e7f27c1 100644 --- a/src/main/java/one/talon/model/UpdateCatalog.java +++ b/src/main/java/one/talon/model/UpdateCatalog.java @@ -50,7 +50,7 @@ /** * UpdateCatalog */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCatalog { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/UpdateCollection.java b/src/main/java/one/talon/model/UpdateCollection.java index 555ce5e3..229752f1 100644 --- a/src/main/java/one/talon/model/UpdateCollection.java +++ b/src/main/java/one/talon/model/UpdateCollection.java @@ -50,7 +50,7 @@ /** * UpdateCollection */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCollection { public static final String SERIALIZED_NAME_DESCRIPTION = "description"; @SerializedName(SERIALIZED_NAME_DESCRIPTION) diff --git a/src/main/java/one/talon/model/UpdateCoupon.java b/src/main/java/one/talon/model/UpdateCoupon.java index 30d8f7f8..531eb6cf 100644 --- a/src/main/java/one/talon/model/UpdateCoupon.java +++ b/src/main/java/one/talon/model/UpdateCoupon.java @@ -53,7 +53,7 @@ /** * UpdateCoupon */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCoupon { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) @@ -261,7 +261,7 @@ public UpdateCoupon attributes(@javax.annotation.Nullable Object attributes) { } /** - * Arbitrary properties associated with this item. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/UpdateCouponBatch.java b/src/main/java/one/talon/model/UpdateCouponBatch.java index 8c7faf20..db91cc91 100644 --- a/src/main/java/one/talon/model/UpdateCouponBatch.java +++ b/src/main/java/one/talon/model/UpdateCouponBatch.java @@ -50,7 +50,7 @@ /** * UpdateCouponBatch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCouponBatch { public static final String SERIALIZED_NAME_USAGE_LIMIT = "usageLimit"; @SerializedName(SERIALIZED_NAME_USAGE_LIMIT) @@ -197,7 +197,7 @@ public UpdateCouponBatch attributes(@javax.annotation.Nullable Object attributes } /** - * Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. + * Arbitrary properties associated with this campaign. * @return attributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/UpdateCouponsData.java b/src/main/java/one/talon/model/UpdateCouponsData.java index eb5727b8..83ff3938 100644 --- a/src/main/java/one/talon/model/UpdateCouponsData.java +++ b/src/main/java/one/talon/model/UpdateCouponsData.java @@ -48,7 +48,7 @@ /** * UpdateCouponsData */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCouponsData { public static final String SERIALIZED_NAME_BATCH_I_D = "BatchID"; @SerializedName(SERIALIZED_NAME_BATCH_I_D) diff --git a/src/main/java/one/talon/model/UpdateCustomEffect.java b/src/main/java/one/talon/model/UpdateCustomEffect.java index a0f317d2..f960ad24 100644 --- a/src/main/java/one/talon/model/UpdateCustomEffect.java +++ b/src/main/java/one/talon/model/UpdateCustomEffect.java @@ -51,7 +51,7 @@ /** * UpdateCustomEffect */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCustomEffect { public static final String SERIALIZED_NAME_APPLICATION_IDS = "applicationIds"; @SerializedName(SERIALIZED_NAME_APPLICATION_IDS) diff --git a/src/main/java/one/talon/model/UpdateCustomerSessionV2409Response.java b/src/main/java/one/talon/model/UpdateCustomerSessionV2409Response.java index bafeacc3..7b102ab8 100644 --- a/src/main/java/one/talon/model/UpdateCustomerSessionV2409Response.java +++ b/src/main/java/one/talon/model/UpdateCustomerSessionV2409Response.java @@ -50,7 +50,7 @@ /** * UpdateCustomerSessionV2409Response */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateCustomerSessionV2409Response { public static final String SERIALIZED_NAME_MESSAGE = "message"; @SerializedName(SERIALIZED_NAME_MESSAGE) diff --git a/src/main/java/one/talon/model/UpdateExperiment.java b/src/main/java/one/talon/model/UpdateExperiment.java index 182fe2c6..6e08351c 100644 --- a/src/main/java/one/talon/model/UpdateExperiment.java +++ b/src/main/java/one/talon/model/UpdateExperiment.java @@ -49,7 +49,7 @@ /** * UpdateExperiment */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateExperiment { public static final String SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL = "isVariantAssignmentExternal"; @SerializedName(SERIALIZED_NAME_IS_VARIANT_ASSIGNMENT_EXTERNAL) diff --git a/src/main/java/one/talon/model/UpdateExperimentVariant.java b/src/main/java/one/talon/model/UpdateExperimentVariant.java index 31621ee3..6f6812aa 100644 --- a/src/main/java/one/talon/model/UpdateExperimentVariant.java +++ b/src/main/java/one/talon/model/UpdateExperimentVariant.java @@ -49,7 +49,7 @@ /** * UpdateExperimentVariant */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateExperimentVariant { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/UpdateExperimentVariantArray.java b/src/main/java/one/talon/model/UpdateExperimentVariantArray.java index 2df48d63..5a1f5771 100644 --- a/src/main/java/one/talon/model/UpdateExperimentVariantArray.java +++ b/src/main/java/one/talon/model/UpdateExperimentVariantArray.java @@ -51,7 +51,7 @@ /** * UpdateExperimentVariantArray */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateExperimentVariantArray { public static final String SERIALIZED_NAME_VARIANTS = "variants"; @SerializedName(SERIALIZED_NAME_VARIANTS) diff --git a/src/main/java/one/talon/model/UpdateExperimentVariantName.java b/src/main/java/one/talon/model/UpdateExperimentVariantName.java index 2f07aa48..f5b4f6c3 100644 --- a/src/main/java/one/talon/model/UpdateExperimentVariantName.java +++ b/src/main/java/one/talon/model/UpdateExperimentVariantName.java @@ -48,7 +48,7 @@ /** * UpdateExperimentVariantName */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateExperimentVariantName { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateLoyaltyCard.java b/src/main/java/one/talon/model/UpdateLoyaltyCard.java index dd170983..d99e98e6 100644 --- a/src/main/java/one/talon/model/UpdateLoyaltyCard.java +++ b/src/main/java/one/talon/model/UpdateLoyaltyCard.java @@ -48,7 +48,7 @@ /** * UpdateLoyaltyCard */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateLoyaltyCard { public static final String SERIALIZED_NAME_STATUS = "status"; @SerializedName(SERIALIZED_NAME_STATUS) diff --git a/src/main/java/one/talon/model/UpdateLoyaltyCardRequest.java b/src/main/java/one/talon/model/UpdateLoyaltyCardRequest.java index 261c2174..28a2cbe7 100644 --- a/src/main/java/one/talon/model/UpdateLoyaltyCardRequest.java +++ b/src/main/java/one/talon/model/UpdateLoyaltyCardRequest.java @@ -48,7 +48,7 @@ /** * UpdateLoyaltyCardRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateLoyaltyCardRequest { public static final String SERIALIZED_NAME_STATUS = "status"; @SerializedName(SERIALIZED_NAME_STATUS) diff --git a/src/main/java/one/talon/model/UpdateLoyaltyProgram.java b/src/main/java/one/talon/model/UpdateLoyaltyProgram.java index 2fbbe414..f5521d34 100644 --- a/src/main/java/one/talon/model/UpdateLoyaltyProgram.java +++ b/src/main/java/one/talon/model/UpdateLoyaltyProgram.java @@ -53,7 +53,7 @@ /** * UpdateLoyaltyProgram */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateLoyaltyProgram { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java b/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java index 04b47d08..8737e1cc 100644 --- a/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java +++ b/src/main/java/one/talon/model/UpdateLoyaltyProgramTier.java @@ -49,7 +49,7 @@ /** * Update a tier in a specified loyalty program. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateLoyaltyProgramTier { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/UpdatePicklist.java b/src/main/java/one/talon/model/UpdatePicklist.java index 4c9d7148..4539c8ec 100644 --- a/src/main/java/one/talon/model/UpdatePicklist.java +++ b/src/main/java/one/talon/model/UpdatePicklist.java @@ -50,7 +50,7 @@ /** * UpdatePicklist */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdatePicklist { /** * The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. diff --git a/src/main/java/one/talon/model/UpdatePriceType.java b/src/main/java/one/talon/model/UpdatePriceType.java index f85b7163..2e92427d 100644 --- a/src/main/java/one/talon/model/UpdatePriceType.java +++ b/src/main/java/one/talon/model/UpdatePriceType.java @@ -50,7 +50,7 @@ /** * UpdatePriceType */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdatePriceType { public static final String SERIALIZED_NAME_TITLE = "title"; @SerializedName(SERIALIZED_NAME_TITLE) diff --git a/src/main/java/one/talon/model/UpdateReferral.java b/src/main/java/one/talon/model/UpdateReferral.java index 64b03b3b..78a4d3e5 100644 --- a/src/main/java/one/talon/model/UpdateReferral.java +++ b/src/main/java/one/talon/model/UpdateReferral.java @@ -49,7 +49,7 @@ /** * UpdateReferral */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateReferral { public static final String SERIALIZED_NAME_FRIEND_PROFILE_INTEGRATION_ID = "friendProfileIntegrationId"; @SerializedName(SERIALIZED_NAME_FRIEND_PROFILE_INTEGRATION_ID) diff --git a/src/main/java/one/talon/model/UpdateReferralBatch.java b/src/main/java/one/talon/model/UpdateReferralBatch.java index a79def19..59a78817 100644 --- a/src/main/java/one/talon/model/UpdateReferralBatch.java +++ b/src/main/java/one/talon/model/UpdateReferralBatch.java @@ -49,7 +49,7 @@ /** * UpdateReferralBatch */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateReferralBatch { public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes"; @SerializedName(SERIALIZED_NAME_ATTRIBUTES) diff --git a/src/main/java/one/talon/model/UpdateReward.java b/src/main/java/one/talon/model/UpdateReward.java index 90a93ea9..89ac997b 100644 --- a/src/main/java/one/talon/model/UpdateReward.java +++ b/src/main/java/one/talon/model/UpdateReward.java @@ -53,7 +53,7 @@ /** * UpdateReward */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateReward { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateRiskNotification.java b/src/main/java/one/talon/model/UpdateRiskNotification.java new file mode 100644 index 00000000..fd9cb607 --- /dev/null +++ b/src/main/java/one/talon/model/UpdateRiskNotification.java @@ -0,0 +1,542 @@ +/* + * 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) 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#tag/Customer-sessions/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 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 java.io.IOException; +import java.util.Arrays; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import one.talon.JSON; + +/** + * Data for updating a risk notification. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") +public class UpdateRiskNotification { + /** + * The entity type to analyze within the given time frame. + */ + @JsonAdapter(EntityEnum.Adapter.class) + public enum EntityEnum { + CUSTOMER_PROFILE("customer_profile"), + + CUSTOMER_SESSION("customer_session"); + + private String value; + + EntityEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static EntityEnum fromValue(String value) { + for (EntityEnum b : EntityEnum.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 EntityEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public EntityEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return EntityEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + EntityEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_ENTITY = "entity"; + @SerializedName(SERIALIZED_NAME_ENTITY) + @javax.annotation.Nonnull + private EntityEnum entity; + + /** + * The activity metric to analyze within the given entity. + */ + @JsonAdapter(ActivityEnum.Adapter.class) + public enum ActivityEnum { + LOYALTY_POINTS_EARNED("loyalty_points_earned"), + + DISCOUNTED_AMOUNT("discounted_amount"), + + COMPLETED_ORDERS("completed_orders"), + + COUPON_ATTEMPTS("coupon_attempts"); + + private String value; + + ActivityEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActivityEnum fromValue(String value) { + for (ActivityEnum b : ActivityEnum.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 ActivityEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActivityEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActivityEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + ActivityEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_ACTIVITY = "activity"; + @SerializedName(SERIALIZED_NAME_ACTIVITY) + @javax.annotation.Nonnull + private ActivityEnum activity; + + /** + * The rolling time window for risk evaluation. + */ + @JsonAdapter(TimeFrameEnum.Adapter.class) + public enum TimeFrameEnum { + _1_DAY("1_day"), + + _1_WEEK("1_week"), + + _1_MONTH("1_month"); + + private String value; + + TimeFrameEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TimeFrameEnum fromValue(String value) { + for (TimeFrameEnum b : TimeFrameEnum.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 TimeFrameEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TimeFrameEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TimeFrameEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + TimeFrameEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_TIME_FRAME = "timeFrame"; + @SerializedName(SERIALIZED_NAME_TIME_FRAME) + @javax.annotation.Nonnull + private TimeFrameEnum timeFrame; + + public static final String SERIALIZED_NAME_ACTIVE = "active"; + @SerializedName(SERIALIZED_NAME_ACTIVE) + @javax.annotation.Nonnull + private Boolean active; + + public UpdateRiskNotification() { + } + + public UpdateRiskNotification entity(@javax.annotation.Nonnull EntityEnum entity) { + this.entity = entity; + return this; + } + + /** + * The entity type to analyze within the given time frame. + * @return entity + */ + @javax.annotation.Nonnull + public EntityEnum getEntity() { + return entity; + } + + public void setEntity(@javax.annotation.Nonnull EntityEnum entity) { + this.entity = entity; + } + + + public UpdateRiskNotification activity(@javax.annotation.Nonnull ActivityEnum activity) { + this.activity = activity; + return this; + } + + /** + * The activity metric to analyze within the given entity. + * @return activity + */ + @javax.annotation.Nonnull + public ActivityEnum getActivity() { + return activity; + } + + public void setActivity(@javax.annotation.Nonnull ActivityEnum activity) { + this.activity = activity; + } + + + public UpdateRiskNotification timeFrame(@javax.annotation.Nonnull TimeFrameEnum timeFrame) { + this.timeFrame = timeFrame; + return this; + } + + /** + * The rolling time window for risk evaluation. + * @return timeFrame + */ + @javax.annotation.Nonnull + public TimeFrameEnum getTimeFrame() { + return timeFrame; + } + + public void setTimeFrame(@javax.annotation.Nonnull TimeFrameEnum timeFrame) { + this.timeFrame = timeFrame; + } + + + public UpdateRiskNotification active(@javax.annotation.Nonnull Boolean active) { + this.active = active; + return this; + } + + /** + * Indicates whether this risk notification is active. + * @return active + */ + @javax.annotation.Nonnull + public Boolean getActive() { + return active; + } + + public void setActive(@javax.annotation.Nonnull Boolean active) { + this.active = active; + } + + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + * + * @param key name of the property + * @param value value of the property + * @return the UpdateRiskNotification instance itself + */ + public UpdateRiskNotification putAdditionalProperty(String key, Object value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) property. + * + * @return a map of objects + */ + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + * + * @param key name of the property + * @return an object + */ + public Object getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UpdateRiskNotification updateRiskNotification = (UpdateRiskNotification) o; + return Objects.equals(this.entity, updateRiskNotification.entity) && + Objects.equals(this.activity, updateRiskNotification.activity) && + Objects.equals(this.timeFrame, updateRiskNotification.timeFrame) && + Objects.equals(this.active, updateRiskNotification.active)&& + Objects.equals(this.additionalProperties, updateRiskNotification.additionalProperties); + } + + @Override + public int hashCode() { + return Objects.hash(entity, activity, timeFrame, active, additionalProperties); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UpdateRiskNotification {\n"); + sb.append(" entity: ").append(toIndentedString(entity)).append("\n"); + sb.append(" activity: ").append(toIndentedString(activity)).append("\n"); + sb.append(" timeFrame: ").append(toIndentedString(timeFrame)).append("\n"); + sb.append(" active: ").append(toIndentedString(active)).append("\n"); + sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).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(Object o) { + return o == null ? "null" : o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(Arrays.asList("entity", "activity", "timeFrame", "active")); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(Arrays.asList("entity", "activity", "timeFrame", "active")); + } + + /** + * Validates the JSON Element and throws an exception if issues found + * + * @param jsonElement JSON Element + * @throws IOException if the JSON Element is invalid with respect to UpdateRiskNotification + */ + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + if (jsonElement == null) { + if (!UpdateRiskNotification.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in UpdateRiskNotification is not found in the empty JSON string", UpdateRiskNotification.openapiRequiredFields.toString())); + } + } + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : UpdateRiskNotification.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); + } + } + JsonObject jsonObj = jsonElement.getAsJsonObject(); + if (!jsonObj.get("entity").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `entity` to be a primitive type in the JSON string but got `%s`", jsonObj.get("entity").toString())); + } + // validate the required field `entity` + EntityEnum.validateJsonElement(jsonObj.get("entity")); + if (!jsonObj.get("activity").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `activity` to be a primitive type in the JSON string but got `%s`", jsonObj.get("activity").toString())); + } + // validate the required field `activity` + ActivityEnum.validateJsonElement(jsonObj.get("activity")); + if (!jsonObj.get("timeFrame").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `timeFrame` to be a primitive type in the JSON string but got `%s`", jsonObj.get("timeFrame").toString())); + } + // validate the required field `timeFrame` + TimeFrameEnum.validateJsonElement(jsonObj.get("timeFrame")); + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!UpdateRiskNotification.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'UpdateRiskNotification' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(UpdateRiskNotification.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, UpdateRiskNotification value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + obj.remove("additionalProperties"); + // serialize additional properties + if (value.getAdditionalProperties() != null) { + for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { + if (entry.getValue() instanceof String) + obj.addProperty(entry.getKey(), (String) entry.getValue()); + else if (entry.getValue() instanceof Number) + obj.addProperty(entry.getKey(), (Number) entry.getValue()); + else if (entry.getValue() instanceof Boolean) + obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); + else if (entry.getValue() instanceof Character) + obj.addProperty(entry.getKey(), (Character) entry.getValue()); + else { + JsonElement jsonElement = gson.toJsonTree(entry.getValue()); + if (jsonElement.isJsonArray()) { + obj.add(entry.getKey(), jsonElement.getAsJsonArray()); + } else { + obj.add(entry.getKey(), jsonElement.getAsJsonObject()); + } + } + } + } + elementAdapter.write(out, obj); + } + + @Override + public UpdateRiskNotification read(JsonReader in) throws IOException { + JsonElement jsonElement = elementAdapter.read(in); + validateJsonElement(jsonElement); + JsonObject jsonObj = jsonElement.getAsJsonObject(); + // store additional fields in the deserialized instance + UpdateRiskNotification instance = thisAdapter.fromJsonTree(jsonObj); + for (Map.Entry entry : jsonObj.entrySet()) { + if (!openapiFields.contains(entry.getKey())) { + if (entry.getValue().isJsonPrimitive()) { // primitive type + if (entry.getValue().getAsJsonPrimitive().isString()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); + else if (entry.getValue().getAsJsonPrimitive().isNumber()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); + else if (entry.getValue().getAsJsonPrimitive().isBoolean()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); + else + throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); + } else if (entry.getValue().isJsonArray()) { + instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); + } else { // JSON object + instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); + } + } + } + return instance; + } + + }.nullSafe(); + } + } + + /** + * Create an instance of UpdateRiskNotification given an JSON string + * + * @param jsonString JSON string + * @return An instance of UpdateRiskNotification + * @throws IOException if the JSON string is invalid with respect to UpdateRiskNotification + */ + public static UpdateRiskNotification fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, UpdateRiskNotification.class); + } + + /** + * Convert an instance of UpdateRiskNotification to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/one/talon/model/UpdateRole.java b/src/main/java/one/talon/model/UpdateRole.java index 78158f30..0a456a5d 100644 --- a/src/main/java/one/talon/model/UpdateRole.java +++ b/src/main/java/one/talon/model/UpdateRole.java @@ -50,7 +50,7 @@ /** * UpdateRole */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateRole { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateStore.java b/src/main/java/one/talon/model/UpdateStore.java index aa6cd6b4..fab37a2e 100644 --- a/src/main/java/one/talon/model/UpdateStore.java +++ b/src/main/java/one/talon/model/UpdateStore.java @@ -48,7 +48,7 @@ /** * UpdateStore */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateStore { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/UpdateSupportRequest.java b/src/main/java/one/talon/model/UpdateSupportRequest.java index a9ec8d95..3c35dde3 100644 --- a/src/main/java/one/talon/model/UpdateSupportRequest.java +++ b/src/main/java/one/talon/model/UpdateSupportRequest.java @@ -48,7 +48,7 @@ /** * UpdateSupportRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateSupportRequest { /** * Current status of the support request. diff --git a/src/main/java/one/talon/model/UpdateUser.java b/src/main/java/one/talon/model/UpdateUser.java index 140ab86d..c75e106d 100644 --- a/src/main/java/one/talon/model/UpdateUser.java +++ b/src/main/java/one/talon/model/UpdateUser.java @@ -50,7 +50,7 @@ /** * UpdateUser */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UpdateUser { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/one/talon/model/User.java b/src/main/java/one/talon/model/User.java index 30a99f7c..d2cb9cd4 100644 --- a/src/main/java/one/talon/model/User.java +++ b/src/main/java/one/talon/model/User.java @@ -51,7 +51,7 @@ /** * User */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class User { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) @@ -437,7 +437,7 @@ public User applicationNotificationSubscriptions(@javax.annotation.Nullable Obje } /** - * Application notifications that the user is subscribed to. + * Arbitrary properties associated with this campaign. * @return applicationNotificationSubscriptions */ @javax.annotation.Nullable @@ -513,7 +513,7 @@ public User additionalAttributes(@javax.annotation.Nullable Object additionalAtt } /** - * Additional user attributes, created and used by external identity providers. + * Arbitrary properties associated with this campaign. * @return additionalAttributes */ @javax.annotation.Nullable diff --git a/src/main/java/one/talon/model/UserEntity.java b/src/main/java/one/talon/model/UserEntity.java index 61342521..c6f4a423 100644 --- a/src/main/java/one/talon/model/UserEntity.java +++ b/src/main/java/one/talon/model/UserEntity.java @@ -48,7 +48,7 @@ /** * UserEntity */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class UserEntity { public static final String SERIALIZED_NAME_USER_ID = "userId"; @SerializedName(SERIALIZED_NAME_USER_ID) diff --git a/src/main/java/one/talon/model/ValueMap.java b/src/main/java/one/talon/model/ValueMap.java index 6ef91eec..4c0187c5 100644 --- a/src/main/java/one/talon/model/ValueMap.java +++ b/src/main/java/one/talon/model/ValueMap.java @@ -49,7 +49,7 @@ /** * ValueMap */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class ValueMap { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/Webhook.java b/src/main/java/one/talon/model/Webhook.java index b1e796b1..d6867522 100644 --- a/src/main/java/one/talon/model/Webhook.java +++ b/src/main/java/one/talon/model/Webhook.java @@ -52,7 +52,7 @@ /** * Webhook */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class Webhook { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/WebhookAuthentication.java b/src/main/java/one/talon/model/WebhookAuthentication.java index 5eefeefd..0e2123db 100644 --- a/src/main/java/one/talon/model/WebhookAuthentication.java +++ b/src/main/java/one/talon/model/WebhookAuthentication.java @@ -52,7 +52,7 @@ /** * WebhookAuthentication */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WebhookAuthentication { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/WebhookAuthenticationDataBasic.java b/src/main/java/one/talon/model/WebhookAuthenticationDataBasic.java index 82df3e8e..11c0049a 100644 --- a/src/main/java/one/talon/model/WebhookAuthenticationDataBasic.java +++ b/src/main/java/one/talon/model/WebhookAuthenticationDataBasic.java @@ -48,7 +48,7 @@ /** * WebhookAuthenticationDataBasic */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WebhookAuthenticationDataBasic { public static final String SERIALIZED_NAME_USERNAME = "username"; @SerializedName(SERIALIZED_NAME_USERNAME) diff --git a/src/main/java/one/talon/model/WebhookAuthenticationDataCustom.java b/src/main/java/one/talon/model/WebhookAuthenticationDataCustom.java index 8921ba6c..cb770b00 100644 --- a/src/main/java/one/talon/model/WebhookAuthenticationDataCustom.java +++ b/src/main/java/one/talon/model/WebhookAuthenticationDataCustom.java @@ -50,7 +50,7 @@ /** * WebhookAuthenticationDataCustom */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WebhookAuthenticationDataCustom { public static final String SERIALIZED_NAME_HEADERS = "headers"; @SerializedName(SERIALIZED_NAME_HEADERS) diff --git a/src/main/java/one/talon/model/WebhookAuthenticationWebhookRef.java b/src/main/java/one/talon/model/WebhookAuthenticationWebhookRef.java index c7e77c7d..eef624a6 100644 --- a/src/main/java/one/talon/model/WebhookAuthenticationWebhookRef.java +++ b/src/main/java/one/talon/model/WebhookAuthenticationWebhookRef.java @@ -48,7 +48,7 @@ /** * WebhookAuthenticationWebhookRef */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WebhookAuthenticationWebhookRef { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java b/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java index 09b7198d..f56d1cc8 100644 --- a/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java +++ b/src/main/java/one/talon/model/WebhookWithOutgoingIntegrationDetails.java @@ -52,7 +52,7 @@ /** * WebhookWithOutgoingIntegrationDetails */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WebhookWithOutgoingIntegrationDetails { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/one/talon/model/WillAwardGiveawayEffectProps.java b/src/main/java/one/talon/model/WillAwardGiveawayEffectProps.java index 4c5908d7..b8db1066 100644 --- a/src/main/java/one/talon/model/WillAwardGiveawayEffectProps.java +++ b/src/main/java/one/talon/model/WillAwardGiveawayEffectProps.java @@ -46,9 +46,9 @@ import one.talon.JSON; /** - * The properties specific to the \"awardGiveaway\" effect when the session is not closed yet. This effect replaces \"awardGiveaway\" only when updating a session with any state other than \"closed\". This is to ensure no giveaway codes are leaked when they are still not guaranteed to be awarded. + * The equivalent of the `awardGiveaway` effect but returned when updating a session with any state other than `closed`. This ensures no giveaway codes are leaked when they are still not guaranteed to be awarded. For more information about session states, see [Manage the session's state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.22.0") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.23.0") public class WillAwardGiveawayEffectProps { public static final String SERIALIZED_NAME_POOL_ID = "poolId"; @SerializedName(SERIALIZED_NAME_POOL_ID) @@ -74,7 +74,7 @@ public WillAwardGiveawayEffectProps poolId(@javax.annotation.Nonnull Long poolId } /** - * The ID of the giveaways pool the code will be taken from. + * The internal ID of the giveaway pool. * @return poolId */ @javax.annotation.Nonnull @@ -93,7 +93,7 @@ public WillAwardGiveawayEffectProps poolName(@javax.annotation.Nonnull String po } /** - * The name of the giveaways pool the code will be taken from. + * The name of the giveaway pool. * @return poolName */ @javax.annotation.Nonnull @@ -112,7 +112,7 @@ public WillAwardGiveawayEffectProps recipientIntegrationId(@javax.annotation.Non } /** - * The integration ID of the profile that will be awarded the giveaway. + * The integration ID of the customer that receives the giveaway. * @return recipientIntegrationId */ @javax.annotation.Nonnull diff --git a/src/test/java/one/talon/api/IntegrationApiTest.java b/src/test/java/one/talon/api/IntegrationApiTest.java index fa49a621..5972d232 100644 --- a/src/test/java/one/talon/api/IntegrationApiTest.java +++ b/src/test/java/one/talon/api/IntegrationApiTest.java @@ -31,6 +31,7 @@ import one.talon.model.DeleteLoyaltyTransactionsRequest; import one.talon.model.ErrorResponse; import one.talon.model.ErrorResponseWithStatus; +import one.talon.model.EventV3; import one.talon.model.GenerateLoyaltyCard; import one.talon.model.GetCustomerAchievementHistory200Response; import one.talon.model.GetCustomerAchievements200Response; @@ -42,6 +43,8 @@ import one.talon.model.IntegrationCustomerSessionResponse; import one.talon.model.IntegrationEventV2Request; import one.talon.model.IntegrationEventV2Response; +import one.talon.model.IntegrationEventV3Request; +import one.talon.model.IntegrationEventV3Response; import one.talon.model.IntegrationGetAllCampaigns200Response; import one.talon.model.IntegrationRequest; import one.talon.model.IntegrationStateV2; @@ -59,7 +62,6 @@ import one.talon.model.ReopenSessionResponse; import one.talon.model.ReturnIntegrationRequest; import one.talon.model.UpdateAudience; -import one.talon.model.UpdateCustomerProfileV2409Response; import one.talon.model.UpdateCustomerSessionV2409Response; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -181,7 +183,7 @@ public void deleteAudienceMembershipsV2Test() throws ApiException { /** * Delete audience * - * Delete an audience created by a third-party integration. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). + * Delete an audience. > [!warning] This endpoint also removes any associations recorded between a customer profile and this audience. > [!note] Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). * * @throws ApiException if the Api call fails */ @@ -326,6 +328,20 @@ public void getCustomerSessionTest() throws ApiException { // TODO: test validations } + /** + * Get advanced event + * + * Retrieve an advanced event by its identifier. + * + * @throws ApiException if the Api call fails + */ + @Test + public void getEventV3Test() throws ApiException { + String integrationId = null; + EventV3 response = api.getEventV3(integrationId); + // TODO: test validations + } + /** * Get customer's loyalty balances * @@ -420,7 +436,7 @@ public void getLoyaltyProgramProfilePointsTest() throws ApiException { Long loyaltyProgramId = null; String integrationId = null; String status = null; - String subledgerId = null; + List subledgerId = null; List customerSessionIDs = null; List transactionUUIDs = null; Long pageSize = null; @@ -553,7 +569,7 @@ public void syncCatalogTest() throws ApiException { /** * Track event * - * Triggers a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * Trigger a custom event. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - `profileId` is required even though the schema does not specify it. > - If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. * * @throws ApiException if the Api call fails */ @@ -567,6 +583,23 @@ public void trackEventV2Test() throws ApiException { // TODO: test validations } + /** + * Track advanced event + * + * Trigger an advanced event. Advanced events are idempotent, uniquely identifiable events. They can also reference a previously closed session to add more context for rule evaluation. To use this endpoint: 1. [Create a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. In a rule, add the **Check for event types** [condition](https://docs.talon.one/docs/dev/concepts/entities/events#use-an-event-in-a-rule) and select the event you created. 1. Trigger the event with this endpoint. You can [list](https://docs.talon.one/docs/product/applications/display-events#list-events) the received events in the **Events** view of the Campaign Manager. For example, you can use this endpoint to trigger an event when a customer shares a link to a product. See our [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!note] **Note** > - If the customer profile does not exist, it will be created. However, the `customer_profile_created` [built-in event](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. + * + * @throws ApiException if the Api call fails + */ + @Test + public void trackEventV3Test() throws ApiException { + IntegrationEventV3Request integrationEventV3Request = null; + String silent = null; + Boolean dry = null; + Boolean forceCompleteEvaluation = null; + IntegrationEventV3Response response = api.trackEventV3(integrationEventV3Request, silent, dry, forceCompleteEvaluation); + // TODO: test validations + } + /** * Unlink customer profile from a loyalty card * diff --git a/src/test/java/one/talon/api/ManagementApiTest.java b/src/test/java/one/talon/api/ManagementApiTest.java index 716da530..7bffd0a4 100644 --- a/src/test/java/one/talon/api/ManagementApiTest.java +++ b/src/test/java/one/talon/api/ManagementApiTest.java @@ -906,10 +906,12 @@ public void exportCustomerSessionsTest() throws ApiException { Long applicationId = null; OffsetDateTime createdBefore = null; OffsetDateTime createdAfter = null; + OffsetDateTime updatedBefore = null; + OffsetDateTime updatedAfter = null; String profileIntegrationId = null; String dateFormat = null; String customerSessionState = null; - String response = api.exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState); + String response = api.exportCustomerSessions(applicationId, createdBefore, createdAfter, updatedBefore, updatedAfter, profileIntegrationId, dateFormat, customerSessionState); // TODO: test validations } @@ -1016,7 +1018,7 @@ public void exportLoyaltyCardLedgerTest() throws ApiException { /** * Export loyalty cards * - * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request. + * 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.google.com/search?q=split+CSV+into+multiple+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. - `attributes`: The custom attributes of this loyalty card. * * @throws ApiException if the Api call fails */ @@ -2417,7 +2419,7 @@ public void importCouponsTest() throws ApiException { /** * Import loyalty cards * - * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` + * Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint. > [!note] Your CSV file must contain less than 500,000 rows. Requests time out after 30 seconds. ## Example ```csv identifier,state,customerprofileids,attributes 123-456-789AT,active,Alexa001;UserA,'{\"\"my_attributes\"\": \"\"10_off\"\"}\" ``` * * @throws ApiException if the Api call fails */ @@ -2444,6 +2446,21 @@ public void importLoyaltyCustomersTiersTest() throws ApiException { // TODO: test validations } + /** + * Import join dates for a loyalty program + * + * Upload a CSV file containing customer profile IDs and their join dates for the specified loyalty program. Send the file as multipart data. > [!important] This endpoint only works with profile-based loyalty programs. The CSV file **must** contain the following columns: - `customerprofileid`: The integration ID of the customer profile whose join date you want to update. - `newjoindate`: The new join date for the customer in RFC3339 format. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note**: - Customer profiles must already exist. If a referenced profile does not exist, the import fails with a `400` error. - If a join date already exists for a profile, the uploaded date replaces it. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv customerprofileid,newjoindate customer1,2024-03-21T07:32:14Z customer2,2025-04-16T21:12:37Z customer3,2026-05-03T11:47:01Z ``` + * + * @throws ApiException if the Api call fails + */ + @Test + public void importLoyaltyJoinDatesTest() throws ApiException { + Long loyaltyProgramId = null; + File upFile = null; + ModelImport response = api.importLoyaltyJoinDates(loyaltyProgramId, upFile); + // TODO: test validations + } + /** * Import loyalty points * @@ -2566,8 +2583,8 @@ public void listApplicationCartItemFiltersTest() throws ApiException { Long applicationId = null; Long pageSize = null; Long skip = null; - String title = null; - ListApplicationCartItemFilters200Response response = api.listApplicationCartItemFilters(applicationId, pageSize, skip, title); + String name = null; + ListApplicationCartItemFilters200Response response = api.listApplicationCartItemFilters(applicationId, pageSize, skip, name); // TODO: test validations } diff --git a/src/test/java/one/talon/model/AchievementAdditionalPropertiesV2Test.java b/src/test/java/one/talon/model/AchievementAdditionalPropertiesV2Test.java index 70e0ef09..45e0e753 100644 --- a/src/test/java/one/talon/model/AchievementAdditionalPropertiesV2Test.java +++ b/src/test/java/one/talon/model/AchievementAdditionalPropertiesV2Test.java @@ -20,6 +20,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.TimePoint; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -53,6 +54,14 @@ public void createdByTest() { // TODO: test createdBy } + /** + * Test the property 'periodEndOverride' + */ + @Test + public void periodEndOverrideTest() { + // TODO: test periodEndOverride + } + /** * Test the property 'hasProgress' */ diff --git a/src/test/java/one/talon/model/AchievementReferenceTest.java b/src/test/java/one/talon/model/AchievementReferenceTest.java index 094e1078..4e92f21e 100644 --- a/src/test/java/one/talon/model/AchievementReferenceTest.java +++ b/src/test/java/one/talon/model/AchievementReferenceTest.java @@ -69,4 +69,12 @@ public void campaignIdTest() { // TODO: test campaignId } + /** + * Test the property 'campaignName' + */ + @Test + public void campaignNameTest() { + // TODO: test campaignName + } + } diff --git a/src/test/java/one/talon/model/AchievementV2Test.java b/src/test/java/one/talon/model/AchievementV2Test.java index cdd4b66e..e141970c 100644 --- a/src/test/java/one/talon/model/AchievementV2Test.java +++ b/src/test/java/one/talon/model/AchievementV2Test.java @@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import one.talon.model.TimePoint; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -161,6 +162,14 @@ public void createdByTest() { // TODO: test createdBy } + /** + * Test the property 'periodEndOverride' + */ + @Test + public void periodEndOverrideTest() { + // TODO: test periodEndOverride + } + /** * Test the property 'hasProgress' */ diff --git a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java b/src/test/java/one/talon/model/CampaignEligibilityExperimentTest.java similarity index 71% rename from src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java rename to src/test/java/one/talon/model/CampaignEligibilityExperimentTest.java index a447f32d..8b5733ae 100644 --- a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseSortTest.java +++ b/src/test/java/one/talon/model/CampaignEligibilityExperimentTest.java @@ -24,25 +24,33 @@ import org.junit.jupiter.api.Test; /** - * Model tests for ScimServiceProviderConfigResponseSort + * Model tests for CampaignEligibilityExperiment */ -public class ScimServiceProviderConfigResponseSortTest { - private final ScimServiceProviderConfigResponseSort model = new ScimServiceProviderConfigResponseSort(); +public class CampaignEligibilityExperimentTest { + private final CampaignEligibilityExperiment model = new CampaignEligibilityExperiment(); /** - * Model tests for ScimServiceProviderConfigResponseSort + * Model tests for CampaignEligibilityExperiment */ @Test - public void testScimServiceProviderConfigResponseSort() { - // TODO: test ScimServiceProviderConfigResponseSort + public void testCampaignEligibilityExperiment() { + // TODO: test CampaignEligibilityExperiment } /** - * Test the property 'supported' + * Test the property 'id' */ @Test - public void supportedTest() { - // TODO: test supported + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'variantId' + */ + @Test + public void variantIdTest() { + // TODO: test variantId } } diff --git a/src/test/java/one/talon/model/CampaignEligibilityTest.java b/src/test/java/one/talon/model/CampaignEligibilityTest.java index f4812af2..99c1f408 100644 --- a/src/test/java/one/talon/model/CampaignEligibilityTest.java +++ b/src/test/java/one/talon/model/CampaignEligibilityTest.java @@ -24,6 +24,7 @@ import java.util.Arrays; import java.util.List; import one.talon.model.CampaignEligibilityDetails; +import one.talon.model.CampaignEligibilityExperiment; import one.talon.model.RuleMetadataEligibility; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -138,4 +139,12 @@ public void rulesTest() { // TODO: test rules } + /** + * Test the property 'experiment' + */ + @Test + public void experimentTest() { + // TODO: test experiment + } + } diff --git a/src/test/java/one/talon/model/ExperimentConfidenceTimelineDataPointTest.java b/src/test/java/one/talon/model/ExperimentConfidenceTimelineDataPointTest.java new file mode 100644 index 00000000..53619423 --- /dev/null +++ b/src/test/java/one/talon/model/ExperimentConfidenceTimelineDataPointTest.java @@ -0,0 +1,58 @@ +/* + * 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) 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#tag/Customer-sessions/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 java.io.IOException; +import java.time.OffsetDateTime; +import java.util.Arrays; +import one.talon.model.ExperimentVariantResultConfidence; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +/** + * Model tests for ExperimentConfidenceTimelineDataPoint + */ +public class ExperimentConfidenceTimelineDataPointTest { + private final ExperimentConfidenceTimelineDataPoint model = new ExperimentConfidenceTimelineDataPoint(); + + /** + * Model tests for ExperimentConfidenceTimelineDataPoint + */ + @Test + public void testExperimentConfidenceTimelineDataPoint() { + // TODO: test ExperimentConfidenceTimelineDataPoint + } + + /** + * Test the property 'date' + */ + @Test + public void dateTest() { + // TODO: test date + } + + /** + * Test the property 'confidence' + */ + @Test + public void confidenceTest() { + // TODO: test confidence + } + +} diff --git a/src/test/java/one/talon/model/ScimServiceProviderConfigResponsePatchTest.java b/src/test/java/one/talon/model/ExperimentConfidenceTimelineTest.java similarity index 72% rename from src/test/java/one/talon/model/ScimServiceProviderConfigResponsePatchTest.java rename to src/test/java/one/talon/model/ExperimentConfidenceTimelineTest.java index 4ee3f424..259a0360 100644 --- a/src/test/java/one/talon/model/ScimServiceProviderConfigResponsePatchTest.java +++ b/src/test/java/one/talon/model/ExperimentConfidenceTimelineTest.java @@ -19,30 +19,33 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; +import java.util.ArrayList; import java.util.Arrays; +import java.util.List; +import one.talon.model.ExperimentConfidenceTimelineDataPoint; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; /** - * Model tests for ScimServiceProviderConfigResponsePatch + * Model tests for ExperimentConfidenceTimeline */ -public class ScimServiceProviderConfigResponsePatchTest { - private final ScimServiceProviderConfigResponsePatch model = new ScimServiceProviderConfigResponsePatch(); +public class ExperimentConfidenceTimelineTest { + private final ExperimentConfidenceTimeline model = new ExperimentConfidenceTimeline(); /** - * Model tests for ScimServiceProviderConfigResponsePatch + * Model tests for ExperimentConfidenceTimeline */ @Test - public void testScimServiceProviderConfigResponsePatch() { - // TODO: test ScimServiceProviderConfigResponsePatch + public void testExperimentConfidenceTimeline() { + // TODO: test ExperimentConfidenceTimeline } /** - * Test the property 'supported' + * Test the property 'data' */ @Test - public void supportedTest() { - // TODO: test supported + public void dataTest() { + // TODO: test data } } diff --git a/src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotificationTest.java b/src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotificationTest.java deleted file mode 100644 index 942e0b27..00000000 --- a/src/test/java/one/talon/model/IntegrationHubEventPayloadLoyaltyProfileBasedNotificationTest.java +++ /dev/null @@ -1,172 +0,0 @@ -/* - * 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) 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#tag/Customer-sessions/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 java.io.IOException; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import one.talon.model.IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction; -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.Test; - -/** - * Model tests for IntegrationHubEventPayloadLoyaltyProfileBasedNotification - */ -public class IntegrationHubEventPayloadLoyaltyProfileBasedNotificationTest { - private final IntegrationHubEventPayloadLoyaltyProfileBasedNotification model = new IntegrationHubEventPayloadLoyaltyProfileBasedNotification(); - - /** - * Model tests for IntegrationHubEventPayloadLoyaltyProfileBasedNotification - */ - @Test - public void testIntegrationHubEventPayloadLoyaltyProfileBasedNotification() { - // TODO: test IntegrationHubEventPayloadLoyaltyProfileBasedNotification - } - - /** - * Test the property 'profileIntegrationID' - */ - @Test - public void profileIntegrationIDTest() { - // TODO: test profileIntegrationID - } - - /** - * Test the property 'loyaltyProgramID' - */ - @Test - public void loyaltyProgramIDTest() { - // TODO: test loyaltyProgramID - } - - /** - * Test the property 'loyaltyProgramName' - */ - @Test - public void loyaltyProgramNameTest() { - // TODO: test loyaltyProgramName - } - - /** - * Test the property 'subledgerID' - */ - @Test - public void subledgerIDTest() { - // TODO: test subledgerID - } - - /** - * Test the property 'sourceOfEvent' - */ - @Test - public void sourceOfEventTest() { - // TODO: test sourceOfEvent - } - - /** - * Test the property 'currentTier' - */ - @Test - public void currentTierTest() { - // TODO: test currentTier - } - - /** - * Test the property 'employeeName' - */ - @Test - public void employeeNameTest() { - // TODO: test employeeName - } - - /** - * Test the property 'userID' - */ - @Test - public void userIDTest() { - // TODO: test userID - } - - /** - * Test the property 'currentPoints' - */ - @Test - public void currentPointsTest() { - // TODO: test currentPoints - } - - /** - * Test the property 'actions' - */ - @Test - public void actionsTest() { - // TODO: test actions - } - - /** - * Test the property 'publishedAt' - */ - @Test - public void publishedAtTest() { - // TODO: test publishedAt - } - - /** - * Test the property 'oldTier' - */ - @Test - public void oldTierTest() { - // TODO: test oldTier - } - - /** - * Test the property 'tierExpirationDate' - */ - @Test - public void tierExpirationDateTest() { - // TODO: test tierExpirationDate - } - - /** - * Test the property 'timestampOfTierChange' - */ - @Test - public void timestampOfTierChangeTest() { - // TODO: test timestampOfTierChange - } - - /** - * Test the property 'pointsRequiredToTheNextTier' - */ - @Test - public void pointsRequiredToTheNextTierTest() { - // TODO: test pointsRequiredToTheNextTier - } - - /** - * Test the property 'nextTier' - */ - @Test - public void nextTierTest() { - // TODO: test nextTier - } - -} diff --git a/src/test/java/one/talon/model/IntegrationHubEventRecordTest.java b/src/test/java/one/talon/model/IntegrationHubEventRecordTest.java index 4afaaae5..51752e6e 100644 --- a/src/test/java/one/talon/model/IntegrationHubEventRecordTest.java +++ b/src/test/java/one/talon/model/IntegrationHubEventRecordTest.java @@ -21,6 +21,7 @@ import java.io.IOException; import java.time.OffsetDateTime; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -55,19 +56,27 @@ public void flowIdTest() { } /** - * Test the property 'eventType' + * Test the property 'integrationName' */ @Test - public void eventTypeTest() { - // TODO: test eventType + public void integrationNameTest() { + // TODO: test integrationName + } + + /** + * Test the property 'instanceName' + */ + @Test + public void instanceNameTest() { + // TODO: test instanceName } /** - * Test the property 'eventData' + * Test the property 'eventType' */ @Test - public void eventDataTest() { - // TODO: test eventData + public void eventTypeTest() { + // TODO: test eventType } /** @@ -95,11 +104,11 @@ public void deliveredAtTest() { } /** - * Test the property 'processAfter' + * Test the property 'scheduledTo' */ @Test - public void processAfterTest() { - // TODO: test processAfter + public void scheduledToTest() { + // TODO: test scheduledTo } /** @@ -110,4 +119,12 @@ public void retryTest() { // TODO: test retry } + /** + * Test the property 'payload' + */ + @Test + public void payloadTest() { + // TODO: test payload + } + } diff --git a/src/test/java/one/talon/model/IntegrationHubEventTypeTest.java b/src/test/java/one/talon/model/IntegrationHubEventTypeTest.java new file mode 100644 index 00000000..3885fa32 --- /dev/null +++ b/src/test/java/one/talon/model/IntegrationHubEventTypeTest.java @@ -0,0 +1,32 @@ +/* + * 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) 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#tag/Customer-sessions/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.annotations.SerializedName; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +/** + * Model tests for IntegrationHubEventType + */ +public class IntegrationHubEventTypeTest { + /** + * Model tests for IntegrationHubEventType + */ + @Test + public void testIntegrationHubEventType() { + // TODO: test IntegrationHubEventType + } + +} diff --git a/src/test/java/one/talon/model/IntegrationHubFlowResponseTest.java b/src/test/java/one/talon/model/IntegrationHubFlowResponseTest.java index 954df3ec..5ab2de73 100644 --- a/src/test/java/one/talon/model/IntegrationHubFlowResponseTest.java +++ b/src/test/java/one/talon/model/IntegrationHubFlowResponseTest.java @@ -19,8 +19,10 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; +import java.time.OffsetDateTime; import java.util.Arrays; import one.talon.model.IntegrationHubFlowConfigResponse; +import org.openapitools.jackson.nullable.JsonNullable; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -47,11 +49,51 @@ public void idTest() { } /** - * Test the property 'applicationID' + * Test the property 'integrationName' */ @Test - public void applicationIDTest() { - // TODO: test applicationID + public void integrationNameTest() { + // TODO: test integrationName + } + + /** + * Test the property 'instanceName' + */ + @Test + public void instanceNameTest() { + // TODO: test instanceName + } + + /** + * Test the property 'createdAt' + */ + @Test + public void createdAtTest() { + // TODO: test createdAt + } + + /** + * Test the property 'disabledUntil' + */ + @Test + public void disabledUntilTest() { + // TODO: test disabledUntil + } + + /** + * Test the property 'applicationId' + */ + @Test + public void applicationIdTest() { + // TODO: test applicationId + } + + /** + * Test the property 'loyaltyProgramId' + */ + @Test + public void loyaltyProgramIdTest() { + // TODO: test loyaltyProgramId } /** diff --git a/src/test/java/one/talon/model/IntegrationHubFlowTest.java b/src/test/java/one/talon/model/IntegrationHubFlowTest.java index c2d975ef..b54dddab 100644 --- a/src/test/java/one/talon/model/IntegrationHubFlowTest.java +++ b/src/test/java/one/talon/model/IntegrationHubFlowTest.java @@ -20,6 +20,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -45,6 +46,14 @@ public void applicationIDTest() { // TODO: test applicationID } + /** + * Test the property 'loyaltyProgramID' + */ + @Test + public void loyaltyProgramIDTest() { + // TODO: test loyaltyProgramID + } + /** * Test the property 'eventType' */ diff --git a/src/test/java/one/talon/model/IntegrationHubFlowWithConfigTest.java b/src/test/java/one/talon/model/IntegrationHubFlowWithConfigTest.java index 51ecb132..a890d571 100644 --- a/src/test/java/one/talon/model/IntegrationHubFlowWithConfigTest.java +++ b/src/test/java/one/talon/model/IntegrationHubFlowWithConfigTest.java @@ -20,6 +20,7 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; +import one.talon.model.IntegrationHubEventType; import one.talon.model.IntegrationHubFlowConfig; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -46,6 +47,14 @@ public void applicationIDTest() { // TODO: test applicationID } + /** + * Test the property 'loyaltyProgramID' + */ + @Test + public void loyaltyProgramIDTest() { + // TODO: test loyaltyProgramID + } + /** * Test the property 'eventType' */ diff --git a/src/test/java/one/talon/model/IntegrationHubPaginatedEventPayloadTest.java b/src/test/java/one/talon/model/IntegrationHubPaginatedEventPayloadTest.java index d96becc0..d2811d16 100644 --- a/src/test/java/one/talon/model/IntegrationHubPaginatedEventPayloadTest.java +++ b/src/test/java/one/talon/model/IntegrationHubPaginatedEventPayloadTest.java @@ -23,6 +23,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import one.talon.model.IntegrationHubEventType; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; diff --git a/src/test/java/one/talon/model/RoleV2ApplicationDetailsTest.java b/src/test/java/one/talon/model/RoleV2ApplicationDetailsTest.java index e987fd52..1b814949 100644 --- a/src/test/java/one/talon/model/RoleV2ApplicationDetailsTest.java +++ b/src/test/java/one/talon/model/RoleV2ApplicationDetailsTest.java @@ -20,7 +20,6 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; -import one.talon.model.RolesV2Thresholds; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -70,12 +69,4 @@ public void toolsTest() { // TODO: test tools } - /** - * Test the property 'thresholds' - */ - @Test - public void thresholdsTest() { - // TODO: test thresholds - } - } diff --git a/src/test/java/one/talon/model/RoleV2PermissionsTest.java b/src/test/java/one/talon/model/RoleV2PermissionsTest.java index b0e67986..fa7139b5 100644 --- a/src/test/java/one/talon/model/RoleV2PermissionsTest.java +++ b/src/test/java/one/talon/model/RoleV2PermissionsTest.java @@ -24,6 +24,7 @@ import java.util.List; import one.talon.model.RoleV2PermissionSet; import one.talon.model.RoleV2RolesGroup; +import one.talon.model.RolesV2Thresholds; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -57,4 +58,12 @@ public void rolesTest() { // TODO: test roles } + /** + * Test the property 'thresholds' + */ + @Test + public void thresholdsTest() { + // TODO: test thresholds + } + } diff --git a/src/test/java/one/talon/model/RolesV2ThresholdsTest.java b/src/test/java/one/talon/model/RolesV2ThresholdsTest.java index 70701b34..72f18846 100644 --- a/src/test/java/one/talon/model/RolesV2ThresholdsTest.java +++ b/src/test/java/one/talon/model/RolesV2ThresholdsTest.java @@ -37,6 +37,14 @@ public void testRolesV2Thresholds() { // TODO: test RolesV2Thresholds } + /** + * Test the property 'loyaltyProgramId' + */ + @Test + public void loyaltyProgramIdTest() { + // TODO: test loyaltyProgramId + } + /** * Test the property 'loyaltyPointsLimit' */ diff --git a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java index 94e610c6..4f02f01c 100644 --- a/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java +++ b/src/test/java/one/talon/model/ScimServiceProviderConfigResponseTest.java @@ -25,8 +25,6 @@ import one.talon.model.ScimServiceProviderConfigResponseBulk; import one.talon.model.ScimServiceProviderConfigResponseChangePassword; import one.talon.model.ScimServiceProviderConfigResponseFilter; -import one.talon.model.ScimServiceProviderConfigResponsePatch; -import one.talon.model.ScimServiceProviderConfigResponseSort; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; diff --git a/src/test/java/one/talon/model/UpdateCustomerProfileV2409ResponseTest.java b/src/test/java/one/talon/model/UpdateRiskNotificationTest.java similarity index 67% rename from src/test/java/one/talon/model/UpdateCustomerProfileV2409ResponseTest.java rename to src/test/java/one/talon/model/UpdateRiskNotificationTest.java index 690c2f81..2400f9cf 100644 --- a/src/test/java/one/talon/model/UpdateCustomerProfileV2409ResponseTest.java +++ b/src/test/java/one/talon/model/UpdateRiskNotificationTest.java @@ -19,48 +19,54 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; -import java.util.ArrayList; import java.util.Arrays; -import java.util.List; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; /** - * Model tests for UpdateCustomerProfileV2409Response + * Model tests for UpdateRiskNotification */ -public class UpdateCustomerProfileV2409ResponseTest { - private final UpdateCustomerProfileV2409Response model = new UpdateCustomerProfileV2409Response(); +public class UpdateRiskNotificationTest { + private final UpdateRiskNotification model = new UpdateRiskNotification(); /** - * Model tests for UpdateCustomerProfileV2409Response + * Model tests for UpdateRiskNotification */ @Test - public void testUpdateCustomerProfileV2409Response() { - // TODO: test UpdateCustomerProfileV2409Response + public void testUpdateRiskNotification() { + // TODO: test UpdateRiskNotification } /** - * Test the property 'message' + * Test the property 'entity' */ @Test - public void messageTest() { - // TODO: test message + public void entityTest() { + // TODO: test entity } /** - * Test the property 'errors' + * Test the property 'activity' */ @Test - public void errorsTest() { - // TODO: test errors + public void activityTest() { + // TODO: test activity } /** - * Test the property 'statusCode' + * Test the property 'timeFrame' */ @Test - public void statusCodeTest() { - // TODO: test statusCode + public void timeFrameTest() { + // TODO: test timeFrame + } + + /** + * Test the property 'active' + */ + @Test + public void activeTest() { + // TODO: test active } }