diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
index b8fd9b5b..b8d61479 100644
--- a/.openapi-generator/FILES
+++ b/.openapi-generator/FILES
@@ -222,6 +222,9 @@ docs/DeleteUserRequest.md
docs/Effect.md
docs/EffectEntity.md
docs/EmailEntity.md
+docs/EmbeddedAnalyticsConfiguration.md
+docs/EmbeddedAnalyticsConfigurationDashboards.md
+docs/EmbeddedDashboardConfiguration.md
docs/Endpoint.md
docs/Entity.md
docs/EntityWithTalangVisibleID.md
@@ -240,6 +243,9 @@ docs/Experiment.md
docs/ExperimentCampaignCopy.md
docs/ExperimentCopy.md
docs/ExperimentCopyExperiment.md
+docs/ExperimentListResults.md
+docs/ExperimentListResultsRequest.md
+docs/ExperimentResult.md
docs/ExperimentResults.md
docs/ExperimentVariant.md
docs/ExperimentVariantAllocation.md
@@ -318,6 +324,8 @@ docs/GetRulesets200Response.md
docs/GetUsers200Response.md
docs/GetWebhooks200Response.md
docs/Giveaway.md
+docs/GiveawayPoolNotification.md
+docs/GiveawayPoolNotificationData.md
docs/GiveawaysPool.md
docs/HiddenConditionsEffects.md
docs/History.md
@@ -561,6 +569,7 @@ docs/RoleV2PermissionSet.md
docs/RoleV2Permissions.md
docs/RoleV2Readonly.md
docs/RoleV2RolesGroup.md
+docs/RolesV2Thresholds.md
docs/RollbackAddedLoyaltyPointsEffectProps.md
docs/RollbackCouponEffectProps.md
docs/RollbackDeductedLoyaltyPointsEffectProps.md
@@ -569,6 +578,7 @@ docs/RollbackIncreasedAchievementProgressEffectProps.md
docs/RollbackReferralEffectProps.md
docs/Rule.md
docs/RuleFailureReason.md
+docs/RuleMetadata.md
docs/Ruleset.md
docs/SSOConfig.md
docs/SamlConnection.md
@@ -927,6 +937,9 @@ src/main/java/one/talon/model/DeleteUserRequest.java
src/main/java/one/talon/model/Effect.java
src/main/java/one/talon/model/EffectEntity.java
src/main/java/one/talon/model/EmailEntity.java
+src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java
+src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java
+src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java
src/main/java/one/talon/model/Endpoint.java
src/main/java/one/talon/model/Entity.java
src/main/java/one/talon/model/EntityWithTalangVisibleID.java
@@ -945,6 +958,9 @@ src/main/java/one/talon/model/Experiment.java
src/main/java/one/talon/model/ExperimentCampaignCopy.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
+src/main/java/one/talon/model/ExperimentListResultsRequest.java
+src/main/java/one/talon/model/ExperimentResult.java
src/main/java/one/talon/model/ExperimentResults.java
src/main/java/one/talon/model/ExperimentVariant.java
src/main/java/one/talon/model/ExperimentVariantAllocation.java
@@ -1023,6 +1039,8 @@ src/main/java/one/talon/model/GetRulesets200Response.java
src/main/java/one/talon/model/GetUsers200Response.java
src/main/java/one/talon/model/GetWebhooks200Response.java
src/main/java/one/talon/model/Giveaway.java
+src/main/java/one/talon/model/GiveawayPoolNotification.java
+src/main/java/one/talon/model/GiveawayPoolNotificationData.java
src/main/java/one/talon/model/GiveawaysPool.java
src/main/java/one/talon/model/HiddenConditionsEffects.java
src/main/java/one/talon/model/History.java
@@ -1264,6 +1282,7 @@ src/main/java/one/talon/model/RoleV2PermissionSet.java
src/main/java/one/talon/model/RoleV2Permissions.java
src/main/java/one/talon/model/RoleV2Readonly.java
src/main/java/one/talon/model/RoleV2RolesGroup.java
+src/main/java/one/talon/model/RolesV2Thresholds.java
src/main/java/one/talon/model/RollbackAddedLoyaltyPointsEffectProps.java
src/main/java/one/talon/model/RollbackCouponEffectProps.java
src/main/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectProps.java
@@ -1272,6 +1291,7 @@ src/main/java/one/talon/model/RollbackIncreasedAchievementProgressEffectProps.ja
src/main/java/one/talon/model/RollbackReferralEffectProps.java
src/main/java/one/talon/model/Rule.java
src/main/java/one/talon/model/RuleFailureReason.java
+src/main/java/one/talon/model/RuleMetadata.java
src/main/java/one/talon/model/Ruleset.java
src/main/java/one/talon/model/SSOConfig.java
src/main/java/one/talon/model/SamlConnection.java
@@ -1603,6 +1623,9 @@ src/test/java/one/talon/model/DeleteUserRequestTest.java
src/test/java/one/talon/model/EffectEntityTest.java
src/test/java/one/talon/model/EffectTest.java
src/test/java/one/talon/model/EmailEntityTest.java
+src/test/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboardsTest.java
+src/test/java/one/talon/model/EmbeddedAnalyticsConfigurationTest.java
+src/test/java/one/talon/model/EmbeddedDashboardConfigurationTest.java
src/test/java/one/talon/model/EndpointTest.java
src/test/java/one/talon/model/EntityTest.java
src/test/java/one/talon/model/EntityWithTalangVisibleIDTest.java
@@ -1620,6 +1643,9 @@ src/test/java/one/talon/model/EventV3Test.java
src/test/java/one/talon/model/ExperimentCampaignCopyTest.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
+src/test/java/one/talon/model/ExperimentListResultsTest.java
+src/test/java/one/talon/model/ExperimentResultTest.java
src/test/java/one/talon/model/ExperimentResultsTest.java
src/test/java/one/talon/model/ExperimentTest.java
src/test/java/one/talon/model/ExperimentVariantAllocationTest.java
@@ -1698,6 +1724,8 @@ src/test/java/one/talon/model/GetReservedCustomers200ResponseTest.java
src/test/java/one/talon/model/GetRulesets200ResponseTest.java
src/test/java/one/talon/model/GetUsers200ResponseTest.java
src/test/java/one/talon/model/GetWebhooks200ResponseTest.java
+src/test/java/one/talon/model/GiveawayPoolNotificationDataTest.java
+src/test/java/one/talon/model/GiveawayPoolNotificationTest.java
src/test/java/one/talon/model/GiveawayTest.java
src/test/java/one/talon/model/GiveawaysPoolTest.java
src/test/java/one/talon/model/HiddenConditionsEffectsTest.java
@@ -1940,6 +1968,7 @@ src/test/java/one/talon/model/RoleV2PermissionsTest.java
src/test/java/one/talon/model/RoleV2ReadonlyTest.java
src/test/java/one/talon/model/RoleV2RolesGroupTest.java
src/test/java/one/talon/model/RoleV2Test.java
+src/test/java/one/talon/model/RolesV2ThresholdsTest.java
src/test/java/one/talon/model/RollbackAddedLoyaltyPointsEffectPropsTest.java
src/test/java/one/talon/model/RollbackCouponEffectPropsTest.java
src/test/java/one/talon/model/RollbackDeductedLoyaltyPointsEffectPropsTest.java
@@ -1947,6 +1976,7 @@ src/test/java/one/talon/model/RollbackDiscountEffectPropsTest.java
src/test/java/one/talon/model/RollbackIncreasedAchievementProgressEffectPropsTest.java
src/test/java/one/talon/model/RollbackReferralEffectPropsTest.java
src/test/java/one/talon/model/RuleFailureReasonTest.java
+src/test/java/one/talon/model/RuleMetadataTest.java
src/test/java/one/talon/model/RuleTest.java
src/test/java/one/talon/model/RulesetTest.java
src/test/java/one/talon/model/SSOConfigTest.java
diff --git a/README.md b/README.md
index 90796d89..19178791 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.06.01
+ 26.07.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.06.01"
+compile "one.talon:talon-one-client:26.07.0"
```
### Others
@@ -231,7 +231,6 @@ Class | Method | HTTP request | Description
*IntegrationApi* | [**getLoyaltyProgramProfileTransactions**](docs/IntegrationApi.md#getLoyaltyProgramProfileTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions
*IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
*IntegrationApi* | [**linkLoyaltyCardToProfile**](docs/IntegrationApi.md#linkLoyaltyCardToProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card
-*IntegrationApi* | [**priceHistory**](docs/IntegrationApi.md#priceHistory) | **POST** /v1/best_prior_price_history | Get summary of price history
*IntegrationApi* | [**reopenCustomerSession**](docs/IntegrationApi.md#reopenCustomerSession) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session
*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
@@ -389,6 +388,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**listExperiments**](docs/ManagementApi.md#listExperiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments
*ManagementApi* | [**listStores**](docs/ManagementApi.md#listStores) | **GET** /v1/applications/{applicationId}/stores | List stores
*ManagementApi* | [**oktaEventHandlerChallenge**](docs/ManagementApi.md#oktaEventHandlerChallenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
+*ManagementApi* | [**priceHistory**](docs/ManagementApi.md#priceHistory) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history
*ManagementApi* | [**removeLoyaltyPoints**](docs/ManagementApi.md#removeLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
*ManagementApi* | [**resetPassword**](docs/ManagementApi.md#resetPassword) | **POST** /v1/reset_password | Reset password
*ManagementApi* | [**scimCreateGroup**](docs/ManagementApi.md#scimCreateGroup) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
@@ -638,6 +638,9 @@ Class | Method | HTTP request | Description
- [Effect](docs/Effect.md)
- [EffectEntity](docs/EffectEntity.md)
- [EmailEntity](docs/EmailEntity.md)
+- [EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
+- [EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
+- [EmbeddedDashboardConfiguration](docs/EmbeddedDashboardConfiguration.md)
- [Endpoint](docs/Endpoint.md)
- [Entity](docs/Entity.md)
- [EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md)
@@ -656,6 +659,9 @@ Class | Method | HTTP request | Description
- [ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
- [ExperimentCopy](docs/ExperimentCopy.md)
- [ExperimentCopyExperiment](docs/ExperimentCopyExperiment.md)
+- [ExperimentListResults](docs/ExperimentListResults.md)
+- [ExperimentListResultsRequest](docs/ExperimentListResultsRequest.md)
+- [ExperimentResult](docs/ExperimentResult.md)
- [ExperimentResults](docs/ExperimentResults.md)
- [ExperimentVariant](docs/ExperimentVariant.md)
- [ExperimentVariantAllocation](docs/ExperimentVariantAllocation.md)
@@ -734,6 +740,8 @@ Class | Method | HTTP request | Description
- [GetUsers200Response](docs/GetUsers200Response.md)
- [GetWebhooks200Response](docs/GetWebhooks200Response.md)
- [Giveaway](docs/Giveaway.md)
+- [GiveawayPoolNotification](docs/GiveawayPoolNotification.md)
+- [GiveawayPoolNotificationData](docs/GiveawayPoolNotificationData.md)
- [GiveawaysPool](docs/GiveawaysPool.md)
- [HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
- [History](docs/History.md)
@@ -975,6 +983,7 @@ Class | Method | HTTP request | Description
- [RoleV2Permissions](docs/RoleV2Permissions.md)
- [RoleV2Readonly](docs/RoleV2Readonly.md)
- [RoleV2RolesGroup](docs/RoleV2RolesGroup.md)
+- [RolesV2Thresholds](docs/RolesV2Thresholds.md)
- [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md)
- [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
- [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
@@ -983,6 +992,7 @@ Class | Method | HTTP request | Description
- [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
- [Rule](docs/Rule.md)
- [RuleFailureReason](docs/RuleFailureReason.md)
+- [RuleMetadata](docs/RuleMetadata.md)
- [Ruleset](docs/Ruleset.md)
- [SSOConfig](docs/SSOConfig.md)
- [SamlConnection](docs/SamlConnection.md)
@@ -1111,18 +1121,6 @@ Authentication schemes defined for the API:
- **API key parameter name**: Authorization
- **Location**: HTTP header
-### manager_auth
-
-- **Type**: API key
-- **API key parameter name**: Authorization
-- **Location**: HTTP header
-
-### management_key
-
-- **Type**: API key
-- **API key parameter name**: Authorization
-- **Location**: HTTP header
-
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
diff --git a/api/openapi.yaml b/api/openapi.yaml
index ff0e468d..c8bb77a1 100644
--- a/api/openapi.yaml
+++ b/api/openapi.yaml
@@ -5,24 +5,23 @@ info:
manage applications and campaigns:
- Use the operations in the [Integration API section](#integration-api)
- are used to integrate with our platform
+ to integrate with our platform.
- Use the operation in the [Management API section](#management-api) to
manage applications and campaigns.
## Determining the base URL of the endpoints
The API is available at the same hostname as your Campaign Manager deployment.
+
For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`,
- the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint
- is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ the 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}`.
title: Talon.One API
version: ""
servers:
- url: https://yourbaseurl.talon.one
security:
- api_key_v1: []
-- manager_auth: []
-- management_key: []
tags:
- description: |
Operations for updating account information such as billing email addresses, inviting users, etc.
@@ -155,7 +154,7 @@ tags:
name: Roles
- description: |
Represents a session used for authentication purposes.
- Create one with the [Create session](#operation/createSession) endpoint.
+ Create one with the [Create session](#tag/Sessions/operation/createSession) endpoint.
name: Sessions
- description: Represents store budgets. You can set a store budget to limit the total
amount an individual store can spend in a campaign.
@@ -184,7 +183,7 @@ paths:
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
explode: false
in: path
name: customerSessionId
@@ -219,33 +218,52 @@ paths:
x-accepts:
- application/json
put:
- description: "Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).\n\
- The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects)\
- \ that match the current cart.\nFor example, use this endpoint to share the\
- \ contents of a customer's cart with Talon.One.\n\n**Note:** \n- The currency\
- \ for the session and the cart items in it is the currency set for the Application\
- \ linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign)\
- \ are not considered for rule evaluation.\n\n### Session management\n\nTo\
- \ use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions)\n\
- and their states and refer to the `state` parameter documentation the request\
- \ body schema docs below.\n\n### Sessions and customer profiles\n\n- To link\
- \ a session to a customer profile, set the `profileId` parameter in the request\
- \ body to a customer profile's `integrationId`.\n- While you can create an\
- \ anonymous session with `profileId=\"\"`, we recommend you use a guest ID\
- \ instead.\n- A profile can be linked to simultaneous sessions in different\
- \ Applications. Either:\n - Use unique session integration IDs or,\n - Use\
- \ the same session integration ID across all of the Applications.\n\n**Note:**\
- \ If the specified profile does not exist, an empty profile is **created automatically**.\n\
- \ You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).\n\
- \n
\n
Performance tips
\n\
- \n - Updating a customer session returns a response with the new integration\
- \ state. Use the `responseContent` property to save yourself extra API calls.\n\
- \ For example, you can get the customer profile details directly without\
- \ extra requests.\n - We recommend sending requests sequentially. See [Managing\
- \ parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).\n\
-
\n\nFor more information, see:\n- The introductory video in [Getting\
- \ started](https://docs.talon.one/docs/dev/getting-started/overview).\n- The\
- \ [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).\n"
+ description: |
+ Update or create a [customer
+ session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).
+
+ The endpoint responds with the potential promotion rule
+ [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that
+ match the current cart.
+
+ For example, use this endpoint to share the contents of a customer's cart
+ with Talon.One.
+
+ > [!note] **Note**
+ > - The currency for the session and the cart items in it is the currency set for the Application linked to this session.
+ > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation.
+
+ ### Session management
+
+ To use this endpoint, start by learning about [customer
+ sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions)
+ and their states and refer to the `state` parameter documentation the
+ request body schema docs below.
+
+ ### Sessions and customer profiles
+
+ - To link a session to a customer profile, set the `profileId` parameter in
+ the request body to a customer profile's `integrationId`.
+
+ - While you can create an anonymous session with `profileId=""`, we
+ recommend you use a guest ID instead.
+
+ - A profile can be linked to simultaneous sessions in different
+ Applications. Either:
+ - Use unique session integration IDs or,
+ - Use the same session integration ID across all of the Applications.
+
+ > [!note] **Note**
+ > - If the specified profile does not exist, an empty profile is **created automatically**.
+ > You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).
+ > - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.
+ > For example, you can get the customer profile details directly without extra requests.
+ > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
+
+ For more information, see:
+
+ - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview).
+ - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
operationId: updateCustomerSessionV2
parameters:
- description: |
@@ -268,7 +286,7 @@ paths:
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
explode: false
in: path
name: customerSessionId
@@ -277,15 +295,17 @@ paths:
type: string
style: simple
- description: |
- A timestamp value of a future date that acts as a current date when included in the query.
+ A timestamp value of a future date that acts as a current date when
+ included in the query.
- Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)).
+ Use this parameter, for example, to test campaigns that would be
+ evaluated for this customer session in the future (say, [scheduled
+ campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)).
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - It can **only** be a date in the future.
- - It can **only** be used if the `dry` parameter in the query is set to `true`.
+ > [!note] **Note**
+ > - It must be an RFC3339 timestamp string.
+ > - It can **only** be a date in the future.
+ > - It can **only** be used if the `dry` parameter in the query is set to `true`.
explode: true
in: query
name: now
@@ -297,6 +317,104 @@ paths:
requestBody:
content:
application/json:
+ examples:
+ eCommerce:
+ description: |
+ Update a customer session with multiple cart items and attributes,
+ including SKUs, prices, and more.
+ summary: "Example: eCommerce"
+ value:
+ customerSession:
+ profileId: 382370BKDB946
+ cartItems:
+ - name: Wireless Bluetooth Headphones
+ sku: AUDIO-WH350
+ quantity: 1
+ price: 79.99
+ weight: 310
+ - name: USB-C Charging Cable
+ sku: CABLE-USBC-2M
+ quantity: 2
+ price: 15.99
+ weight: 40
+ responseContent:
+ - customerSession
+ - customerProfile
+ x-vertical: ecommerce
+ QSR & dining:
+ description: |
+ Update a customer session as a customer builds a combo meal, including
+ quantities, categories, and more.
+ summary: "Example: QSR & dining"
+ value:
+ customerSession:
+ profileId: 382370BKDB946
+ cartItems:
+ - name: Cheeseburger
+ sku: BURGER-001
+ quantity: 1
+ price: 8.99
+ category: Main
+ - name: French Fries
+ sku: SIDE-002
+ quantity: 1
+ price: 3.49
+ category: Side
+ - name: Cola
+ sku: DRINK-003
+ quantity: 1
+ price: 2.49
+ category: Beverage
+ responseContent:
+ - customerSession
+ - customerProfile
+ - loyalty
+ x-vertical: qsr
+ Financial services:
+ description: |
+ Update a customer session when a cardholder completes a purchase.
+ summary: "Example: Financial services"
+ value:
+ customerSession:
+ profileId: customer-789
+ cartItems:
+ - name: Card Purchase - Electronics Store
+ sku: TXN-CC-001
+ quantity: 1
+ price: 250
+ attributes:
+ CardType: credit
+ MerchantCategory: electronics
+ TransactionType: card_payment
+ responseContent:
+ - customerSession
+ - customerProfile
+ - loyalty
+ x-vertical: finance
+ Travel & hospitality:
+ description: |
+ Update a customer session when a guest books a hotel stay to
+ automatically award bonus loyalty points for stays that exceed
+ the minimum night count.
+ summary: "Example: Travel & hospitality"
+ value:
+ customerSession:
+ profileId: customer-321
+ cartItems:
+ - name: Deluxe Room - 5 nights
+ sku: HOTEL-ROOM-DLX
+ quantity: 5
+ price: 189
+ attributes:
+ CheckInDate: 2026-06-10
+ CheckOutDate: 2026-06-15
+ StayNights: 5
+ PropertyType: hotel
+ responseContent:
+ - customerSession
+ - customerProfile
+ - loyalty
+ x-vertical: travel
schema:
$ref: "#/components/schemas/IntegrationRequest"
description: body
@@ -340,11 +458,18 @@ paths:
description: |
Create a new return request for the specified cart items.
- This endpoint automatically changes the session state from `closed` to `partially_returned`.
+ This endpoint automatically changes the session state from `closed` to
+ `partially_returned`.
+
+ > [!note] This will roll back any effects associated with these cart items.
+ > For more information, see [our documentation on session
+ > states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states)
+ > and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
- **Note:** This will roll back any effects associated with these cart items. For more information, see
- [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states)
- and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
+ > [!note] To make request processing idempotent for this endpoint, include the `Idempotency-Key` header with an idempotency key in requests. Also:
+ > - Requests with the `Idempotency-Key` header are logged in the Talon.One access logs.
+ > - Responses for idempotent requests are stored in the database and expire 24 hours after the request is sent.
+ > - Idempotency keys are typically UUID keys and should not exceed 255 characters in length.
operationId: returnCartItems
parameters:
- description: |
@@ -360,7 +485,7 @@ paths:
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
explode: false
in: path
name: customerSessionId
@@ -399,38 +524,57 @@ paths:
- application/json
/v2/customer_sessions/{customerSessionId}/reopen:
put:
- description: "Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).\n\
- For example, if a session has been completed but still needs to be edited,\
- \ you can reopen it with this endpoint.\nA reopen session is treated like\
- \ a standard open session.\n\nWhen reopening a session:\n- The `talon_session_reopened`\
- \ event is triggered. You can see it in the **Events** view in the Campaign\
- \ Manager.\n- The session state is updated to `open`.\n- Any modified budgets\
- \ and triggered effects are rolled back when the session closes.\n- Depending\
- \ on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy)\n\
- \ in your loyalty programs, points are rolled back in the following ways:\n\
- \ - Pending points are rolled back automatically.\n - If **Active points\
- \ deduction** setting is enabled, any points that were earned and activated\
- \ when the session closed \n are rolled back.\n - If **Negative balance**\
- \ is enabled, the rollback can create a negative points balance.\n\n\n\n\
- \ Effects and budgets unimpacted by a session reopening
\n\
- \ \n
The following effects and budgets remain in the state they\
- \ were in when the session closed:
\n
\n - Add free item\
- \ effect
\n - Award giveaway
\n - Coupon and referral\
- \ creation
\n - Coupon reservation
\n - Custom effect
\n\
- \ - Update attribute value
\n - Update cart item attribute\
- \ value
\n
\n
\n\n\n \nTo see an example of\
- \ a rollback, see the Cancelling a session with campaign budgets tutorial.
\n\n**Note:**\
- \ If your order workflow requires you to create a new session instead of reopening\
- \ a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)\
- \ endpoint to cancel a closed session and create a new one.\n"
+ description: |
+ Reopen a closed [customer
+ session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).
+
+ For example, if a session has been completed but still needs to be edited,
+ you can reopen it with this endpoint.
+
+ A reopen session is treated like a standard open session.
+
+ When reopening a session:
+
+ - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager.
+ - The session state is updated to `open`.
+ - Any modified budgets and triggered effects are rolled back when the session closes.
+ - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy)
+ in your loyalty programs, points are rolled back in the following ways:
+ - Pending points are rolled back automatically.
+ - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed
+ are rolled back.
+ - If **Negative balance** is enabled, the rollback can create a negative points balance.
+
+
+ Effects and budgets unimpacted by a session reopening
+
+
The following effects and budgets remain in the state they were in when the session closed:
+
+ - Add free item effect
+ - Award giveaway
+ - Coupon and referral creation
+ - Coupon reservation
+ - Custom effect
+ - Update attribute value
+ - Update cart item attribute value
+
+
+
+
+ To see an example of a rollback, see the
+ [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial.
+
+ > [!note] If your order workflow requires you to create a new session
+ > instead of reopening a session, use the
+ > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ > endpoint to cancel a closed session and create a new one.
operationId: reopenCustomerSession
parameters:
- description: |
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
explode: false
in: path
name: customerSessionId
@@ -467,21 +611,21 @@ paths:
/v2/customer_profiles/{integrationId}:
put:
description: |
- Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.
+ Update or create a [Customer
+ Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles).
+ This endpoint triggers the Rule Builder.
You can use this endpoint to:
- Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first.
- Modify the audience the customer profile is a member of.
- **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
-
-
Performance tips
-
- - Updating a customer profile returns a response with the requested integration state.
- - You can use the `responseContent` property to save yourself extra API calls. For example, you can get
- the customer profile details directly without extra requests.
- - We recommend sending requests sequentially.
- See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
-
+
+ > [!note] **Note**
+ > - Updating a customer profile returns a response with the requested integration state.
+ > - You can use the `responseContent` property to save yourself extra API calls. For example, you can get
+ > the customer profile details directly without extra requests.
+ > - We recommend sending requests sequentially.
+ > See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
+ > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
operationId: updateCustomerProfileV2
parameters:
- description: |
@@ -530,6 +674,51 @@ paths:
requestBody:
content:
application/json:
+ examples:
+ eCommerce:
+ description: Create a new customer with basic information and sign-up
+ date.
+ summary: "Example: eCommerce"
+ value:
+ attributes:
+ Name: Chris Taylor
+ Email: chris.taylor@example.com
+ SignupDate: 2026-01-21T15:04:05+07:00
+ PaymentMethod: Bank transfer
+ x-vertical: ecommerce
+ QSR & dining:
+ description: |
+ Update a customer profile with dietary preferences and ordering behaviors to personalize offers.
+ summary: "Example: QSR & dining"
+ value:
+ attributes:
+ Name: Jane Doe
+ Email: jane.doe@example.com
+ DietaryPreferences: vegetarian
+ x-vertical: qsr
+ Financial services:
+ description: |
+ Update a customer profile with account type and card details to enable
+ personalized cashback campaigns.
+ summary: "Example: Financial services"
+ value:
+ attributes:
+ Name: Alex Johnson
+ Email: alex.johnson@example.com
+ AccountType: premium_checking
+ PreferredCard: credit
+ x-vertical: finance
+ Travel & hospitality:
+ description: |
+ Update a traveler profile with a churn risk score to identify travelers who
+ haven't booked a flight in several months and offer time-sensitive rewards.
+ summary: "Example: Travel & hospitality"
+ value:
+ attributes:
+ Name: Maria Chen
+ Email: maria.chen@example.com
+ ChurnRisk: 0.872
+ x-vertical: travel
schema:
$ref: "#/components/schemas/CustomerProfileIntegrationRequestV2"
description: body
@@ -571,16 +760,20 @@ paths:
/v2/customer_profiles:
put:
description: |
- Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request.
+ Update (or create) up to 1000 [customer
+ profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles)
+ in 1 request.
The `integrationId` must be any identifier that remains stable for
the customer. Do not use an ID that the customer can update
themselves. For example, you can use a database ID.
- A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions).
+ A customer profile [can be linked to one or more
+ sessions](https://docs.talon.one/integration-api#tag/Customer-sessions).
- **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates,
- use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
+ > [!note] This endpoint does not trigger the Rule Engine.
+ > To trigger the Rule Engine for customer profile updates,
+ > use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
operationId: updateCustomerProfilesV2
parameters:
- description: |
@@ -632,26 +825,79 @@ paths:
/v2/audiences:
post:
description: |
- Create an audience. The audience can be created directly from scratch or can come from third party platforms.
+ Create an audience. The audience can be created directly from scratch or can
+ come from third party platforms.
+
+ > [!note] Audiences can also be created from scratch via the Campaign
+ Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences).
- **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences).
+ To create an audience from an existing audience from a [technology
+ partner](https://docs.talon.one/docs/dev/technology-partners/overview):
- To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview):
- 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform.
+ 1. Set the `integration` property to `mparticle`, `segment` etc., depending
+ on a third-party platform.
1. Set `integrationId` to the ID of this audience in a third-party platform.
To create an audience from an existing audience in another platform:
+
1. Do not use the `integration` property.
1. Set `integrationId` to the ID of this audience in the 3rd-party platform.
- To create an audience from scratch:
- 1. Only set the `name` property.
+ To create an audience from scratch, only set the `name` property.
- Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
+ Once you create your first audience, audience-specific rule conditions are
+ enabled in the Rule Builder.
operationId: createAudienceV2
requestBody:
content:
application/json:
+ examples:
+ eCommerce:
+ description: Create an audience for high-value customers.
+ summary: "Example: eCommerce"
+ value:
+ name: VIP Customers
+ description: Customers with high lifetime value and frequent purchases
+ sandbox: false
+ createdIn3rdParty: false
+ x-vertical: ecommerce
+ QSR & dining:
+ description: |
+ Creating an audience for customers who frequently order breakfast items during morning hours.
+ This audience can be targeted with breakfast promotions, early-bird offers, or morning loyalty bonuses.
+ summary: "Example: QSR & dining"
+ value:
+ name: Breakfast Regulars
+ description: Customers who order breakfast items 3+ times per week
+ during weekday mornings
+ sandbox: false
+ createdIn3rdParty: false
+ x-vertical: qsr
+ Financial services:
+ description: |
+ Create an audience for customers who recently opened an account to
+ target them with welcome bonuses or first-transaction cashback rewards.
+ summary: "Example: Financial services"
+ value:
+ name: New Account Holders
+ description: Customers who opened an account within the last 30
+ days
+ sandbox: false
+ createdIn3rdParty: false
+ x-vertical: finance
+ Travel & hospitality:
+ description: |
+ Create an audience for luxury-oriented travelers so tour operators
+ can automatically trigger personalized offers, such as complimentary
+ spa vouchers, when they initiate a booking.
+ summary: "Example: Travel & hospitality"
+ value:
+ name: Luxury Seekers
+ description: Travelers who consistently book premium accommodations
+ and high-end tour packages
+ sandbox: false
+ createdIn3rdParty: false
+ x-vertical: travel
schema:
$ref: "#/components/schemas/NewAudience"
description: body
@@ -695,9 +941,11 @@ paths:
description: |
Delete an audience created by a third-party integration.
- **Warning:** This endpoint also removes any associations recorded between a customer profile and this 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).
+ > [!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).
operationId: deleteAudienceV2
parameters:
- description: The ID of the audience.
@@ -831,7 +1079,9 @@ paths:
The endpoint supports 1000 audience actions (`add` or `remove`) per request.
- **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ > [!note] You can also do this using the
+ > [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience)
+ > effect.
operationId: updateCustomerProfileAudiences
requestBody:
content:
@@ -912,14 +1162,22 @@ paths:
/v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile:
post:
description: |
- [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect
- and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
- They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them.
+ [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview)
+ allow customers to collect and spend loyalty points within a [card-based loyalty
+ program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
+
+ They are useful to gamify loyalty programs and can be used with or without
+ customer profiles linked to them.
- Link a customer profile to a given loyalty card for the card to be set as **Registered**.
- This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card).
+ Link a customer profile to a given loyalty card for the card to be set as
+ **Registered**.
- **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
+ This affects how it can be used. See the
+ [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card).
+
+ > [!note] You can link as many customer profiles to a given loyalty card as the
+ > [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs)
+ > allows.
operationId: linkLoyaltyCardToProfile
parameters:
- description: |
@@ -998,7 +1256,7 @@ paths:
Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card.
To get the `integrationId` of a customer profile, you can use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2)
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
endpoint.
operationId: unlinkLoyaltyCardFromProfile
parameters:
@@ -1076,26 +1334,28 @@ paths:
Triggers a custom event.
To use this endpoint:
- 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager.
- 1. Update or create a rule to check for this event.
- 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.
- Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create
- a custom event when you can use a built-in event.
-
- For example, use this endpoint to trigger an event when a customer shares a link to a product.
- See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).
+ 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event)
+ in the Campaign Manager.
+ 1. Update or create a rule to check for this event.
+ 1. Trigger the event with this endpoint. After you have successfully sent an
+ event to Talon.One, you can list the received events in the **Events** view
+ in the Campaign Manager.
-
+ Talon.One also offers a set of [built-in
+ events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure
+ you do not create a custom event when you can use a built-in event.
-
Important
+ For example, use this endpoint to trigger an event when a customer shares a
+ link to a product.
- 1. `profileId` is required even though the schema does not specify it.
- 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.
- 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
- 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.
+ See the [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.
operationId: trackEventV2
parameters:
- description: |
@@ -1168,9 +1428,13 @@ paths:
/v1/referrals:
post:
description: |
- Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
+ Creates a referral code for an advocate. The code will be valid for the
+ referral campaign for which is created, indicated in the `campaignId`
+ parameter, and will be associated with the profile specified in the
+ `advocateProfileIntegrationId` parameter as the advocate's profile.
- **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits)
+ > set are ignored when you use this endpoint.
operationId: createReferral
requestBody:
content:
@@ -1209,9 +1473,14 @@ paths:
/v1/referrals_for_multiple_advocates:
post:
description: |
- Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
-
- **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ Creates unique referral codes for multiple advocates. The code will be valid
+ for the referral campaign for which it is created, indicated in the
+ `campaignId` parameter, and one referral code will be associated with one
+ advocate using the profile specified in the `advocateProfileIntegrationId`
+ parameter as the advocate's profile.
+
+ > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits)
+ > set are ignored when you use this endpoint.
operationId: createReferralsForMultipleAdvocates
parameters:
- description: |
@@ -1265,20 +1534,23 @@ paths:
/v1/customer_data/{integrationId}:
delete:
description: |
- Delete all attributes on the customer profile and on entities that reference this customer profile.
-
- **Important:**
- - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments)
- that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application,
- customer data will be deleted from all sandbox Applications. This is because customer data is shared
- between Applications from the same environment.
- - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
+ Delete all attributes on the customer profile and on entities that reference
+ this customer profile.
+
+ > [!warning] **Warning**
+ > - Customer data is deleted from all Applications in the
+ > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments)
+ > that the API key belongs to. For example, if you use this endpoint with an API key that belongs
+ > to a sandbox Application, customer data will be deleted from all sandbox Applications.
+ > This is because customer data is shared between Applications from the same environment.
+ > - To preserve performance, we recommend avoiding deleting customer data
+ > during peak-traffic hours.
operationId: deleteCustomerData
parameters:
- description: |
The integration ID of the customer profile. You can get the `integrationId` of a profile using:
- - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
- - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
+ - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: integrationId
@@ -1315,10 +1587,12 @@ paths:
coupon code.
operationId: deleteCouponReservation
parameters:
- - description: "The code of the coupon.\n\n**Important:** The coupon code requires\
- \ [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) \nif\
- \ it contains special characters.\nFor example, you must encode `SUMMER25%OFF`\
- \ as `SUMMER25%25OFF`.\n"
+ - description: |
+ The code of the coupon.
+
+ **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp)
+ if it contains special characters.
+ For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
explode: false
in: path
name: couponValue
@@ -1367,25 +1641,24 @@ paths:
reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code)
effect.
- **Note:**
-
- - If the **Reservation mandatory** option was selected when creating the
- specified coupon, the endpoint creates a **hard** reservation, meaning only users who have
- this coupon code reserved can redeem it.
- Otherwise, the endpoint creates a **soft** reservation, meaning the coupon
- is associated with the specified customer profiles (they show up when using
- the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory)
- endpoint), but any user can redeem it.
- This can be useful, for example, to display a _coupon wallet_ for customers
- when they visit your store.
-
- - If the **Coupon visibility** option was selected when creating the
- specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code
- will be returned for all customer profiles in the [List customer
- data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint.
-
- - This endpoint overrides the coupon reservation limit set when
- [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons).
+ > [!note] **Note**
+ > - If the **Reservation mandatory** option was selected when creating the
+ > specified coupon, the endpoint creates a **hard** reservation, meaning only users who have
+ > this coupon code reserved can redeem it.
+ >
+ > Otherwise, the endpoint creates a **soft** reservation, meaning the coupon
+ > is associated with the specified customer profiles (they show up when using
+ > the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+ > endpoint), but any user can redeem it.
+ >
+ > This can be useful, for example, to display a _coupon wallet_ for customers
+ > when they visit your store.
+ > - If the **Coupon visibility** option was selected when creating the
+ > specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code
+ > will be returned for all customer profiles in the [List customer
+ > data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) endpoint.
+ > - This endpoint overrides the coupon reservation limit set when
+ > [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons).
To ensure that coupons cannot be reserved after the reservation limit is
reached, use the [Create coupon code
@@ -1397,10 +1670,12 @@ paths:
[Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
operationId: createCouponReservation
parameters:
- - description: "The code of the coupon.\n\n**Important:** The coupon code requires\
- \ [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) \nif\
- \ it contains special characters.\nFor example, you must encode `SUMMER25%OFF`\
- \ as `SUMMER25%25OFF`.\n"
+ - description: |
+ The code of the coupon.
+
+ **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp)
+ if it contains special characters.
+ For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
explode: false
in: path
name: couponValue
@@ -1503,8 +1778,8 @@ paths:
parameters:
- description: |
The integration ID of the customer profile. You can get the `integrationId` of a profile using:
- - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
- - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
+ - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: integrationId
@@ -1833,12 +2108,13 @@ paths:
type: string
style: simple
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -1892,12 +2168,18 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances:
get:
description: |
- Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program.
- You can filter balances by date and subledger ID, and include tier-related information in the response.
+ Retrieve loyalty ledger balances for the given Integration ID in the
+ specified loyalty program.
- **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID.
+ You can filter balances by date and subledger ID, and include tier-related
+ information in the response.
- Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.
+ > [!note] If no filtering options are applied, you retrieve all loyalty
+ > balances on the current date for the given integration ID.
+
+ Loyalty balances are calculated when Talon.One receives your request using
+ the points stored in our database, so retrieving a large number of balances
+ at once can impact performance.
For more information, see:
- [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards)
@@ -1929,12 +2211,13 @@ paths:
type: string
style: simple
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -2012,16 +2295,26 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances:
get:
description: |
- Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program.
- You can filter balances by date and subledger ID, and include tier-related information in the response.
+ Retrieve loyalty ledger balances for the given Integration ID in the
+ specified loyalty program.
- **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID.
+ You can filter balances by date and subledger ID, and include tier-related
+ information in the response.
- Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.
+ > [!note] If no filtering options are applied, you retrieve all loyalty
+ > balances on the current date for the given integration ID.
+
+ Loyalty balances are calculated when Talon.One receives your request using
+ the points stored in our database, so retrieving a large number of balances
+ at once can impact performance.
For more information, see:
- - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards)
- - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+
+ - [Managing card-based loyalty program
+ data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards)
+
+ - [Managing profile-based loyalty program
+ data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
operationId: getLoyaltyLedgerBalances
parameters:
- description: |
@@ -2049,12 +2342,13 @@ paths:
type: string
style: simple
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -2192,12 +2486,13 @@ paths:
type: string
style: form
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: startDate
@@ -2207,12 +2502,13 @@ paths:
type: string
style: form
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -2312,12 +2608,15 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions:
get:
description: |
- Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program.
+ Retrieve paginated results of loyalty transaction logs for the given
+ Integration ID in the specified loyalty program.
- You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned.
+ You can filter transactions by date. If no filters are applied, the last 50
+ loyalty transactions for the given integration ID are returned.
- **Note:** To retrieve all loyalty program transaction logs in a given loyalty program,
- use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ > [!note] To retrieve all loyalty program transaction logs in a given
+ > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions)
+ > endpoint.
operationId: getLoyaltyProgramProfileTransactions
parameters:
- description: |
@@ -2344,10 +2643,13 @@ paths:
schema:
type: string
style: simple
- - description: "Filter the results by a list of customer session IDs. \n\nTo\
- \ include multiple IDs, repeat the parameter for each one, for example,\
- \ \n`?customerSessionIDs=id1&customerSessionIDs=id2`.\n\nThe response contains\
- \ only data associated with the specified sessions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: customerSessionIDs
@@ -2357,9 +2659,13 @@ paths:
type: string
type: array
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\
- \nThe response contains only data associated with the specified transactions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: transactionUUIDs
@@ -2394,12 +2700,13 @@ paths:
type: string
style: form
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: startDate
@@ -2409,12 +2716,13 @@ paths:
type: string
style: form
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -2482,12 +2790,15 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions:
get:
description: |
- Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program.
+ Retrieve paginated results of loyalty transaction logs for the given
+ Integration ID in the specified loyalty program.
- You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned.
+ You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50
+ loyalty transactions for the given integration ID are returned.
- **Note:** To retrieve all loyalty program transaction logs in a given loyalty program,
- use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ > [!note] To retrieve all loyalty program transaction logs in a given
+ > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions)
+ > endpoint.
operationId: getLoyaltyProgramProfileLedgerTransactions
parameters:
- description: |
@@ -2514,10 +2825,13 @@ paths:
schema:
type: string
style: simple
- - description: "Filter the results by a list of customer session IDs. \n\nTo\
- \ include multiple IDs, repeat the parameter for each one, for example,\
- \ \n`?customerSessionIDs=id1&customerSessionIDs=id2`.\n\nThe response contains\
- \ only data associated with the specified sessions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: customerSessionIDs
@@ -2527,9 +2841,13 @@ paths:
type: string
type: array
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\
- \nThe response contains only data associated with the specified transactions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: transactionUUIDs
@@ -2565,12 +2883,13 @@ paths:
type: string
style: form
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: startDate
@@ -2580,12 +2899,13 @@ paths:
type: string
style: form
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -2653,9 +2973,9 @@ paths:
description: |
Delete a customer's transactions in all loyalty ledgers or a specified ledger.
- **Note:** To retrieve loyalty transaction logs for a specific customer in a given
- loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions)
- endpoint.
+ > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program,
+ > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions)
+ > endpoint.
operationId: deleteLoyaltyTransactionsFromLedgers
parameters:
- description: |
@@ -2671,8 +2991,8 @@ paths:
style: simple
- description: |
The integration ID of the customer profile. You can get the `integrationId` of a profile using:
- - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
- - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
+ - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: integrationId
@@ -3256,7 +3576,9 @@ paths:
description: |
Update the given campaign.
- **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
+ > [!important] You cannot use this endpoint to update campaigns if [campaign staging and
+ > revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions)
+ > is enabled for your Application.
operationId: updateCampaign
parameters:
- $ref: "#/components/parameters/applicationId"
@@ -3615,21 +3937,16 @@ paths:
put:
description: |
Update all coupons or a specific batch of coupons in the given campaign.
- You can find the `batchId` on the **Coupons** page of your campaign
- in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).
-
-
Important
+ You can find the `batchId` on the **Coupons** page of your campaign in the
+ Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
-
- - Only send sequential requests to this endpoint.
- - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.
- - With this
PUT endpoint, if you do not explicitly set a value for the startDate and expiryDate properties in your request, it is automatically set to null.
-
+ > [!note] **Note**
+ > - Only send sequential requests to this endpoint.
+ > - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.
+ > - With this `PUT` endpoint, if you do not explicitly set a value for the `startDate` and `expiryDate` properties in your request, it is automatically set to `null`.
-
-
- To update a specific coupon, use [Update coupon](#operation/updateCoupon).
+ To update a specific coupon, use [Update coupon](#tag/Coupons/operation/updateCoupon).
operationId: updateCouponBatch
parameters:
- $ref: "#/components/parameters/applicationId"
@@ -3964,12 +4281,9 @@ paths:
description: |
Update the specified coupon.
-
-
Important
-
-
With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.
-
-
+ > [!note]
+ > With this `PUT` endpoint, if you do not explicitly set a value for the `startDate`, `expiryDate`,
+ > and `recipientIntegrationId` properties in your request, it is automatically set to `null`.
operationId: updateCoupon
parameters:
- $ref: "#/components/parameters/applicationId"
@@ -4007,13 +4321,12 @@ paths:
/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total:
post:
description: |
- List the coupons whose attributes match the query criteria
- in the given campaign.
+ List the coupons whose attributes match the query criteria in the given campaign.
- The match is successful if all the attributes of the request are found in a coupon,
- even if the coupon has more attributes that are not present on the request.
+ The match is successful if all the attributes of the request are found in a
+ coupon, even if the coupon has more attributes that are not present on the request.
- **Note:** The total count is not included in the response.
+ > [!note] The total count is not included in the response.
operationId: searchCouponsAdvancedWithoutTotalCount
parameters:
- $ref: "#/components/parameters/pageSize"
@@ -4134,12 +4447,13 @@ paths:
/v1/applications/{applicationId}/coupons_search_advanced/no_total:
post:
description: |
- List the coupons whose attributes match the query criteria in all the campaigns of the given Application.
+ List the coupons whose attributes match the query criteria in all the
+ campaigns of the given Application.
- The match is successful if all the attributes of the request are found in a coupon,
- even if the coupon has more attributes that are not present on the request.
+ The match is successful if all the attributes of the request are found in a
+ coupon, even if the coupon has more attributes that are not present on the request.
- **Note:** The total count is not included in the response.
+ > [!note] The total count is not included in the response.
operationId: searchCouponsAdvancedApplicationWideWithoutTotalCount
parameters:
- $ref: "#/components/parameters/pageSize"
@@ -4675,11 +4989,14 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}:
get:
description: |
- Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview).
- To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms).
+ Get the specified [loyalty
+ program](https://docs.talon.one/docs/product/loyalty-programs/overview).
+
+ To list all loyalty programs in your Application, use [List loyalty
+ programs](#tag/Loyalty/operation/getLoyaltyPrograms).
- To list the loyalty programs that a customer profile is part of, use the
- [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+ To list the loyalty programs that a customer profile is part of, use
+ [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory).
operationId: getLoyaltyProgram
parameters:
- description: |
@@ -4763,11 +5080,12 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/dashboard:
get:
description: |
- Retrieve the statistics displayed on the specified loyalty program's dashboard,
- such as the total active points, pending points, spent points, and expired points.
+ Retrieve the statistics displayed on the specified loyalty program's
+ dashboard, such as the total active points, pending points, spent points, and expired
+ points.
- **Important:** The returned data does not include the current day. All statistics
- are updated daily at 11:59 PM in the loyalty program time zone.
+ > [!important] The returned data does not include the current day. All statistics
+ > are updated daily at 11:59 PM in the loyalty program time zone.
operationId: getDashboardStatistics
parameters:
- description: |
@@ -4792,9 +5110,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -4806,9 +5125,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -4831,49 +5151,81 @@ paths:
- application/json
/v1/loyalty_programs/{loyaltyProgramId}/import_points:
post:
- description: "Upload a CSV file containing the loyalty points you want to import\
- \ into a given loyalty program.\nSend the file as multipart data.\n\nDepending\
- \ on the type of loyalty program, you can import points into a given customer\
- \ profile or loyalty card.\n\nThe CSV file contains the following columns:\n\
- \n- `customerprofileid` (optional): For profile-based loyalty programs, the\
- \ integration ID of the customer profile where the loyalty points are imported.\n\
- \n **Note**: If the customer profile does not exist, it will be created.\
- \ The profile will not be visible in any Application\n until a session or\
- \ profile update is received for that profile.\n- `identifier` (optional):\
- \ For card-based loyalty programs, the identifier of the loyalty card where\
- \ the loyalty points are imported.\n- `amount`: The amount of points to award\
- \ to the customer profile.\n- `startdate` (optional): The earliest date when\
- \ the points can be redeemed. The points are `active` from this date until\
- \ the expiration date.\n\n This parameter accepts one of the following values:\n\
- \ - A timestamp string in RFC3339 format.\n - `immediate`\n - `on_action`\n\
- \ \n **Note**:\n Empty or missing values default to `immediate`.\n- `expirydate`\
- \ (optional): The latest date when the points can be redeemed. The points\
- \ are `expired` after this date.\n\n **Note**: It must be an RFC3339 timestamp\
- \ string or string `unlimited`. Empty or missing values are considered `unlimited`.\n\
- \ \n If passed, `validityDuration` should be omitted.\n- `validityDuration`\
- \ (optional): The duration for which the points remain active, relative to\
- \ the \n activation date.\n\n The time format is an **integer** followed\
- \ by one letter indicating the time unit.\n\n\n Examples: `30s`, `40m`, `1h`,\
- \ `5D`, `7W`, `10M`, `15Y`.\n\n\n Available units:\n\n\n - `s`: seconds\n\
- \ - `m`: minutes\n - `h`: hours\n - `D`: days\n - `W`: weeks\n - `M`:\
- \ months\n - `Y`: years\n\n\n You can round certain units up or down:\n\n\
- \ - `_D` for rounding down days only. Signifies the start of the day.\n \
- \ - `_U` for rounding up days, weeks, months and years. Signifies the end\
- \ of\n the day, week, month or year.\n\n If passed, `expirydate` should\
- \ be omitted.\n- `subledgerid` (optional): The ID of the subledger that should\
- \ received the points.\n- `reason` (optional): The reason why these points\
- \ are awarded.\n\nYou can use the time zone of your choice. It is converted\
- \ to UTC internally by Talon.One.\n\n**Note:** For existing customer profiles\
- \ and loyalty cards, the imported points are added to any previous active\
- \ or pending points, depending on the\nvalue provided for `startdate`. If\
- \ `startdate` matches the current date, the imported points are _active_.\
- \ If it is later, the points are _pending_ until\nthe date provided for `startdate`\
- \ is reached.\n\n**Note:** We recommend limiting your file size to 500MB.\n\
- \n**Example for profile-based programs:**\n\n```text\ncustomerprofileid,amount,startdate,expirydate,subledgerid,reason\n\
- URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement\n\
- ```\n\n**Example for card-based programs:**\n\n```text\nidentifier,amount,startdate,expirydate,subledgerid,reason\n\
- summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement\n\
- ```\n"
+ description: |
+ Upload a CSV file containing the loyalty points you want to import into a
+ given loyalty program.
+
+ Send the file as multipart data.
+
+ Depending on the type of loyalty program, you can import points into a given
+ customer profile or loyalty card.
+
+ The CSV file contains the following columns:
+
+ - `customerprofileid` (optional): For profile-based loyalty programs, the
+ integration ID of the customer profile where the loyalty points are
+ imported.
+ **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.
+ - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported.
+ - `amount`: The amount of points to award to the customer profile.
+ - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date.
+ This parameter accepts one of the following values:
+ - A timestamp string in RFC3339 format.
+ - `immediate`
+ - `on_action`
+ **Note**: Empty or missing values default to `immediate`.
+ - `expirydate` (optional): The latest date when the points can be redeemed.
+ The points are `expired` after this date.
+ **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`.
+ If passed, `validityDuration` should be omitted.
+ - `validityDuration` (optional): The duration for which the points remain active, relative to the
+ activation date. The time format is an **integer** followed by one letter indicating the time unit.
+ Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
+
+ Available units:
+
+ - `s`: seconds
+ - `m`: minutes
+ - `h`: hours
+ - `D`: days
+ - `W`: weeks
+ - `M`: months
+ - `Y`: years
+
+ You can round certain units up or down:
+
+ - `_D` for rounding down days only. Signifies the start of the day.
+ - `_U` for rounding up days, weeks, months and years. Signifies the end of
+ the day, week, month or year.
+
+ If passed, `expirydate` should be omitted.
+ - `subledgerid` (optional): The ID of the subledger that should received the points.
+ - `reason` (optional): The reason why these points are awarded.
+
+ You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
+
+ > [!note] For existing customer profiles and loyalty cards, the imported
+ > points are added to any previous active or pending points, depending on the
+ > value provided for `startdate`. If `startdate` matches the current date, the
+ > imported points are _active_. If it is later, the points are _pending_ until
+ > the date provided for `startdate` is reached.
+
+ > [!note] We recommend limiting your file size to 500 MB.
+
+ ## Example for profile-based programs
+
+ ```text
+ customerprofileid,amount,startdate,expirydate,subledgerid,reason
+ URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement
+ ```
+
+ ## Example for card-based programs
+
+ ```text
+ identifier,amount,startdate,expirydate,subledgerid,reason
+ summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement
+ ```
operationId: importLoyaltyPoints
parameters:
- description: |
@@ -4920,29 +5272,45 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers:
post:
description: |
- Upload a CSV file containing existing customers to be assigned to existing tiers.
+ Upload a CSV file containing existing customers to be assigned to existing
+ tiers.
+
Send the file as multipart data.
- **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled.
+ > [!important] This endpoint only works with loyalty programs with advanced
+ > tiers (with expiration and downgrade policy) feature enabled.
The CSV file should contain the following columns:
- - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used.
- - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned.
+
+ - `subledgerid` (optional): The ID of the subledger. If this field is empty,
+ the main ledger will be used.
+ - `customerprofileid`: The integration ID of the customer profile to whom
+ the tier should be assigned.
- `tiername`: The name of an existing tier to assign to the customer.
- - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date.
+ - `expirydate`: The expiration date of the tier when the tier is
+ reevaluated. It should be a future date.
About customer assignment to a tier:
- - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import.
- - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated.
- **Note:** We recommend not using this endpoint to update the tier of a customer.
- To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points.
+ - If the customer isn't already in a tier, the customer is assigned to the
+ specified tier during the tier import.
+ - If the customer is already in the tier that's specified in the CSV file,
+ only the expiration date is updated.
- You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
+ > [!note] We recommend not using this endpoint to update the tier of a customer.
+
+ To update a customer's tier, you can
+ [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or
+ [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their
+ loyalty points.
+
+ You can use the time zone of your choice. It is converted to UTC internally
+ by Talon.One.
+
+ > [!note] We recommend limiting your file size to 500 MB.
- **Note:** We recommend limiting your file size to 500MB.
+ ## Example
- **Example:**
```csv
subledgerid,customerprofileid,tiername,expirydate
SUB1,alexa,Gold,2024-03-21T07:32:14Z
@@ -5006,7 +5374,7 @@ paths:
Get the loyalty ledger for this profile integration ID.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
**Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program,
we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
@@ -5051,7 +5419,7 @@ paths:
Add points in the specified loyalty program for the given customer.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
operationId: addLoyaltyPoints
parameters:
- description: The identifier for the loyalty program.
@@ -5107,14 +5475,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points:
put:
description: |
- Deduct points from the specified loyalty program and specified customer profile.
+ Deduct points from the specified loyalty program and specified customer
+ profile.
- **Important:**
- - Only active points can be deducted.
- - Only pending points are rolled back when a session is cancelled or reopened.
+ > [!note] **Note**
+ > - Only active points can be deducted.
+ > - Only pending points are rolled back when a session is cancelled or reopened.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ endpoint.
operationId: removeLoyaltyPoints
parameters:
- description: The identifier for the loyalty program.
@@ -5170,9 +5540,11 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log:
get:
description: |
- Download a CSV file containing a customer's transaction logs in the loyalty program.
+ Download a CSV file containing a customer's transaction logs in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 generated file can contain the following columns:
@@ -5198,9 +5570,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -5212,9 +5585,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -5279,7 +5653,8 @@ paths:
description: |
Download a CSV file containing the join dates of all customers in the loyalty program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 generated file can contain the following columns:
@@ -5398,9 +5773,10 @@ paths:
get:
deprecated: true
description: |
- ⚠️ Deprecation notice: Support for requests to this endpoint will end soon.
- To retrieve statistics for a loyalty program, use the [Get statistics for
- loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics)
+ > [warning] This endpoint is deprecated.
+
+ To retrieve statistics for a loyalty program, use the
+ [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics)
endpoint.
Retrieve the statistics of the specified loyalty program, such as the
@@ -5433,14 +5809,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances:
get:
description: |
- Download a CSV file containing the balance of each customer in the loyalty program.
+ Download a CSV file containing the balance of each customer in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 generated file can contain the following columns:
- `loyaltyProgramID`: The ID of the loyalty program.
- - `loyaltySubledger`: The name of the subdleger, when applicatble.
+ - `loyaltySubledger`: The name of the subledger, when applicable.
- `profileIntegrationID`: The integration ID of the customer profile.
- `currentBalance`: The current point balance.
- `pendingBalance`: The number of pending points.
@@ -5457,15 +5835,15 @@ paths:
schema:
type: string
style: simple
- - description: "Used to return expired, active, and pending loyalty balances\
- \ before this\ntimestamp. You can enter any past, present, or future timestamp\
- \ value.\n\n**Note:**\n\n- It must be an RFC3339 timestamp string.\n- You\
- \ can include a time component in your string, for example,\n`T23:59:59`\
- \ to specify the end of the day. The time zone setting\nconsidered is `UTC`.\
- \ If you do not include a time component, a default\ntime value of `T00:00:00`\
- \ (midnight) in `UTC` is considered.\n- This parameter does not affect the\
- \ `currentTier` field in the CSV file, \nwhich shows the customer's tier\
- \ at the time of export.\n"
+ - description: |
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
+
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export.
explode: true
in: query
name: endDate
@@ -5509,12 +5887,14 @@ paths:
get:
deprecated: true
description: |
- ⚠️ Deprecation notice: Support for requests to this endpoint will end soon.
- To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint.
+ To export customer loyalty balances to CSV, use the [Export customer loyalty
+ balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint.
- Download a CSV file containing the balance of each customer in the loyalty program.
+ Download a CSV file containing the balance of each customer in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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).
operationId: exportLoyaltyBalance
parameters:
- description: The identifier for the loyalty program.
@@ -5526,12 +5906,13 @@ paths:
type: string
style: simple
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -5568,11 +5949,15 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/transactions:
get:
description: |
- Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included.
- **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned.
-
- **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program,
- we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ Retrieve loyalty program transaction logs in a given loyalty program with
+ filtering options applied. Manual and imported transactions are also
+ included.
+
+ > [!note] **Note**
+ > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned.
+ > - To get loyalty transaction logs for a given Integration ID in
+ > a loyalty program, we recommend using the Integration API's [Get customer's loyalty
+ > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
operationId: getLoyaltyProgramTransactions
parameters:
- description: |
@@ -5610,10 +5995,13 @@ paths:
schema:
type: string
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,\
- \ \n`?customerSessionIDs=id1&customerSessionIDs=id2`.\n\nThe response contains\
- \ only data associated with the specified sessions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: customerSessionIDs
@@ -5623,9 +6011,13 @@ paths:
type: string
type: array
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\
- \nThe response contains only data associated with the specified transactions.\n"
+ - description: |
+ 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.
explode: true
in: query
name: transactionUUIDs
@@ -5636,12 +6028,13 @@ paths:
type: array
style: form
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: startDate
@@ -5651,12 +6044,13 @@ paths:
type: string
style: form
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -5722,18 +6116,24 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/import_cards:
post:
description: |
- Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program.
+ 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 (;).
+ - `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:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500MB.
- **Example:**
+ ## Example
```csv
identifier,state,customerprofileids
@@ -5786,14 +6186,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/batch:
post:
description: |
- Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
+ Create a batch of loyalty cards in a specified [card-based loyalty
+ program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
Customers can use loyalty cards to collect and spend loyalty points.
- **Important:**
-
- - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes.
- - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+ > [!important] **Note**
+ > - The specified card-based loyalty program must have a defined card code
+ > format that is used to generate the loyalty card codes.
+ > - Trying to create more than 20,000 loyalty cards in a single request
+ > returns an error message with a `400` status code.
operationId: createBatchLoyaltyCards
parameters:
- description: |
@@ -5848,15 +6250,19 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/export_card_balances:
get:
description: |
- Download a CSV file containing the balances of all cards in the loyalty program.
+ Download a CSV file containing the balances of all cards in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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:
- `loyaltyProgramID`: The ID of the loyalty program.
- `loyaltySubledger`: The name of the subdleger, when applicatble.
- - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.
- - `cardState`:The state of the loyalty card. It can be `active` or `inactive`.
+ - `cardIdentifier`: The identifier of the loyalty card, which must match the regular
+ expression `^[A-Za-z0-9._%+@-]+$`.
+ - `cardState`:The state of the loyalty card. It can be `active` or
+ `inactive`.
- `currentBalance`: The current point balance.
- `pendingBalance`: The number of pending points.
- `expiredBalance`: The number of expired points.
@@ -5875,12 +6281,13 @@ paths:
type: integer
style: simple
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -6004,16 +6411,13 @@ paths:
To link the card to one or more customer profiles, use the
`customerProfileIds` parameter in the request body.
- **Note:**
-
- - The number of customer profiles linked to the loyalty card cannot exceed
- the loyalty program's `usersPerCardLimit`. To find the program's limit, use
- the [Get loyalty
- program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram)
- endpoint.
-
- - If the loyalty program has a defined code format, it will be used for the
- loyalty card identifier.
+ > [!note] **Note**
+ > - The number of customer profiles linked to the loyalty card cannot exceed
+ > the loyalty program's `usersPerCardLimit`. To find the program's limit, use
+ > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram)
+ > endpoint.
+ > - If the loyalty program has a defined code format, it will be used for the
+ > loyalty card identifier.
operationId: generateLoyaltyCard
parameters:
- description: |
@@ -6064,11 +6468,14 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/export:
get:
description: |
- Download a CSV file containing the loyalty cards from a specified loyalty program.
+ Download a CSV file containing the loyalty cards from a specified loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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.
@@ -6077,6 +6484,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.
operationId: exportLoyaltyCards
parameters:
- description: |
@@ -6101,8 +6509,7 @@ paths:
- description: |
Only return loyalty cards created before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
+ **Note:** This must be an RFC3339 timestamp string.
explode: true
in: query
name: createdBefore
@@ -6114,8 +6521,7 @@ paths:
- description: |
Only return loyalty cards created after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
+ **Note:** This must be an RFC3339 timestamp string.
explode: true
in: query
name: createdAfter
@@ -6142,8 +6548,8 @@ paths:
examples:
response:
value: |
- identifier,created,status,userpercardlimit,customerprofileids,blockreason,generated,batchid
- CARD-1234,2020-06-10T09:05:27.993483Z,active,3,['profile1'],card limit reached,false,gwedcbfp
+ identifier,created,status,userpercardlimit,customerprofileids,blockreason,generated,batchid,attributes
+ CARD-1234,2020-06-10T09:05:27.993483Z,active,3,['profile1'],card limit reached,false,gwedcbfp,{"ForumPosts": 17}
schema:
format: csv
type: string
@@ -6490,9 +6896,11 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log:
get:
description: |
- Download a CSV file containing a loyalty card ledger log of the loyalty program.
+ Download a CSV file containing a loyalty card ledger log of the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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).
operationId: exportLoyaltyCardLedger
parameters:
- description: |
@@ -6528,9 +6936,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -6542,9 +6951,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -6628,12 +7038,13 @@ paths:
type: string
style: simple
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: startDate
@@ -6643,12 +7054,13 @@ paths:
type: string
style: form
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: endDate
@@ -6726,12 +7138,14 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer:
put:
description: |
- Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card.
-
- **Important:**
-
- - The original card is automatically blocked once the new card is created, and it cannot be activated again.
- - The default status of the new card is _active_.
+ Transfer loyalty card data, such as linked customers, loyalty balances and
+ transactions, from a given loyalty card to a new, automatically created
+ loyalty card.
+
+ > [!important] **Note**
+ > - The original card is automatically blocked once the new card is created,
+ and it cannot be activated again.
+ > - The default status of the new card is _active_.
operationId: transferLoyaltyCard
parameters:
- description: |
@@ -6801,32 +7215,38 @@ paths:
/v1/giveaways/pools/{poolId}/import:
post:
description: |
- Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data.
+ Upload a CSV file containing the giveaway codes that should be created. Send
+ the file as multipart data.
The CSV file contains the following columns:
+
- `code` (required): The code of your giveaway, for instance, a gift card redemption code.
- `startdate`: The start date in RFC3339 of the code redemption period.
- `enddate`: The last date in RFC3339 of the code redemption period.
- - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `"{"provider": "myPartnerCompany"}"`.
- The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not.
- You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One.
+ The `startdate` and `enddate` have nothing to do with the _validity_ of the
+ codes. They are only used by the Rule Engine to award the codes or not.
- **Note:**
+ You can use the time zone setting of your choice. The values are converted
+ to UTC internally by Talon.One.
- - We recommend limiting your file size to 500MB.
- - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes.
+ > [!note] **Note**
+ > - We recommend limiting your file size to 500MB.
+ > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes.
- **Example:**
+ ## Example
```text
code,startdate,enddate,attributes
- GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}"
- GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}"
- GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Aliexpress""}"
+ GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Amazon""}"
+ GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Amazon""}"
+ GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Aliexpress""}"
```
operationId: importPoolGiveaways
parameters:
@@ -6862,9 +7282,11 @@ paths:
/v1/giveaways/pools/{poolId}/export:
get:
description: |
- Download a CSV file containing the giveaway codes of a specific giveaway pool.
+ Download a CSV file containing the giveaway codes of a specific giveaway
+ pool.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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:
@@ -6877,8 +7299,12 @@ paths:
- `used`: An indication of whether the giveaway is already awarded.
- `importid`: The ID of the import which created the giveaway.
- `created`: The creation time of the giveaway code.
- - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded.
- - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+ - `profileintegrationid`: The third-party integration ID of the customer
+ profile that was awarded the giveaway. Can be empty if the giveaway was not
+ awarded.
+ - `profileid`: The internal ID of the customer profile that was awarded the
+ giveaway. Can be empty if the giveaway was not awarded or an internal ID
+ does not exist.
operationId: exportPoolGiveaways
parameters:
- description: "The ID of the pool. You can find it in the Campaign Manager,\
@@ -7040,7 +7466,7 @@ paths:
operationId: deleteAccountCollection
parameters:
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7068,7 +7494,7 @@ paths:
operationId: getAccountCollection
parameters:
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7101,7 +7527,7 @@ paths:
operationId: updateAccountCollection
parameters:
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7159,7 +7585,7 @@ paths:
- $ref: "#/components/parameters/pageSize"
- $ref: "#/components/parameters/skip"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7315,7 +7741,8 @@ paths:
- $ref: "#/components/parameters/applicationId"
- $ref: "#/components/parameters/campaignId"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in Application](#operation/listCollectionsInApplication) endpoint."
+ \ in Application](#tag/Collections/operation/listCollectionsInApplication)\
+ \ endpoint."
explode: false
in: path
name: collectionId
@@ -7345,7 +7772,8 @@ paths:
- $ref: "#/components/parameters/applicationId"
- $ref: "#/components/parameters/campaignId"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in Application](#operation/listCollectionsInApplication) endpoint."
+ \ in Application](#tag/Collections/operation/listCollectionsInApplication)\
+ \ endpoint."
explode: false
in: path
name: collectionId
@@ -7379,7 +7807,8 @@ paths:
- $ref: "#/components/parameters/applicationId"
- $ref: "#/components/parameters/campaignId"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in Application](#operation/listCollectionsInApplication) endpoint."
+ \ in Application](#tag/Collections/operation/listCollectionsInApplication)\
+ \ endpoint."
explode: false
in: path
name: collectionId
@@ -7417,7 +7846,9 @@ paths:
/v1/collections/{collectionId}/import:
post:
description: |
- Upload a CSV file containing the collection of string values that should be attached as payload for collection.
+ Upload a CSV file containing the collection of string values that should be
+ attached as payload for collection.
+
The file should be sent as multipart data.
The import **replaces** the initial content of the collection.
@@ -7428,20 +7859,21 @@ paths:
A collection is limited to 500,000 items.
- Example:
+ ## Example
```
item
- Addidas
+ Adidas
Nike
Asics
```
- **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ > [!note] Before sending a request to this endpoint, ensure the data in the
+ > CSV to import is different from the data currently stored in the collection.
operationId: importAccountCollection
parameters:
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7484,7 +7916,9 @@ paths:
/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import:
post:
description: |
- Upload a CSV file containing the collection of string values that should be attached as payload for collection.
+ Upload a CSV file containing the collection of string values that should be
+ attached as payload for collection.
+
The file should be sent as multipart data.
The import **replaces** the initial content of the collection.
@@ -7495,22 +7929,24 @@ paths:
A collection is limited to 500,000 items.
- Example:
+ ## Example
```
item
- Addidas
+ Adidas
Nike
Asics
```
- **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ > [!note] Before sending a request to this endpoint, ensure the data in the
+ > CSV to import is different from the data currently stored in the collection.
operationId: importCollection
parameters:
- $ref: "#/components/parameters/applicationId"
- $ref: "#/components/parameters/campaignId"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in Application](#operation/listCollectionsInApplication) endpoint."
+ \ in Application](#tag/Collections/operation/listCollectionsInApplication)\
+ \ endpoint."
explode: false
in: path
name: collectionId
@@ -7549,11 +7985,12 @@ paths:
description: |
Download a CSV file containing items from a given account-level collection.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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).
operationId: exportAccountCollectionItems
parameters:
- description: "The ID of the collection. You can get it with the [List collections\
- \ in account](#operation/listAccountCollections) endpoint."
+ \ in account](#tag/Collections/operation/listAccountCollections) endpoint."
explode: false
in: path
name: collectionId
@@ -7599,13 +8036,15 @@ paths:
description: |
Download a CSV file containing items from a given campaign-level collection.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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).
operationId: exportCollectionItems
parameters:
- $ref: "#/components/parameters/applicationId"
- $ref: "#/components/parameters/campaignId"
- description: "The ID of the collection. You can get it with the [List collections\
- \ in Application](#operation/listCollectionsInApplication) endpoint."
+ \ in Application](#tag/Collections/operation/listCollectionsInApplication)\
+ \ endpoint."
explode: false
in: path
name: collectionId
@@ -7714,9 +8153,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -7728,9 +8168,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -7764,9 +8205,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -7778,9 +8220,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -7933,20 +8376,16 @@ paths:
description: |
Return the details of the specified customer profile.
-
-
Performance tips
-
- You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options:
-
- - Request the customer profile to be part of the response content using
- [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2).
- - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
-
+ > [!note]
+ > You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options:
+ > - Request the customer profile to be part of the response content using
+ > [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2).
+ > - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
operationId: getCustomerProfile
parameters:
- description: |
The value of the `id` property of a customer profile. Get it with the
- [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: customerId
@@ -8004,7 +8443,7 @@ paths:
- $ref: "#/components/parameters/applicationId"
- description: |
The value of the `id` property of a customer profile. Get it with the
- [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: customerId
@@ -8038,9 +8477,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -8052,9 +8492,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -8120,9 +8561,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -8134,9 +8576,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -8148,7 +8591,7 @@ paths:
- $ref: "#/components/parameters/applicationId"
- description: |
The value of the `id` property of a customer profile. Get it with the
- [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: customerId
@@ -8180,7 +8623,7 @@ paths:
- $ref: "#/components/parameters/applicationId"
- description: |
The value of the `id` property of a customer profile. Get it with the
- [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
explode: false
in: path
name: customerId
@@ -8608,16 +9051,19 @@ paths:
/v1/audiences/{audienceId}/memberships/import:
post:
description: |
- Upload a CSV file containing the integration IDs of the members you want to add to an audience.
+ Upload a CSV file containing the integration IDs of the members you want to
+ add to an audience.
+
+ The file should be sent as multipart data and should contain only the
+ following column (required):
- The file should be sent as multipart data and should contain only the following column (required):
- `profileintegrationid`: The integration ID of the customer profile.
The import **replaces** the previous list of audience members.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
- Example:
+ ## Example
```text
profileintegrationid
@@ -8675,11 +9121,14 @@ paths:
/v1/audiences/{audienceId}/memberships/export:
get:
description: |
- Download a CSV file containing the integration IDs of the members of an audience.
+ Download a CSV file containing the integration IDs of the members of an
+ audience.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 file contains the following column:
+
- `profileintegrationid`: The integration ID of the customer profile.
operationId: exportAudiencesMemberships
parameters:
@@ -8791,11 +9240,13 @@ paths:
x-content-type: application/json
x-accepts:
- application/json
- /v1/best_prior_price_history:
+ /v1/applications/{applicationId}/price_history:
post:
description: |
Fetch the historical price data for a given SKU within a defined timeframe.
operationId: priceHistory
+ parameters:
+ - $ref: "#/components/parameters/applicationId"
requestBody:
$ref: "#/components/requestBodies/PriceHistory"
responses:
@@ -8807,7 +9258,8 @@ paths:
description: Ok
summary: Get summary of price history
tags:
- - integration
+ - management
+ x-scalar-stability: experimental
x-content-type: application/json
x-accepts:
- application/json
@@ -8976,18 +9428,22 @@ paths:
/v1/attributes/{attributeId}/allowed_list/import:
post:
description: |
- Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute.
+ Upload a CSV file containing a list of [picklist
+ values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values)
+ for the specified attribute.
The file should be sent as multipart data.
- The import **replaces** the previous list of allowed values for this attribute, if any.
+ The import **replaces** the previous list of allowed values for this
+ attribute, if any.
The CSV file **must** only contain the following column:
- - `item` (required): the values in your allowed list, for example a list of SKU's.
+
+ - `item`: The values in your allowed list, for example a list of SKUs.
An allowed list is limited to 500,000 items.
- Example:
+ ## Example
```text
item
@@ -9119,24 +9575,28 @@ paths:
- Remove an item from the catalog.
- Remove multiple items from the catalog.
- You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`.
+ You can either add, update, or delete up to 1000 cart items in a single
+ request. Each item synced to a catalog must have a unique `SKU`.
- **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code.
+ > [!important] You can perform only one type of action in a single sync
+ request. Syncing items with duplicate `SKU` values in a single request
+ returns an error message with a `400` status code.
- For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs).
+ For more information, read [managing cart item
+ catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs).
### Filtering cart items
Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes)
- to filter items and select the ones you want to edit or delete when editing or deleting more than one item
- at a time.
+ to filter items and select the ones you want to edit or delete when editing
+ or deleting more than one item at a time.
The `filters` array contains an object with the following properties:
- `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes)
connected to the catalog. It is applied to all items in the catalog.
- - `op`: The filtering operator indicating the relationship between the value of each
- cart item in the catalog and the value of the `value` property for the attribute selected
+ - `op`: The filtering operator indicating the relationship between the value
+ of each cart item in the catalog and the value of the `value` property for the attribute selected
in `attr`.
The value of `op` can be one of the following:
@@ -9149,12 +9609,12 @@ paths:
- `IN`: One of the comma-separated values that `value` is set to.
**Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only.
-
- `value`: The value of the attribute selected in `attr`.
### Payload examples
- Synchronization actions are sent as `PUT` requests. See the structure for each action:
+ Synchronization actions are sent as `PUT` requests. See the structure for
+ each action:
Adding an item to the catalog
@@ -9826,7 +10286,8 @@ paths:
/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons:
post:
description: |
- Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
+ Upload a CSV file containing the coupons that should be created. The file
+ should be sent as multipart data.
The CSV file contains the following columns:
@@ -9834,31 +10295,29 @@ paths:
There is no maximum length but limiting the code to 30 characters
ensures it is fully readable in the Campaign Manager.
The code should be unique unless you set `skipDuplicates` to `true`.
-
- `expirydate`: The end date in RFC3339 of the code redemption period.
- `startdate`: The start date in RFC3339 of the code redemption period.
- `recipientintegrationid`: The integration ID of the recipient of the coupon.
Only the customer with this integration ID can redeem this code. Available only for personal codes.
- `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided.
- `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value.
- - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `"{"category": "10_off"}"`.
You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
- **Example:**
+ ## Example
```text
"value","expirydate","startdate","recipientintegrationid","limitval","attributes","discountlimit"
- COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}",2.4
+ COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"":
+ ""10_off""}",2.4
```
- Once imported, you can find the `batchId` in the Campaign Manager or by
- using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+ Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
operationId: importCoupons
parameters:
- $ref: "#/components/parameters/applicationId"
@@ -9897,7 +10356,8 @@ paths:
description: |
Download a CSV file containing the coupons that match the given properties.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 can contain the following columns:
@@ -9919,7 +10379,7 @@ paths:
- `limits`: The limits set on this coupon.
- `limitval`: The maximum number of redemptions of this code.
- `recipientintegrationid`: The integration ID of the recipient of the coupon.
- Only the customer with this integration ID can redeem this code. Available only for personal codes.
+ Only the customer with this integration ID can redeem this code. Available only for personal codes.
- `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect).
- `reservation`: Whether the coupon can be reserved for multiple customers.
- `reservation_counter`: How many times this coupon has been reserved.
@@ -10097,9 +10557,11 @@ paths:
/v1/applications/{applicationId}/export_referrals:
get:
description: |
- Download a CSV file containing the referrals that match the given parameters.
+ Download a CSV file containing the referrals that match the given
+ parameters.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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:
@@ -10210,9 +10672,11 @@ paths:
/v1/applications/{applicationId}/export_effects:
get:
description: |
- Download a CSV file containing the triggered effects that match the given attributes.
+ Download a CSV file containing the triggered effects that match the given
+ attributes.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 generated file can contain the following columns:
@@ -10300,9 +10764,11 @@ paths:
description: |
Download a CSV file containing the customer sessions that match the request.
- **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention).
+ > [!important] Archived sessions cannot be exported. See the [retention
+ > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention).
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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).
- `id`: The internal ID of the session.
- `firstsession`: Whether this is a first session.
@@ -10311,7 +10777,8 @@ paths:
- `profileid`: The internal ID of the customer profile.
- `profileintegrationid`: The integration ID of the customer profile.
- `created`: The timestamp when the session was created.
- - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session.
+ - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states)
+ of the session.
- `cartitems`: The cart items in the session.
- `discounts`: The discounts in the session.
- `total`: The total value of cart items and additional costs in the session, before any discounts are applied.
@@ -10320,7 +10787,8 @@ paths:
- `cancelledat`: Timestamp when the session was cancelled.
- `referral`: The referral code in the session.
- `identifiers`: The identifiers in the session.
- - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session.
+ - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs)
+ in the session.
- `updated`: Timestamp of the last session update.
- `store_integration_id`: The integration ID of the store.
- `coupons`: Coupon codes in the session.
@@ -10402,6 +10870,7 @@ paths:
post:
description: |
Upload a CSV file containing the referrals that should be created.
+
The file should be sent as multipart data.
The CSV file contains the following columns:
@@ -10411,26 +10880,29 @@ paths:
- `startdate`: The start date in RFC3339 of the code redemption period.
- `expirydate`: The end date in RFC3339 of the code redemption period.
- `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank.
- - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `"{"category": "10_off"}"`.
You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
- **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles)
- is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2)
- endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2)
- endpoint to create the customer profiles.
+ > [!important] When you import a CSV file with referrals,
+ > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles)
+ > is **not** automatically created for each `advocateprofileintegrationid`
+ > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2)
+ > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2)
+ > endpoint to create the customer profiles.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
- **Example:**
+ ## Example
```text
code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes
- REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"": ""10_off""}"
- REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"": ""20_off""}"
+ REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"":
+ ""10_off""}"
+ REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"":
+ ""20_off""}"
```
operationId: importReferrals
parameters:
@@ -11122,9 +11594,13 @@ paths:
/v2/invites:
post:
description: |
- Create a new user in the account and send an invitation to their email address.
+ Create a new user in the account and send an invitation to their email
+ address.
- **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+ > [!note] The invitation token is valid for 24 hours after the email has
+ > been sent. You can resend an invitation to a user with the [Resend
+ > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail)
+ > endpoint.
operationId: createInviteV2
requestBody:
$ref: "#/components/requestBodies/NewInvitation"
@@ -11146,7 +11622,7 @@ paths:
description: |
Resend an email invitation to an existing user.
- **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ > [!note] The invitation token is valid for 24 hours after the email has been sent.
operationId: createInviteEmail
requestBody:
content:
@@ -11171,9 +11647,10 @@ paths:
/v1/password_recovery_emails:
post:
description: |
- Send an email with a password recovery link to the email address of an existing account.
+ Send an email with a password recovery link to the email address of an
+ existing account.
- **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+ > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
operationId: createPasswordRecoveryEmail
requestBody:
content:
@@ -11229,7 +11706,7 @@ paths:
parameters:
- description: |
The identifier of the account. Retrieve it via the
- [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId`
+ [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId`
property.
explode: false
in: path
@@ -11259,7 +11736,7 @@ paths:
parameters:
- description: |
The identifier of the account. Retrieve it via the
- [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId`
+ [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId`
property.
explode: false
in: path
@@ -11296,18 +11773,19 @@ paths:
post:
description: |
Create a session to use the Management API endpoints.
- Use the value of the `token` property provided in the response as bearer token in other API calls.
- A token is valid for 3 months. In accordance with best pratices, use your generated token
- for all your API requests. Do **not** regenerate a token for each request.
+ Use the value of the `token` property provided in the response as bearer
+ token in other API calls.
- This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup.
+ A token is valid for 3 months. In accordance with best pratices, use your
+ generated token for all your API requests. Do **not** regenerate a token for each request.
-
-
Granular API key
- Instead of using a session, you can also use the
Management API key feature
- in the Campaign Manager to decide which endpoints can be used with a given key.
-
+ This endpoint has a rate limit of 3 to 6 requests per second per account,
+ depending on your setup.
+
+ > [!note]
+ > Instead of using a session, you can also use the Management API key feature
+ > in the Campaign Manager to decide which endpoints can be used with a given key.
operationId: createSession
requestBody:
content:
@@ -11673,7 +12151,8 @@ paths:
description: |
Download a CSV file containing the stores linked to a specific campaign.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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 column:
@@ -12060,7 +12539,8 @@ paths:
description: |
Download a CSV file containing the store budgets for a given campaign.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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:
@@ -12421,12 +12901,16 @@ paths:
/v1/applications/{applicationId}/campaign_analytics/export:
get:
description: |
- Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application.
+ Download a CSV file containing analytics data aggregated by campaign for the
+ campaigns of an Application.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!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:
- - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data).
+
+ - `campaign_id`: The ID of the campaign. This column also contains labels
+ for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data).
- `start_date`: The start of the aggregation time frame in UTC.
- `end_date`: The end of the aggregation time frame in UTC.
- `revenue`: The total, pre-discount value of all items purchased in a customer session.
@@ -12454,9 +12938,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeStart
@@ -12468,9 +12953,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
explode: true
in: query
name: rangeEnd
@@ -12724,6 +13210,65 @@ components:
IntegrationEventV2Request:
content:
application/json:
+ examples:
+ eCommerce:
+ description: Track a custom event such as newsletter sign-up.
+ summary: "Example: eCommerce"
+ value:
+ profileId: customer-123
+ type: newsletter_signup
+ attributes:
+ SubscriptionType: weekly
+ responseContent:
+ - customerProfile
+ - triggeredCampaigns
+ x-vertical: ecommerce
+ QSR & dining:
+ description: |
+ Record a customer's first app sign-in so you can automatically trigger a welcome reward or bonus loyalty points.
+ summary: "Example: QSR & dining"
+ value:
+ profileId: customer-456
+ type: app_first_signin
+ attributes:
+ SignupChannel: mobile_app
+ DeviceType: ios
+ responseContent:
+ - customerProfile
+ - triggeredCampaigns
+ - loyalty
+ x-vertical: qsr
+ Financial services:
+ description: |
+ Track when a customer completes identity verification on a cryptocurrency platform
+ to trigger a reward, such as €10 in cryptocurrency.
+ summary: "Example: Financial services"
+ value:
+ profileId: customer-789
+ type: identity_verification_completed
+ attributes:
+ VerificationLevel: full_kyc
+ Platform: mobile_app
+ responseContent:
+ - customerProfile
+ - triggeredCampaigns
+ x-vertical: finance
+ Travel & hospitality:
+ description: |
+ Track when a customer attends their fifth show in a year to automatically
+ assign a unique voucher code to their account as an omnichannel reward.
+ summary: "Example: Travel & hospitality"
+ value:
+ profileId: customer-321
+ type: show_attendance
+ attributes:
+ Venue: Grand Theater
+ EventCategory: live_music
+ AttendanceCount: 5
+ responseContent:
+ - customerProfile
+ - triggeredCampaigns
+ x-vertical: travel
schema:
$ref: "#/components/schemas/IntegrationEventV2Request"
description: body
@@ -13629,6 +14174,7 @@ components:
\ of this item."
example: 1
format: int64
+ readOnly: true
title: Returned quantity of item
type: integer
remainingQuantity:
@@ -13636,6 +14182,7 @@ components:
\ on returns of this item."
example: 1
format: int64
+ readOnly: true
title: Remaining quantity of item
type: integer
price:
@@ -13672,6 +14219,7 @@ components:
type: number
position:
description: Position of the Cart Item in the Cart (calculated internally).
+ readOnly: true
title: Position of Cart Item
type: number
attributes:
@@ -13698,12 +14246,14 @@ components:
catalogItemID:
description: The catalog item ID.
format: int64
+ readOnly: true
title: The catalog item ID
type: integer
selectedPriceType:
description: The selected price type for this cart item (e.g. the price
for members only).
example: member
+ readOnly: true
title: Price Type
type: string
adjustmentReferenceId:
@@ -13711,6 +14261,7 @@ components:
cart item. Only returned if the selected price resulted from a price adjustment.
example: 68851723-e6fa-488f-ace9-112581e6c19b
format: uuid
+ readOnly: true
title: Price Adjustment ID
type: string
adjustmentEffectiveFrom:
@@ -13719,6 +14270,7 @@ components:
contains this field.
example: 2021-09-12T10:12:42Z
format: date-time
+ readOnly: true
title: Price Adjustment Start Date
type: string
adjustmentEffectiveUntil:
@@ -13727,6 +14279,7 @@ components:
contains this field.
example: 2021-09-12T10:12:42Z
format: date-time
+ readOnly: true
title: Price Adjustment Expiry Date
type: string
prices:
@@ -13743,6 +14296,7 @@ components:
effectiveUntil: 2025-05-30T00:00:00Z
base:
price: 100
+ readOnly: true
required:
- quantity
- sku
@@ -13873,7 +14427,15 @@ components:
title: Session identifiers
type: array
attributes:
- $ref: "#/components/schemas/NewCustomerSessionV2_allOf_attributes"
+ additionalProperties: true
+ description: |
+ Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city.
+
+ You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes).
+ Custom attributes must be created in the Campaign Manager before you set them with this property.
+ example:
+ ShippingCity: Berlin
+ type: object
description: The representation of the customer session.
CustomerSessionV2:
allOf:
@@ -13952,7 +14514,8 @@ components:
- 10
- 12
referralCode: NT2K54D9
- attributes: "{ShippingCity=Berlin}"
+ attributes:
+ ShippingCity: Berlin
id: 6
state: open
applicationId: 322
@@ -15173,7 +15736,8 @@ components:
- 10
- 12
referralCode: NT2K54D9
- attributes: "{ShippingCity=Berlin}"
+ attributes:
+ ShippingCity: Berlin
id: 6
state: open
applicationId: 322
@@ -15416,6 +15980,7 @@ components:
NewCustomerProfile:
properties:
attributes:
+ additionalProperties: true
description: Arbitrary properties associated with this item.
example:
Language: english
@@ -15507,7 +16072,7 @@ components:
This field is updated on calls that trigger the Rule Engine and that are
not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).
- For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation)
+ For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation)
for a customer doesn't impact this field.
example: 2020-02-08T14:15:20Z
format: date-time
@@ -16163,7 +16728,7 @@ components:
type: string
activeRulesetId:
description: |
- [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
+ [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this
campaign applies on customer session evaluation.
example: 6
format: int64
@@ -16246,6 +16811,9 @@ components:
format: int64
type: integer
type: array
+ couponAttributes:
+ description: Arbitrary properties associated with coupons in this campaign.
+ type: object
required:
- features
- limits
@@ -16561,6 +17129,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -17877,6 +18446,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -18031,6 +18601,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -18509,6 +19080,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -18663,6 +19235,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -19109,7 +19682,7 @@ components:
The identifier of this profile, set by your integration layer. It must be unique within the account.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2).
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2).
example: R195412
maxLength: 1000
type: string
@@ -19328,7 +19901,7 @@ components:
type: string
audienceId:
description: "The ID of the audience. You get it via the `id` property when\
- \ [creating an audience](#operation/createAudienceV2)."
+ \ [creating an audience](#tag/Audiences/operation/createAudienceV2)."
example: 748
format: int64
type: integer
@@ -19403,6 +19976,31 @@ components:
items:
$ref: "#/components/schemas/IntegrationCustomerProfileAudienceRequestItem"
type: array
+ RuleMetadata:
+ properties:
+ title:
+ description: A short description of the rule.
+ example: Give discount via coupon
+ type: string
+ displayName:
+ description: A customer-facing name used to identify the reward defined
+ within the rule.
+ example: 20% off all shoes!
+ type: string
+ displayDescription:
+ description: "A customer-facing description of the reward defined in the\
+ \ rule. \n\nFor example, this property can contain details about eligibility\
+ \ requirements, reward timelines, or terms and conditions.\n"
+ example: Get a 20% discount on all shoes during Thanksgiving! Offer valid
+ till Dec 5 only.
+ type: string
+ relatedData:
+ description: |
+ Data related to the reward, such as a vendor name, an image URL, or a content management system (CMS) ID.
+ example: https://example.com/discounts/20-off-shoes.png
+ type: string
+ required:
+ - title
IntegrationCampaign:
allOf:
- properties:
@@ -20872,6 +21470,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -21026,6 +21625,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -22836,6 +23436,9 @@ components:
- achievements
type: string
type: array
+ couponAttributes:
+ description: Arbitrary properties associated with coupons in this campaign.
+ type: object
RevisionVersion:
allOf:
- $ref: "#/components/schemas/IdentifiableEntity"
@@ -23204,6 +23807,7 @@ components:
myattribute: 20
endTime: 2021-10-01T02:00:00Z
state: disabled
+ couponAttributes: "{}"
limits:
- period: yearly
entities:
@@ -23254,7 +23858,7 @@ components:
type: string
activeRulesetId:
description: |
- [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
+ [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this
campaign applies on customer session evaluation.
example: 2
format: int64
@@ -23331,10 +23935,12 @@ components:
description: |
A list of store IDs that you want to link to the campaign.
- **Note:**
- - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.
- - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty.
- - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file.
+ > [!note] **Note**
+ > - Campaigns with linked store IDs will only be evaluated when there is a
+ > [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ > that references a linked store.
+ > - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty.
+ > - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file.
example:
- 1
- 2
@@ -23343,6 +23949,9 @@ components:
format: int64
type: integer
type: array
+ couponAttributes:
+ description: Arbitrary properties associated with coupons in this campaign.
+ type: object
required:
- features
- limits
@@ -25153,7 +25762,7 @@ components:
type: integer
uniquePrefix:
description: |
- **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint.
+ **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.
example: ""
title: Coupon code unique prefix
type: string
@@ -26565,6 +27174,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -27041,6 +27651,115 @@ components:
required:
- campaign
- isVariantAssignmentExternal
+ ExperimentListResultsRequest:
+ properties:
+ experimentIds:
+ items:
+ format: int64
+ type: integer
+ type: array
+ required:
+ - experimentIds
+ ExperimentVariantResult:
+ properties:
+ variantId:
+ description: The ID of the variant.
+ example: 1
+ format: int64
+ type: integer
+ variantName:
+ description: The name of the variant.
+ example: Variant A
+ type: string
+ variantWeight:
+ description: The weight of the variant.
+ example: 50
+ format: int64
+ type: integer
+ isWinner:
+ description: Calculated flag if the variant is the winner.
+ example: true
+ type: boolean
+ totalRevenue:
+ description: "The total, pre-discount value of all items purchased in a\
+ \ customer session."
+ example: 100
+ type: number
+ sessionsCount:
+ description: The number of all closed sessions.
+ example: 100
+ type: number
+ avgItemsPerSession:
+ description: The number of items from sessions divided by the number of
+ sessions.
+ example: 100
+ type: number
+ avgSessionValue:
+ description: "The average customer session value, calculated by dividing\
+ \ the revenue value by the number of sessions."
+ example: 100
+ type: number
+ avgDiscountedSessionValue:
+ description: "The average customer session value, calculated by dividing\
+ \ the revenue value by the number of sessions."
+ example: 100
+ type: number
+ totalDiscounts:
+ description: The total value of discounts given for cart items in sessions.
+ example: 10
+ type: number
+ couponsCount:
+ description: The number of times a coupon was successfully redeemed in sessions.
+ example: 12
+ type: number
+ ExperimentVariantResultConfidence:
+ properties:
+ avgSessionValue:
+ description: The calculated confidence value of the average customer session
+ value.
+ example: 100
+ type: number
+ avgDiscountedSessionValue:
+ description: The calculated confidence value of the average customer discounted
+ session value.
+ example: 100
+ type: number
+ avgItemsPerSession:
+ description: The calculated confidence value of the number of items from
+ sessions value.
+ example: 100
+ type: number
+ required:
+ - avgDiscountedSessionValue
+ - avgItemsPerSession
+ - avgSessionValue
+ ExperimentResults:
+ properties:
+ variants:
+ items:
+ $ref: "#/components/schemas/ExperimentVariantResult"
+ type: array
+ confidence:
+ $ref: "#/components/schemas/ExperimentVariantResultConfidence"
+ required:
+ - confidence
+ - variants
+ ExperimentResult:
+ allOf:
+ - $ref: "#/components/schemas/ExperimentResults"
+ - properties:
+ experimentId:
+ example: 1
+ format: int64
+ type: integer
+ required:
+ - experimentId
+ ExperimentListResults:
+ properties:
+ results:
+ items:
+ $ref: "#/components/schemas/ExperimentResult"
+ type: array
UpdateExperiment:
allOf:
- properties:
@@ -27136,86 +27855,6 @@ components:
type: string
required:
- name
- ExperimentVariantResult:
- properties:
- variantId:
- description: The ID of the variant.
- example: 1
- format: int64
- type: integer
- variantName:
- description: The name of the variant.
- example: Variant A
- type: string
- variantWeight:
- description: The weight of the variant.
- example: 50
- format: int64
- type: integer
- totalRevenue:
- description: "The total, pre-discount value of all items purchased in a\
- \ customer session."
- example: 100
- type: number
- sessionsCount:
- description: The number of all closed sessions.
- example: 100
- type: number
- avgItemsPerSession:
- description: The number of items from sessions divided by the number of
- sessions.
- example: 100
- type: number
- avgSessionValue:
- description: "The average customer session value, calculated by dividing\
- \ the revenue value by the number of sessions."
- example: 100
- type: number
- avgDiscountedSessionValue:
- description: "The average customer session value, calculated by dividing\
- \ the revenue value by the number of sessions."
- example: 100
- type: number
- totalDiscounts:
- description: The total value of discounts given for cart items in sessions.
- example: 10
- type: number
- couponsCount:
- description: The number of times a coupon was successfully redeemed in sessions.
- example: 12
- type: number
- ExperimentVariantResultConfidence:
- properties:
- avgSessionValue:
- description: The calculated confidence value of the average customer session
- value.
- example: 100
- type: number
- avgDiscountedSessionValue:
- description: The calculated confidence value of the average customer discounted
- session value.
- example: 100
- type: number
- avgItemsPerSession:
- description: The calculated confidence value of the number of items from
- sessions value.
- example: 100
- type: number
- required:
- - avgDiscountedSessionValue
- - avgItemsPerSession
- - avgSessionValue
- ExperimentResults:
- properties:
- variants:
- items:
- $ref: "#/components/schemas/ExperimentVariantResult"
- type: array
- confidence:
- $ref: "#/components/schemas/ExperimentVariantResultConfidence"
- required:
- - confidence
- - properties
ExperimentCampaignCopy:
properties:
name:
@@ -27794,6 +28433,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -27959,17 +28599,16 @@ components:
description: Activate loyalty points
example:
transactionUUIDs:
- - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- sessionId: sessionId
+ - 8f1a8d7c-9c3e-4a5e-9f0d-2c5f7a3b1cde
+ sessionId: ac08cc3c43470426591ad75b2d685ec04_v2
properties:
transactionUUIDs:
- description: "An array of transaction UUIDs used to activate specific pending\
- \ point transactions. \n\nIf provided, do not include the `sessionId`\
- \ parameter.\n"
+ description: |
+ An array of transaction UUIDs used to activate specific pending point transactions.
+
+ If provided, do not include the `sessionId` parameter.
+ example:
+ - 8f1a8d7c-9c3e-4a5e-9f0d-2c5f7a3b1cde
items:
format: uuid
type: string
@@ -27982,6 +28621,7 @@ components:
The ID of the session containing the pending point transactions to activate.
If provided, do not include the `transactionUUIDs` parameter.
+ example: ac08cc3c43470426591ad75b2d685ec04_v2
minLength: 1
type: string
LoyaltyLedgerEntry:
@@ -31286,8 +31926,10 @@ components:
- priceType
- referenceId
AddPriceAdjustmentCatalogAction:
- description: |
- The specific properties of the "ADD_PRICE_ADJUSTMENT" catalog sync action.
+ description: "The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog\
+ \ sync action.\n \n**Note:** You can only use this object if the `Beta`\
+ \ **price types** feature is enabled for your Application.\nTo enable it,\
+ \ contact your Technical Account Manager.\n"
properties:
sku:
description: The SKU of the item for which the price is being adjusted.
@@ -32990,6 +33632,14 @@ components:
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:
@@ -33007,6 +33657,11 @@ 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"
@@ -35199,6 +35854,25 @@ components:
allOf:
- $ref: "#/components/schemas/EventV3"
description: The advanced event that was processed.
+ EmbeddedDashboardConfiguration:
+ properties:
+ workspaceId:
+ description: The ID of the workspace that contains dashboards.
+ example: main_workspace
+ type: string
+ dashboardId:
+ description: The ID of the dashboard that contains metrics.
+ example: campaign_insights_metrics
+ type: string
+ required:
+ - dashboardId
+ - workspaceId
+ EmbeddedAnalyticsConfiguration:
+ properties:
+ dashboards:
+ $ref: "#/components/schemas/EmbeddedAnalyticsConfiguration_dashboards"
+ required:
+ - dashboards
CampaignNotificationBase:
properties:
NotificationType:
@@ -36413,6 +37087,90 @@ components:
- Data
- NotificationType
- TotalResultSize
+ GiveawayPoolNotificationData:
+ properties:
+ Event:
+ description: The event type of the notification.
+ example: giveaway_codes_low
+ type: string
+ PoolId:
+ description: The ID of the giveaway pool.
+ example: 5
+ format: int64
+ minimum: 1
+ type: integer
+ PoolName:
+ description: The name of the giveaway pool.
+ example: Summer Giveaway
+ type: string
+ PoolDescription:
+ description: The description of the giveaway pool.
+ example: Summer giveaway codes
+ type: string
+ AccountId:
+ description: The ID of the account that owns the giveaway pool.
+ example: 10
+ format: int64
+ minimum: 1
+ type: integer
+ ApplicationId:
+ description: The ID of the Application connected to the giveaway pool.
+ example: 42
+ format: int64
+ minimum: 1
+ type: integer
+ TotalCodes:
+ description: The total number of codes in the giveaway pool.
+ example: 1000
+ format: int64
+ type: integer
+ UsedCodes:
+ description: The number of codes that have been used.
+ example: 920
+ format: int64
+ type: integer
+ RemainingCodes:
+ description: The number of codes remaining in the giveaway pool.
+ example: 80
+ format: int64
+ type: integer
+ ThresholdPercent:
+ description: The percentage threshold for the notification. The notification
+ is triggered when the number of codes drops below this threshold.
+ example: 10
+ format: int64
+ type: integer
+ required:
+ - AccountId
+ - ApplicationId
+ - Event
+ - PoolDescription
+ - PoolId
+ - PoolName
+ - RemainingCodes
+ - ThresholdPercent
+ - TotalCodes
+ - UsedCodes
+ GiveawayPoolNotification:
+ properties:
+ TotalResultSize:
+ example: 1
+ format: int64
+ type: integer
+ Data:
+ description: The array of giveaway pool notifications.
+ items:
+ $ref: "#/components/schemas/GiveawayPoolNotificationData"
+ type: array
+ NotificationType:
+ description: The type of notification.
+ enum:
+ - GiveawayPoolNotification
+ type: string
+ required:
+ - Data
+ - NotificationType
+ - TotalResultSize
ExpiringCouponsData:
properties:
CouponValue:
@@ -37579,6 +38337,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -37733,6 +38492,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -38803,6 +39563,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -39322,6 +40083,7 @@ components:
experimentId: 1
id: 4
state: enabled
+ couponAttributes: "{}"
reservecouponEffectCount: 9
updatedBy: Jane Doe
frontendState: running
@@ -41775,14 +42537,6 @@ components:
items: {}
minItems: 1
type: array
- NewCustomerSessionV2_allOf_attributes:
- description: |
- Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city.
-
- You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes).
- Custom attributes must be created in the Campaign Manager before you set them with this property.
- example: "{ShippingCity=Berlin}"
- type: object
Attributes_of_coupon:
description: Custom attributes associated with this coupon.
title: Attributes of coupon
@@ -41955,6 +42709,12 @@ components:
description: The number of times the product or SKU was purchased.
IntegrationHubEventPayloadCouponBasedNotifications_allOf_Attributes:
type: object
+ EmbeddedAnalyticsConfiguration_dashboards:
+ properties:
+ campaignInsights:
+ allOf:
+ - $ref: "#/components/schemas/EmbeddedDashboardConfiguration"
+ description: The configuration of the embedded Insights dashboard for campaigns.
securitySchemes:
api_key_v1:
description: |
@@ -41986,48 +42746,4 @@ components:
in: header
name: Authorization
type: apiKey
- manager_auth:
- description: |
- This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API.
-
- To create the token:
-
- 1. Get a bearer token by calling the [createSession](#operation/createSession) endpoint.
- 1. Use the `token` property of the response in the HTTP header of your next queries:
- `Authorization: Bearer $TOKEN`.
-
- A token is valid for 3 months. In accordance with best pratices, use your generated token
- for all your API requests. Do **not** regenerate a token for each request.
-
- **Note:** We recommend that you use a [Management API key](https://docs.talon.one/management-api#section/Authentication/management_key)
- instead of a bearer token.
- in: header
- name: Authorization
- type: apiKey
- management_key:
- description: |
- The API key authentication gives you access to the endpoints selected by the admin who created the key.
- Using an API key is the recommended authentication method.
-
- The key must be generated by an admin and given to the developer that requires it:
-
- 1. Sign in to the Campaign Manager and click **Account** > **Tools** > **Management API Keys**.
- 1. Click **Create Key** and give it a name.
- 1. Set an expiration date.
-
- **Tip**: Avoid choosing expiration dates that fall at the end of
- the year or during other high-traffic periods.
-
- 1. Choose the endpoints the key should give access to.
- 1. Click **Create Key**.
- 1. Share it with your developer.
-
- The developer can now use the API key in the HTTP header, prefixing it with `ManagementKey-v1`:
-
- ```
- Authorization: ManagementKey-v1 bd9479c59e16f9dbc644d33aa74d58270fe13bf3
- ```
- in: header
- name: Authorization
- type: apiKey
diff --git a/build.gradle b/build.gradle
index 027c9455..4bd706fe 100644
--- a/build.gradle
+++ b/build.gradle
@@ -4,7 +4,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'
group = 'one.talon'
-version = '26.06.01'
+version = '26.07.0'
buildscript {
repositories {
diff --git a/build.sbt b/build.sbt
index 1a813391..9bd8b28f 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.06.01",
+ version := "26.07.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
diff --git a/docs/ActivateLoyaltyPoints.md b/docs/ActivateLoyaltyPoints.md
index e3f14aeb..ef00e98f 100644
--- a/docs/ActivateLoyaltyPoints.md
+++ b/docs/ActivateLoyaltyPoints.md
@@ -8,7 +8,7 @@ Activate loyalty points
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**transactionUUIDs** | **Set<UUID>** | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional] |
+|**transactionUUIDs** | **Set<UUID>** | An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter. | [optional] |
|**sessionId** | **String** | The ID of the session containing the pending point transactions to activate. If provided, do not include the `transactionUUIDs` parameter. | [optional] |
diff --git a/docs/AddPriceAdjustmentCatalogAction.md b/docs/AddPriceAdjustmentCatalogAction.md
index 068a062c..26a873eb 100644
--- a/docs/AddPriceAdjustmentCatalogAction.md
+++ b/docs/AddPriceAdjustmentCatalogAction.md
@@ -2,7 +2,7 @@
# AddPriceAdjustmentCatalogAction
-The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
+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.
## Properties
diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md
index 07f56d69..01564d07 100644
--- a/docs/ApplicationCustomer.md
+++ b/docs/ApplicationCustomer.md
@@ -10,13 +10,13 @@
|**id** | **Long** | The internal ID of the customer profile. | |
|**created** | **OffsetDateTime** | The time this entity was created. | |
|**integrationId** | **String** | The integration ID set by your integration layer. | |
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
|**accountId** | **Long** | The ID of the Talon.One account that owns this profile. | |
|**closedSessions** | **Long** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). | |
|**totalSales** | **BigDecimal** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | |
|**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional] |
|**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] |
-|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | |
+|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. | |
|**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] |
|**advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] |
diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md
index a9d3d36b..35df7792 100644
--- a/docs/AudienceCustomer.md
+++ b/docs/AudienceCustomer.md
@@ -10,13 +10,13 @@
|**id** | **Long** | The internal ID of the customer profile. | |
|**created** | **OffsetDateTime** | The time this entity was created. | |
|**integrationId** | **String** | The integration ID set by your integration layer. | |
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
|**accountId** | **Long** | The ID of the Talon.One account that owns this profile. | |
|**closedSessions** | **Long** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). | |
|**totalSales** | **BigDecimal** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | |
|**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional] |
|**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] |
-|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | |
+|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. | |
|**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] |
|**connectedApplicationsIds** | **List<Long>** | A list of the IDs of the Applications that are connected to this customer profile. | [optional] |
|**connectedAudiences** | **List<Long>** | A list of the IDs of the audiences that are connected to this customer profile. | [optional] |
diff --git a/docs/BaseCampaign.md b/docs/BaseCampaign.md
index 9a0d4708..52108aaf 100644
--- a/docs/BaseCampaign.md
+++ b/docs/BaseCampaign.md
@@ -13,7 +13,7 @@
|**endTime** | **OffsetDateTime** | Timestamp when the campaign will become inactive. | [optional] |
|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
|**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. | |
-|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
+|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
|**tags** | **List<String>** | A list of tags for the campaign. | |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. | |
@@ -23,6 +23,7 @@
|**campaignGroups** | **List<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] |
|**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
diff --git a/docs/Campaign.md b/docs/Campaign.md
index b92334bf..f4221ddf 100644
--- a/docs/Campaign.md
+++ b/docs/Campaign.md
@@ -17,7 +17,7 @@
|**endTime** | **OffsetDateTime** | Timestamp when the campaign will become inactive. | [optional] |
|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
|**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. | |
-|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
+|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
|**tags** | **List<String>** | A list of tags for the campaign. | |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. | |
@@ -27,6 +27,7 @@
|**campaignGroups** | **List<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] |
|**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
|**budgets** | [**List<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | [optional] |
|**couponRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] |
|**referralRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] |
diff --git a/docs/CartItem.md b/docs/CartItem.md
index 48befa0c..c6a204de 100644
--- a/docs/CartItem.md
+++ b/docs/CartItem.md
@@ -10,8 +10,8 @@
|**name** | **String** | Name of item. | [optional] |
|**sku** | **String** | Stock keeping unit of item. | |
|**quantity** | **Long** | Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. | |
-|**returnedQuantity** | **Long** | Number of returned items, calculated internally based on returns of this item. | [optional] |
-|**remainingQuantity** | **Long** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional] |
+|**returnedQuantity** | **Long** | Number of returned items, calculated internally based on returns of this item. | [optional] [readonly] |
+|**remainingQuantity** | **Long** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional] [readonly] |
|**price** | **BigDecimal** | Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). If it is part of a catalog, setting a price here overrides the price from the catalog. | [optional] |
|**category** | **String** | Type, group or model of the item. | [optional] |
|**product** | [**Product**](Product.md) | | [optional] |
@@ -19,15 +19,15 @@
|**height** | **BigDecimal** | Height of item in mm. | [optional] |
|**width** | **BigDecimal** | Width of item in mm. | [optional] |
|**length** | **BigDecimal** | Length of item in mm. | [optional] |
-|**position** | **BigDecimal** | Position of the Cart Item in the Cart (calculated internally). | [optional] |
+|**position** | **BigDecimal** | Position of the Cart Item in the Cart (calculated internally). | [optional] [readonly] |
|**attributes** | **Object** | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. | [optional] |
|**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] |
-|**catalogItemID** | **Long** | The catalog item ID. | [optional] |
-|**selectedPriceType** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional] |
-|**adjustmentReferenceId** | **UUID** | The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. | [optional] |
-|**adjustmentEffectiveFrom** | **OffsetDateTime** | The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] |
-|**adjustmentEffectiveUntil** | **OffsetDateTime** | The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] |
-|**prices** | [**Map<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. | [optional] |
+|**catalogItemID** | **Long** | The catalog item ID. | [optional] [readonly] |
+|**selectedPriceType** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional] [readonly] |
+|**adjustmentReferenceId** | **UUID** | The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. | [optional] [readonly] |
+|**adjustmentEffectiveFrom** | **OffsetDateTime** | The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] [readonly] |
+|**adjustmentEffectiveUntil** | **OffsetDateTime** | The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] [readonly] |
+|**prices** | [**Map<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. | [optional] [readonly] |
diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md
index 78e0fa3d..5042526f 100644
--- a/docs/CustomerProfile.md
+++ b/docs/CustomerProfile.md
@@ -10,13 +10,13 @@
|**id** | **Long** | The internal ID of the customer profile. | |
|**created** | **OffsetDateTime** | The time this entity was created. | |
|**integrationId** | **String** | The integration ID set by your integration layer. | |
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
|**accountId** | **Long** | The ID of the Talon.One account that owns this profile. | |
|**closedSessions** | **Long** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). | |
|**totalSales** | **BigDecimal** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | |
|**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional] |
|**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] |
-|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. | |
+|**lastActivity** | **OffsetDateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. | |
|**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] |
diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md
index 7ee87b1c..49f9a79f 100644
--- a/docs/CustomerProfileAudienceRequestItem.md
+++ b/docs/CustomerProfileAudienceRequestItem.md
@@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**action** | [**ActionEnum**](#ActionEnum) | 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. | |
|**profileIntegrationId** | **String** | The ID of this customer profile in the third-party integration. | |
-|**audienceId** | **Long** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). | |
+|**audienceId** | **Long** | The ID of the audience. You get it via the `id` property when [creating an audience](#tag/Audiences/operation/createAudienceV2). | |
diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md
index 71fd0c2b..4b2d5137 100644
--- a/docs/CustomerProfileIntegrationRequestV2.md
+++ b/docs/CustomerProfileIntegrationRequestV2.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
|**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] |
|**responseContent** | [**List<ResponseContentEnum>**](#List<ResponseContentEnum>) | Extends the response with the chosen data entities. Use this property to get as much data back as needed from one request instead of sending extra requests to other endpoints. | [optional] |
|**audiencesChanges** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | Audiences memberships changes for this profile. | [optional] |
diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md
index 9b015ce2..2c09b6c8 100644
--- a/docs/CustomerSessionV2.md
+++ b/docs/CustomerSessionV2.md
@@ -22,7 +22,7 @@
|**experimentVariantAllocations** | [**List<ExperimentVariantAllocation>**](ExperimentVariantAllocation.md) | The experiment variant allocations to add to this session. | [optional] |
|**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] |
|**identifiers** | **List<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). - We recommend passing an anonymized (hashed) version of the identifier value. | [optional] |
-|**attributes** | **Object** | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] |
+|**attributes** | **Map<String, Object>** | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] |
|**firstSession** | **Boolean** | Indicates whether this is the first session for the customer's profile. It's always `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`. | |
|**total** | **BigDecimal** | The total value of cart items and additional costs in the session, before any discounts are applied. | |
diff --git a/docs/EmbeddedAnalyticsConfiguration.md b/docs/EmbeddedAnalyticsConfiguration.md
new file mode 100644
index 00000000..5a62f17a
--- /dev/null
+++ b/docs/EmbeddedAnalyticsConfiguration.md
@@ -0,0 +1,13 @@
+
+
+# EmbeddedAnalyticsConfiguration
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**dashboards** | [**EmbeddedAnalyticsConfigurationDashboards**](EmbeddedAnalyticsConfigurationDashboards.md) | | |
+
+
+
diff --git a/docs/EmbeddedAnalyticsConfigurationDashboards.md b/docs/EmbeddedAnalyticsConfigurationDashboards.md
new file mode 100644
index 00000000..25ef4037
--- /dev/null
+++ b/docs/EmbeddedAnalyticsConfigurationDashboards.md
@@ -0,0 +1,13 @@
+
+
+# EmbeddedAnalyticsConfigurationDashboards
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**campaignInsights** | [**EmbeddedDashboardConfiguration**](EmbeddedDashboardConfiguration.md) | The configuration of the embedded Insights dashboard for campaigns. | [optional] |
+
+
+
diff --git a/docs/EmbeddedDashboardConfiguration.md b/docs/EmbeddedDashboardConfiguration.md
new file mode 100644
index 00000000..0f37bb6e
--- /dev/null
+++ b/docs/EmbeddedDashboardConfiguration.md
@@ -0,0 +1,14 @@
+
+
+# EmbeddedDashboardConfiguration
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**workspaceId** | **String** | The ID of the workspace that contains dashboards. | |
+|**dashboardId** | **String** | The ID of the dashboard that contains metrics. | |
+
+
+
diff --git a/docs/ExperimentListResults.md b/docs/ExperimentListResults.md
new file mode 100644
index 00000000..c5f8dd30
--- /dev/null
+++ b/docs/ExperimentListResults.md
@@ -0,0 +1,13 @@
+
+
+# ExperimentListResults
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**results** | [**List<ExperimentResult>**](ExperimentResult.md) | | [optional] |
+
+
+
diff --git a/docs/ExperimentListResultsRequest.md b/docs/ExperimentListResultsRequest.md
new file mode 100644
index 00000000..956df0c9
--- /dev/null
+++ b/docs/ExperimentListResultsRequest.md
@@ -0,0 +1,13 @@
+
+
+# ExperimentListResultsRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**experimentIds** | **List<Long>** | | |
+
+
+
diff --git a/docs/ExperimentResult.md b/docs/ExperimentResult.md
new file mode 100644
index 00000000..9be3c9f1
--- /dev/null
+++ b/docs/ExperimentResult.md
@@ -0,0 +1,15 @@
+
+
+# ExperimentResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**variants** | [**List<ExperimentVariantResult>**](ExperimentVariantResult.md) | | |
+|**confidence** | [**ExperimentVariantResultConfidence**](ExperimentVariantResultConfidence.md) | | |
+|**experimentId** | **Long** | | |
+
+
+
diff --git a/docs/ExperimentResults.md b/docs/ExperimentResults.md
index 1a4aae57..e2205d67 100644
--- a/docs/ExperimentResults.md
+++ b/docs/ExperimentResults.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**variants** | [**List<ExperimentVariantResult>**](ExperimentVariantResult.md) | | [optional] |
+|**variants** | [**List<ExperimentVariantResult>**](ExperimentVariantResult.md) | | |
|**confidence** | [**ExperimentVariantResultConfidence**](ExperimentVariantResultConfidence.md) | | |
diff --git a/docs/ExperimentVariantResult.md b/docs/ExperimentVariantResult.md
index 24ecb7b5..b4ec6c24 100644
--- a/docs/ExperimentVariantResult.md
+++ b/docs/ExperimentVariantResult.md
@@ -10,6 +10,7 @@
|**variantId** | **Long** | The ID of the variant. | [optional] |
|**variantName** | **String** | The name of the variant. | [optional] |
|**variantWeight** | **Long** | The weight of the variant. | [optional] |
+|**isWinner** | **Boolean** | Calculated flag if the variant is the winner. | [optional] |
|**totalRevenue** | **BigDecimal** | The total, pre-discount value of all items purchased in a customer session. | [optional] |
|**sessionsCount** | **BigDecimal** | The number of all closed sessions. | [optional] |
|**avgItemsPerSession** | **BigDecimal** | The number of items from sessions divided by the number of sessions. | [optional] |
diff --git a/docs/GiveawayPoolNotification.md b/docs/GiveawayPoolNotification.md
new file mode 100644
index 00000000..104ec502
--- /dev/null
+++ b/docs/GiveawayPoolNotification.md
@@ -0,0 +1,23 @@
+
+
+# GiveawayPoolNotification
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalResultSize** | **Long** | | |
+|**data** | [**List<GiveawayPoolNotificationData>**](GiveawayPoolNotificationData.md) | The array of giveaway pool notifications. | |
+|**notificationType** | [**NotificationTypeEnum**](#NotificationTypeEnum) | The type of notification. | |
+
+
+
+## Enum: NotificationTypeEnum
+
+| Name | Value |
+|---- | -----|
+| GIVEAWAY_POOL_NOTIFICATION | "GiveawayPoolNotification" |
+
+
+
diff --git a/docs/GiveawayPoolNotificationData.md b/docs/GiveawayPoolNotificationData.md
new file mode 100644
index 00000000..7a1a2a5f
--- /dev/null
+++ b/docs/GiveawayPoolNotificationData.md
@@ -0,0 +1,22 @@
+
+
+# GiveawayPoolNotificationData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**event** | **String** | The event type of the notification. | |
+|**poolId** | **Long** | The ID of the giveaway pool. | |
+|**poolName** | **String** | The name of the giveaway pool. | |
+|**poolDescription** | **String** | The description of the giveaway pool. | |
+|**accountId** | **Long** | The ID of the account that owns the giveaway pool. | |
+|**applicationId** | **Long** | The ID of the Application connected to the giveaway pool. | |
+|**totalCodes** | **Long** | The total number of codes in the giveaway pool. | |
+|**usedCodes** | **Long** | The number of codes that have been used. | |
+|**remainingCodes** | **Long** | The number of codes remaining in the giveaway pool. | |
+|**thresholdPercent** | **Long** | The percentage threshold for the notification. The notification is triggered when the number of codes drops below this threshold. | |
+
+
+
diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md
index 2e301eff..0ede64fd 100644
--- a/docs/IntegrationApi.md
+++ b/docs/IntegrationApi.md
@@ -28,7 +28,6 @@ All URIs are relative to *https://yourbaseurl.talon.one*
| [**getLoyaltyProgramProfileTransactions**](IntegrationApi.md#getLoyaltyProgramProfileTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions |
| [**getReservedCustomers**](IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved |
| [**linkLoyaltyCardToProfile**](IntegrationApi.md#linkLoyaltyCardToProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card |
-| [**priceHistory**](IntegrationApi.md#priceHistory) | **POST** /v1/best_prior_price_history | Get summary of price history |
| [**reopenCustomerSession**](IntegrationApi.md#reopenCustomerSession) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session |
| [**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 |
@@ -139,18 +138,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -185,7 +172,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -203,7 +190,7 @@ public class Example {
Create audience
-Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
+Create an audience. The audience can be created directly from scratch or can come from third party platforms. > [!note] Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch, only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
### Example
```java
@@ -275,7 +262,7 @@ public class Example {
Create coupon reservation
-Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
+Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. > [!note] **Note** > - If the **Reservation mandatory** option was selected when creating the > specified coupon, the endpoint creates a **hard** reservation, meaning only users who have > this coupon code reserved can redeem it. > > Otherwise, the endpoint creates a **soft** reservation, meaning the coupon > is associated with the specified customer profiles (they show up when using > the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) > endpoint), but any user can redeem it. > > This can be useful, for example, to display a _coupon wallet_ for customers > when they visit your store. > - If the **Coupon visibility** option was selected when creating the > specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code > will be returned for all customer profiles in the [List customer > data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) endpoint. > - This endpoint overrides the coupon reservation limit set when > [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
### Example
```java
@@ -299,7 +286,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String couponValue = "couponValue_example"; // String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
+ String couponValue = "couponValue_example"; // String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
CouponReservations couponReservations = new CouponReservations(); // CouponReservations | body
try {
Coupon result = apiInstance.createCouponReservation(couponValue, couponReservations);
@@ -319,7 +306,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **couponValue** | **String**| The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. | |
+| **couponValue** | **String**| The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. | |
| **couponReservations** | [**CouponReservations**](CouponReservations.md)| body | |
### Return type
@@ -349,7 +336,7 @@ public class Example {
Create referral code for an advocate
-Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
### Example
```java
@@ -420,7 +407,7 @@ public class Example {
Create referral codes for multiple advocates
-Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
### Example
```java
@@ -564,7 +551,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 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).
### Example
```java
@@ -659,7 +646,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String couponValue = "couponValue_example"; // String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
+ String couponValue = "couponValue_example"; // String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
CouponReservations couponReservations = new CouponReservations(); // CouponReservations | body
try {
apiInstance.deleteCouponReservation(couponValue, couponReservations);
@@ -678,7 +665,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **couponValue** | **String**| The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. | |
+| **couponValue** | **String**| The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. | |
| **couponReservations** | [**CouponReservations**](CouponReservations.md)| body | |
### Return type
@@ -708,7 +695,7 @@ null (empty response body)
Delete customer's personal data
-Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
+Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
### Example
```java
@@ -732,7 +719,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
try {
apiInstance.deleteCustomerData(integrationId);
} catch (ApiException e) {
@@ -750,7 +737,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
### Return type
@@ -778,7 +765,7 @@ null (empty response body)
Delete customer's transactions from loyalty ledgers
-Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
### Example
```java
@@ -803,7 +790,7 @@ public class Example {
IntegrationApi apiInstance = new IntegrationApi(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.
- String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
DeleteLoyaltyTransactionsRequest deleteLoyaltyTransactionsRequest = new DeleteLoyaltyTransactionsRequest(); // DeleteLoyaltyTransactionsRequest |
try {
apiInstance.deleteLoyaltyTransactionsFromLedgers(loyaltyProgramId, integrationId, deleteLoyaltyTransactionsRequest);
@@ -823,7 +810,7 @@ public class Example {
| 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. | |
-| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
| **deleteLoyaltyTransactionsRequest** | [**DeleteLoyaltyTransactionsRequest**](DeleteLoyaltyTransactionsRequest.md)| | |
### Return type
@@ -853,7 +840,7 @@ null (empty response body)
Generate loyalty card
-Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
### Example
```java
@@ -1118,7 +1105,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ String integrationId = "integrationId_example"; // String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
Boolean profile = true; // Boolean | Set to `true` to include customer profile information in the response.
Boolean referrals = true; // Boolean | Set to `true` to include referral information in the response.
Boolean coupons = true; // Boolean | Set to `true` to include coupon information in the response.
@@ -1143,7 +1130,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **integrationId** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
| **profile** | **Boolean**| Set to `true` to include customer profile information in the response. | [optional] |
| **referrals** | **Boolean**| Set to `true` to include referral information in the response. | [optional] |
| **coupons** | **Boolean**| Set to `true` to include coupon information in the response. | [optional] |
@@ -1201,7 +1188,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
try {
IntegrationCustomerSessionResponse result = apiInstance.getCustomerSession(customerSessionId);
System.out.println(result);
@@ -1220,7 +1207,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
+| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. | |
### Return type
@@ -1248,7 +1235,7 @@ public class Example {
Get customer's loyalty balances
-Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
### Example
```java
@@ -1274,7 +1261,7 @@ public class Example {
IntegrationApi apiInstance = new IntegrationApi(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.
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.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
Boolean includeTiers = false; // Boolean | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier.
Boolean includeProjectedTier = false; // Boolean | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance.
@@ -1298,7 +1285,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. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] |
| **includeTiers** | **Boolean**| Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. | [optional] [default to false] |
| **includeProjectedTier** | **Boolean**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to false] |
@@ -1356,7 +1343,7 @@ public class Example {
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
Long loyaltyProgramId = 56L; // Long | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
String loyaltyCardId = "loyaltyCardId_example"; // String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
List subledgerId = Arrays.asList(); // List | Filter results by one or more subledger IDs. Must be exact match.
try {
LoyaltyCardBalances result = apiInstance.getLoyaltyCardBalances(loyaltyProgramId, loyaltyCardId, endDate, subledgerId);
@@ -1378,7 +1365,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
| **loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **subledgerId** | [**List<String>**](String.md)| Filter results by one or more subledger IDs. Must be exact match. | [optional] |
### Return type
@@ -1524,8 +1511,8 @@ public class Example {
String loyaltyCardId = "loyaltyCardId_example"; // String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.
List subledgerId = Arrays.asList(); // List | Filter results by one or more subledger IDs. Must be exact match.
String loyaltyTransactionType = "manual"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
- OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
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.
@@ -1553,8 +1540,8 @@ public class Example {
| **loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. | |
| **subledgerId** | [**List<String>**](String.md)| Filter results by one or more subledger IDs. Must be exact match. | [optional] |
| **loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [enum: manual, session, import] |
-| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
-| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **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] |
@@ -1676,7 +1663,7 @@ public class Example {
List customer's loyalty transactions
-Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
### Example
```java
@@ -1702,12 +1689,12 @@ public class Example {
IntegrationApi apiInstance = new IntegrationApi(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.
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.
- 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.
+ 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.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
String loyaltyTransactionType = "manual"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
- OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
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.
Boolean awaitsActivation = true; // Boolean | If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response.
@@ -1731,12 +1718,12 @@ 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. | |
-| **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] |
+| **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] |
| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] |
| **loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [enum: manual, session, import] |
-| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
-| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **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] |
| **awaitsActivation** | **Boolean**| If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. | [optional] |
@@ -1840,7 +1827,7 @@ public class Example {
Link customer profile to card
-[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
+[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). > [!note] You can link as many customer profiles to a given loyalty card as the > [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) > allows.
### Example
```java
@@ -1910,94 +1897,13 @@ public class Example {
| **401** | Unauthorized | - |
| **404** | Not found | - |
-
-# **priceHistory**
-> PriceHistoryResponse priceHistory(priceHistoryRequest)
-
-Get summary of price history
-
-Fetch the historical price data for a given SKU within a defined timeframe.
-
-### 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: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
- // 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);
- PriceHistoryRequest priceHistoryRequest = new PriceHistoryRequest(); // PriceHistoryRequest | body
- try {
- PriceHistoryResponse result = apiInstance.priceHistory(priceHistoryRequest);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling IntegrationApi#priceHistory");
- 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 |
-|------------- | ------------- | ------------- | -------------|
-| **priceHistoryRequest** | [**PriceHistoryRequest**](PriceHistoryRequest.md)| body | |
-
-### Return type
-
-[**PriceHistoryResponse**](PriceHistoryResponse.md)
-
-### Authorization
-
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [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 | - |
-
# **reopenCustomerSession**
> ReopenSessionResponse reopenCustomerSession(customerSessionId)
Reopen customer session
-Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a> tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
+Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> To see an example of a rollback, see the [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial. > [!note] If your order workflow requires you to create a new session > instead of reopening a session, use the > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) > endpoint to cancel a closed session and create a new one.
### Example
```java
@@ -2021,7 +1927,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
try {
ReopenSessionResponse result = apiInstance.reopenCustomerSession(customerSessionId);
System.out.println(result);
@@ -2040,7 +1946,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
+| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. | |
### Return type
@@ -2068,7 +1974,7 @@ public class Example {
Return cart items
-Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
+Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. > [!note] This will roll back any effects associated with these cart items. > For more information, see [our documentation on session > states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) > and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). > [!note] To make request processing idempotent for this endpoint, include the `Idempotency-Key` header with an idempotency key in requests. Also: > - Requests with the `Idempotency-Key` header are logged in the Talon.One access logs. > - Responses for idempotent requests are stored in the database and expire 24 hours after the request is sent. > - Idempotency keys are typically UUID keys and should not exceed 255 characters in length.
### Example
```java
@@ -2092,7 +1998,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
ReturnIntegrationRequest returnIntegrationRequest = new ReturnIntegrationRequest(); // ReturnIntegrationRequest | body
Boolean dry = true; // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
try {
@@ -2113,7 +2019,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
+| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. | |
| **returnIntegrationRequest** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md)| body | |
| **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional] |
@@ -2143,7 +2049,7 @@ public class Example {
Sync cart item catalog
-Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
+Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. > [!important] You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
### Example
```java
@@ -2217,7 +2123,7 @@ public class Example {
Track event
-Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
+Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!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
@@ -2295,7 +2201,7 @@ public class Example {
Unlink customer profile from a loyalty card
-Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
### Example
```java
@@ -2516,7 +2422,7 @@ public class Example {
Update multiple customer profiles' audiences
-Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. > [!note] You can also do this using the > [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) > effect.
### Example
```java
@@ -2587,7 +2493,7 @@ null (empty response body)
Update customer profile
-Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
+Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. > [!note] **Note** > - Updating a customer profile returns a response with the requested integration state. > - You can use the `responseContent` property to save yourself extra API calls. For example, you can get > the customer profile details directly without extra requests. > - We recommend sending requests sequentially. > See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
### Example
```java
@@ -2665,7 +2571,7 @@ public class Example {
Update multiple customer profiles
-Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
+Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). > [!note] This endpoint does not trigger the Rule Engine. > To trigger the Rule Engine for customer profile updates, > use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
### Example
```java
@@ -2738,7 +2644,7 @@ public class Example {
Update customer session
-Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
+Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. > [!note] **Note** > - The currency for the session and the cart items in it is the currency set for the Application linked to this session. > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. > [!note] **Note** > - If the specified profile does not exist, an empty profile is **created automatically**. > You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). > - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. > For example, you can get the customer profile details directly without extra requests. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
### Example
```java
@@ -2762,10 +2668,10 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ String customerSessionId = "customerSessionId_example"; // String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
IntegrationRequest integrationRequest = new IntegrationRequest(); // IntegrationRequest | body
Boolean dry = true; // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).
- OffsetDateTime now = OffsetDateTime.now(); // OffsetDateTime | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`.
+ OffsetDateTime now = OffsetDateTime.now(); // OffsetDateTime | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`.
try {
IntegrationStateV2 result = apiInstance.updateCustomerSessionV2(customerSessionId, integrationRequest, dry, now);
System.out.println(result);
@@ -2784,10 +2690,10 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
+| **customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. | |
| **integrationRequest** | [**IntegrationRequest**](IntegrationRequest.md)| body | |
| **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional] |
-| **now** | **OffsetDateTime**| A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. | [optional] |
+| **now** | **OffsetDateTime**| A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`. | [optional] |
### Return type
diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md
index bc838fb3..ce3714dc 100644
--- a/docs/ManagementApi.md
+++ b/docs/ManagementApi.md
@@ -150,6 +150,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
| [**listExperiments**](ManagementApi.md#listExperiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments |
| [**listStores**](ManagementApi.md#listStores) | **GET** /v1/applications/{applicationId}/stores | List stores |
| [**oktaEventHandlerChallenge**](ManagementApi.md#oktaEventHandlerChallenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership |
+| [**priceHistory**](ManagementApi.md#priceHistory) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history |
| [**removeLoyaltyPoints**](ManagementApi.md#removeLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile |
| [**resetPassword**](ManagementApi.md#resetPassword) | **POST** /v1/reset_password | Reset password |
| [**scimCreateGroup**](ManagementApi.md#scimCreateGroup) | **POST** /v1/provisioning/scim/Groups | Create SCIM group |
@@ -209,18 +210,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -254,7 +243,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -289,18 +278,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -338,7 +315,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -359,7 +336,7 @@ null (empty response body)
Add points to customer profile
-Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
### Example
```java
@@ -376,18 +353,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -425,7 +390,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -463,18 +428,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -513,7 +466,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -548,18 +501,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -594,7 +535,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -632,18 +573,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -682,7 +611,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -720,18 +649,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -766,7 +683,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -801,18 +718,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -847,7 +752,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -865,7 +770,7 @@ public class Example {
Create loyalty cards
-Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. > [!important] **Note** > - The specified card-based loyalty program must have a defined card code > format that is used to generate the loyalty card codes. > - Trying to create more than 20,000 loyalty cards in a single request > returns an error message with a `400` status code.
### Example
```java
@@ -882,18 +787,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -930,7 +823,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -968,18 +861,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1016,7 +897,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1051,18 +932,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1100,7 +969,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1137,18 +1006,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1187,7 +1044,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1222,18 +1079,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1274,7 +1119,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1310,18 +1155,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1360,7 +1193,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1395,18 +1228,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1445,7 +1266,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1480,18 +1301,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1532,7 +1341,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1551,7 +1360,7 @@ public class Example {
Resend invitation email
-Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
+Resend an email invitation to an existing user. > [!note] The invitation token is valid for 24 hours after the email has been sent.
### Example
```java
@@ -1568,18 +1377,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1614,7 +1411,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1632,7 +1429,7 @@ public class Example {
Invite user
-Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+Create a new user in the account and send an invitation to their email address. > [!note] The invitation token is valid for 24 hours after the email has > been sent. You can resend an invitation to a user with the [Resend > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) > endpoint.
### Example
```java
@@ -1649,18 +1446,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1695,7 +1480,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1713,7 +1498,7 @@ public class Example {
Request a password reset
-Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+Send an email with a password recovery link to the email address of an existing account. > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
### Example
```java
@@ -1730,18 +1515,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1776,7 +1549,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1794,7 +1567,7 @@ public class Example {
Create session
-Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
+Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. > [!note] > Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> > in the Campaign Manager to decide which endpoints can be used with a given key.
### Example
```java
@@ -1811,18 +1584,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1857,7 +1618,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1892,18 +1653,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -1940,7 +1689,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -1977,18 +1726,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2022,7 +1759,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2057,18 +1794,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2106,7 +1831,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2144,18 +1869,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2163,7 +1876,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
try {
apiInstance.deleteAccountCollection(collectionId);
} catch (ApiException e) {
@@ -2181,7 +1894,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
### Return type
@@ -2189,7 +1902,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2225,18 +1938,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2274,7 +1975,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2311,18 +2012,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2358,7 +2047,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2393,18 +2082,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2444,7 +2121,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2480,18 +2157,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2501,7 +2166,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
try {
apiInstance.deleteCollection(applicationId, campaignId, collectionId);
} catch (ApiException e) {
@@ -2521,7 +2186,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
### Return type
@@ -2529,7 +2194,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2565,18 +2230,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2614,7 +2267,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2649,18 +2302,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2722,7 +2363,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2757,18 +2398,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2804,7 +2433,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2841,18 +2470,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2890,7 +2507,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -2925,18 +2542,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -2972,7 +2577,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3008,18 +2613,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3053,7 +2646,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3088,18 +2681,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3133,7 +2714,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3168,18 +2749,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3209,7 +2778,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3244,18 +2813,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3291,7 +2848,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3312,7 +2869,7 @@ null (empty response body)
Export account-level collection's items
-Download a CSV file containing items from a given account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+Download a CSV file containing items from a given account-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
### Example
```java
@@ -3329,18 +2886,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3348,7 +2893,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
try {
String result = apiInstance.exportAccountCollectionItems(collectionId);
System.out.println(result);
@@ -3367,7 +2912,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
### Return type
@@ -3375,7 +2920,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3412,18 +2957,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3462,7 +2995,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3483,7 +3016,7 @@ public class Example {
Export Application analytics aggregated by campaign
-Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
+Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. > [!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: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
### Example
```java
@@ -3500,18 +3033,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3520,8 +3041,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
List campaignIds = Arrays.asList(); // List | Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.
try {
String result = apiInstance.exportApplicationCampaignAnalytics(applicationId, rangeStart, rangeEnd, campaignIds);
@@ -3542,8 +3063,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **campaignIds** | [**List<String>**](String.md)| Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. | [optional] |
### Return type
@@ -3552,7 +3073,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3570,7 +3091,7 @@ public class Example {
Export audience members
-Download a CSV file containing the integration IDs of the members of an audience. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
+Download a CSV file containing the integration IDs of the members of an audience. > [!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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
### Example
```java
@@ -3587,18 +3108,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3633,7 +3142,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3654,7 +3163,7 @@ public class Example {
Export campaign store budgets
-Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
+Download a CSV file containing the store budgets for a given campaign. > [!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: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
### Example
```java
@@ -3671,18 +3180,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3723,7 +3220,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3744,7 +3241,7 @@ public class Example {
Export stores
-Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
+Download a CSV file containing the stores linked to a specific campaign. > [!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 column: - `store_integration_id`: The identifier of the store.
### Example
```java
@@ -3761,18 +3258,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3809,7 +3294,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3830,7 +3315,7 @@ public class Example {
Export campaign-level collection's items
-Download a CSV file containing items from a given campaign-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+Download a CSV file containing items from a given campaign-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
### Example
```java
@@ -3847,18 +3332,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -3868,7 +3341,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
try {
String result = apiInstance.exportCollectionItems(applicationId, campaignId, collectionId);
System.out.println(result);
@@ -3889,7 +3362,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
### Return type
@@ -3897,7 +3370,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -3917,7 +3390,7 @@ public class Example {
Export coupons
-Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+Download a CSV file containing the coupons that match the given properties. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
### Example
```java
@@ -3934,18 +3407,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4008,7 +3469,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4026,7 +3487,7 @@ public class Example {
Export customer sessions
-Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
+Download a CSV file containing the customer sessions that match the request. > [!important] Archived sessions cannot be exported. See the [retention > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). > [!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). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
### Example
```java
@@ -4043,18 +3504,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4099,7 +3548,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4134,18 +3583,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4184,7 +3621,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4202,7 +3639,7 @@ public class Example {
Export triggered effects
-Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
+Download a CSV file containing the triggered effects that match the given attributes. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
### Example
```java
@@ -4219,18 +3656,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4273,7 +3698,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4291,7 +3716,7 @@ public class Example {
Export customer loyalty balance to CSV
-⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
### Example
```java
@@ -4308,18 +3733,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4328,7 +3741,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
try {
String result = apiInstance.exportLoyaltyBalance(loyaltyProgramId, endDate);
System.out.println(result);
@@ -4348,7 +3761,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **String**| The identifier for the loyalty program. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
### Return type
@@ -4356,7 +3769,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4376,7 +3789,7 @@ public class Example {
Export customer loyalty balances
-Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
+Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subledger, when applicable. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
### Example
```java
@@ -4393,18 +3806,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4413,7 +3814,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export.
try {
String result = apiInstance.exportLoyaltyBalances(loyaltyProgramId, endDate);
System.out.println(result);
@@ -4433,7 +3834,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **String**| The identifier for the loyalty program. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. | [optional] |
### Return type
@@ -4441,7 +3842,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4461,7 +3862,7 @@ public class Example {
Export all card transaction logs
-Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
+Download a CSV file containing the balances of all cards in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
### Example
```java
@@ -4478,18 +3879,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4498,7 +3887,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long loyaltyProgramId = 56L; // Long | 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.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
try {
String result = apiInstance.exportLoyaltyCardBalances(loyaltyProgramId, endDate);
System.out.println(result);
@@ -4518,7 +3907,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
### Return type
@@ -4526,7 +3915,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4546,7 +3935,7 @@ public class Example {
Export card's ledger log
-Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+Download a CSV file containing a loyalty card ledger log of the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
### Example
```java
@@ -4563,18 +3952,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4584,8 +3961,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long loyaltyProgramId = 56L; // Long | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
String loyaltyCardId = "loyaltyCardId_example"; // String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String dateFormat = "excel"; // String | Determines the format of dates in the export document.
try {
String result = apiInstance.exportLoyaltyCardLedger(loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, dateFormat);
@@ -4607,8 +3984,8 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
| **loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. | |
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] |
### Return type
@@ -4617,7 +3994,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4637,7 +4014,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.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
+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.
### Example
```java
@@ -4654,18 +4031,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4675,8 +4040,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long loyaltyProgramId = 56L; // Long | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
String batchId = "batchId_example"; // String | Filter results by loyalty card batch ID.
- OffsetDateTime createdBefore = OffsetDateTime.now(); // OffsetDateTime | Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
- OffsetDateTime createdAfter = OffsetDateTime.now(); // OffsetDateTime | Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
+ OffsetDateTime createdBefore = OffsetDateTime.now(); // OffsetDateTime | Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string.
+ OffsetDateTime createdAfter = OffsetDateTime.now(); // OffsetDateTime | Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string.
String dateFormat = "excel"; // String | Determines the format of dates in the export document.
try {
String result = apiInstance.exportLoyaltyCards(loyaltyProgramId, batchId, createdBefore, createdAfter, dateFormat);
@@ -4698,8 +4063,8 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
| **batchId** | **String**| Filter results by loyalty card batch ID. | [optional] |
-| **createdBefore** | **OffsetDateTime**| Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional] |
-| **createdAfter** | **OffsetDateTime**| Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional] |
+| **createdBefore** | **OffsetDateTime**| Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. | [optional] |
+| **createdAfter** | **OffsetDateTime**| Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string. | [optional] |
| **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] |
### Return type
@@ -4708,7 +4073,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4728,7 +4093,7 @@ public class Example {
Export customers' loyalty program join dates
-Download a CSV file containing the join dates of all customers in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
+Download a CSV file containing the join dates of all customers in the 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 generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
### Example
```java
@@ -4745,18 +4110,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4791,7 +4144,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4811,7 +4164,7 @@ public class Example {
Export customer's transaction logs
-Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
+Download a CSV file containing a customer's transaction logs in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
### Example
```java
@@ -4828,18 +4181,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4847,8 +4188,8 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
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 dateFormat = "excel"; // String | Determines the format of dates in the export document.
@@ -4870,8 +4211,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **loyaltyProgramId** | **String**| The identifier for the loyalty program. | |
| **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. | |
| **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601] |
@@ -4882,7 +4223,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4900,7 +4241,7 @@ public class Example {
Export giveaway codes of a giveaway pool
-Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+Download a CSV file containing the giveaway codes of a specific giveaway pool. > [!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: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
### Example
```java
@@ -4917,18 +4258,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -4967,7 +4296,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -4986,7 +4315,7 @@ public class Example {
Export referrals
-Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
+Download a CSV file containing the referrals that match the given parameters. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
### Example
```java
@@ -5003,18 +4332,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5063,7 +4380,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5098,18 +4415,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5150,7 +4455,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5185,18 +4490,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5205,8 +4498,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String path = "path_example"; // String | Only return results where the request path matches the given regular expression.
String method = "get"; // String | Only return results where the request method matches the given regular expression.
String status = "success"; // String | Filter results by HTTP status codes.
@@ -5232,8 +4525,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **path** | **String**| Only return results where the request path matches the given regular expression. | [optional] |
| **method** | **String**| Only return results where the request method matches the given regular expression. | [optional] [enum: get, put, post, delete, patch] |
| **status** | **String**| Filter results by HTTP status codes. | [optional] [enum: success, error] |
@@ -5247,7 +4540,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5282,18 +4575,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5301,7 +4582,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long accountId = 56L; // Long | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
+ Long accountId = 56L; // Long | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property.
try {
Account result = apiInstance.getAccount(accountId);
System.out.println(result);
@@ -5320,7 +4601,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **accountId** | **Long**| The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. | |
+| **accountId** | **Long**| The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. | |
### Return type
@@ -5328,7 +4609,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5363,18 +4644,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5382,7 +4651,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long accountId = 56L; // Long | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
+ Long accountId = 56L; // Long | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property.
try {
AccountAnalytics result = apiInstance.getAccountAnalytics(accountId);
System.out.println(result);
@@ -5401,7 +4670,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **accountId** | **Long**| The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. | |
+| **accountId** | **Long**| The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. | |
### Return type
@@ -5409,7 +4678,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5444,18 +4713,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5463,7 +4720,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
try {
Collection result = apiInstance.getAccountCollection(collectionId);
System.out.println(result);
@@ -5482,7 +4739,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
### Return type
@@ -5490,7 +4747,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5526,18 +4783,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5576,7 +4821,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5613,18 +4858,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5659,7 +4892,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5694,18 +4927,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5744,7 +4965,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5779,18 +5000,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5825,7 +5034,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5860,18 +5069,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5906,7 +5103,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -5941,18 +5138,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -5961,7 +5146,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
try {
ApplicationCustomer result = apiInstance.getApplicationCustomer(applicationId, customerId);
System.out.println(result);
@@ -5981,7 +5166,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
-| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
### Return type
@@ -5989,7 +5174,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6024,18 +5209,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6080,7 +5253,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6115,18 +5288,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6169,7 +5330,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6204,18 +5365,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6258,7 +5407,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6293,18 +5442,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6345,7 +5482,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6380,18 +5517,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6456,7 +5581,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6491,18 +5616,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6539,7 +5652,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6574,18 +5687,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6644,7 +5745,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6679,18 +5780,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6729,7 +5818,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6764,18 +5853,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6810,7 +5887,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6845,18 +5922,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6905,7 +5970,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -6940,18 +6005,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -6994,7 +6047,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7030,18 +6083,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7082,7 +6123,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7117,18 +6158,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7165,7 +6194,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7200,18 +6229,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7248,7 +6265,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7283,18 +6300,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7304,8 +6309,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String granularity = "1 hour"; // String | The time interval between the results in the returned time-series.
try {
GetCampaignAnalytics200Response result = apiInstance.getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, granularity);
@@ -7327,8 +6332,8 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **granularity** | **String**| The time interval between the results in the returned time-series. | [optional] [enum: 1 hour, 1 day, 1 week, 1 month, 1 year] |
### Return type
@@ -7337,7 +6342,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7372,18 +6377,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7428,7 +6421,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7463,18 +6456,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7509,7 +6490,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7544,18 +6525,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7594,7 +6563,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7629,18 +6598,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7687,7 +6644,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7722,18 +6679,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7798,7 +6743,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7834,18 +6779,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7900,7 +6833,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -7935,18 +6868,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -7956,7 +6877,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
try {
Collection result = apiInstance.getCollection(applicationId, campaignId, collectionId);
System.out.println(result);
@@ -7977,7 +6898,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
### Return type
@@ -7985,7 +6906,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8021,18 +6942,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8040,7 +6949,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
Long pageSize = 1000L; // Long | The number of items in the response.
Long skip = 56L; // Long | The number of items to skip when paging through large result sets.
try {
@@ -8061,7 +6970,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
| **pageSize** | **Long**| The number of items in the response. | [optional] [default to 1000] |
| **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] |
@@ -8071,7 +6980,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8107,18 +7016,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8191,7 +7088,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8226,18 +7123,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8245,10 +7130,10 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
Long pageSize = 1000L; // Long | The number of items in the response.
Long skip = 56L; // Long | The number of items to skip when paging through large result sets.
try {
@@ -8269,10 +7154,10 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
-| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
| **pageSize** | **Long**| The number of items in the response. | [optional] [default to 1000] |
| **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] |
@@ -8282,7 +7167,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8317,18 +7202,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8336,8 +7209,8 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long pageSize = 1000L; // Long | The number of items in the response.
Long skip = 56L; // Long | The number of items to skip when paging through large result sets.
@@ -8364,8 +7237,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **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 1000] |
| **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] |
@@ -8381,7 +7254,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8416,18 +7289,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8436,7 +7297,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
Long pageSize = 1000L; // 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 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.
@@ -8459,7 +7320,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
-| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
| **pageSize** | **Long**| The number of items in the response. | [optional] [default to 1000] |
| **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] |
| **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional] |
@@ -8470,7 +7331,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8488,7 +7349,7 @@ public class Example {
Get customer profile
-Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
+Return the details of the specified customer profile. > [!note] > You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options: > - Request the customer profile to be part of the response content using > [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). > - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
### Example
```java
@@ -8505,18 +7366,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8524,7 +7373,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
+ Long customerId = 56L; // Long | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.
try {
CustomerProfile result = apiInstance.getCustomerProfile(customerId);
System.out.println(result);
@@ -8543,7 +7392,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
+| **customerId** | **Long**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. | |
### Return type
@@ -8551,7 +7400,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8586,18 +7435,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8642,7 +7479,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8679,18 +7516,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8729,7 +7554,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8764,18 +7589,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8816,7 +7629,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8834,7 +7647,7 @@ public class Example {
Get statistics for loyalty dashboard
-Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
+Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. > [!important] The returned data does not include the current day. All statistics > are updated daily at 11:59 PM in the loyalty program time zone.
### Example
```java
@@ -8851,18 +7664,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8871,8 +7672,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long loyaltyProgramId = 56L; // 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.
- OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeStart = OffsetDateTime.now(); // OffsetDateTime | Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime rangeEnd = OffsetDateTime.now(); // OffsetDateTime | Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
try {
GetDashboardStatistics200Response result = apiInstance.getDashboardStatistics(loyaltyProgramId, rangeStart, rangeEnd, subledgerId);
@@ -8893,8 +7694,8 @@ public class Example {
| 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. | |
-| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
-| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeStart** | **OffsetDateTime**| Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
+| **rangeEnd** | **OffsetDateTime**| Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | |
| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] |
### Return type
@@ -8903,7 +7704,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -8938,18 +7739,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -8992,7 +7781,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9027,18 +7816,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9075,7 +7852,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9110,18 +7887,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9164,7 +7929,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9199,18 +7964,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9247,7 +8000,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9285,18 +8038,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9306,8 +8047,8 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long loyaltyProgramId = 56L; // Long | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
String loyaltyCardId = "loyaltyCardId_example"; // String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.
- OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
Long pageSize = 1000L; // 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 subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
@@ -9333,8 +8074,8 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
| **loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. | |
-| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
-| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **pageSize** | **Long**| The number of items in the response. | [optional] [default to 1000] |
| **skip** | **Long**| The number of items to skip when paging through large result sets. | [optional] |
| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional] |
@@ -9347,7 +8088,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9384,18 +8125,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9442,7 +8171,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9462,7 +8191,7 @@ public class Example {
Get customer's loyalty balances
-Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
### Example
```java
@@ -9479,18 +8208,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9500,7 +8217,7 @@ public class Example {
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.
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.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger.
Boolean includeTiers = false; // Boolean | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier.
Boolean includeProjectedTier = false; // Boolean | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance.
@@ -9524,7 +8241,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. | |
-| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **subledgerId** | **String**| The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. | [optional] |
| **includeTiers** | **Boolean**| Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. | [optional] [default to false] |
| **includeProjectedTier** | **Boolean**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to false] |
@@ -9535,7 +8252,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9556,7 +8273,7 @@ public class Example {
Get customer's full loyalty ledger
-Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
### Example
```java
@@ -9573,18 +8290,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9621,7 +8326,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9639,7 +8344,7 @@ public class Example {
Get loyalty program
-Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#tag/Loyalty/operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory).
### Example
```java
@@ -9656,18 +8361,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9702,7 +8395,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9720,7 +8413,7 @@ public class Example {
List customer's loyalty transactions
-Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
### Example
```java
@@ -9737,18 +8430,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9758,12 +8439,12 @@ public class Example {
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.
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.
- 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.
+ 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.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger.
String loyaltyTransactionType = "manual"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
- OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
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.
Boolean awaitsActivation = true; // Boolean | If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response.
@@ -9787,12 +8468,12 @@ 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. | |
-| **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] |
+| **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] |
| **subledgerId** | **String**| The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. | [optional] |
| **loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [enum: manual, session, import] |
-| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
-| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **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] |
| **awaitsActivation** | **Boolean**| If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. | [optional] |
@@ -9803,7 +8484,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9824,7 +8505,7 @@ public class Example {
List loyalty program transactions
-Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. > [!note] **Note** > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. > - To get loyalty transaction logs for a given Integration ID in > a loyalty program, we recommend using the Integration API's [Get customer's loyalty > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
### Example
```java
@@ -9841,18 +8522,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9863,10 +8532,10 @@ public class Example {
Long loyaltyProgramId = 56L; // 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.
String loyaltyTransactionType = "manual"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
- 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.
- OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
- OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ 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.
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
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.
Boolean awaitsActivation = true; // Boolean | If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response.
@@ -9891,10 +8560,10 @@ public class Example {
| **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. | |
| **loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [enum: manual, session, import] |
| **subledgerId** | **String**| The ID of the subledger by which we filter the data. | [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] |
-| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
-| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **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] |
+| **startDate** | **OffsetDateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
+| **endDate** | **OffsetDateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] |
| **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] |
| **awaitsActivation** | **Boolean**| If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. | [optional] |
@@ -9905,7 +8574,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -9943,18 +8612,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -9985,7 +8642,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10003,7 +8660,7 @@ This endpoint does not need any parameter.
Get loyalty program statistics
-⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
+> [warning] This endpoint is deprecated. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
### Example
```java
@@ -10020,18 +8677,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10066,7 +8711,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10101,18 +8746,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10173,7 +8806,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10208,18 +8841,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10274,7 +8895,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10309,18 +8930,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10355,7 +8964,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10390,18 +8999,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10440,7 +9037,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10475,18 +9072,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10529,7 +9114,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10564,18 +9149,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10612,7 +9185,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10648,18 +9221,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10694,7 +9255,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10729,18 +9290,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10779,7 +9328,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10814,18 +9363,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10860,7 +9397,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10895,18 +9432,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -10955,7 +9480,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -10973,7 +9498,7 @@ public class Example {
Import data into existing account-level collection
-Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
### Example
```java
@@ -10990,18 +9515,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11009,7 +9522,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importAccountCollection(collectionId, upFile);
@@ -11029,7 +9542,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
| **upFile** | **String**| The file containing the data that is being imported. | [optional] |
### Return type
@@ -11038,7 +9551,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11058,7 +9571,7 @@ public class Example {
Import allowed values for attribute
-Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
+Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item`: The values in your allowed list, for example a list of SKUs. An allowed list is limited to 500,000 items. ## Example ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
### Example
```java
@@ -11075,18 +9588,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11123,7 +9624,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11144,7 +9645,7 @@ public class Example {
Import audience members
-Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
+Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text profileintegrationid charles alexa ```
### Example
```java
@@ -11161,18 +9662,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11209,7 +9698,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11247,18 +9736,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11301,7 +9778,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11337,18 +9814,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11387,7 +9852,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11408,7 +9873,7 @@ public class Example {
Import data into existing campaign-level collection
-Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
### Example
```java
@@ -11425,18 +9890,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11446,7 +9899,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importCollection(applicationId, campaignId, collectionId, upFile);
@@ -11468,7 +9921,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
| **upFile** | **String**| The file containing the data that is being imported. | [optional] |
### Return type
@@ -11477,7 +9930,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11496,7 +9949,7 @@ public class Example {
Import coupons
-Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
### Example
```java
@@ -11513,18 +9966,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11565,7 +10006,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11583,7 +10024,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:** We recommend limiting your file size to 500MB. **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 (;). > [!note] We recommend limiting your file size to 500MB. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
### Example
```java
@@ -11600,18 +10041,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11648,7 +10077,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11668,7 +10097,7 @@ public class Example {
Import customers into loyalty tiers
-Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
+Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. > [!important] This endpoint only works with loyalty programs with advanced > tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. > [!note] We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
### Example
```java
@@ -11685,18 +10114,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11733,7 +10150,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11754,7 +10171,7 @@ public class Example {
Import loyalty points
-Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
+Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit.<br /> Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] For existing customer profiles and loyalty cards, the imported > points are added to any previous active or pending points, depending on the > value provided for `startdate`. If `startdate` matches the current date, the > imported points are _active_. If it is later, the points are _pending_ until > the date provided for `startdate` is reached. > [!note] We recommend limiting your file size to 500 MB. ## Example for profile-based programs ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` ## Example for card-based programs ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
### Example
```java
@@ -11771,18 +10188,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11821,7 +10226,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11839,7 +10244,7 @@ public class Example {
Import giveaway codes into a giveaway pool
-Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
+Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. > [!note] **Note** > - We recommend limiting your file size to 500MB. > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. ## Example ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
### Example
```java
@@ -11856,18 +10261,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11904,7 +10297,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -11922,7 +10315,7 @@ public class Example {
Import referrals
-Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
+Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!important] When you import a CSV file with referrals, > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) > is **not** automatically created for each `advocateprofileintegrationid` > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) > endpoint to create the customer profiles. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
### Example
```java
@@ -11939,18 +10332,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -11989,7 +10370,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12024,18 +10405,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12069,7 +10438,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12104,18 +10473,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12158,7 +10515,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12196,18 +10553,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12250,7 +10595,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12285,18 +10630,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12327,7 +10660,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12362,18 +10695,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12414,7 +10735,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12452,18 +10773,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12508,7 +10817,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12543,18 +10852,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12601,7 +10898,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12637,18 +10934,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12693,7 +10978,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12729,18 +11014,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12781,7 +11054,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12816,18 +11089,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12878,7 +11139,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12913,18 +11174,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -12954,7 +11203,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -12966,13 +11215,84 @@ null (empty response body)
|-------------|-------------|------------------|
| **200** | OK | - |
+
+# **priceHistory**
+> PriceHistoryResponse priceHistory(applicationId, priceHistoryRequest)
+
+Get summary of price history
+
+Fetch the historical price data for a given SKU within a defined timeframe.
+
+### 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 applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ PriceHistoryRequest priceHistoryRequest = new PriceHistoryRequest(); // PriceHistoryRequest | body
+ try {
+ PriceHistoryResponse result = apiInstance.priceHistory(applicationId, priceHistoryRequest);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#priceHistory");
+ 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 |
+|------------- | ------------- | ------------- | -------------|
+| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
+| **priceHistoryRequest** | [**PriceHistoryRequest**](PriceHistoryRequest.md)| body | |
+
+### Return type
+
+[**PriceHistoryResponse**](PriceHistoryResponse.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 | - |
+
# **removeLoyaltyPoints**
> removeLoyaltyPoints(loyaltyProgramId, integrationId, deductLoyaltyPoints)
Deduct points from customer profile
-Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+Deduct points from the specified loyalty program and specified customer profile. > [!note] **Note** > - Only active points can be deducted. > - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
### Example
```java
@@ -12989,18 +11309,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13038,7 +11346,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13076,18 +11384,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13122,7 +11418,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13157,18 +11453,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13203,7 +11487,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13238,18 +11522,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13284,7 +11556,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13319,18 +11591,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13364,7 +11624,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13399,18 +11659,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13444,7 +11692,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13479,18 +11727,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13525,7 +11761,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13560,18 +11796,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13602,7 +11826,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13637,18 +11861,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13679,7 +11891,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13714,18 +11926,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13756,7 +11956,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13791,18 +11991,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13833,7 +12021,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13868,18 +12056,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13914,7 +12090,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -13949,18 +12125,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -13991,7 +12155,7 @@ This endpoint does not need any parameter.
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14026,18 +12190,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14074,7 +12226,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14109,18 +12261,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14157,7 +12297,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14192,18 +12332,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14240,7 +12368,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14275,18 +12403,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14323,7 +12439,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14341,7 +12457,7 @@ public class Example {
List coupons that match the given attributes (without total count)
-List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
### Example
```java
@@ -14358,18 +12474,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14432,7 +12536,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14450,7 +12554,7 @@ public class Example {
List coupons that match the given attributes in campaign (without total count)
-List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
### Example
```java
@@ -14467,18 +12571,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14541,7 +12633,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14576,18 +12668,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14624,7 +12704,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14645,7 +12725,7 @@ public class Example {
Transfer card data
-Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
+Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. > [!important] **Note** > - The original card is automatically blocked once the new card is created, and it cannot be activated again. > - The default status of the new card is _active_.
### Example
```java
@@ -14662,18 +12742,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14711,7 +12779,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14749,18 +12817,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14768,7 +12824,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint.
UpdateCollection updateCollection = new UpdateCollection(); // UpdateCollection | body
try {
Collection result = apiInstance.updateAccountCollection(collectionId, updateCollection);
@@ -14788,7 +12844,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. | |
| **updateCollection** | [**UpdateCollection**](UpdateCollection.md)| body | |
### Return type
@@ -14797,7 +12853,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14835,18 +12891,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14887,7 +12931,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -14925,18 +12969,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -14973,7 +13005,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15008,18 +13040,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15056,7 +13076,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15074,7 +13094,7 @@ public class Example {
Update campaign
-Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
+Update the given campaign. > [!important] You cannot use this endpoint to update campaigns if [campaign staging and > revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) > is enabled for your Application.
### Example
```java
@@ -15091,18 +13111,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15141,7 +13149,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15176,18 +13184,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15197,7 +13193,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long applicationId = 56L; // Long | The ID of the Application. It is displayed in your Talon.One deployment URL.
Long campaignId = 56L; // Long | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Long collectionId = 56L; // Long | The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.
UpdateCampaignCollection updateCampaignCollection = new UpdateCampaignCollection(); // UpdateCampaignCollection | body
try {
Collection result = apiInstance.updateCollection(applicationId, campaignId, collectionId, updateCampaignCollection);
@@ -15219,7 +13215,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **applicationId** | **Long**| The ID of the Application. It is displayed in your Talon.One deployment URL. | |
| **campaignId** | **Long**| The ID of the campaign. It is displayed in your Talon.One deployment URL. | |
-| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. | |
+| **collectionId** | **Long**| The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. | |
| **updateCampaignCollection** | [**UpdateCampaignCollection**](UpdateCampaignCollection.md)| body | |
### Return type
@@ -15228,7 +13224,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15247,7 +13243,7 @@ public class Example {
Update coupon
-Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
+Update the specified coupon. > [!note] > With this `PUT` endpoint, if you do not explicitly set a value for the `startDate`, `expiryDate`, > and `recipientIntegrationId` properties in your request, it is automatically set to `null`.
### Example
```java
@@ -15264,18 +13260,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15316,7 +13300,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15334,7 +13318,7 @@ public class Example {
Update coupons
-Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code> and <code>expiryDate</code> properties in your request, it is automatically set to <code>null</code>.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
+Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). > [!note] **Note** > - Only send sequential requests to this endpoint. > - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team. > - With this `PUT` endpoint, if you do not explicitly set a value for the `startDate` and `expiryDate` properties in your request, it is automatically set to `null`. To update a specific coupon, use [Update coupon](#tag/Coupons/operation/updateCoupon).
### Example
```java
@@ -15351,18 +13335,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15400,7 +13372,7 @@ null (empty response body)
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15435,18 +13407,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15485,7 +13445,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15523,18 +13483,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15575,7 +13523,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15610,18 +13558,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15658,7 +13594,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15693,18 +13629,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15743,7 +13667,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
@@ -15780,18 +13704,6 @@ public class Example {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://yourbaseurl.talon.one");
- // Configure API key authorization: management_key
- ApiKeyAuth management_key = (ApiKeyAuth) defaultClient.getAuthentication("management_key");
- management_key.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //management_key.setApiKeyPrefix("Token");
-
- // Configure API key authorization: manager_auth
- ApiKeyAuth manager_auth = (ApiKeyAuth) defaultClient.getAuthentication("manager_auth");
- manager_auth.setApiKey("YOUR API KEY");
- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
- //manager_auth.setApiKeyPrefix("Token");
-
// Configure API key authorization: api_key_v1
ApiKeyAuth api_key_v1 = (ApiKeyAuth) defaultClient.getAuthentication("api_key_v1");
api_key_v1.setApiKey("YOUR API KEY");
@@ -15828,7 +13740,7 @@ public class Example {
### Authorization
-[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+[api_key_v1](../README.md#api_key_v1)
### HTTP request headers
diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md
index d80feb38..10abce4d 100644
--- a/docs/MultipleCustomerProfileIntegrationRequestItem.md
+++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md
@@ -7,8 +7,8 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
-|**integrationId** | **String** | The identifier of this profile, set by your integration layer. It must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2). | |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
+|**integrationId** | **String** | The identifier of this profile, set by your integration layer. It must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). | |
diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md
index 35c299da..436930fb 100644
--- a/docs/NewCampaign.md
+++ b/docs/NewCampaign.md
@@ -13,7 +13,7 @@
|**endTime** | **OffsetDateTime** | Timestamp when the campaign will become inactive. | [optional] |
|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
|**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. | |
-|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
+|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
|**tags** | **List<String>** | A list of tags for the campaign. | |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. | |
@@ -23,6 +23,7 @@
|**campaignGroups** | **List<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] |
|**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
|**evaluationGroupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. | [optional] |
diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md
index 49b9cc8a..5e6b2ebb 100644
--- a/docs/NewCoupons.md
+++ b/docs/NewCoupons.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] |
|**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#operation/createCouponsAsync) endpoint. | [optional] |
+|**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] |
|**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] |
diff --git a/docs/NewCustomerProfile.md b/docs/NewCustomerProfile.md
index 61a45de0..f8303377 100644
--- a/docs/NewCustomerProfile.md
+++ b/docs/NewCustomerProfile.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+|**attributes** | **Map<String, Object>** | Arbitrary properties associated with this item. | [optional] |
diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md
index 1626af93..74a7a99b 100644
--- a/docs/NewCustomerSessionV2.md
+++ b/docs/NewCustomerSessionV2.md
@@ -19,7 +19,7 @@ The representation of the customer session.
|**experimentVariantAllocations** | [**List<ExperimentVariantAllocation>**](ExperimentVariantAllocation.md) | The experiment variant allocations to add to this session. | [optional] |
|**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] |
|**identifiers** | **List<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). - We recommend passing an anonymized (hashed) version of the identifier value. | [optional] |
-|**attributes** | **Object** | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] |
+|**attributes** | **Map<String, Object>** | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] |
diff --git a/docs/NewRevisionVersion.md b/docs/NewRevisionVersion.md
index f5f70986..90ed2923 100644
--- a/docs/NewRevisionVersion.md
+++ b/docs/NewRevisionVersion.md
@@ -19,6 +19,7 @@
|**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
diff --git a/docs/RevisionVersion.md b/docs/RevisionVersion.md
index dcf7b63d..a6ff72f0 100644
--- a/docs/RevisionVersion.md
+++ b/docs/RevisionVersion.md
@@ -20,6 +20,7 @@
|**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
|**accountId** | **Long** | | |
|**applicationId** | **Long** | | |
|**campaignId** | **Long** | | |
diff --git a/docs/RoleV2ApplicationDetails.md b/docs/RoleV2ApplicationDetails.md
index 285b8194..ba01fb72 100644
--- a/docs/RoleV2ApplicationDetails.md
+++ b/docs/RoleV2ApplicationDetails.md
@@ -11,6 +11,7 @@
|**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/RolesV2Thresholds.md b/docs/RolesV2Thresholds.md
new file mode 100644
index 00000000..9a054129
--- /dev/null
+++ b/docs/RolesV2Thresholds.md
@@ -0,0 +1,13 @@
+
+
+# RolesV2Thresholds
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**loyaltyPointsLimit** | **Long** | Maximum number of loyalty points a support user can award without approval. | [optional] |
+
+
+
diff --git a/docs/RuleMetadata.md b/docs/RuleMetadata.md
new file mode 100644
index 00000000..03a7d9c8
--- /dev/null
+++ b/docs/RuleMetadata.md
@@ -0,0 +1,16 @@
+
+
+# RuleMetadata
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**title** | **String** | A short description of the rule. | |
+|**displayName** | **String** | A customer-facing name used to identify the reward defined within the rule. | [optional] |
+|**displayDescription** | **String** | A customer-facing description of the reward defined in the rule. For example, this property can contain details about eligibility requirements, reward timelines, or terms and conditions. | [optional] |
+|**relatedData** | **String** | Data related to the reward, such as a vendor name, an image URL, or a content management system (CMS) ID. | [optional] |
+
+
+
diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md
index fd43111d..7cae9295 100644
--- a/docs/UpdateCampaign.md
+++ b/docs/UpdateCampaign.md
@@ -13,7 +13,7 @@
|**endTime** | **OffsetDateTime** | Timestamp when the campaign will become inactive. | [optional] |
|**attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
|**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. | [optional] |
-|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
+|**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation. | [optional] |
|**tags** | **List<String>** | A list of tags for the campaign. | |
|**reevaluateOnReturn** | **Boolean** | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
|**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign. | |
@@ -23,7 +23,8 @@
|**campaignGroups** | **List<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional] |
|**evaluationGroupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] |
-|**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional] |
+|**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. > [!note] **Note** > - Campaigns with linked store IDs will only be evaluated when there is a > [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) > that references a linked store. > - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. > - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional] |
+|**couponAttributes** | **Object** | Arbitrary properties associated with coupons in this campaign. | [optional] |
diff --git a/pom.xml b/pom.xml
index c1970f28..56ed5cca 100644
--- a/pom.xml
+++ b/pom.xml
@@ -5,7 +5,7 @@
talon-one-client
jar
talon-one-client
- 26.06.01
+ 26.07.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/ApiCallback.java b/src/main/java/one/talon/ApiCallback.java
index 469a4e1d..5100b782 100644
--- a/src/main/java/one/talon/ApiCallback.java
+++ b/src/main/java/one/talon/ApiCallback.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ApiClient.java b/src/main/java/one/talon/ApiClient.java
index 2b03af5d..1ba9ae80 100644
--- a/src/main/java/one/talon/ApiClient.java
+++ b/src/main/java/one/talon/ApiClient.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -102,8 +102,6 @@ public ApiClient() {
// Setup authentications (key: authentication name, value: authentication).
authentications.put("api_key_v1", new ApiKeyAuth("header", "Authorization"));
- authentications.put("manager_auth", new ApiKeyAuth("header", "Authorization"));
- authentications.put("management_key", new ApiKeyAuth("header", "Authorization"));
// Prevent the authentications from being modified.
authentications = Collections.unmodifiableMap(authentications);
}
@@ -120,8 +118,6 @@ public ApiClient(OkHttpClient client) {
// Setup authentications (key: authentication name, value: authentication).
authentications.put("api_key_v1", new ApiKeyAuth("header", "Authorization"));
- authentications.put("manager_auth", new ApiKeyAuth("header", "Authorization"));
- authentications.put("management_key", new ApiKeyAuth("header", "Authorization"));
// Prevent the authentications from being modified.
authentications = Collections.unmodifiableMap(authentications);
}
@@ -146,7 +142,7 @@ protected void init() {
json = new JSON();
// Set default User-Agent.
- setUserAgent("OpenAPI-Generator/26.06.01/java");
+ setUserAgent("OpenAPI-Generator/26.07.0/java");
authentications = new HashMap();
}
diff --git a/src/main/java/one/talon/ApiException.java b/src/main/java/one/talon/ApiException.java
index 463d984c..79b527bc 100644
--- a/src/main/java/one/talon/ApiException.java
+++ b/src/main/java/one/talon/ApiException.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ApiResponse.java b/src/main/java/one/talon/ApiResponse.java
index 9ea8e305..fb5a01fd 100644
--- a/src/main/java/one/talon/ApiResponse.java
+++ b/src/main/java/one/talon/ApiResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/Configuration.java b/src/main/java/one/talon/Configuration.java
index 7b2fa24e..7884d449 100644
--- a/src/main/java/one/talon/Configuration.java
+++ b/src/main/java/one/talon/Configuration.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -19,7 +19,7 @@
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.21.0")
public class Configuration {
- public static final String VERSION = "26.06.01";
+ public static final String VERSION = "26.07.0";
private static final AtomicReference defaultApiClient = new AtomicReference<>();
private static volatile Supplier apiClientFactory = ApiClient::new;
diff --git a/src/main/java/one/talon/GzipRequestInterceptor.java b/src/main/java/one/talon/GzipRequestInterceptor.java
index 7ac83c81..afd0d269 100644
--- a/src/main/java/one/talon/GzipRequestInterceptor.java
+++ b/src/main/java/one/talon/GzipRequestInterceptor.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/JSON.java b/src/main/java/one/talon/JSON.java
index 6e76b731..7e1993d3 100644
--- a/src/main/java/one/talon/JSON.java
+++ b/src/main/java/one/talon/JSON.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -308,6 +308,9 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Effect.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EffectEntity.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EmailEntity.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EmbeddedAnalyticsConfiguration.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EmbeddedAnalyticsConfigurationDashboards.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EmbeddedDashboardConfiguration.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Endpoint.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Entity.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.EntityWithTalangVisibleID.CustomTypeAdapterFactory());
@@ -326,6 +329,9 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentCampaignCopy.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());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentListResultsRequest.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentResult.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentResults.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentVariant.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.ExperimentVariantAllocation.CustomTypeAdapterFactory());
@@ -404,6 +410,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.GetUsers200Response.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.GetWebhooks200Response.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Giveaway.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.GiveawayPoolNotification.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.GiveawayPoolNotificationData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.GiveawaysPool.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.HiddenConditionsEffects.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.History.CustomTypeAdapterFactory());
@@ -645,6 +653,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RoleV2Permissions.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RoleV2Readonly.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RoleV2RolesGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RolesV2Thresholds.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RollbackAddedLoyaltyPointsEffectProps.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RollbackCouponEffectProps.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RollbackDeductedLoyaltyPointsEffectProps.CustomTypeAdapterFactory());
@@ -653,6 +662,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RollbackReferralEffectProps.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Rule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RuleFailureReason.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new one.talon.model.RuleMetadata.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.Ruleset.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.SSOConfig.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new one.talon.model.SamlConnection.CustomTypeAdapterFactory());
diff --git a/src/main/java/one/talon/Pair.java b/src/main/java/one/talon/Pair.java
index 1f6dcece..067c50c7 100644
--- a/src/main/java/one/talon/Pair.java
+++ b/src/main/java/one/talon/Pair.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ProgressRequestBody.java b/src/main/java/one/talon/ProgressRequestBody.java
index cdc2b7b3..097edcac 100644
--- a/src/main/java/one/talon/ProgressRequestBody.java
+++ b/src/main/java/one/talon/ProgressRequestBody.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ProgressResponseBody.java b/src/main/java/one/talon/ProgressResponseBody.java
index b647c9c1..aa31617b 100644
--- a/src/main/java/one/talon/ProgressResponseBody.java
+++ b/src/main/java/one/talon/ProgressResponseBody.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ServerConfiguration.java b/src/main/java/one/talon/ServerConfiguration.java
index 268c3a3b..0b3d4967 100644
--- a/src/main/java/one/talon/ServerConfiguration.java
+++ b/src/main/java/one/talon/ServerConfiguration.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/ServerVariable.java b/src/main/java/one/talon/ServerVariable.java
index 9fe685d4..c37bb615 100644
--- a/src/main/java/one/talon/ServerVariable.java
+++ b/src/main/java/one/talon/ServerVariable.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/StringUtil.java b/src/main/java/one/talon/StringUtil.java
index 09e24146..aee15d0b 100644
--- a/src/main/java/one/talon/StringUtil.java
+++ b/src/main/java/one/talon/StringUtil.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/api/IntegrationApi.java b/src/main/java/one/talon/api/IntegrationApi.java
index cd70eb79..d874dc58 100644
--- a/src/main/java/one/talon/api/IntegrationApi.java
+++ b/src/main/java/one/talon/api/IntegrationApi.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -67,8 +67,6 @@
import one.talon.model.NewReferral;
import one.talon.model.NewReferralsForMultipleAdvocates;
import java.time.OffsetDateTime;
-import one.talon.model.PriceHistoryRequest;
-import one.talon.model.PriceHistoryResponse;
import one.talon.model.Referral;
import one.talon.model.ReopenSessionResponse;
import one.talon.model.ReturnIntegrationRequest;
@@ -322,7 +320,7 @@ public okhttp3.Call bestPriorPriceCall(@javax.annotation.Nonnull BestPriorPriceR
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -469,7 +467,7 @@ private okhttp3.Call createAudienceV2ValidateBeforeCall(@javax.annotation.Nonnul
/**
* Create audience
- * Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
+ * Create an audience. The audience can be created directly from scratch or can come from third party platforms. > [!note] Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch, only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
* @param newAudience body (required)
* @return Audience
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -490,7 +488,7 @@ public Audience createAudienceV2(@javax.annotation.Nonnull NewAudience newAudien
/**
* Create audience
- * Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
+ * Create an audience. The audience can be created directly from scratch or can come from third party platforms. > [!note] Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch, only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
* @param newAudience body (required)
* @return ApiResponse<Audience>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -512,7 +510,7 @@ public ApiResponse createAudienceV2WithHttpInfo(@javax.annotation.Nonn
/**
* Create audience (asynchronously)
- * Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
+ * Create an audience. The audience can be created directly from scratch or can come from third party platforms. > [!note] Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch, only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
* @param newAudience body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -536,7 +534,7 @@ public okhttp3.Call createAudienceV2Async(@javax.annotation.Nonnull NewAudience
}
/**
* Build call for createCouponReservation
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -615,8 +613,8 @@ private okhttp3.Call createCouponReservationValidateBeforeCall(@javax.annotation
/**
* Create coupon reservation
- * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. > [!note] **Note** > - If the **Reservation mandatory** option was selected when creating the > specified coupon, the endpoint creates a **hard** reservation, meaning only users who have > this coupon code reserved can redeem it. > > Otherwise, the endpoint creates a **soft** reservation, meaning the coupon > is associated with the specified customer profiles (they show up when using > the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) > endpoint), but any user can redeem it. > > This can be useful, for example, to display a _coupon wallet_ for customers > when they visit your store. > - If the **Coupon visibility** option was selected when creating the > specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code > will be returned for all customer profiles in the [List customer > data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) endpoint. > - This endpoint overrides the coupon reservation limit set when > [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @return Coupon
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -637,8 +635,8 @@ public Coupon createCouponReservation(@javax.annotation.Nonnull String couponVal
/**
* Create coupon reservation
- * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. > [!note] **Note** > - If the **Reservation mandatory** option was selected when creating the > specified coupon, the endpoint creates a **hard** reservation, meaning only users who have > this coupon code reserved can redeem it. > > Otherwise, the endpoint creates a **soft** reservation, meaning the coupon > is associated with the specified customer profiles (they show up when using > the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) > endpoint), but any user can redeem it. > > This can be useful, for example, to display a _coupon wallet_ for customers > when they visit your store. > - If the **Coupon visibility** option was selected when creating the > specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code > will be returned for all customer profiles in the [List customer > data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) endpoint. > - This endpoint overrides the coupon reservation limit set when > [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @return ApiResponse<Coupon>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -660,8 +658,8 @@ public ApiResponse createCouponReservationWithHttpInfo(@javax.annotation
/**
* Create coupon reservation (asynchronously)
- * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. > [!note] **Note** > - If the **Reservation mandatory** option was selected when creating the > specified coupon, the endpoint creates a **hard** reservation, meaning only users who have > this coupon code reserved can redeem it. > > Otherwise, the endpoint creates a **soft** reservation, meaning the coupon > is associated with the specified customer profiles (they show up when using > the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) > endpoint), but any user can redeem it. > > This can be useful, for example, to display a _coupon wallet_ for customers > when they visit your store. > - If the **Coupon visibility** option was selected when creating the > specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code > will be returned for all customer profiles in the [List customer > data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) endpoint. > - This endpoint overrides the coupon reservation limit set when > [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -756,7 +754,7 @@ private okhttp3.Call createReferralValidateBeforeCall(@javax.annotation.Nonnull
/**
* Create referral code for an advocate
- * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferral body (required)
* @return Referral
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -776,7 +774,7 @@ public Referral createReferral(@javax.annotation.Nonnull NewReferral newReferral
/**
* Create referral code for an advocate
- * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferral body (required)
* @return ApiResponse<Referral>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -797,7 +795,7 @@ public ApiResponse createReferralWithHttpInfo(@javax.annotation.Nonnul
/**
* Create referral code for an advocate (asynchronously)
- * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferral body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -897,7 +895,7 @@ private okhttp3.Call createReferralsForMultipleAdvocatesValidateBeforeCall(@java
/**
* Create referral codes for multiple advocates
- * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferralsForMultipleAdvocates 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)
* @return CreateReferralsForMultipleAdvocates201Response
@@ -919,7 +917,7 @@ public CreateReferralsForMultipleAdvocates201Response createReferralsForMultiple
/**
* Create referral codes for multiple advocates
- * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferralsForMultipleAdvocates 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)
* @return ApiResponse<CreateReferralsForMultipleAdvocates201Response>
@@ -942,7 +940,7 @@ public ApiResponse createReferra
/**
* Create referral codes for multiple advocates (asynchronously)
- * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
+ * Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. > [!note] Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) > set are ignored when you use this endpoint.
* @param newReferralsForMultipleAdvocates 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 _callback The callback to be executed when the API call finishes
@@ -1170,7 +1168,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 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).
* @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
@@ -1189,7 +1187,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 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).
* @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
@@ -1210,7 +1208,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 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).
* @param audienceId The ID of the audience. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1233,7 +1231,7 @@ public okhttp3.Call deleteAudienceV2Async(@javax.annotation.Nonnull Long audienc
}
/**
* Build call for deleteCouponReservation
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1313,7 +1311,7 @@ private okhttp3.Call deleteCouponReservationValidateBeforeCall(@javax.annotation
/**
* Delete coupon reservations
* Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1333,7 +1331,7 @@ public void deleteCouponReservation(@javax.annotation.Nonnull String couponValue
/**
* Delete coupon reservations
* Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1355,7 +1353,7 @@ public ApiResponse deleteCouponReservationWithHttpInfo(@javax.annotation.N
/**
* Delete coupon reservations (asynchronously)
* Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
- * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
+ * @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
* @param couponReservations body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1378,7 +1376,7 @@ public okhttp3.Call deleteCouponReservationAsync(@javax.annotation.Nonnull Strin
}
/**
* Build call for deleteCustomerData
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -1449,8 +1447,8 @@ private okhttp3.Call deleteCustomerDataValidateBeforeCall(@javax.annotation.Nonn
/**
* Delete customer's personal data
- * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1467,8 +1465,8 @@ public void deleteCustomerData(@javax.annotation.Nonnull String integrationId) t
/**
* Delete customer's personal data
- * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1487,8 +1485,8 @@ public ApiResponse deleteCustomerDataWithHttpInfo(@javax.annotation.Nonnul
/**
* Delete customer's personal data (asynchronously)
- * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (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
@@ -1510,7 +1508,7 @@ public okhttp3.Call deleteCustomerDataAsync(@javax.annotation.Nonnull String int
/**
* Build call for deleteLoyaltyTransactionsFromLedgers
* @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 ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param deleteLoyaltyTransactionsRequest (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1595,9 +1593,9 @@ private okhttp3.Call deleteLoyaltyTransactionsFromLedgersValidateBeforeCall(@jav
/**
* Delete customer's transactions from loyalty ledgers
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @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 ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param deleteLoyaltyTransactionsRequest (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1616,9 +1614,9 @@ public void deleteLoyaltyTransactionsFromLedgers(@javax.annotation.Nonnull Long
/**
* Delete customer's transactions from loyalty ledgers
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @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 ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param deleteLoyaltyTransactionsRequest (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1639,9 +1637,9 @@ public ApiResponse deleteLoyaltyTransactionsFromLedgersWithHttpInfo(@javax
/**
* Delete customer's transactions from loyalty ledgers (asynchronously)
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @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 ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param deleteLoyaltyTransactionsRequest (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1742,7 +1740,7 @@ private okhttp3.Call generateLoyaltyCardValidateBeforeCall(@javax.annotation.Non
/**
* Generate loyalty card
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @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 generateLoyaltyCard body (required)
* @return LoyaltyCard
@@ -1763,7 +1761,7 @@ public LoyaltyCard generateLoyaltyCard(@javax.annotation.Nonnull Long loyaltyPro
/**
* Generate loyalty card
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @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 generateLoyaltyCard body (required)
* @return ApiResponse<LoyaltyCard>
@@ -1785,7 +1783,7 @@ public ApiResponse generateLoyaltyCardWithHttpInfo(@javax.annotatio
/**
* Generate loyalty card (asynchronously)
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @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 generateLoyaltyCard body (required)
* @param _callback The callback to be executed when the API call finishes
@@ -2185,7 +2183,7 @@ public okhttp3.Call getCustomerAchievementsAsync(@javax.annotation.Nonnull Strin
}
/**
* Build call for getCustomerInventory
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2287,7 +2285,7 @@ private okhttp3.Call getCustomerInventoryValidateBeforeCall(@javax.annotation.No
/**
* List customer data
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2313,7 +2311,7 @@ public CustomerInventory getCustomerInventory(@javax.annotation.Nonnull String i
/**
* List customer data
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2340,7 +2338,7 @@ public ApiResponse getCustomerInventoryWithHttpInfo(@javax.an
/**
* List customer data (asynchronously)
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2368,7 +2366,7 @@ public okhttp3.Call getCustomerInventoryAsync(@javax.annotation.Nonnull String i
}
/**
* Build call for getCustomerSession
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2440,7 +2438,7 @@ private okhttp3.Call getCustomerSessionValidateBeforeCall(@javax.annotation.Nonn
/**
* Get customer session
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return IntegrationCustomerSessionResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2460,7 +2458,7 @@ public IntegrationCustomerSessionResponse getCustomerSession(@javax.annotation.N
/**
* Get customer session
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return ApiResponse<IntegrationCustomerSessionResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2481,7 +2479,7 @@ public ApiResponse getCustomerSessionWithHtt
/**
* Get customer session (asynchronously)
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (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
@@ -2505,7 +2503,7 @@ public okhttp3.Call getCustomerSessionAsync(@javax.annotation.Nonnull String cus
* 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)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2602,10 +2600,10 @@ private okhttp3.Call getLoyaltyBalancesValidateBeforeCall(@javax.annotation.Nonn
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2628,10 +2626,10 @@ public LoyaltyBalancesWithTiers getLoyaltyBalances(@javax.annotation.Nonnull Lon
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2655,10 +2653,10 @@ public ApiResponse getLoyaltyBalancesWithHttpInfo(@jav
/**
* Get customer's loyalty balances (asynchronously)
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2686,7 +2684,7 @@ public okhttp3.Call getLoyaltyBalancesAsync(@javax.annotation.Nonnull Long loyal
* Build call for getLoyaltyCardBalances
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -2776,7 +2774,7 @@ private okhttp3.Call getLoyaltyCardBalancesValidateBeforeCall(@javax.annotation.
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @return LoyaltyCardBalances
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2800,7 +2798,7 @@ public LoyaltyCardBalances getLoyaltyCardBalances(@javax.annotation.Nonnull Long
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @return ApiResponse<LoyaltyCardBalances>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2825,7 +2823,7 @@ public ApiResponse getLoyaltyCardBalancesWithHttpInfo(@java
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -3058,8 +3056,8 @@ public okhttp3.Call getLoyaltyCardPointsAsync(@javax.annotation.Nonnull Long loy
* @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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)
@@ -3183,8 +3181,8 @@ private okhttp3.Call getLoyaltyCardTransactionsValidateBeforeCall(@javax.annotat
* @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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)
@@ -3214,8 +3212,8 @@ public GetLoyaltyCardTransactions200Response getLoyaltyCardTransactions(@javax.a
* @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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)
@@ -3246,8 +3244,8 @@ public ApiResponse getLoyaltyCardTransact
* @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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)
@@ -3482,12 +3480,12 @@ public okhttp3.Call getLoyaltyProgramProfilePointsAsync(@javax.annotation.Nonnul
* Build call for getLoyaltyProgramProfileTransactions
* @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 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 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 subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3604,15 +3602,15 @@ private okhttp3.Call getLoyaltyProgramProfileTransactionsValidateBeforeCall(@jav
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3635,15 +3633,15 @@ public GetLoyaltyProgramProfileTransactions200Response getLoyaltyProgramProfileT
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3667,15 +3665,15 @@ public ApiResponse getLoyaltyPr
/**
* List customer's loyalty transactions (asynchronously)
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3926,7 +3924,7 @@ private okhttp3.Call linkLoyaltyCardToProfileValidateBeforeCall(@javax.annotatio
/**
* Link customer profile to card
- * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
+ * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). > [!note] You can link as many customer profiles to a given loyalty card as the > [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) > allows.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -3949,7 +3947,7 @@ public LoyaltyCard linkLoyaltyCardToProfile(@javax.annotation.Nonnull Long loyal
/**
* Link customer profile to card
- * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
+ * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). > [!note] You can link as many customer profiles to a given loyalty card as the > [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) > allows.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -3973,7 +3971,7 @@ public ApiResponse linkLoyaltyCardToProfileWithHttpInfo(@javax.anno
/**
* Link customer profile to card (asynchronously)
- * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
+ * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). > [!note] You can link as many customer profiles to a given loyalty card as the > [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) > allows.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -3997,136 +3995,9 @@ public okhttp3.Call linkLoyaltyCardToProfileAsync(@javax.annotation.Nonnull Long
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
- /**
- * Build call for priceHistory
- * @param priceHistoryRequest body (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 | - |
-
- */
- public okhttp3.Call priceHistoryCall(@javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, 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 = priceHistoryRequest;
-
- // create path and map variables
- String localVarPath = "/v1/best_prior_price_history";
-
- 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 = {
- "application/json"
- };
- final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
- if (localVarContentType != null) {
- localVarHeaderParams.put("Content-Type", localVarContentType);
- }
-
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
- return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
- }
-
- @SuppressWarnings("rawtypes")
- private okhttp3.Call priceHistoryValidateBeforeCall(@javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, final ApiCallback _callback) throws ApiException {
- // verify the required parameter 'priceHistoryRequest' is set
- if (priceHistoryRequest == null) {
- throw new ApiException("Missing the required parameter 'priceHistoryRequest' when calling priceHistory(Async)");
- }
-
- return priceHistoryCall(priceHistoryRequest, _callback);
-
- }
-
- /**
- * Get summary of price history
- * Fetch the historical price data for a given SKU within a defined timeframe.
- * @param priceHistoryRequest body (required)
- * @return PriceHistoryResponse
- * @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 | - |
-
- */
- public PriceHistoryResponse priceHistory(@javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest) throws ApiException {
- ApiResponse localVarResp = priceHistoryWithHttpInfo(priceHistoryRequest);
- return localVarResp.getData();
- }
-
- /**
- * Get summary of price history
- * Fetch the historical price data for a given SKU within a defined timeframe.
- * @param priceHistoryRequest body (required)
- * @return ApiResponse<PriceHistoryResponse>
- * @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 | - |
-
- */
- public ApiResponse priceHistoryWithHttpInfo(@javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest) throws ApiException {
- okhttp3.Call localVarCall = priceHistoryValidateBeforeCall(priceHistoryRequest, null);
- Type localVarReturnType = new TypeToken(){}.getType();
- return localVarApiClient.execute(localVarCall, localVarReturnType);
- }
-
- /**
- * Get summary of price history (asynchronously)
- * Fetch the historical price data for a given SKU within a defined timeframe.
- * @param priceHistoryRequest body (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 | - |
-
- */
- public okhttp3.Call priceHistoryAsync(@javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, final ApiCallback _callback) throws ApiException {
-
- okhttp3.Call localVarCall = priceHistoryValidateBeforeCall(priceHistoryRequest, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
- localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
- return localVarCall;
- }
/**
* Build call for reopenCustomerSession
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -4197,8 +4068,8 @@ private okhttp3.Call reopenCustomerSessionValidateBeforeCall(@javax.annotation.N
/**
* Reopen customer session
- * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a> tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> To see an example of a rollback, see the [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial. > [!note] If your order workflow requires you to create a new session > instead of reopening a session, use the > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) > endpoint to cancel a closed session and create a new one.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return ReopenSessionResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -4217,8 +4088,8 @@ public ReopenSessionResponse reopenCustomerSession(@javax.annotation.Nonnull Str
/**
* Reopen customer session
- * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a> tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> To see an example of a rollback, see the [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial. > [!note] If your order workflow requires you to create a new session > instead of reopening a session, use the > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) > endpoint to cancel a closed session and create a new one.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return ApiResponse<ReopenSessionResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -4238,8 +4109,8 @@ public ApiResponse reopenCustomerSessionWithHttpInfo(@jav
/**
* Reopen customer session (asynchronously)
- * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a> tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> To see an example of a rollback, see the [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial. > [!note] If your order workflow requires you to create a new session > instead of reopening a session, use the > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) > endpoint to cancel a closed session and create a new one.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (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
@@ -4261,7 +4132,7 @@ public okhttp3.Call reopenCustomerSessionAsync(@javax.annotation.Nonnull String
}
/**
* Build call for returnCartItems
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param returnIntegrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional)
* @param _callback Callback for upload/download progress
@@ -4344,8 +4215,8 @@ private okhttp3.Call returnCartItemsValidateBeforeCall(@javax.annotation.Nonnull
/**
* Return cart items
- * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. > [!note] This will roll back any effects associated with these cart items. > For more information, see [our documentation on session > states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) > and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). > [!note] To make request processing idempotent for this endpoint, include the `Idempotency-Key` header with an idempotency key in requests. Also: > - Requests with the `Idempotency-Key` header are logged in the Talon.One access logs. > - Responses for idempotent requests are stored in the database and expire 24 hours after the request is sent. > - Idempotency keys are typically UUID keys and should not exceed 255 characters in length.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param returnIntegrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional)
* @return IntegrationStateV2
@@ -4366,8 +4237,8 @@ public IntegrationStateV2 returnCartItems(@javax.annotation.Nonnull String custo
/**
* Return cart items
- * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. > [!note] This will roll back any effects associated with these cart items. > For more information, see [our documentation on session > states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) > and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). > [!note] To make request processing idempotent for this endpoint, include the `Idempotency-Key` header with an idempotency key in requests. Also: > - Requests with the `Idempotency-Key` header are logged in the Talon.One access logs. > - Responses for idempotent requests are stored in the database and expire 24 hours after the request is sent. > - Idempotency keys are typically UUID keys and should not exceed 255 characters in length.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param returnIntegrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional)
* @return ApiResponse<IntegrationStateV2>
@@ -4389,8 +4260,8 @@ public ApiResponse returnCartItemsWithHttpInfo(@javax.annota
/**
* Return cart items (asynchronously)
- * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. > [!note] This will roll back any effects associated with these cart items. > For more information, see [our documentation on session > states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) > and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). > [!note] To make request processing idempotent for this endpoint, include the `Idempotency-Key` header with an idempotency key in requests. Also: > - Requests with the `Idempotency-Key` header are logged in the Talon.One access logs. > - Responses for idempotent requests are stored in the database and expire 24 hours after the request is sent. > - Idempotency keys are typically UUID keys and should not exceed 255 characters in length.
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param returnIntegrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -4493,7 +4364,7 @@ private okhttp3.Call syncCatalogValidateBeforeCall(@javax.annotation.Nonnull Lon
/**
* Sync cart item catalog
- * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
+ * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. > [!important] You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
* @param catalogId The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. (required)
* @param catalogSyncRequest body (required)
* @return Catalog
@@ -4515,7 +4386,7 @@ public Catalog syncCatalog(@javax.annotation.Nonnull Long catalogId, @javax.anno
/**
* Sync cart item catalog
- * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
+ * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. > [!important] You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
* @param catalogId The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. (required)
* @param catalogSyncRequest body (required)
* @return ApiResponse<Catalog>
@@ -4538,7 +4409,7 @@ public ApiResponse syncCatalogWithHttpInfo(@javax.annotation.Nonnull Lo
/**
* Sync cart item catalog (asynchronously)
- * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
+ * Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. > [!important] You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
* @param catalogId The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. (required)
* @param catalogSyncRequest body (required)
* @param _callback The callback to be executed when the API call finishes
@@ -4650,7 +4521,7 @@ private okhttp3.Call trackEventV2ValidateBeforeCall(@javax.annotation.Nonnull In
/**
* Track event
- * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
+ * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!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)
@@ -4674,7 +4545,7 @@ public IntegrationEventV2Response trackEventV2(@javax.annotation.Nonnull Integra
/**
* Track event
- * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
+ * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!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)
@@ -4699,7 +4570,7 @@ public ApiResponse trackEventV2WithHttpInfo(@javax.a
/**
* Track event (asynchronously)
- * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
+ * Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). > [!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)
@@ -4812,7 +4683,7 @@ private okhttp3.Call unlinkLoyaltyCardFromProfileValidateBeforeCall(@javax.annot
/**
* Unlink customer profile from a loyalty card
- * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @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)
* @param loyaltyCardId The identifier of the loyalty card. You can get this ID using the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -4835,7 +4706,7 @@ public LoyaltyCard unlinkLoyaltyCardFromProfile(@javax.annotation.Nonnull Long l
/**
* Unlink customer profile from a loyalty card
- * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @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)
* @param loyaltyCardId The identifier of the loyalty card. You can get this ID using the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -4859,7 +4730,7 @@ public ApiResponse unlinkLoyaltyCardFromProfileWithHttpInfo(@javax.
/**
* Unlink customer profile from a loyalty card (asynchronously)
- * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Unlink a customer profile from a [registered](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card) loyalty card. To get the `integrationId` of a customer profile, you can use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @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)
* @param loyaltyCardId The identifier of the loyalty card. You can get this ID using the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param loyaltyCardRegistration body (required)
@@ -5243,7 +5114,7 @@ private okhttp3.Call updateCustomerProfileAudiencesValidateBeforeCall(@javax.ann
/**
* Update multiple customer profiles' audiences
- * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. > [!note] You can also do this using the > [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) > effect.
* @param customerProfileAudienceRequest body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -5262,7 +5133,7 @@ public void updateCustomerProfileAudiences(@javax.annotation.Nonnull CustomerPro
/**
* Update multiple customer profiles' audiences
- * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. > [!note] You can also do this using the > [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) > effect.
* @param customerProfileAudienceRequest body (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -5283,7 +5154,7 @@ public ApiResponse updateCustomerProfileAudiencesWithHttpInfo(@javax.annot
/**
* Update multiple customer profiles' audiences (asynchronously)
- * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. > [!note] You can also do this using the > [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) > effect.
* @param customerProfileAudienceRequest body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -5395,7 +5266,7 @@ private okhttp3.Call updateCustomerProfileV2ValidateBeforeCall(@javax.annotation
/**
* Update customer profile
- * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
+ * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. > [!note] **Note** > - Updating a customer profile returns a response with the requested integration state. > - You can use the `responseContent` property to save yourself extra API calls. For example, you can get > the customer profile details directly without extra requests. > - We recommend sending requests sequentially. > See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
* @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 customerProfileIntegrationRequestV2 body (required)
* @param runRuleEngine Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. (optional, default to false)
@@ -5419,7 +5290,7 @@ public CustomerProfileIntegrationResponseV2 updateCustomerProfileV2(@javax.annot
/**
* Update customer profile
- * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
+ * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. > [!note] **Note** > - Updating a customer profile returns a response with the requested integration state. > - You can use the `responseContent` property to save yourself extra API calls. For example, you can get > the customer profile details directly without extra requests. > - We recommend sending requests sequentially. > See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
* @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 customerProfileIntegrationRequestV2 body (required)
* @param runRuleEngine Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. (optional, default to false)
@@ -5444,7 +5315,7 @@ public ApiResponse updateCustomerProfileV2
/**
* Update customer profile (asynchronously)
- * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
+ * Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. > [!note] **Note** > - Updating a customer profile returns a response with the requested integration state. > - You can use the `responseContent` property to save yourself extra API calls. For example, you can get > the customer profile details directly without extra requests. > - We recommend sending requests sequentially. > See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
* @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 customerProfileIntegrationRequestV2 body (required)
* @param runRuleEngine Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. (optional, default to false)
@@ -5547,7 +5418,7 @@ private okhttp3.Call updateCustomerProfilesV2ValidateBeforeCall(@javax.annotatio
/**
* Update multiple customer profiles
- * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
+ * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). > [!note] This endpoint does not trigger the Rule Engine. > To trigger the Rule Engine for customer profile updates, > use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
* @param multipleCustomerProfileIntegrationRequest 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)
* @return MultipleCustomerProfileIntegrationResponseV2
@@ -5568,7 +5439,7 @@ public MultipleCustomerProfileIntegrationResponseV2 updateCustomerProfilesV2(@ja
/**
* Update multiple customer profiles
- * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
+ * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). > [!note] This endpoint does not trigger the Rule Engine. > To trigger the Rule Engine for customer profile updates, > use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
* @param multipleCustomerProfileIntegrationRequest 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)
* @return ApiResponse<MultipleCustomerProfileIntegrationResponseV2>
@@ -5590,7 +5461,7 @@ public ApiResponse updateCustomerP
/**
* Update multiple customer profiles (asynchronously)
- * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
+ * Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). > [!note] This endpoint does not trigger the Rule Engine. > To trigger the Rule Engine for customer profile updates, > use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
* @param multipleCustomerProfileIntegrationRequest 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 _callback The callback to be executed when the API call finishes
@@ -5614,10 +5485,10 @@ public okhttp3.Call updateCustomerProfilesV2Async(@javax.annotation.Nonnull Mult
}
/**
* Build call for updateCustomerSessionV2
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param integrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional)
- * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
+ * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -5703,11 +5574,11 @@ private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(@javax.annotation
/**
* Update customer session
- * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. > [!note] **Note** > - The currency for the session and the cart items in it is the currency set for the Application linked to this session. > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. > [!note] **Note** > - If the specified profile does not exist, an empty profile is **created automatically**. > You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). > - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. > For example, you can get the customer profile details directly without extra requests. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param integrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional)
- * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
+ * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
* @return IntegrationStateV2
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -5727,11 +5598,11 @@ public IntegrationStateV2 updateCustomerSessionV2(@javax.annotation.Nonnull Stri
/**
* Update customer session
- * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. > [!note] **Note** > - The currency for the session and the cart items in it is the currency set for the Application linked to this session. > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. > [!note] **Note** > - If the specified profile does not exist, an empty profile is **created automatically**. > You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). > - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. > For example, you can get the customer profile details directly without extra requests. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param integrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional)
- * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
+ * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
* @return ApiResponse<IntegrationStateV2>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -5752,11 +5623,11 @@ public ApiResponse updateCustomerSessionV2WithHttpInfo(@java
/**
* Update customer session (asynchronously)
- * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. > [!note] **Note** > - The currency for the session and the cart items in it is the currency set for the Application linked to this session. > - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. > [!note] **Note** > - If the specified profile does not exist, an empty profile is **created automatically**. > You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). > - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. > For example, you can get the customer profile details directly without extra requests. > - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param integrationRequest body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional)
- * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional)
+ * @param now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). > [!note] **Note** > - It must be an RFC3339 timestamp string. > - It can **only** be a date in the future. > - It can **only** be used if the `dry` parameter in the query is set to `true`. (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
diff --git a/src/main/java/one/talon/api/ManagementApi.java b/src/main/java/one/talon/api/ManagementApi.java
index e6d69dd5..234dabe9 100644
--- a/src/main/java/one/talon/api/ManagementApi.java
+++ b/src/main/java/one/talon/api/ManagementApi.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -131,6 +131,8 @@
import one.talon.model.NewPasswordEmail;
import one.talon.model.NewStore;
import java.time.OffsetDateTime;
+import one.talon.model.PriceHistoryRequest;
+import one.talon.model.PriceHistoryResponse;
import one.talon.model.Referral;
import one.talon.model.RoleV2;
import one.talon.model.RoleV2Base;
@@ -257,7 +259,7 @@ public okhttp3.Call activateUserByEmailCall(@javax.annotation.Nonnull ActivateUs
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -387,7 +389,7 @@ public okhttp3.Call addLoyaltyCardPointsCall(@javax.annotation.Nonnull Long loya
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -542,7 +544,7 @@ public okhttp3.Call addLoyaltyPointsCall(@javax.annotation.Nonnull String loyalt
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -569,7 +571,7 @@ private okhttp3.Call addLoyaltyPointsValidateBeforeCall(@javax.annotation.Nonnul
/**
* Add points to customer profile
- * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 addLoyaltyPoints body (required)
@@ -590,7 +592,7 @@ public void addLoyaltyPoints(@javax.annotation.Nonnull String loyaltyProgramId,
/**
* Add points to customer profile
- * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 addLoyaltyPoints body (required)
@@ -613,7 +615,7 @@ public ApiResponse addLoyaltyPointsWithHttpInfo(@javax.annotation.Nonnull
/**
* Add points to customer profile (asynchronously)
- * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 addLoyaltyPoints body (required)
@@ -694,7 +696,7 @@ public okhttp3.Call copyCampaignToApplicationsCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -840,7 +842,7 @@ public okhttp3.Call createAccountCollectionCall(@javax.annotation.Nonnull NewCol
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -983,7 +985,7 @@ public okhttp3.Call createAchievementCall(@javax.annotation.Nonnull Long applica
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1135,7 +1137,7 @@ public okhttp3.Call createAdditionalCostCall(@javax.annotation.Nonnull NewAdditi
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1262,7 +1264,7 @@ public okhttp3.Call createAttributeCall(@javax.annotation.Nonnull NewAttribute n
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1394,7 +1396,7 @@ public okhttp3.Call createBatchLoyaltyCardsCall(@javax.annotation.Nonnull Long l
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1416,7 +1418,7 @@ private okhttp3.Call createBatchLoyaltyCardsValidateBeforeCall(@javax.annotation
/**
* Create loyalty cards
- * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+ * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. > [!important] **Note** > - The specified card-based loyalty program must have a defined card code > format that is used to generate the loyalty card codes. > - Trying to create more than 20,000 loyalty cards in a single request > returns an error message with a `400` status code.
* @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 loyaltyCardBatch body (required)
* @return LoyaltyCardBatchResponse
@@ -1438,7 +1440,7 @@ public LoyaltyCardBatchResponse createBatchLoyaltyCards(@javax.annotation.Nonnul
/**
* Create loyalty cards
- * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+ * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. > [!important] **Note** > - The specified card-based loyalty program must have a defined card code > format that is used to generate the loyalty card codes. > - Trying to create more than 20,000 loyalty cards in a single request > returns an error message with a `400` status code.
* @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 loyaltyCardBatch body (required)
* @return ApiResponse<LoyaltyCardBatchResponse>
@@ -1461,7 +1463,7 @@ public ApiResponse createBatchLoyaltyCardsWithHttpInfo
/**
* Create loyalty cards (asynchronously)
- * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+ * Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. > [!important] **Note** > - The specified card-based loyalty program must have a defined card code > format that is used to generate the loyalty card codes. > - Trying to create more than 20,000 loyalty cards in a single request > returns an error message with a `400` status code.
* @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 loyaltyCardBatch body (required)
* @param _callback The callback to be executed when the API call finishes
@@ -1540,7 +1542,7 @@ public okhttp3.Call createCampaignFromTemplateCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1681,7 +1683,7 @@ public okhttp3.Call createCampaignStoreBudgetCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1830,7 +1832,7 @@ public okhttp3.Call createCollectionCall(@javax.annotation.Nonnull Long applicat
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -1983,7 +1985,7 @@ public okhttp3.Call createCouponsCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2136,7 +2138,7 @@ public okhttp3.Call createCouponsAsyncCall(@javax.annotation.Nonnull Long applic
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2283,7 +2285,7 @@ public okhttp3.Call createCouponsDeletionJobCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2436,7 +2438,7 @@ public okhttp3.Call createCouponsForMultipleRecipientsCall(@javax.annotation.Non
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2585,7 +2587,7 @@ public okhttp3.Call createInviteEmailCall(@javax.annotation.Nonnull NewInviteEma
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2602,7 +2604,7 @@ private okhttp3.Call createInviteEmailValidateBeforeCall(@javax.annotation.Nonnu
/**
* Resend invitation email
- * Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ * Resend an email invitation to an existing user. > [!note] The invitation token is valid for 24 hours after the email has been sent.
* @param newInviteEmail body (required)
* @return NewInviteEmail
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2620,7 +2622,7 @@ public NewInviteEmail createInviteEmail(@javax.annotation.Nonnull NewInviteEmail
/**
* Resend invitation email
- * Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ * Resend an email invitation to an existing user. > [!note] The invitation token is valid for 24 hours after the email has been sent.
* @param newInviteEmail body (required)
* @return ApiResponse<NewInviteEmail>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2639,7 +2641,7 @@ public ApiResponse createInviteEmailWithHttpInfo(@javax.annotati
/**
* Resend invitation email (asynchronously)
- * Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ * Resend an email invitation to an existing user. > [!note] The invitation token is valid for 24 hours after the email has been sent.
* @param newInviteEmail body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2712,7 +2714,7 @@ public okhttp3.Call createInviteV2Call(@javax.annotation.Nonnull NewInvitation n
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2729,7 +2731,7 @@ private okhttp3.Call createInviteV2ValidateBeforeCall(@javax.annotation.Nonnull
/**
* Invite user
- * Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+ * Create a new user in the account and send an invitation to their email address. > [!note] The invitation token is valid for 24 hours after the email has > been sent. You can resend an invitation to a user with the [Resend > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) > endpoint.
* @param newInvitation body (required)
* @return User
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2747,7 +2749,7 @@ public User createInviteV2(@javax.annotation.Nonnull NewInvitation newInvitation
/**
* Invite user
- * Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+ * Create a new user in the account and send an invitation to their email address. > [!note] The invitation token is valid for 24 hours after the email has > been sent. You can resend an invitation to a user with the [Resend > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) > endpoint.
* @param newInvitation body (required)
* @return ApiResponse<User>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2766,7 +2768,7 @@ public ApiResponse createInviteV2WithHttpInfo(@javax.annotation.Nonnull Ne
/**
* Invite user (asynchronously)
- * Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+ * Create a new user in the account and send an invitation to their email address. > [!note] The invitation token is valid for 24 hours after the email has > been sent. You can resend an invitation to a user with the [Resend > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) > endpoint.
* @param newInvitation body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2839,7 +2841,7 @@ public okhttp3.Call createPasswordRecoveryEmailCall(@javax.annotation.Nonnull Ne
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2856,7 +2858,7 @@ private okhttp3.Call createPasswordRecoveryEmailValidateBeforeCall(@javax.annota
/**
* Request a password reset
- * Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+ * Send an email with a password recovery link to the email address of an existing account. > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
* @param newPasswordEmail body (required)
* @return NewPasswordEmail
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2874,7 +2876,7 @@ public NewPasswordEmail createPasswordRecoveryEmail(@javax.annotation.Nonnull Ne
/**
* Request a password reset
- * Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+ * Send an email with a password recovery link to the email address of an existing account. > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
* @param newPasswordEmail body (required)
* @return ApiResponse<NewPasswordEmail>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2893,7 +2895,7 @@ public ApiResponse createPasswordRecoveryEmailWithHttpInfo(@ja
/**
* Request a password reset (asynchronously)
- * Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+ * Send an email with a password recovery link to the email address of an existing account. > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
* @param newPasswordEmail body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2966,7 +2968,7 @@ public okhttp3.Call createSessionCall(@javax.annotation.Nonnull LoginParams logi
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -2983,7 +2985,7 @@ private okhttp3.Call createSessionValidateBeforeCall(@javax.annotation.Nonnull L
/**
* Create session
- * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
+ * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. > [!note] > Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> > in the Campaign Manager to decide which endpoints can be used with a given key.
* @param loginParams body (required)
* @return Session
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3001,7 +3003,7 @@ public Session createSession(@javax.annotation.Nonnull LoginParams loginParams)
/**
* Create session
- * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
+ * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. > [!note] > Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> > in the Campaign Manager to decide which endpoints can be used with a given key.
* @param loginParams body (required)
* @return ApiResponse<Session>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3020,7 +3022,7 @@ public ApiResponse createSessionWithHttpInfo(@javax.annotation.Nonnull
/**
* Create session (asynchronously)
- * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
+ * Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. > [!note] > Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> > in the Campaign Manager to decide which endpoints can be used with a given key.
* @param loginParams body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -3097,7 +3099,7 @@ public okhttp3.Call createStoreCall(@javax.annotation.Nonnull Long applicationId
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3237,7 +3239,7 @@ public okhttp3.Call deactivateUserByEmailCall(@javax.annotation.Nonnull Deactiva
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3367,7 +3369,7 @@ public okhttp3.Call deductLoyaltyCardPointsCall(@javax.annotation.Nonnull Long l
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3463,7 +3465,7 @@ public okhttp3.Call deductLoyaltyCardPointsAsync(@javax.annotation.Nonnull Long
}
/**
* Build call for deleteAccountCollection
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -3516,7 +3518,7 @@ public okhttp3.Call deleteAccountCollectionCall(@javax.annotation.Nonnull Long c
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3534,7 +3536,7 @@ private okhttp3.Call deleteAccountCollectionValidateBeforeCall(@javax.annotation
/**
* Delete account-level collection
* Delete a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3551,7 +3553,7 @@ public void deleteAccountCollection(@javax.annotation.Nonnull Long collectionId)
/**
* Delete account-level collection
* Delete a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3570,7 +3572,7 @@ public ApiResponse deleteAccountCollectionWithHttpInfo(@javax.annotation.N
/**
* Delete account-level collection (asynchronously)
* Delete a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (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
@@ -3648,7 +3650,7 @@ public okhttp3.Call deleteAchievementCall(@javax.annotation.Nonnull Long applica
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3794,7 +3796,7 @@ public okhttp3.Call deleteCampaignCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -3938,7 +3940,7 @@ public okhttp3.Call deleteCampaignStoreBudgetsCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4028,7 +4030,7 @@ public okhttp3.Call deleteCampaignStoreBudgetsAsync(@javax.annotation.Nonnull Lo
* Build call for deleteCollection
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -4083,7 +4085,7 @@ public okhttp3.Call deleteCollectionCall(@javax.annotation.Nonnull Long applicat
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4113,7 +4115,7 @@ private okhttp3.Call deleteCollectionValidateBeforeCall(@javax.annotation.Nonnul
* Delete a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -4132,7 +4134,7 @@ public void deleteCollection(@javax.annotation.Nonnull Long applicationId, @java
* Delete a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -4153,7 +4155,7 @@ public ApiResponse deleteCollectionWithHttpInfo(@javax.annotation.Nonnull
* Delete a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (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
@@ -4228,7 +4230,7 @@ public okhttp3.Call deleteCouponCall(@javax.annotation.Nonnull Long applicationI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4433,7 +4435,7 @@ public okhttp3.Call deleteCouponsCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4607,7 +4609,7 @@ public okhttp3.Call deleteLoyaltyCardCall(@javax.annotation.Nonnull Long loyalty
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4747,7 +4749,7 @@ public okhttp3.Call deleteReferralCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -4889,7 +4891,7 @@ public okhttp3.Call deleteStoreCall(@javax.annotation.Nonnull Long applicationId
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5022,7 +5024,7 @@ public okhttp3.Call deleteUserCall(@javax.annotation.Nonnull Long userId, final
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5144,7 +5146,7 @@ public okhttp3.Call deleteUserByEmailCall(@javax.annotation.Nonnull DeleteUserRe
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5264,7 +5266,7 @@ public okhttp3.Call destroySessionCall(final ApiCallback _callback) throws ApiEx
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5384,7 +5386,7 @@ public okhttp3.Call disconnectCampaignStoresCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5472,7 +5474,7 @@ public okhttp3.Call disconnectCampaignStoresAsync(@javax.annotation.Nonnull Long
}
/**
* Build call for exportAccountCollectionItems
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -5526,7 +5528,7 @@ public okhttp3.Call exportAccountCollectionItemsCall(@javax.annotation.Nonnull L
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5543,8 +5545,8 @@ private okhttp3.Call exportAccountCollectionItemsValidateBeforeCall(@javax.annot
/**
* Export account-level collection's items
- * Download a CSV file containing items from a given account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Download a CSV file containing items from a given account-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -5563,8 +5565,8 @@ public String exportAccountCollectionItems(@javax.annotation.Nonnull Long collec
/**
* Export account-level collection's items
- * Download a CSV file containing items from a given account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Download a CSV file containing items from a given account-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -5584,8 +5586,8 @@ public ApiResponse exportAccountCollectionItemsWithHttpInfo(@javax.annot
/**
* Export account-level collection's items (asynchronously)
- * Download a CSV file containing items from a given account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Download a CSV file containing items from a given account-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (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
@@ -5666,7 +5668,7 @@ public okhttp3.Call exportAchievementsCall(@javax.annotation.Nonnull Long applic
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5767,8 +5769,8 @@ public okhttp3.Call exportAchievementsAsync(@javax.annotation.Nonnull Long appli
/**
* Build call for exportApplicationCampaignAnalytics
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param campaignIds Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -5833,7 +5835,7 @@ public okhttp3.Call exportApplicationCampaignAnalyticsCall(@javax.annotation.Non
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5860,10 +5862,10 @@ private okhttp3.Call exportApplicationCampaignAnalyticsValidateBeforeCall(@javax
/**
* Export Application analytics aggregated by campaign
- * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
+ * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. > [!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: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param campaignIds Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -5881,10 +5883,10 @@ public String exportApplicationCampaignAnalytics(@javax.annotation.Nonnull Long
/**
* Export Application analytics aggregated by campaign
- * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
+ * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. > [!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: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param campaignIds Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -5903,10 +5905,10 @@ public ApiResponse exportApplicationCampaignAnalyticsWithHttpInfo(@javax
/**
* Export Application analytics aggregated by campaign (asynchronously)
- * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
+ * Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application. > [!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: - `campaign_id`: The ID of the campaign. This column also contains labels for the [total and influenced values](https://docs.talon.one/docs/product/campaigns/analytics/application-dashboard#display-the-analytics-data). - `start_date`: The start of the aggregation time frame in UTC. - `end_date`: The end of the aggregation time frame in UTC. - `revenue`: The total, pre-discount value of all items purchased in a customer session. - `sessions`: The number of all closed sessions. - `average_session_value`: The average customer session value, calculated by dividing the revenue value by the number of sessions. - `average_items_per_session`: The number of items from sessions divided by the number of sessions. - `coupons`: The number of times a coupon was successfully redeemed in sessions. - `discounts`: The total value of discounts given for cart items in sessions.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param campaignIds Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -5982,7 +5984,7 @@ public okhttp3.Call exportAudiencesMembershipsCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -5999,7 +6001,7 @@ private okhttp3.Call exportAudiencesMembershipsValidateBeforeCall(@javax.annotat
/**
* Export audience members
- * Download a CSV file containing the integration IDs of the members of an audience. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
+ * Download a CSV file containing the integration IDs of the members of an audience. > [!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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
* @param audienceId The ID of the audience. (required)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -6020,7 +6022,7 @@ public String exportAudiencesMemberships(@javax.annotation.Nonnull Long audience
/**
* Export audience members
- * Download a CSV file containing the integration IDs of the members of an audience. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
+ * Download a CSV file containing the integration IDs of the members of an audience. > [!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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
* @param audienceId The ID of the audience. (required)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -6042,7 +6044,7 @@ public ApiResponse exportAudiencesMembershipsWithHttpInfo(@javax.annotat
/**
* Export audience members (asynchronously)
- * Download a CSV file containing the integration IDs of the members of an audience. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
+ * Download a CSV file containing the integration IDs of the members of an audience. > [!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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
* @param audienceId The ID of the audience. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -6133,7 +6135,7 @@ public okhttp3.Call exportCampaignStoreBudgetsCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -6155,7 +6157,7 @@ private okhttp3.Call exportCampaignStoreBudgetsValidateBeforeCall(@javax.annotat
/**
* Export campaign store budgets
- * Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
+ * Download a CSV file containing the store budgets for a given campaign. > [!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: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param action The action that this budget is limiting. (optional)
@@ -6179,7 +6181,7 @@ public String exportCampaignStoreBudgets(@javax.annotation.Nonnull Long applicat
/**
* Export campaign store budgets
- * Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
+ * Download a CSV file containing the store budgets for a given campaign. > [!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: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param action The action that this budget is limiting. (optional)
@@ -6204,7 +6206,7 @@ public ApiResponse exportCampaignStoreBudgetsWithHttpInfo(@javax.annotat
/**
* Export campaign store budgets (asynchronously)
- * Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
+ * Download a CSV file containing the store budgets for a given campaign. > [!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: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param action The action that this budget is limiting. (optional)
@@ -6288,7 +6290,7 @@ public okhttp3.Call exportCampaignStoresCall(@javax.annotation.Nonnull Long appl
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -6310,7 +6312,7 @@ private okhttp3.Call exportCampaignStoresValidateBeforeCall(@javax.annotation.No
/**
* Export stores
- * Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
+ * Download a CSV file containing the stores linked to a specific campaign. > [!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 column: - `store_integration_id`: The identifier of the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @return String
@@ -6332,7 +6334,7 @@ public String exportCampaignStores(@javax.annotation.Nonnull Long applicationId,
/**
* Export stores
- * Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
+ * Download a CSV file containing the stores linked to a specific campaign. > [!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 column: - `store_integration_id`: The identifier of the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @return ApiResponse<String>
@@ -6355,7 +6357,7 @@ public ApiResponse exportCampaignStoresWithHttpInfo(@javax.annotation.No
/**
* Export stores (asynchronously)
- * Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
+ * Download a CSV file containing the stores linked to a specific campaign. > [!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 column: - `store_integration_id`: The identifier of the store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param _callback The callback to be executed when the API call finishes
@@ -6382,7 +6384,7 @@ public okhttp3.Call exportCampaignStoresAsync(@javax.annotation.Nonnull Long app
* Build call for exportCollectionItems
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -6438,7 +6440,7 @@ public okhttp3.Call exportCollectionItemsCall(@javax.annotation.Nonnull Long app
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -6465,10 +6467,10 @@ private okhttp3.Call exportCollectionItemsValidateBeforeCall(@javax.annotation.N
/**
* Export campaign-level collection's items
- * Download a CSV file containing items from a given campaign-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing items from a given campaign-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -6487,10 +6489,10 @@ public String exportCollectionItems(@javax.annotation.Nonnull Long applicationId
/**
* Export campaign-level collection's items
- * Download a CSV file containing items from a given campaign-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing items from a given campaign-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -6510,10 +6512,10 @@ public ApiResponse exportCollectionItemsWithHttpInfo(@javax.annotation.N
/**
* Export campaign-level collection's items (asynchronously)
- * Download a CSV file containing items from a given campaign-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing items from a given campaign-level collection. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (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
@@ -6657,7 +6659,7 @@ public okhttp3.Call exportCouponsCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -6674,7 +6676,7 @@ private okhttp3.Call exportCouponsValidateBeforeCall(@javax.annotation.Nonnull L
/**
* Export coupons
- * Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+ * Download a CSV file containing the coupons that match the given properties. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional)
@@ -6706,7 +6708,7 @@ public String exportCoupons(@javax.annotation.Nonnull Long applicationId, @javax
/**
* Export coupons
- * Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+ * Download a CSV file containing the coupons that match the given properties. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional)
@@ -6739,7 +6741,7 @@ public ApiResponse exportCouponsWithHttpInfo(@javax.annotation.Nonnull L
/**
* Export coupons (asynchronously)
- * Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+ * Download a CSV file containing the coupons that match the given properties. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. (optional)
@@ -6851,7 +6853,7 @@ public okhttp3.Call exportCustomerSessionsCall(@javax.annotation.Nonnull Long ap
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -6868,7 +6870,7 @@ private okhttp3.Call exportCustomerSessionsValidateBeforeCall(@javax.annotation.
/**
* Export customer sessions
- * Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
+ * Download a CSV file containing the customer sessions that match the request. > [!important] Archived sessions cannot be exported. See the [retention > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). > [!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). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
* @param 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)
@@ -6891,7 +6893,7 @@ public String exportCustomerSessions(@javax.annotation.Nonnull Long applicationI
/**
* Export customer sessions
- * Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
+ * Download a CSV file containing the customer sessions that match the request. > [!important] Archived sessions cannot be exported. See the [retention > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). > [!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). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
* @param 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)
@@ -6915,7 +6917,7 @@ public ApiResponse exportCustomerSessionsWithHttpInfo(@javax.annotation.
/**
* Export customer sessions (asynchronously)
- * Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
+ * Download a CSV file containing the customer sessions that match the request. > [!important] Archived sessions cannot be exported. See the [retention > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). > [!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). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
* @param 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)
@@ -7003,7 +7005,7 @@ public okhttp3.Call exportCustomersTiersCall(@javax.annotation.Nonnull String lo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7156,7 +7158,7 @@ public okhttp3.Call exportEffectsCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7173,7 +7175,7 @@ private okhttp3.Call exportEffectsValidateBeforeCall(@javax.annotation.Nonnull L
/**
* Export triggered effects
- * Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
+ * Download a CSV file containing the triggered effects that match the given attributes. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -7195,7 +7197,7 @@ public String exportEffects(@javax.annotation.Nonnull Long applicationId, @javax
/**
* Export triggered effects
- * Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
+ * Download a CSV file containing the triggered effects that match the given attributes. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -7218,7 +7220,7 @@ public ApiResponse exportEffectsWithHttpInfo(@javax.annotation.Nonnull L
/**
* Export triggered effects (asynchronously)
- * Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
+ * Download a CSV file containing the triggered effects that match the given attributes. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -7244,7 +7246,7 @@ public okhttp3.Call exportEffectsAsync(@javax.annotation.Nonnull Long applicatio
/**
* Build call for exportLoyaltyBalance
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -7304,7 +7306,7 @@ public okhttp3.Call exportLoyaltyBalanceCall(@javax.annotation.Nonnull String lo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7322,9 +7324,9 @@ private okhttp3.Call exportLoyaltyBalanceValidateBeforeCall(@javax.annotation.No
/**
* Export customer loyalty balance to CSV
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7345,9 +7347,9 @@ public String exportLoyaltyBalance(@javax.annotation.Nonnull String loyaltyProgr
/**
* Export customer loyalty balance to CSV
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7369,9 +7371,9 @@ public ApiResponse exportLoyaltyBalanceWithHttpInfo(@javax.annotation.No
/**
* Export customer loyalty balance to CSV (asynchronously)
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param _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
@@ -7396,7 +7398,7 @@ public okhttp3.Call exportLoyaltyBalanceAsync(@javax.annotation.Nonnull String l
/**
* Build call for exportLoyaltyBalances
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -7454,7 +7456,7 @@ public okhttp3.Call exportLoyaltyBalancesCall(@javax.annotation.Nonnull String l
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7471,9 +7473,9 @@ private okhttp3.Call exportLoyaltyBalancesValidateBeforeCall(@javax.annotation.N
/**
* Export customer loyalty balances
- * Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
+ * Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subledger, when applicable. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7492,9 +7494,9 @@ public String exportLoyaltyBalances(@javax.annotation.Nonnull String loyaltyProg
/**
* Export customer loyalty balances
- * Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
+ * Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subledger, when applicable. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7514,9 +7516,9 @@ public ApiResponse exportLoyaltyBalancesWithHttpInfo(@javax.annotation.N
/**
* Export customer loyalty balances (asynchronously)
- * Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
+ * Download a CSV file containing the balance of each customer in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subledger, when applicable. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
* @param loyaltyProgramId The identifier for the loyalty program. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export. (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
@@ -7539,7 +7541,7 @@ public okhttp3.Call exportLoyaltyBalancesAsync(@javax.annotation.Nonnull String
/**
* Build call for exportLoyaltyCardBalances
* @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 endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -7597,7 +7599,7 @@ public okhttp3.Call exportLoyaltyCardBalancesCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7614,9 +7616,9 @@ private okhttp3.Call exportLoyaltyCardBalancesValidateBeforeCall(@javax.annotati
/**
* Export all card transaction logs
- * Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
+ * Download a CSV file containing the balances of all cards in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
* @param 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 endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7635,9 +7637,9 @@ public String exportLoyaltyCardBalances(@javax.annotation.Nonnull Long loyaltyPr
/**
* Export all card transaction logs
- * Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
+ * Download a CSV file containing the balances of all cards in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
* @param 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 endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -7657,9 +7659,9 @@ public ApiResponse exportLoyaltyCardBalancesWithHttpInfo(@javax.annotati
/**
* Export all card transaction logs (asynchronously)
- * Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
+ * Download a CSV file containing the balances of all cards in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
* @param 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 endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param _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
@@ -7683,8 +7685,8 @@ public okhttp3.Call exportLoyaltyCardBalancesAsync(@javax.annotation.Nonnull Lon
* Build call for exportLoyaltyCardLedger
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -7752,7 +7754,7 @@ public okhttp3.Call exportLoyaltyCardLedgerCall(@javax.annotation.Nonnull Long l
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7784,11 +7786,11 @@ private okhttp3.Call exportLoyaltyCardLedgerValidateBeforeCall(@javax.annotation
/**
* Export card's ledger log
- * Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing a loyalty card ledger log of the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -7808,11 +7810,11 @@ public String exportLoyaltyCardLedger(@javax.annotation.Nonnull Long loyaltyProg
/**
* Export card's ledger log
- * Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing a loyalty card ledger log of the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -7833,11 +7835,11 @@ public ApiResponse exportLoyaltyCardLedgerWithHttpInfo(@javax.annotation
/**
* Export card's ledger log (asynchronously)
- * Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ * Download a CSV file containing a loyalty card ledger log of the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -7862,8 +7864,8 @@ public okhttp3.Call exportLoyaltyCardLedgerAsync(@javax.annotation.Nonnull Long
* Build call for exportLoyaltyCards
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param batchId Filter results by loyalty card batch ID. (optional)
- * @param createdBefore Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string. (optional)
- * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. (optional)
+ * @param createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
+ * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -7934,7 +7936,7 @@ public okhttp3.Call exportLoyaltyCardsCall(@javax.annotation.Nonnull Long loyalt
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -7951,11 +7953,11 @@ 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.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
+ * 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.
* @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)
- * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. (optional)
+ * @param createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
+ * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -7975,11 +7977,11 @@ 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.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
+ * 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.
* @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)
- * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. (optional)
+ * @param createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
+ * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -8000,11 +8002,11 @@ 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.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
+ * 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.
* @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)
- * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. (optional)
+ * @param createdBefore Only return loyalty cards created before this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
+ * @param createdAfter Only return loyalty cards created after this timestamp. **Note:** This must be an RFC3339 timestamp string. (optional)
* @param dateFormat Determines the format of dates in the export document. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -8081,7 +8083,7 @@ public okhttp3.Call exportLoyaltyJoinDatesCall(@javax.annotation.Nonnull String
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8098,7 +8100,7 @@ private okhttp3.Call exportLoyaltyJoinDatesValidateBeforeCall(@javax.annotation.
/**
* Export customers' loyalty program join dates
- * Download a CSV file containing the join dates of all customers in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
+ * Download a CSV file containing the join dates of all customers in the 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 generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
* @param loyaltyProgramId The identifier of the loyalty program. (required)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -8118,7 +8120,7 @@ public String exportLoyaltyJoinDates(@javax.annotation.Nonnull String loyaltyPro
/**
* Export customers' loyalty program join dates
- * Download a CSV file containing the join dates of all customers in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
+ * Download a CSV file containing the join dates of all customers in the 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 generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
* @param loyaltyProgramId The identifier of the loyalty program. (required)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -8139,7 +8141,7 @@ public ApiResponse exportLoyaltyJoinDatesWithHttpInfo(@javax.annotation.
/**
* Export customers' loyalty program join dates (asynchronously)
- * Download a CSV file containing the join dates of all customers in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
+ * Download a CSV file containing the join dates of all customers in the 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 generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `profileIntegrationID`: The integration ID of the customer profile. - `joinDate`: The customer's loyalty program join date in RFC3339 format.
* @param loyaltyProgramId The identifier of the loyalty program. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -8162,8 +8164,8 @@ public okhttp3.Call exportLoyaltyJoinDatesAsync(@javax.annotation.Nonnull String
}
/**
* Build call for exportLoyaltyLedger
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param loyaltyProgramId The identifier for the loyalty program. (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 dateFormat Determines the format of dates in the export document. (optional)
@@ -8231,7 +8233,7 @@ public okhttp3.Call exportLoyaltyLedgerCall(@javax.annotation.Nonnull OffsetDate
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8263,9 +8265,9 @@ private okhttp3.Call exportLoyaltyLedgerValidateBeforeCall(@javax.annotation.Non
/**
* Export customer's transaction logs
- * Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * Download a CSV file containing a customer's transaction logs in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param loyaltyProgramId The identifier for the loyalty program. (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 dateFormat Determines the format of dates in the export document. (optional)
@@ -8285,9 +8287,9 @@ public String exportLoyaltyLedger(@javax.annotation.Nonnull OffsetDateTime range
/**
* Export customer's transaction logs
- * Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * Download a CSV file containing a customer's transaction logs in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param loyaltyProgramId The identifier for the loyalty program. (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 dateFormat Determines the format of dates in the export document. (optional)
@@ -8308,9 +8310,9 @@ public ApiResponse exportLoyaltyLedgerWithHttpInfo(@javax.annotation.Non
/**
* Export customer's transaction logs (asynchronously)
- * Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * Download a CSV file containing a customer's transaction logs in the loyalty program. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param loyaltyProgramId The identifier for the loyalty program. (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 dateFormat Determines the format of dates in the export document. (optional)
@@ -8396,7 +8398,7 @@ public okhttp3.Call exportPoolGiveawaysCall(@javax.annotation.Nonnull Long poolI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8413,7 +8415,7 @@ private okhttp3.Call exportPoolGiveawaysValidateBeforeCall(@javax.annotation.Non
/**
* Export giveaway codes of a giveaway pool
- * Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+ * Download a CSV file containing the giveaway codes of a specific giveaway pool. > [!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: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param createdBefore Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. (optional)
* @param createdAfter Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. (optional)
@@ -8434,7 +8436,7 @@ public String exportPoolGiveaways(@javax.annotation.Nonnull Long poolId, @javax.
/**
* Export giveaway codes of a giveaway pool
- * Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+ * Download a CSV file containing the giveaway codes of a specific giveaway pool. > [!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: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param createdBefore Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. (optional)
* @param createdAfter Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. (optional)
@@ -8456,7 +8458,7 @@ public ApiResponse exportPoolGiveawaysWithHttpInfo(@javax.annotation.Non
/**
* Export giveaway codes of a giveaway pool (asynchronously)
- * Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+ * Download a CSV file containing the giveaway codes of a specific giveaway pool. > [!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: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param createdBefore Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. (optional)
* @param createdAfter Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. (optional)
@@ -8567,7 +8569,7 @@ public okhttp3.Call exportReferralsCall(@javax.annotation.Nonnull Long applicati
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8584,7 +8586,7 @@ private okhttp3.Call exportReferralsValidateBeforeCall(@javax.annotation.Nonnull
/**
* Export referrals
- * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
+ * Download a CSV file containing the referrals that match the given parameters. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -8609,7 +8611,7 @@ public String exportReferrals(@javax.annotation.Nonnull Long applicationId, @jav
/**
* Export referrals
- * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
+ * Download a CSV file containing the referrals that match the given parameters. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -8635,7 +8637,7 @@ public ApiResponse exportReferralsWithHttpInfo(@javax.annotation.Nonnull
/**
* Export referrals (asynchronously)
- * Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
+ * Download a CSV file containing the referrals that match the given parameters. > [!tip] If the exported CSV file is too large to view, you can > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId Filter results by campaign ID. (optional)
* @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
@@ -8733,7 +8735,7 @@ public okhttp3.Call generateCouponRejectionsCall(@javax.annotation.Nonnull Strin
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8818,8 +8820,8 @@ public okhttp3.Call generateCouponRejectionsAsync(@javax.annotation.Nonnull Stri
/**
* Build call for getAccessLogsWithoutTotalCount
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param path Only return results where the request path matches the given regular expression. (optional)
* @param method Only return results where the request method matches the given regular expression. (optional)
* @param status Filter results by HTTP status codes. (optional)
@@ -8909,7 +8911,7 @@ public okhttp3.Call getAccessLogsWithoutTotalCountCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -8938,8 +8940,8 @@ private okhttp3.Call getAccessLogsWithoutTotalCountValidateBeforeCall(@javax.ann
* Get access logs for Application
* Retrieve the list of API calls sent to the specified Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param path Only return results where the request path matches the given regular expression. (optional)
* @param method Only return results where the request method matches the given regular expression. (optional)
* @param status Filter results by HTTP status codes. (optional)
@@ -8964,8 +8966,8 @@ public GetAccessLogsWithoutTotalCount200Response getAccessLogsWithoutTotalCount(
* Get access logs for Application
* Retrieve the list of API calls sent to the specified Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param path Only return results where the request path matches the given regular expression. (optional)
* @param method Only return results where the request method matches the given regular expression. (optional)
* @param status Filter results by HTTP status codes. (optional)
@@ -8991,8 +8993,8 @@ public ApiResponse getAccessLogsWitho
* Get access logs for Application (asynchronously)
* Retrieve the list of API calls sent to the specified Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param path Only return results where the request path matches the given regular expression. (optional)
* @param method Only return results where the request method matches the given regular expression. (optional)
* @param status Filter results by HTTP status codes. (optional)
@@ -9018,7 +9020,7 @@ public okhttp3.Call getAccessLogsWithoutTotalCountAsync(@javax.annotation.Nonnul
}
/**
* Build call for getAccount
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -9070,7 +9072,7 @@ public okhttp3.Call getAccountCall(@javax.annotation.Nonnull Long accountId, fin
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9088,7 +9090,7 @@ private okhttp3.Call getAccountValidateBeforeCall(@javax.annotation.Nonnull Long
/**
* Get account details
* Return the details of your companies Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @return Account
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9106,7 +9108,7 @@ public Account getAccount(@javax.annotation.Nonnull Long accountId) throws ApiEx
/**
* Get account details
* Return the details of your companies Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @return ApiResponse<Account>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9125,7 +9127,7 @@ public ApiResponse getAccountWithHttpInfo(@javax.annotation.Nonnull Lon
/**
* Get account details (asynchronously)
* Return the details of your companies Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (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
@@ -9145,7 +9147,7 @@ public okhttp3.Call getAccountAsync(@javax.annotation.Nonnull Long accountId, fi
}
/**
* Build call for getAccountAnalytics
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -9197,7 +9199,7 @@ public okhttp3.Call getAccountAnalyticsCall(@javax.annotation.Nonnull Long accou
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9215,7 +9217,7 @@ private okhttp3.Call getAccountAnalyticsValidateBeforeCall(@javax.annotation.Non
/**
* Get account analytics
* Return the analytics of your Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @return AccountAnalytics
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9233,7 +9235,7 @@ public AccountAnalytics getAccountAnalytics(@javax.annotation.Nonnull Long accou
/**
* Get account analytics
* Return the analytics of your Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (required)
* @return ApiResponse<AccountAnalytics>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9252,7 +9254,7 @@ public ApiResponse getAccountAnalyticsWithHttpInfo(@javax.anno
/**
* Get account analytics (asynchronously)
* Return the analytics of your Talon.One account.
- * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. (required)
+ * @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property. (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
@@ -9272,7 +9274,7 @@ public okhttp3.Call getAccountAnalyticsAsync(@javax.annotation.Nonnull Long acco
}
/**
* Build call for getAccountCollection
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -9325,7 +9327,7 @@ public okhttp3.Call getAccountCollectionCall(@javax.annotation.Nonnull Long coll
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9343,7 +9345,7 @@ private okhttp3.Call getAccountCollectionValidateBeforeCall(@javax.annotation.No
/**
* Get account-level collection
* Retrieve a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @return Collection
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9362,7 +9364,7 @@ public Collection getAccountCollection(@javax.annotation.Nonnull Long collection
/**
* Get account-level collection
* Retrieve a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @return ApiResponse<Collection>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -9382,7 +9384,7 @@ public ApiResponse getAccountCollectionWithHttpInfo(@javax.annotatio
/**
* Get account-level collection (asynchronously)
* Retrieve a given account-level collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (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
@@ -9461,7 +9463,7 @@ public okhttp3.Call getAchievementCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9610,7 +9612,7 @@ public okhttp3.Call getAdditionalCostCall(@javax.annotation.Nonnull Long additio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9750,7 +9752,7 @@ public okhttp3.Call getAdditionalCostsCall(@javax.annotation.Nullable Long pageS
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -9878,7 +9880,7 @@ public okhttp3.Call getApplicationCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10005,7 +10007,7 @@ public okhttp3.Call getApplicationApiHealthCall(@javax.annotation.Nonnull Long a
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10081,7 +10083,7 @@ public okhttp3.Call getApplicationApiHealthAsync(@javax.annotation.Nonnull Long
/**
* Build call for getApplicationCustomer
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -10134,7 +10136,7 @@ public okhttp3.Call getApplicationCustomerCall(@javax.annotation.Nonnull Long ap
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10158,7 +10160,7 @@ private okhttp3.Call getApplicationCustomerValidateBeforeCall(@javax.annotation.
* Get application's customer
* Retrieve the customers of the specified application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return ApplicationCustomer
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -10177,7 +10179,7 @@ public ApplicationCustomer getApplicationCustomer(@javax.annotation.Nonnull Long
* Get application's customer
* Retrieve the customers of the specified application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return ApiResponse<ApplicationCustomer>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -10197,7 +10199,7 @@ public ApiResponse getApplicationCustomerWithHttpInfo(@java
* Get application's customer (asynchronously)
* Retrieve the customers of the specified application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (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
@@ -10291,7 +10293,7 @@ public okhttp3.Call getApplicationCustomerFriendsCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10458,7 +10460,7 @@ public okhttp3.Call getApplicationCustomersCall(@javax.annotation.Nonnull Long a
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10614,7 +10616,7 @@ public okhttp3.Call getApplicationCustomersByAttributesCall(@javax.annotation.No
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10773,7 +10775,7 @@ public okhttp3.Call getApplicationEventTypesCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -10984,7 +10986,7 @@ public okhttp3.Call getApplicationEventsWithoutTotalCountCall(@javax.annotation.
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11158,7 +11160,7 @@ public okhttp3.Call getApplicationSessionCall(@javax.annotation.Nonnull Long app
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11353,7 +11355,7 @@ public okhttp3.Call getApplicationSessionsCall(@javax.annotation.Nonnull Long ap
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11529,7 +11531,7 @@ public okhttp3.Call getApplicationsCall(@javax.annotation.Nullable Long pageSize
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11657,7 +11659,7 @@ public okhttp3.Call getAttributeCall(@javax.annotation.Nonnull Long attributeId,
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11822,7 +11824,7 @@ public okhttp3.Call getAttributesCall(@javax.annotation.Nullable Long pageSize,
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -11986,7 +11988,7 @@ public okhttp3.Call getAudienceMembershipsCall(@javax.annotation.Nonnull Long au
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12146,7 +12148,7 @@ public okhttp3.Call getAudiencesCall(@javax.annotation.Nullable Long pageSize, @
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12285,7 +12287,7 @@ public okhttp3.Call getAudiencesAnalyticsCall(@javax.annotation.Nonnull String a
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12417,7 +12419,7 @@ public okhttp3.Call getCampaignCall(@javax.annotation.Nonnull Long applicationId
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12502,8 +12504,8 @@ public okhttp3.Call getCampaignAsync(@javax.annotation.Nonnull Long applicationI
* Build call for getCampaignAnalytics
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param granularity The time interval between the results in the returned time-series. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -12569,7 +12571,7 @@ public okhttp3.Call getCampaignAnalyticsCall(@javax.annotation.Nonnull Long appl
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12604,8 +12606,8 @@ private okhttp3.Call getCampaignAnalyticsValidateBeforeCall(@javax.annotation.No
* Retrieve statistical data about the performance of the given campaign.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param granularity The time interval between the results in the returned time-series. (optional)
* @return GetCampaignAnalytics200Response
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -12626,8 +12628,8 @@ public GetCampaignAnalytics200Response getCampaignAnalytics(@javax.annotation.No
* Retrieve statistical data about the performance of the given campaign.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param granularity The time interval between the results in the returned time-series. (optional)
* @return ApiResponse<GetCampaignAnalytics200Response>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -12649,8 +12651,8 @@ public ApiResponse getCampaignAnalyticsWithHttp
* Retrieve statistical data about the performance of the given campaign.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param granularity The time interval between the results in the returned time-series. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -12745,7 +12747,7 @@ public okhttp3.Call getCampaignByAttributesCall(@javax.annotation.Nonnull Long a
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -12892,7 +12894,7 @@ public okhttp3.Call getCampaignGroupCall(@javax.annotation.Nonnull Long campaign
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13032,7 +13034,7 @@ public okhttp3.Call getCampaignGroupsCall(@javax.annotation.Nullable Long pageSi
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13193,7 +13195,7 @@ public okhttp3.Call getCampaignTemplatesCall(@javax.annotation.Nullable Long pag
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13409,7 +13411,7 @@ public okhttp3.Call getCampaignsCall(@javax.annotation.Nonnull Long applicationI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13637,7 +13639,7 @@ public okhttp3.Call getChangesCall(@javax.annotation.Nullable Long pageSize, @ja
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13739,7 +13741,7 @@ public okhttp3.Call getChangesAsync(@javax.annotation.Nullable Long pageSize, @j
* Build call for getCollection
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -13794,7 +13796,7 @@ public okhttp3.Call getCollectionCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13824,7 +13826,7 @@ private okhttp3.Call getCollectionValidateBeforeCall(@javax.annotation.Nonnull L
* Retrieve a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @return Collection
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -13845,7 +13847,7 @@ public Collection getCollection(@javax.annotation.Nonnull Long applicationId, @j
* Retrieve a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @return ApiResponse<Collection>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -13867,7 +13869,7 @@ public ApiResponse getCollectionWithHttpInfo(@javax.annotation.Nonnu
* Retrieve a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (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
@@ -13888,7 +13890,7 @@ public okhttp3.Call getCollectionAsync(@javax.annotation.Nonnull Long applicatio
}
/**
* Build call for getCollectionItems
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param _callback Callback for upload/download progress
@@ -13951,7 +13953,7 @@ public okhttp3.Call getCollectionItemsCall(@javax.annotation.Nonnull Long collec
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -13969,7 +13971,7 @@ private okhttp3.Call getCollectionItemsValidateBeforeCall(@javax.annotation.Nonn
/**
* Get collection items
* Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @return GetCollectionItems200Response
@@ -13990,7 +13992,7 @@ public GetCollectionItems200Response getCollectionItems(@javax.annotation.Nonnul
/**
* Get collection items
* Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @return ApiResponse<GetCollectionItems200Response>
@@ -14012,7 +14014,7 @@ public ApiResponse getCollectionItemsWithHttpInfo
/**
* Get collection items (asynchronously)
* Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -14179,7 +14181,7 @@ public okhttp3.Call getCouponsWithoutTotalCountCall(@javax.annotation.Nonnull Lo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -14316,10 +14318,10 @@ public okhttp3.Call getCouponsWithoutTotalCountAsync(@javax.annotation.Nonnull L
}
/**
* Build call for getCustomerActivityReport
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param _callback Callback for upload/download progress
@@ -14390,7 +14392,7 @@ public okhttp3.Call getCustomerActivityReportCall(@javax.annotation.Nonnull Offs
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -14423,10 +14425,10 @@ private okhttp3.Call getCustomerActivityReportValidateBeforeCall(@javax.annotati
/**
* Get customer's activity report
* Fetch the summary report of a given customer in the given application, in a time range.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @return CustomerActivityReport
@@ -14446,10 +14448,10 @@ public CustomerActivityReport getCustomerActivityReport(@javax.annotation.Nonnul
/**
* Get customer's activity report
* Fetch the summary report of a given customer in the given application, in a time range.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @return ApiResponse<CustomerActivityReport>
@@ -14470,10 +14472,10 @@ public ApiResponse getCustomerActivityReportWithHttpInfo
/**
* Get customer's activity report (asynchronously)
* Fetch the summary report of a given customer in the given application, in a time range.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -14495,8 +14497,8 @@ public okhttp3.Call getCustomerActivityReportAsync(@javax.annotation.Nonnull Off
}
/**
* Build call for getCustomerActivityReportsWithoutTotalCount
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @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 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
@@ -14592,7 +14594,7 @@ public okhttp3.Call getCustomerActivityReportsWithoutTotalCountCall(@javax.annot
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -14620,8 +14622,8 @@ private okhttp3.Call getCustomerActivityReportsWithoutTotalCountValidateBeforeCa
/**
* Get Activity Reports for Application Customers
* Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @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 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
@@ -14647,8 +14649,8 @@ public GetCustomerActivityReportsWithoutTotalCount200Response getCustomerActivit
/**
* Get Activity Reports for Application Customers
* Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @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 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
@@ -14675,8 +14677,8 @@ public ApiResponse getCu
/**
* Get Activity Reports for Application Customers (asynchronously)
* Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @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 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
@@ -14705,7 +14707,7 @@ public okhttp3.Call getCustomerActivityReportsWithoutTotalCountAsync(@javax.anno
/**
* Build call for getCustomerAnalytics
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param 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)
@@ -14773,7 +14775,7 @@ public okhttp3.Call getCustomerAnalyticsCall(@javax.annotation.Nonnull Long appl
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -14797,7 +14799,7 @@ private okhttp3.Call getCustomerAnalyticsValidateBeforeCall(@javax.annotation.No
* Get customer's analytics report
* Fetch analytics for a given customer in the given application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param 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)
@@ -14819,7 +14821,7 @@ public CustomerAnalytics getCustomerAnalytics(@javax.annotation.Nonnull Long app
* Get customer's analytics report
* Fetch analytics for a given customer in the given application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param 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)
@@ -14842,7 +14844,7 @@ public ApiResponse getCustomerAnalyticsWithHttpInfo(@javax.an
* Get customer's analytics report (asynchronously)
* Fetch analytics for a given customer in the given application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param 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)
@@ -14865,7 +14867,7 @@ public okhttp3.Call getCustomerAnalyticsAsync(@javax.annotation.Nonnull Long app
}
/**
* Build call for getCustomerProfile
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -14917,7 +14919,7 @@ public okhttp3.Call getCustomerProfileCall(@javax.annotation.Nonnull Long custom
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -14934,8 +14936,8 @@ private okhttp3.Call getCustomerProfileValidateBeforeCall(@javax.annotation.Nonn
/**
* Get customer profile
- * Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Return the details of the specified customer profile. > [!note] > You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options: > - Request the customer profile to be part of the response content using > [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). > - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return CustomerProfile
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -14952,8 +14954,8 @@ public CustomerProfile getCustomerProfile(@javax.annotation.Nonnull Long custome
/**
* Get customer profile
- * Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Return the details of the specified customer profile. > [!note] > You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options: > - Request the customer profile to be part of the response content using > [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). > - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return ApiResponse<CustomerProfile>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -14971,8 +14973,8 @@ public ApiResponse getCustomerProfileWithHttpInfo(@javax.annota
/**
* Get customer profile (asynchronously)
- * Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
- * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Return the details of the specified customer profile. > [!note] > You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options: > - Request the customer profile to be part of the response content using > [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). > - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
+ * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (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
@@ -15068,7 +15070,7 @@ public okhttp3.Call getCustomerProfileAchievementProgressCall(@javax.annotation.
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15234,7 +15236,7 @@ public okhttp3.Call getCustomerProfilesCall(@javax.annotation.Nullable Long page
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15377,7 +15379,7 @@ public okhttp3.Call getCustomersByAttributesCall(@javax.annotation.Nonnull Custo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15462,8 +15464,8 @@ public okhttp3.Call getCustomersByAttributesAsync(@javax.annotation.Nonnull Cust
/**
* Build call for getDashboardStatistics
* @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)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -15528,7 +15530,7 @@ public okhttp3.Call getDashboardStatisticsCall(@javax.annotation.Nonnull Long lo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15555,10 +15557,10 @@ private okhttp3.Call getDashboardStatisticsValidateBeforeCall(@javax.annotation.
/**
* Get statistics for loyalty dashboard
- * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
+ * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. > [!important] The returned data does not include the current day. All statistics > are updated daily at 11:59 PM in the loyalty program time zone.
* @param 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)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @return GetDashboardStatistics200Response
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -15576,10 +15578,10 @@ public GetDashboardStatistics200Response getDashboardStatistics(@javax.annotatio
/**
* Get statistics for loyalty dashboard
- * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
+ * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. > [!important] The returned data does not include the current day. All statistics > are updated daily at 11:59 PM in the loyalty program time zone.
* @param 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)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @return ApiResponse<GetDashboardStatistics200Response>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -15598,10 +15600,10 @@ public ApiResponse getDashboardStatisticsWith
/**
* Get statistics for loyalty dashboard (asynchronously)
- * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
+ * Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. > [!important] The returned data does not include the current day. All statistics > are updated daily at 11:59 PM in the loyalty program time zone.
* @param 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)
- * @param rangeStart Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
- * @param rangeEnd Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeStart Only return results from after this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
+ * @param rangeEnd Only return results from before this timestamp. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (required)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -15697,7 +15699,7 @@ public okhttp3.Call getEventTypesCall(@javax.annotation.Nullable String name, @j
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15833,7 +15835,7 @@ public okhttp3.Call getExperimentCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -15991,7 +15993,7 @@ public okhttp3.Call getExportsCall(@javax.annotation.Nullable Long pageSize, @ja
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16130,7 +16132,7 @@ public okhttp3.Call getLoyaltyCardCall(@javax.annotation.Nonnull Long loyaltyPro
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16224,8 +16226,8 @@ public okhttp3.Call getLoyaltyCardAsync(@javax.annotation.Nonnull Long loyaltyPr
* Build call for getLoyaltyCardTransactionLogs
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
@@ -16313,7 +16315,7 @@ public okhttp3.Call getLoyaltyCardTransactionLogsCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16338,8 +16340,8 @@ private okhttp3.Call getLoyaltyCardTransactionLogsValidateBeforeCall(@javax.anno
* Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
@@ -16366,8 +16368,8 @@ public GetLoyaltyCardTransactionLogs200Response getLoyaltyCardTransactionLogs(@j
* Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
@@ -16395,8 +16397,8 @@ public ApiResponse getLoyaltyCardTrans
* Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param 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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
@@ -16507,7 +16509,7 @@ public okhttp3.Call getLoyaltyCardsCall(@javax.annotation.Nonnull Long loyaltyPr
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16608,7 +16610,7 @@ public okhttp3.Call getLoyaltyCardsAsync(@javax.annotation.Nonnull Long loyaltyP
* Build call for getLoyaltyLedgerBalances
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -16683,7 +16685,7 @@ public okhttp3.Call getLoyaltyLedgerBalancesCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16705,10 +16707,10 @@ private okhttp3.Call getLoyaltyLedgerBalancesValidateBeforeCall(@javax.annotatio
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -16731,10 +16733,10 @@ public LoyaltyBalancesWithTiers getLoyaltyLedgerBalances(@javax.annotation.Nonnu
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -16758,10 +16760,10 @@ public ApiResponse getLoyaltyLedgerBalancesWithHttpInf
/**
* Get customer's loyalty balances (asynchronously)
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -16843,7 +16845,7 @@ public okhttp3.Call getLoyaltyPointsCall(@javax.annotation.Nonnull String loyalt
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -16866,7 +16868,7 @@ private okhttp3.Call getLoyaltyPointsValidateBeforeCall(@javax.annotation.Nonnul
/**
* Get customer's full loyalty ledger
- * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @param loyaltyProgramId The identifier for the loyalty program. (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)
* @return LoyaltyLedger
@@ -16887,7 +16889,7 @@ public LoyaltyLedger getLoyaltyPoints(@javax.annotation.Nonnull String loyaltyPr
/**
* Get customer's full loyalty ledger
- * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @param loyaltyProgramId The identifier for the loyalty program. (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)
* @return ApiResponse<LoyaltyLedger>
@@ -16909,7 +16911,7 @@ public ApiResponse getLoyaltyPointsWithHttpInfo(@javax.annotation
/**
* Get customer's full loyalty ledger (asynchronously)
- * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @param loyaltyProgramId The identifier for the loyalty program. (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 _callback The callback to be executed when the API call finishes
@@ -16985,7 +16987,7 @@ public okhttp3.Call getLoyaltyProgramCall(@javax.annotation.Nonnull Long loyalty
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -17002,7 +17004,7 @@ private okhttp3.Call getLoyaltyProgramValidateBeforeCall(@javax.annotation.Nonnu
/**
* Get loyalty program
- * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+ * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#tag/Loyalty/operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory).
* @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)
* @return LoyaltyProgram
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -17020,7 +17022,7 @@ public LoyaltyProgram getLoyaltyProgram(@javax.annotation.Nonnull Long loyaltyPr
/**
* Get loyalty program
- * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+ * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#tag/Loyalty/operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory).
* @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)
* @return ApiResponse<LoyaltyProgram>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -17039,7 +17041,7 @@ public ApiResponse getLoyaltyProgramWithHttpInfo(@javax.annotati
/**
* Get loyalty program (asynchronously)
- * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
+ * Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#tag/Loyalty/operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory).
* @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)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -17062,12 +17064,12 @@ public okhttp3.Call getLoyaltyProgramAsync(@javax.annotation.Nonnull Long loyalt
* Build call for getLoyaltyProgramProfileLedgerTransactions
* @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 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 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 subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17162,7 +17164,7 @@ public okhttp3.Call getLoyaltyProgramProfileLedgerTransactionsCall(@javax.annota
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -17184,15 +17186,15 @@ private okhttp3.Call getLoyaltyProgramProfileLedgerTransactionsValidateBeforeCal
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17215,15 +17217,15 @@ public GetLoyaltyProgramProfileTransactions200Response getLoyaltyProgramProfileL
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17247,15 +17249,15 @@ public ApiResponse getLoyaltyPr
/**
* List customer's loyalty transactions (asynchronously)
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param 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 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 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 subledgerId The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17284,10 +17286,10 @@ public okhttp3.Call getLoyaltyProgramProfileLedgerTransactionsAsync(@javax.annot
* @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)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param 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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17381,7 +17383,7 @@ public okhttp3.Call getLoyaltyProgramTransactionsCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -17398,14 +17400,14 @@ private okhttp3.Call getLoyaltyProgramTransactionsValidateBeforeCall(@javax.anno
/**
* List loyalty program transactions
- * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. > [!note] **Note** > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. > - To get loyalty transaction logs for a given Integration ID in > a loyalty program, we recommend using the Integration API's [Get customer's loyalty > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @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)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param 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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17428,14 +17430,14 @@ public GetLoyaltyProgramTransactions200Response getLoyaltyProgramTransactions(@j
/**
* List loyalty program transactions
- * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. > [!note] **Note** > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. > - To get loyalty transaction logs for a given Integration ID in > a loyalty program, we recommend using the Integration API's [Get customer's loyalty > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @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)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param 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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17459,14 +17461,14 @@ public ApiResponse getLoyaltyProgramTr
/**
* List loyalty program transactions (asynchronously)
- * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ * Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. > [!note] **Note** > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. > - To get loyalty transaction logs for a given Integration ID in > a loyalty program, we recommend using the Integration API's [Get customer's loyalty > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
* @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)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param 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 startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param 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 awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -17542,7 +17544,7 @@ public okhttp3.Call getLoyaltyProgramsCall(final ApiCallback _callback) throws A
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -17663,7 +17665,7 @@ public okhttp3.Call getLoyaltyStatisticsCall(@javax.annotation.Nonnull Long loya
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -17681,7 +17683,7 @@ private okhttp3.Call getLoyaltyStatisticsValidateBeforeCall(@javax.annotation.No
/**
* Get loyalty program statistics
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
+ * > [warning] This endpoint is deprecated. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
* @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)
* @return LoyaltyDashboardData
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -17701,7 +17703,7 @@ public LoyaltyDashboardData getLoyaltyStatistics(@javax.annotation.Nonnull Long
/**
* Get loyalty program statistics
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
+ * > [warning] This endpoint is deprecated. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
* @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)
* @return ApiResponse<LoyaltyDashboardData>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -17722,7 +17724,7 @@ public ApiResponse getLoyaltyStatisticsWithHttpInfo(@javax
/**
* Get loyalty program statistics (asynchronously)
- * ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
+ * > [warning] This endpoint is deprecated. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
* @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)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -17865,7 +17867,7 @@ public okhttp3.Call getMessageLogsCall(@javax.annotation.Nonnull String entityTy
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18078,7 +18080,7 @@ public okhttp3.Call getReferralsWithoutTotalCountCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18240,7 +18242,7 @@ public okhttp3.Call getRoleV2Call(@javax.annotation.Nonnull Long roleId, final A
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18371,7 +18373,7 @@ public okhttp3.Call getRulesetCall(@javax.annotation.Nonnull Long applicationId,
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18531,7 +18533,7 @@ public okhttp3.Call getRulesetsCall(@javax.annotation.Nonnull Long applicationId
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18678,7 +18680,7 @@ public okhttp3.Call getStoreCall(@javax.annotation.Nonnull Long applicationId, @
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18816,7 +18818,7 @@ public okhttp3.Call getUserCall(@javax.annotation.Nonnull Long userId, final Api
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -18956,7 +18958,7 @@ public okhttp3.Call getUsersCall(@javax.annotation.Nullable Long pageSize, @java
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19084,7 +19086,7 @@ public okhttp3.Call getWebhookCall(@javax.annotation.Nonnull Long webhookId, fin
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19249,7 +19251,7 @@ public okhttp3.Call getWebhooksCall(@javax.annotation.Nullable String applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19340,7 +19342,7 @@ public okhttp3.Call getWebhooksAsync(@javax.annotation.Nullable String applicati
}
/**
* Build call for importAccountCollection
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -19400,7 +19402,7 @@ public okhttp3.Call importAccountCollectionCall(@javax.annotation.Nonnull Long c
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19417,8 +19419,8 @@ private okhttp3.Call importAccountCollectionValidateBeforeCall(@javax.annotation
/**
* Import data into existing account-level collection
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param upFile The 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
@@ -19438,8 +19440,8 @@ public ModelImport importAccountCollection(@javax.annotation.Nonnull Long collec
/**
* Import data into existing account-level collection
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param upFile The 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
@@ -19460,8 +19462,8 @@ public ApiResponse importAccountCollectionWithHttpInfo(@javax.annot
/**
* Import data into existing account-level collection (asynchronously)
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param upFile The 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
@@ -19545,7 +19547,7 @@ public okhttp3.Call importAllowedListCall(@javax.annotation.Nonnull Long attribu
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19562,7 +19564,7 @@ private okhttp3.Call importAllowedListValidateBeforeCall(@javax.annotation.Nonnu
/**
* Import allowed values for attribute
- * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
+ * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item`: The values in your allowed list, for example a list of SKUs. An allowed list is limited to 500,000 items. ## Example ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
* @param attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ModelImport
@@ -19584,7 +19586,7 @@ public ModelImport importAllowedList(@javax.annotation.Nonnull Long attributeId,
/**
* Import allowed values for attribute
- * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
+ * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item`: The values in your allowed list, for example a list of SKUs. An allowed list is limited to 500,000 items. ## Example ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
* @param attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ApiResponse<ModelImport>
@@ -19607,7 +19609,7 @@ public ApiResponse importAllowedListWithHttpInfo(@javax.annotation.
/**
* Import allowed values for attribute (asynchronously)
- * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
+ * Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item`: The values in your allowed list, for example a list of SKUs. An allowed list is limited to 500,000 items. ## Example ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
* @param attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -19693,7 +19695,7 @@ public okhttp3.Call importAudiencesMembershipsCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -19710,7 +19712,7 @@ private okhttp3.Call importAudiencesMembershipsValidateBeforeCall(@javax.annotat
/**
* Import audience members
- * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
+ * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text profileintegrationid charles alexa ```
* @param audienceId The ID of the audience. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ModelImport
@@ -19732,7 +19734,7 @@ public ModelImport importAudiencesMemberships(@javax.annotation.Nonnull Long aud
/**
* Import audience members
- * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
+ * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text profileintegrationid charles alexa ```
* @param audienceId The ID of the audience. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ApiResponse<ModelImport>
@@ -19755,7 +19757,7 @@ public ApiResponse importAudiencesMembershipsWithHttpInfo(@javax.an
/**
* Import audience members (asynchronously)
- * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
+ * Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text profileintegrationid charles alexa ```
* @param audienceId The ID of the audience. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -19851,7 +19853,7 @@ public okhttp3.Call importCampaignStoreBudgetCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20009,7 +20011,7 @@ public okhttp3.Call importCampaignStoresCall(@javax.annotation.Nonnull Long appl
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20106,7 +20108,7 @@ public okhttp3.Call importCampaignStoresAsync(@javax.annotation.Nonnull Long app
* Build call for importCollection
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -20167,7 +20169,7 @@ public okhttp3.Call importCollectionCall(@javax.annotation.Nonnull Long applicat
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20194,10 +20196,10 @@ private okhttp3.Call importCollectionValidateBeforeCall(@javax.annotation.Nonnul
/**
* Import data into existing campaign-level collection
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param upFile The 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
@@ -20216,10 +20218,10 @@ public ModelImport importCollection(@javax.annotation.Nonnull Long applicationId
/**
* Import data into existing campaign-level collection
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param upFile The 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
@@ -20239,10 +20241,10 @@ public ApiResponse importCollectionWithHttpInfo(@javax.annotation.N
/**
* Import data into existing campaign-level collection (asynchronously)
- * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ * Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. ## Example ``` item Adidas Nike Asics ``` > [!note] Before sending a request to this endpoint, ensure the data in the > CSV to import is different from the data currently stored in the collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param upFile The 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
@@ -20329,7 +20331,7 @@ public okhttp3.Call importCouponsCall(@javax.annotation.Nonnull Long application
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20351,7 +20353,7 @@ private okhttp3.Call importCouponsValidateBeforeCall(@javax.annotation.Nonnull L
/**
* Import coupons
- * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+ * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param skipDuplicates An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`. (optional)
@@ -20372,7 +20374,7 @@ public ModelImport importCoupons(@javax.annotation.Nonnull Long applicationId, @
/**
* Import coupons
- * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+ * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param skipDuplicates An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`. (optional)
@@ -20394,7 +20396,7 @@ public ApiResponse importCouponsWithHttpInfo(@javax.annotation.Nonn
/**
* Import coupons (asynchronously)
- * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+ * Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. Must be at least 3 characters long. We recommend using alphanumeric characters. There is no maximum length but limiting the code to 30 characters ensures it is fully readable in the Campaign Manager. The code should be unique unless you set `skipDuplicates` to `true`. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param skipDuplicates An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`. (optional)
@@ -20478,7 +20480,7 @@ public okhttp3.Call importLoyaltyCardsCall(@javax.annotation.Nonnull Long loyalt
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20495,7 +20497,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:** We recommend limiting your file size to 500MB. **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 (;). > [!note] We recommend limiting your file size to 500MB. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
* @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 file containing the data that is being imported. (optional)
* @return ModelImport
@@ -20516,7 +20518,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:** We recommend limiting your file size to 500MB. **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 (;). > [!note] We recommend limiting your file size to 500MB. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
* @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 file containing the data that is being imported. (optional)
* @return ApiResponse<ModelImport>
@@ -20538,7 +20540,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:** We recommend limiting your file size to 500MB. **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 (;). > [!note] We recommend limiting your file size to 500MB. ## Example ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
* @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 file containing the data that is being imported. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -20623,7 +20625,7 @@ public okhttp3.Call importLoyaltyCustomersTiersCall(@javax.annotation.Nonnull Lo
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20640,7 +20642,7 @@ private okhttp3.Call importLoyaltyCustomersTiersValidateBeforeCall(@javax.annota
/**
* Import customers into loyalty tiers
- * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
+ * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. > [!important] This endpoint only works with loyalty programs with advanced > tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. > [!note] We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
* @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)
* @param upFile The file containing the data that is being imported. (optional)
* @return ModelImport
@@ -20662,7 +20664,7 @@ public ModelImport importLoyaltyCustomersTiers(@javax.annotation.Nonnull Long lo
/**
* Import customers into loyalty tiers
- * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
+ * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. > [!important] This endpoint only works with loyalty programs with advanced > tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. > [!note] We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
* @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)
* @param upFile The file containing the data that is being imported. (optional)
* @return ApiResponse<ModelImport>
@@ -20685,7 +20687,7 @@ public ApiResponse importLoyaltyCustomersTiersWithHttpInfo(@javax.a
/**
* Import customers into loyalty tiers (asynchronously)
- * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
+ * Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. > [!important] This endpoint only works with loyalty programs with advanced > tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. > [!note] We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] We recommend limiting your file size to 500 MB. ## Example ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
* @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)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -20773,7 +20775,7 @@ public okhttp3.Call importLoyaltyPointsCall(@javax.annotation.Nonnull Long loyal
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20790,7 +20792,7 @@ private okhttp3.Call importLoyaltyPointsValidateBeforeCall(@javax.annotation.Non
/**
* Import loyalty points
- * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
+ * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit.<br /> Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] For existing customer profiles and loyalty cards, the imported > points are added to any previous active or pending points, depending on the > value provided for `startdate`. If `startdate` matches the current date, the > imported points are _active_. If it is later, the points are _pending_ until > the date provided for `startdate` is reached. > [!note] We recommend limiting your file size to 500 MB. ## Example for profile-based programs ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` ## Example for card-based programs ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
* @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)
* @param notificationsEnabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`. (optional)
* @param upFile The file containing the data that is being imported. (optional)
@@ -20810,7 +20812,7 @@ public ModelImport importLoyaltyPoints(@javax.annotation.Nonnull Long loyaltyPro
/**
* Import loyalty points
- * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
+ * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit.<br /> Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] For existing customer profiles and loyalty cards, the imported > points are added to any previous active or pending points, depending on the > value provided for `startdate`. If `startdate` matches the current date, the > imported points are _active_. If it is later, the points are _pending_ until > the date provided for `startdate` is reached. > [!note] We recommend limiting your file size to 500 MB. ## Example for profile-based programs ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` ## Example for card-based programs ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
* @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)
* @param notificationsEnabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`. (optional)
* @param upFile The file containing the data that is being imported. (optional)
@@ -20831,7 +20833,7 @@ public ApiResponse importLoyaltyPointsWithHttpInfo(@javax.annotatio
/**
* Import loyalty points (asynchronously)
- * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
+ * Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **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. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. This parameter accepts one of the following values: - A timestamp string in RFC3339 format. - `immediate` - `on_action` **Note**: Empty or missing values default to `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. If passed, `validityDuration` should be omitted. - `validityDuration` (optional): The duration for which the points remain active, relative to the activation date. The time format is an **integer** followed by one letter indicating the time unit.<br /> Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `expirydate` should be omitted. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!note] For existing customer profiles and loyalty cards, the imported > points are added to any previous active or pending points, depending on the > value provided for `startdate`. If `startdate` matches the current date, the > imported points are _active_. If it is later, the points are _pending_ until > the date provided for `startdate` is reached. > [!note] We recommend limiting your file size to 500 MB. ## Example for profile-based programs ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` ## Example for card-based programs ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
* @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)
* @param notificationsEnabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`. (optional)
* @param upFile The file containing the data that is being imported. (optional)
@@ -20912,7 +20914,7 @@ public okhttp3.Call importPoolGiveawaysCall(@javax.annotation.Nonnull Long poolI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -20929,7 +20931,7 @@ private okhttp3.Call importPoolGiveawaysValidateBeforeCall(@javax.annotation.Non
/**
* Import giveaway codes into a giveaway pool
- * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
+ * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. > [!note] **Note** > - We recommend limiting your file size to 500MB. > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. ## Example ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ModelImport
@@ -20948,7 +20950,7 @@ public ModelImport importPoolGiveaways(@javax.annotation.Nonnull Long poolId, @j
/**
* Import giveaway codes into a giveaway pool
- * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
+ * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. > [!note] **Note** > - We recommend limiting your file size to 500MB. > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. ## Example ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @return ApiResponse<ModelImport>
@@ -20968,7 +20970,7 @@ public ApiResponse importPoolGiveawaysWithHttpInfo(@javax.annotatio
/**
* Import giveaway codes into a giveaway pool (asynchronously)
- * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
+ * Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. > [!note] **Note** > - We recommend limiting your file size to 500MB. > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. ## Example ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
* @param poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. (required)
* @param upFile The file containing the data that is being imported. (optional)
* @param _callback The callback to be executed when the API call finishes
@@ -21050,7 +21052,7 @@ public okhttp3.Call importReferralsCall(@javax.annotation.Nonnull Long applicati
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21072,7 +21074,7 @@ private okhttp3.Call importReferralsValidateBeforeCall(@javax.annotation.Nonnull
/**
* Import referrals
- * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
+ * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!important] When you import a CSV file with referrals, > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) > is **not** automatically created for each `advocateprofileintegrationid` > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) > endpoint to create the customer profiles. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param upFile The file containing the data that is being imported. (optional)
@@ -21092,7 +21094,7 @@ public ModelImport importReferrals(@javax.annotation.Nonnull Long applicationId,
/**
* Import referrals
- * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
+ * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!important] When you import a CSV file with referrals, > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) > is **not** automatically created for each `advocateprofileintegrationid` > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) > endpoint to create the customer profiles. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param upFile The file containing the data that is being imported. (optional)
@@ -21113,7 +21115,7 @@ public ApiResponse importReferralsWithHttpInfo(@javax.annotation.No
/**
* Import referrals (asynchronously)
- * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
+ * Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.<br /> For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. > [!important] When you import a CSV file with referrals, > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) > is **not** automatically created for each `advocateprofileintegrationid` > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) > endpoint to create the customer profiles. > [!note] We recommend limiting your file size to 500 MB. ## Example ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param upFile The file containing the data that is being imported. (optional)
@@ -21187,7 +21189,7 @@ public okhttp3.Call inviteUserExternalCall(@javax.annotation.Nonnull NewExternal
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21336,7 +21338,7 @@ public okhttp3.Call listAccountCollectionsCall(@javax.annotation.Nullable Long p
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21496,7 +21498,7 @@ public okhttp3.Call listAchievementsCall(@javax.annotation.Nonnull Long applicat
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21638,7 +21640,7 @@ public okhttp3.Call listAllRolesV2Call(final ApiCallback _callback) throws ApiEx
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21772,7 +21774,7 @@ public okhttp3.Call listCampaignStoreBudgetLimitsCall(@javax.annotation.Nonnull
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -21947,7 +21949,7 @@ public okhttp3.Call listCatalogItemsCall(@javax.annotation.Nonnull Long catalogI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22117,7 +22119,7 @@ public okhttp3.Call listCollectionsCall(@javax.annotation.Nonnull Long applicati
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22296,7 +22298,7 @@ public okhttp3.Call listCollectionsInApplicationCall(@javax.annotation.Nonnull L
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22456,7 +22458,7 @@ public okhttp3.Call listExperimentsCall(@javax.annotation.Nonnull Long applicati
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22632,7 +22634,7 @@ public okhttp3.Call listStoresCall(@javax.annotation.Nonnull Long applicationId,
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22780,7 +22782,7 @@ public okhttp3.Call oktaEventHandlerChallengeCall(final ApiCallback _callback) t
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22841,6 +22843,143 @@ public okhttp3.Call oktaEventHandlerChallengeAsync(final ApiCallback _call
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
+ /**
+ * Build call for priceHistory
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * @param priceHistoryRequest body (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 | - |
+
+ */
+ public okhttp3.Call priceHistoryCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, 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 = priceHistoryRequest;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/price_history"
+ .replace("{" + "applicationId" + "}", localVarApiClient.escapeString(applicationId.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 = {
+ "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 priceHistoryValidateBeforeCall(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, 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 priceHistory(Async)");
+ }
+
+ // verify the required parameter 'priceHistoryRequest' is set
+ if (priceHistoryRequest == null) {
+ throw new ApiException("Missing the required parameter 'priceHistoryRequest' when calling priceHistory(Async)");
+ }
+
+ return priceHistoryCall(applicationId, priceHistoryRequest, _callback);
+
+ }
+
+ /**
+ * Get summary of price history
+ * Fetch the historical price data for a given SKU within a defined timeframe.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * @param priceHistoryRequest body (required)
+ * @return PriceHistoryResponse
+ * @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 | - |
+
+ */
+ public PriceHistoryResponse priceHistory(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest) throws ApiException {
+ ApiResponse localVarResp = priceHistoryWithHttpInfo(applicationId, priceHistoryRequest);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Get summary of price history
+ * Fetch the historical price data for a given SKU within a defined timeframe.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * @param priceHistoryRequest body (required)
+ * @return ApiResponse<PriceHistoryResponse>
+ * @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 | - |
+
+ */
+ public ApiResponse priceHistoryWithHttpInfo(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest) throws ApiException {
+ okhttp3.Call localVarCall = priceHistoryValidateBeforeCall(applicationId, priceHistoryRequest, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Get summary of price history (asynchronously)
+ * Fetch the historical price data for a given SKU within a defined timeframe.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * @param priceHistoryRequest body (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 | - |
+
+ */
+ public okhttp3.Call priceHistoryAsync(@javax.annotation.Nonnull Long applicationId, @javax.annotation.Nonnull PriceHistoryRequest priceHistoryRequest, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = priceHistoryValidateBeforeCall(applicationId, priceHistoryRequest, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
/**
* Build call for removeLoyaltyPoints
* @param loyaltyProgramId The identifier for the loyalty program. (required)
@@ -22902,7 +23041,7 @@ public okhttp3.Call removeLoyaltyPointsCall(@javax.annotation.Nonnull String loy
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -22929,7 +23068,7 @@ private okhttp3.Call removeLoyaltyPointsValidateBeforeCall(@javax.annotation.Non
/**
* Deduct points from customer profile
- * Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Deduct points from the specified loyalty program and specified customer profile. > [!note] **Note** > - Only active points can be deducted. > - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 deductLoyaltyPoints body (required)
@@ -22950,7 +23089,7 @@ public void removeLoyaltyPoints(@javax.annotation.Nonnull String loyaltyProgramI
/**
* Deduct points from customer profile
- * Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Deduct points from the specified loyalty program and specified customer profile. > [!note] **Note** > - Only active points can be deducted. > - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 deductLoyaltyPoints body (required)
@@ -22973,7 +23112,7 @@ public ApiResponse removeLoyaltyPointsWithHttpInfo(@javax.annotation.Nonnu
/**
* Deduct points from customer profile (asynchronously)
- * Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ * Deduct points from the specified loyalty program and specified customer profile. > [!note] **Note** > - Only active points can be deducted. > - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
* @param loyaltyProgramId The identifier for the loyalty program. (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 deductLoyaltyPoints body (required)
@@ -23050,7 +23189,7 @@ public okhttp3.Call resetPasswordCall(@javax.annotation.Nonnull NewPassword newP
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23177,7 +23316,7 @@ public okhttp3.Call scimCreateGroupCall(@javax.annotation.Nonnull ScimBaseGroup
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23304,7 +23443,7 @@ public okhttp3.Call scimCreateUserCall(@javax.annotation.Nonnull ScimNewUser sci
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23430,7 +23569,7 @@ public okhttp3.Call scimDeleteGroupCall(@javax.annotation.Nonnull Long groupId,
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23552,7 +23691,7 @@ public okhttp3.Call scimDeleteUserCall(@javax.annotation.Nonnull Long userId, fi
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23675,7 +23814,7 @@ public okhttp3.Call scimGetGroupCall(@javax.annotation.Nonnull Long groupId, fin
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23800,7 +23939,7 @@ public okhttp3.Call scimGetGroupsCall(final ApiCallback _callback) throws ApiExc
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -23917,7 +24056,7 @@ public okhttp3.Call scimGetResourceTypesCall(final ApiCallback _callback) throws
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24034,7 +24173,7 @@ public okhttp3.Call scimGetSchemasCall(final ApiCallback _callback) throws ApiEx
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24151,7 +24290,7 @@ public okhttp3.Call scimGetServiceProviderConfigCall(final ApiCallback _callback
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24270,7 +24409,7 @@ public okhttp3.Call scimGetUserCall(@javax.annotation.Nonnull Long userId, final
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24395,7 +24534,7 @@ public okhttp3.Call scimGetUsersCall(final ApiCallback _callback) throws ApiExce
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24516,7 +24655,7 @@ public okhttp3.Call scimPatchGroupCall(@javax.annotation.Nonnull Long groupId, @
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24653,7 +24792,7 @@ public okhttp3.Call scimPatchUserCall(@javax.annotation.Nonnull Long userId, @ja
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24790,7 +24929,7 @@ public okhttp3.Call scimReplaceGroupAttributesCall(@javax.annotation.Nonnull Lon
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -24927,7 +25066,7 @@ public okhttp3.Call scimReplaceUserAttributesCall(@javax.annotation.Nonnull Long
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25129,7 +25268,7 @@ public okhttp3.Call searchCouponsAdvancedApplicationWideWithoutTotalCountCall(@j
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25151,7 +25290,7 @@ private okhttp3.Call searchCouponsAdvancedApplicationWideWithoutTotalCountValida
/**
* List coupons that match the given attributes (without total count)
- * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
@@ -25183,7 +25322,7 @@ public GetCouponsWithoutTotalCount200Response searchCouponsAdvancedApplicationWi
/**
* List coupons that match the given attributes (without total count)
- * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
@@ -25216,7 +25355,7 @@ public ApiResponse searchCouponsAdvanced
/**
* List coupons that match the given attributes (without total count) (asynchronously)
- * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
* @param pageSize The number of items in the response. (optional, default to 1000)
@@ -25367,7 +25506,7 @@ public okhttp3.Call searchCouponsAdvancedWithoutTotalCountCall(@javax.annotation
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25394,7 +25533,7 @@ private okhttp3.Call searchCouponsAdvancedWithoutTotalCountValidateBeforeCall(@j
/**
* List coupons that match the given attributes in campaign (without total count)
- * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
@@ -25426,7 +25565,7 @@ public GetCouponsWithoutTotalCount200Response searchCouponsAdvancedWithoutTotalC
/**
* List coupons that match the given attributes in campaign (without total count)
- * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
@@ -25459,7 +25598,7 @@ public ApiResponse searchCouponsAdvanced
/**
* List coupons that match the given attributes in campaign (without total count) (asynchronously)
- * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
+ * List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. > [!note] The total count is not included in the response.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
@@ -25551,7 +25690,7 @@ public okhttp3.Call summarizeCampaignStoreBudgetCall(@javax.annotation.Nonnull L
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25702,7 +25841,7 @@ public okhttp3.Call transferLoyaltyCardCall(@javax.annotation.Nonnull Long loyal
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25729,7 +25868,7 @@ private okhttp3.Call transferLoyaltyCardValidateBeforeCall(@javax.annotation.Non
/**
* Transfer card data
- * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
+ * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. > [!important] **Note** > - The original card is automatically blocked once the new card is created, and it cannot be activated again. > - The default status of the new card is _active_.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param transferLoyaltyCard body (required)
@@ -25750,7 +25889,7 @@ public void transferLoyaltyCard(@javax.annotation.Nonnull Long loyaltyProgramId,
/**
* Transfer card data
- * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
+ * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. > [!important] **Note** > - The original card is automatically blocked once the new card is created, and it cannot be activated again. > - The default status of the new card is _active_.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param transferLoyaltyCard body (required)
@@ -25773,7 +25912,7 @@ public ApiResponse transferLoyaltyCardWithHttpInfo(@javax.annotation.Nonnu
/**
* Transfer card data (asynchronously)
- * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
+ * Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. > [!important] **Note** > - The original card is automatically blocked once the new card is created, and it cannot be activated again. > - The default status of the new card is _active_.
* @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 loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param transferLoyaltyCard body (required)
@@ -25798,7 +25937,7 @@ public okhttp3.Call transferLoyaltyCardAsync(@javax.annotation.Nonnull Long loya
}
/**
* Build call for updateAccountCollection
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param updateCollection body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -25855,7 +25994,7 @@ public okhttp3.Call updateAccountCollectionCall(@javax.annotation.Nonnull Long c
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -25878,7 +26017,7 @@ private okhttp3.Call updateAccountCollectionValidateBeforeCall(@javax.annotation
/**
* Update account-level collection
* Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param updateCollection body (required)
* @return Collection
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -25900,7 +26039,7 @@ public Collection updateAccountCollection(@javax.annotation.Nonnull Long collect
/**
* Update account-level collection
* Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param updateCollection body (required)
* @return ApiResponse<Collection>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -25923,7 +26062,7 @@ public ApiResponse updateAccountCollectionWithHttpInfo(@javax.annota
/**
* Update account-level collection (asynchronously)
* Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.
- * @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in account](#tag/Collections/operation/listAccountCollections) endpoint. (required)
* @param updateCollection body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -26008,7 +26147,7 @@ public okhttp3.Call updateAchievementCall(@javax.annotation.Nonnull Long applica
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26170,7 +26309,7 @@ public okhttp3.Call updateAdditionalCostCall(@javax.annotation.Nonnull Long addi
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26307,7 +26446,7 @@ public okhttp3.Call updateAttributeCall(@javax.annotation.Nonnull Long attribute
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26446,7 +26585,7 @@ public okhttp3.Call updateCampaignCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26473,7 +26612,7 @@ private okhttp3.Call updateCampaignValidateBeforeCall(@javax.annotation.Nonnull
/**
* Update campaign
- * Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
+ * Update the given campaign. > [!important] You cannot use this endpoint to update campaigns if [campaign staging and > revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) > is enabled for your Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCampaign body (required)
@@ -26493,7 +26632,7 @@ public Campaign updateCampaign(@javax.annotation.Nonnull Long applicationId, @ja
/**
* Update campaign
- * Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
+ * Update the given campaign. > [!important] You cannot use this endpoint to update campaigns if [campaign staging and > revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) > is enabled for your Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCampaign body (required)
@@ -26514,7 +26653,7 @@ public ApiResponse updateCampaignWithHttpInfo(@javax.annotation.Nonnul
/**
* Update campaign (asynchronously)
- * Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
+ * Update the given campaign. > [!important] You cannot use this endpoint to update campaigns if [campaign staging and > revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) > is enabled for your Application.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCampaign body (required)
@@ -26539,7 +26678,7 @@ public okhttp3.Call updateCampaignAsync(@javax.annotation.Nonnull Long applicati
* Build call for updateCollection
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param updateCampaignCollection body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -26596,7 +26735,7 @@ public okhttp3.Call updateCollectionCall(@javax.annotation.Nonnull Long applicat
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26631,7 +26770,7 @@ private okhttp3.Call updateCollectionValidateBeforeCall(@javax.annotation.Nonnul
* Edit the description of a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param updateCampaignCollection body (required)
* @return Collection
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -26653,7 +26792,7 @@ public Collection updateCollection(@javax.annotation.Nonnull Long applicationId,
* Edit the description of a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param updateCampaignCollection body (required)
* @return ApiResponse<Collection>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -26676,7 +26815,7 @@ public ApiResponse updateCollectionWithHttpInfo(@javax.annotation.No
* Edit the description of a given campaign-level collection.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
- * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. (required)
+ * @param collectionId The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint. (required)
* @param updateCampaignCollection body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -26756,7 +26895,7 @@ public okhttp3.Call updateCouponCall(@javax.annotation.Nonnull Long applicationI
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26788,7 +26927,7 @@ private okhttp3.Call updateCouponValidateBeforeCall(@javax.annotation.Nonnull Lo
/**
* Update coupon
- * Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
+ * Update the specified coupon. > [!note] > With this `PUT` endpoint, if you do not explicitly set a value for the `startDate`, `expiryDate`, > and `recipientIntegrationId` properties in your request, it is automatically set to `null`.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param couponId The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. (required)
@@ -26809,7 +26948,7 @@ public Coupon updateCoupon(@javax.annotation.Nonnull Long applicationId, @javax.
/**
* Update coupon
- * Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
+ * Update the specified coupon. > [!note] > With this `PUT` endpoint, if you do not explicitly set a value for the `startDate`, `expiryDate`, > and `recipientIntegrationId` properties in your request, it is automatically set to `null`.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param couponId The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. (required)
@@ -26831,7 +26970,7 @@ public ApiResponse updateCouponWithHttpInfo(@javax.annotation.Nonnull Lo
/**
* Update coupon (asynchronously)
- * Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
+ * Update the specified coupon. > [!note] > With this `PUT` endpoint, if you do not explicitly set a value for the `startDate`, `expiryDate`, > and `recipientIntegrationId` properties in your request, it is automatically set to `null`.
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param couponId The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. (required)
@@ -26910,7 +27049,7 @@ public okhttp3.Call updateCouponBatchCall(@javax.annotation.Nonnull Long applica
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -26937,7 +27076,7 @@ private okhttp3.Call updateCouponBatchValidateBeforeCall(@javax.annotation.Nonnu
/**
* Update coupons
- * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code> and <code>expiryDate</code> properties in your request, it is automatically set to <code>null</code>.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
+ * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). > [!note] **Note** > - Only send sequential requests to this endpoint. > - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team. > - With this `PUT` endpoint, if you do not explicitly set a value for the `startDate` and `expiryDate` properties in your request, it is automatically set to `null`. To update a specific coupon, use [Update coupon](#tag/Coupons/operation/updateCoupon).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCouponBatch body (required)
@@ -26955,7 +27094,7 @@ public void updateCouponBatch(@javax.annotation.Nonnull Long applicationId, @jav
/**
* Update coupons
- * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code> and <code>expiryDate</code> properties in your request, it is automatically set to <code>null</code>.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
+ * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). > [!note] **Note** > - Only send sequential requests to this endpoint. > - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team. > - With this `PUT` endpoint, if you do not explicitly set a value for the `startDate` and `expiryDate` properties in your request, it is automatically set to `null`. To update a specific coupon, use [Update coupon](#tag/Coupons/operation/updateCoupon).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCouponBatch body (required)
@@ -26975,7 +27114,7 @@ public ApiResponse updateCouponBatchWithHttpInfo(@javax.annotation.Nonnull
/**
* Update coupons (asynchronously)
- * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code> and <code>expiryDate</code> properties in your request, it is automatically set to <code>null</code>.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
+ * Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). > [!note] **Note** > - Only send sequential requests to this endpoint. > - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team. > - With this `PUT` endpoint, if you do not explicitly set a value for the `startDate` and `expiryDate` properties in your request, it is automatically set to `null`. To update a specific coupon, use [Update coupon](#tag/Coupons/operation/updateCoupon).
* @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. (required)
* @param updateCouponBatch body (required)
@@ -27056,7 +27195,7 @@ public okhttp3.Call updateLoyaltyCardCall(@javax.annotation.Nonnull Long loyalty
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -27214,7 +27353,7 @@ public okhttp3.Call updateReferralCall(@javax.annotation.Nonnull Long applicatio
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -27367,7 +27506,7 @@ public okhttp3.Call updateRoleV2Call(@javax.annotation.Nonnull Long roleId, @jav
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -27508,7 +27647,7 @@ public okhttp3.Call updateStoreCall(@javax.annotation.Nonnull Long applicationId
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@@ -27659,7 +27798,7 @@ public okhttp3.Call updateUserCall(@javax.annotation.Nonnull Long userId, @javax
localVarHeaderParams.put("Content-Type", localVarContentType);
}
- String[] localVarAuthNames = new String[] { "management_key", "manager_auth", "api_key_v1" };
+ String[] localVarAuthNames = new String[] { "api_key_v1" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
diff --git a/src/main/java/one/talon/auth/ApiKeyAuth.java b/src/main/java/one/talon/auth/ApiKeyAuth.java
index ea01dd27..f91b7504 100644
--- a/src/main/java/one/talon/auth/ApiKeyAuth.java
+++ b/src/main/java/one/talon/auth/ApiKeyAuth.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/auth/Authentication.java b/src/main/java/one/talon/auth/Authentication.java
index cd173d87..7fc2a112 100644
--- a/src/main/java/one/talon/auth/Authentication.java
+++ b/src/main/java/one/talon/auth/Authentication.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/auth/HttpBasicAuth.java b/src/main/java/one/talon/auth/HttpBasicAuth.java
index 51a5558e..a8b21ce5 100644
--- a/src/main/java/one/talon/auth/HttpBasicAuth.java
+++ b/src/main/java/one/talon/auth/HttpBasicAuth.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/auth/HttpBearerAuth.java b/src/main/java/one/talon/auth/HttpBearerAuth.java
index 5131a112..074bfbfb 100644
--- a/src/main/java/one/talon/auth/HttpBearerAuth.java
+++ b/src/main/java/one/talon/auth/HttpBearerAuth.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/APIError.java b/src/main/java/one/talon/model/APIError.java
index 1b332eb0..c19286c6 100644
--- a/src/main/java/one/talon/model/APIError.java
+++ b/src/main/java/one/talon/model/APIError.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AbstractOpenApiSchema.java b/src/main/java/one/talon/model/AbstractOpenApiSchema.java
index 53a6f3a4..aa4afd2f 100644
--- a/src/main/java/one/talon/model/AbstractOpenApiSchema.java
+++ b/src/main/java/one/talon/model/AbstractOpenApiSchema.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AcceptCouponEffectProps.java b/src/main/java/one/talon/model/AcceptCouponEffectProps.java
index c3203085..4c1776bd 100644
--- a/src/main/java/one/talon/model/AcceptCouponEffectProps.java
+++ b/src/main/java/one/talon/model/AcceptCouponEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AcceptReferralEffectProps.java b/src/main/java/one/talon/model/AcceptReferralEffectProps.java
index 71f4b1f8..54aecc38 100644
--- a/src/main/java/one/talon/model/AcceptReferralEffectProps.java
+++ b/src/main/java/one/talon/model/AcceptReferralEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccessLogEntry.java b/src/main/java/one/talon/model/AccessLogEntry.java
index f7963f1b..c2d6710e 100644
--- a/src/main/java/one/talon/model/AccessLogEntry.java
+++ b/src/main/java/one/talon/model/AccessLogEntry.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Account.java b/src/main/java/one/talon/model/Account.java
index 584da55d..ffb01b23 100644
--- a/src/main/java/one/talon/model/Account.java
+++ b/src/main/java/one/talon/model/Account.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountAdditionalCost.java b/src/main/java/one/talon/model/AccountAdditionalCost.java
index 446a5f3c..ad1fe5df 100644
--- a/src/main/java/one/talon/model/AccountAdditionalCost.java
+++ b/src/main/java/one/talon/model/AccountAdditionalCost.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountAnalytics.java b/src/main/java/one/talon/model/AccountAnalytics.java
index f80499b1..1e233513 100644
--- a/src/main/java/one/talon/model/AccountAnalytics.java
+++ b/src/main/java/one/talon/model/AccountAnalytics.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatistic.java b/src/main/java/one/talon/model/AccountDashboardStatistic.java
index 5e6a1427..3efe2f71 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatistic.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatistic.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java b/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java
index 250f26f5..e099a33c 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatisticCampaigns.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java b/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java
index b85cb4c5..333511a2 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatisticDiscount.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java b/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java
index 0a326fd1..18c491c0 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatisticLoyaltyPoints.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java b/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java
index 1ce69adb..bf6ce9da 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatisticReferrals.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java b/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java
index 0af023d5..4b1fcee2 100644
--- a/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java
+++ b/src/main/java/one/talon/model/AccountDashboardStatisticRevenue.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountEntity.java b/src/main/java/one/talon/model/AccountEntity.java
index 841381f9..6025e010 100644
--- a/src/main/java/one/talon/model/AccountEntity.java
+++ b/src/main/java/one/talon/model/AccountEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AccountLimits.java b/src/main/java/one/talon/model/AccountLimits.java
index 6670c456..43a3feae 100644
--- a/src/main/java/one/talon/model/AccountLimits.java
+++ b/src/main/java/one/talon/model/AccountLimits.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Achievement.java b/src/main/java/one/talon/model/Achievement.java
index 280d43ec..268b7d3b 100644
--- a/src/main/java/one/talon/model/Achievement.java
+++ b/src/main/java/one/talon/model/Achievement.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementAdditionalProperties.java b/src/main/java/one/talon/model/AchievementAdditionalProperties.java
index 47cb4d6a..bafddce9 100644
--- a/src/main/java/one/talon/model/AchievementAdditionalProperties.java
+++ b/src/main/java/one/talon/model/AchievementAdditionalProperties.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java b/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java
index 8221d46b..d736ea4e 100644
--- a/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java
+++ b/src/main/java/one/talon/model/AchievementAdditionalPropertiesV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementBase.java b/src/main/java/one/talon/model/AchievementBase.java
index 1197380d..a03e8088 100644
--- a/src/main/java/one/talon/model/AchievementBase.java
+++ b/src/main/java/one/talon/model/AchievementBase.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementBaseV2.java b/src/main/java/one/talon/model/AchievementBaseV2.java
index 25815706..12b308af 100644
--- a/src/main/java/one/talon/model/AchievementBaseV2.java
+++ b/src/main/java/one/talon/model/AchievementBaseV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementProgress.java b/src/main/java/one/talon/model/AchievementProgress.java
index efe613cd..4e676513 100644
--- a/src/main/java/one/talon/model/AchievementProgress.java
+++ b/src/main/java/one/talon/model/AchievementProgress.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementProgressWithDefinition.java b/src/main/java/one/talon/model/AchievementProgressWithDefinition.java
index 664b8fc8..0f5c95c6 100644
--- a/src/main/java/one/talon/model/AchievementProgressWithDefinition.java
+++ b/src/main/java/one/talon/model/AchievementProgressWithDefinition.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementReference.java b/src/main/java/one/talon/model/AchievementReference.java
index 4bdb986b..17cf4118 100644
--- a/src/main/java/one/talon/model/AchievementReference.java
+++ b/src/main/java/one/talon/model/AchievementReference.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementStatusEntry.java b/src/main/java/one/talon/model/AchievementStatusEntry.java
index 62b5a0cc..84c742c0 100644
--- a/src/main/java/one/talon/model/AchievementStatusEntry.java
+++ b/src/main/java/one/talon/model/AchievementStatusEntry.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AchievementV2.java b/src/main/java/one/talon/model/AchievementV2.java
index 206ce54b..2e007487 100644
--- a/src/main/java/one/talon/model/AchievementV2.java
+++ b/src/main/java/one/talon/model/AchievementV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ActivateLoyaltyPoints.java b/src/main/java/one/talon/model/ActivateLoyaltyPoints.java
index a237b91a..64563588 100644
--- a/src/main/java/one/talon/model/ActivateLoyaltyPoints.java
+++ b/src/main/java/one/talon/model/ActivateLoyaltyPoints.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -81,7 +81,7 @@ public ActivateLoyaltyPoints addTransactionUUIDsItem(UUID transactionUUIDsItem)
}
/**
- * An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter.
+ * An array of transaction UUIDs used to activate specific pending point transactions. If provided, do not include the `sessionId` parameter.
* @return transactionUUIDs
*/
@javax.annotation.Nullable
diff --git a/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java b/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java
index 1fb6da8c..e9cdab28 100644
--- a/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java
+++ b/src/main/java/one/talon/model/ActivateLoyaltyPointsResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ActivateUserRequest.java b/src/main/java/one/talon/model/ActivateUserRequest.java
index 8bc0678a..468b35d5 100644
--- a/src/main/java/one/talon/model/ActivateUserRequest.java
+++ b/src/main/java/one/talon/model/ActivateUserRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddFreeItemEffectProps.java b/src/main/java/one/talon/model/AddFreeItemEffectProps.java
index 7048dba1..22f8b107 100644
--- a/src/main/java/one/talon/model/AddFreeItemEffectProps.java
+++ b/src/main/java/one/talon/model/AddFreeItemEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddItemCatalogAction.java b/src/main/java/one/talon/model/AddItemCatalogAction.java
index b0d1716d..ae99ee05 100644
--- a/src/main/java/one/talon/model/AddItemCatalogAction.java
+++ b/src/main/java/one/talon/model/AddItemCatalogAction.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddLoyaltyPoints.java b/src/main/java/one/talon/model/AddLoyaltyPoints.java
index f0357e85..e7a0c4d1 100644
--- a/src/main/java/one/talon/model/AddLoyaltyPoints.java
+++ b/src/main/java/one/talon/model/AddLoyaltyPoints.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java
index f2c5b4ea..7c4d6462 100644
--- a/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java
+++ b/src/main/java/one/talon/model/AddLoyaltyPointsEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java b/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java
index 87b8c65b..dd3c34f6 100644
--- a/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java
+++ b/src/main/java/one/talon/model/AddPriceAdjustmentCatalogAction.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -50,7 +50,7 @@
import one.talon.JSON;
/**
- * The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
+ * 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.21.0")
public class AddPriceAdjustmentCatalogAction {
diff --git a/src/main/java/one/talon/model/AddToAudienceEffectProps.java b/src/main/java/one/talon/model/AddToAudienceEffectProps.java
index 8d476866..c896d3fe 100644
--- a/src/main/java/one/talon/model/AddToAudienceEffectProps.java
+++ b/src/main/java/one/talon/model/AddToAudienceEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java
index 953af6be..5c15d692 100644
--- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java
+++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesAction.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java
index b72c526a..2dba5320 100644
--- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java
+++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java
index b24cd226..137a5ef7 100644
--- a/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java
+++ b/src/main/java/one/talon/model/AddedDeductedPointsBalancesNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddedDeductedPointsNotification.java b/src/main/java/one/talon/model/AddedDeductedPointsNotification.java
index 1397c87f..cdac162f 100644
--- a/src/main/java/one/talon/model/AddedDeductedPointsNotification.java
+++ b/src/main/java/one/talon/model/AddedDeductedPointsNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java b/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java
index 2c1d77eb..6775a0b9 100644
--- a/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java
+++ b/src/main/java/one/talon/model/AddedDeductedPointsNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AdditionalCampaignProperties.java b/src/main/java/one/talon/model/AdditionalCampaignProperties.java
index 62970f8c..04429c91 100644
--- a/src/main/java/one/talon/model/AdditionalCampaignProperties.java
+++ b/src/main/java/one/talon/model/AdditionalCampaignProperties.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AdditionalCost.java b/src/main/java/one/talon/model/AdditionalCost.java
index 2c8385bd..9ff7c157 100644
--- a/src/main/java/one/talon/model/AdditionalCost.java
+++ b/src/main/java/one/talon/model/AdditionalCost.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AdjustmentDetails.java b/src/main/java/one/talon/model/AdjustmentDetails.java
index 4561dafd..b9477544 100644
--- a/src/main/java/one/talon/model/AdjustmentDetails.java
+++ b/src/main/java/one/talon/model/AdjustmentDetails.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsDataPoint.java b/src/main/java/one/talon/model/AnalyticsDataPoint.java
index 9078eefd..5c25e310 100644
--- a/src/main/java/one/talon/model/AnalyticsDataPoint.java
+++ b/src/main/java/one/talon/model/AnalyticsDataPoint.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java
index 578ac626..c12a8eb2 100644
--- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java
+++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrend.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java
index f6f3634c..0bedd963 100644
--- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java
+++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndInfluencedRate.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java
index 71318cde..6cf2288c 100644
--- a/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java
+++ b/src/main/java/one/talon/model/AnalyticsDataPointWithTrendAndUplift.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsProduct.java b/src/main/java/one/talon/model/AnalyticsProduct.java
index e49f70cb..c19d457e 100644
--- a/src/main/java/one/talon/model/AnalyticsProduct.java
+++ b/src/main/java/one/talon/model/AnalyticsProduct.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AnalyticsSKU.java b/src/main/java/one/talon/model/AnalyticsSKU.java
index 7d294398..3cff9c36 100644
--- a/src/main/java/one/talon/model/AnalyticsSKU.java
+++ b/src/main/java/one/talon/model/AnalyticsSKU.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Application.java b/src/main/java/one/talon/model/Application.java
index 6edfa85e..ac40c4ee 100644
--- a/src/main/java/one/talon/model/Application.java
+++ b/src/main/java/one/talon/model/Application.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationAPIKey.java b/src/main/java/one/talon/model/ApplicationAPIKey.java
index 4b23d152..bb5f1694 100644
--- a/src/main/java/one/talon/model/ApplicationAPIKey.java
+++ b/src/main/java/one/talon/model/ApplicationAPIKey.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java b/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java
index 6ab739d0..2bd7deea 100644
--- a/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java
+++ b/src/main/java/one/talon/model/ApplicationAnalyticsDataPoint.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationApiHealth.java b/src/main/java/one/talon/model/ApplicationApiHealth.java
index f070d3ec..89cc6f33 100644
--- a/src/main/java/one/talon/model/ApplicationApiHealth.java
+++ b/src/main/java/one/talon/model/ApplicationApiHealth.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCIF.java b/src/main/java/one/talon/model/ApplicationCIF.java
index 120f1895..e9cf2293 100644
--- a/src/main/java/one/talon/model/ApplicationCIF.java
+++ b/src/main/java/one/talon/model/ApplicationCIF.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCIFExpression.java b/src/main/java/one/talon/model/ApplicationCIFExpression.java
index 29e5c730..7e22062a 100644
--- a/src/main/java/one/talon/model/ApplicationCIFExpression.java
+++ b/src/main/java/one/talon/model/ApplicationCIFExpression.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCIFReferences.java b/src/main/java/one/talon/model/ApplicationCIFReferences.java
index 77be8db6..5eae3a7f 100644
--- a/src/main/java/one/talon/model/ApplicationCIFReferences.java
+++ b/src/main/java/one/talon/model/ApplicationCIFReferences.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java
index 7c0692e3..60658cb7 100644
--- a/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java
+++ b/src/main/java/one/talon/model/ApplicationCampaignAnalytics.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCampaignStats.java b/src/main/java/one/talon/model/ApplicationCampaignStats.java
index 2eb29783..735c0581 100644
--- a/src/main/java/one/talon/model/ApplicationCampaignStats.java
+++ b/src/main/java/one/talon/model/ApplicationCampaignStats.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationCustomer.java b/src/main/java/one/talon/model/ApplicationCustomer.java
index 3263cdbb..d9f12ae0 100644
--- a/src/main/java/one/talon/model/ApplicationCustomer.java
+++ b/src/main/java/one/talon/model/ApplicationCustomer.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -24,7 +24,9 @@
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import one.talon.model.AudienceMembership;
import one.talon.model.LoyaltyMembership;
import com.google.gson.JsonElement;
@@ -75,7 +77,7 @@ public class ApplicationCustomer {
public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes";
@SerializedName(SERIALIZED_NAME_ATTRIBUTES)
@javax.annotation.Nullable
- private Object attributes;
+ private Map attributes;
public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -177,21 +179,29 @@ public void setIntegrationId(@javax.annotation.Nonnull String integrationId) {
}
- public ApplicationCustomer attributes(@javax.annotation.Nullable Object attributes) {
+ public ApplicationCustomer attributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
return this;
}
+ public ApplicationCustomer putAttributesItem(String key, Object attributesItem) {
+ if (this.attributes == null) {
+ this.attributes = new HashMap<>();
+ }
+ this.attributes.put(key, attributesItem);
+ return this;
+ }
+
/**
* Arbitrary properties associated with this item.
* @return attributes
*/
@javax.annotation.Nullable
- public Object getAttributes() {
+ public Map getAttributes() {
return attributes;
}
- public void setAttributes(@javax.annotation.Nullable Object attributes) {
+ public void setAttributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
}
@@ -313,7 +323,7 @@ public ApplicationCustomer lastActivity(@javax.annotation.Nonnull OffsetDateTime
}
/**
- * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.
+ * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field.
* @return lastActivity
*/
@javax.annotation.Nonnull
diff --git a/src/main/java/one/talon/model/ApplicationCustomerEntity.java b/src/main/java/one/talon/model/ApplicationCustomerEntity.java
index 8c3fd1ff..c8a81b37 100644
--- a/src/main/java/one/talon/model/ApplicationCustomerEntity.java
+++ b/src/main/java/one/talon/model/ApplicationCustomerEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationEntity.java b/src/main/java/one/talon/model/ApplicationEntity.java
index 4e107c9e..ac7d41d2 100644
--- a/src/main/java/one/talon/model/ApplicationEntity.java
+++ b/src/main/java/one/talon/model/ApplicationEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationEvent.java b/src/main/java/one/talon/model/ApplicationEvent.java
index a0ff3080..d62f0896 100644
--- a/src/main/java/one/talon/model/ApplicationEvent.java
+++ b/src/main/java/one/talon/model/ApplicationEvent.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationNotification.java b/src/main/java/one/talon/model/ApplicationNotification.java
index f9cca25d..1845bb15 100644
--- a/src/main/java/one/talon/model/ApplicationNotification.java
+++ b/src/main/java/one/talon/model/ApplicationNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationReferee.java b/src/main/java/one/talon/model/ApplicationReferee.java
index bee35ade..fa3edc4a 100644
--- a/src/main/java/one/talon/model/ApplicationReferee.java
+++ b/src/main/java/one/talon/model/ApplicationReferee.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationSession.java b/src/main/java/one/talon/model/ApplicationSession.java
index 1bcc0935..72b0657b 100644
--- a/src/main/java/one/talon/model/ApplicationSession.java
+++ b/src/main/java/one/talon/model/ApplicationSession.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationSessionEntity.java b/src/main/java/one/talon/model/ApplicationSessionEntity.java
index b1f10370..cb8bbb00 100644
--- a/src/main/java/one/talon/model/ApplicationSessionEntity.java
+++ b/src/main/java/one/talon/model/ApplicationSessionEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ApplicationStoreEntity.java b/src/main/java/one/talon/model/ApplicationStoreEntity.java
index 54726379..d6b255b4 100644
--- a/src/main/java/one/talon/model/ApplicationStoreEntity.java
+++ b/src/main/java/one/talon/model/ApplicationStoreEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AsyncCouponCreationResponse.java b/src/main/java/one/talon/model/AsyncCouponCreationResponse.java
index 29087cdf..9164da38 100644
--- a/src/main/java/one/talon/model/AsyncCouponCreationResponse.java
+++ b/src/main/java/one/talon/model/AsyncCouponCreationResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java
index 92602a8f..0f85ede4 100644
--- a/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java
+++ b/src/main/java/one/talon/model/AsyncCouponDeletionJobResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AsyncCouponsData.java b/src/main/java/one/talon/model/AsyncCouponsData.java
index c9569312..ae1035ec 100644
--- a/src/main/java/one/talon/model/AsyncCouponsData.java
+++ b/src/main/java/one/talon/model/AsyncCouponsData.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Attribute.java b/src/main/java/one/talon/model/Attribute.java
index 75338185..586d1e32 100644
--- a/src/main/java/one/talon/model/Attribute.java
+++ b/src/main/java/one/talon/model/Attribute.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AttributesMandatory.java b/src/main/java/one/talon/model/AttributesMandatory.java
index beee14c2..ae25f7b6 100644
--- a/src/main/java/one/talon/model/AttributesMandatory.java
+++ b/src/main/java/one/talon/model/AttributesMandatory.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AttributesSettings.java b/src/main/java/one/talon/model/AttributesSettings.java
index fa0961d9..b9d226c4 100644
--- a/src/main/java/one/talon/model/AttributesSettings.java
+++ b/src/main/java/one/talon/model/AttributesSettings.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Audience.java b/src/main/java/one/talon/model/Audience.java
index 4be92190..df809d3e 100644
--- a/src/main/java/one/talon/model/Audience.java
+++ b/src/main/java/one/talon/model/Audience.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AudienceAnalytics.java b/src/main/java/one/talon/model/AudienceAnalytics.java
index 9719b7a3..2e6d4088 100644
--- a/src/main/java/one/talon/model/AudienceAnalytics.java
+++ b/src/main/java/one/talon/model/AudienceAnalytics.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AudienceCustomer.java b/src/main/java/one/talon/model/AudienceCustomer.java
index 192bb88a..a83d87ed 100644
--- a/src/main/java/one/talon/model/AudienceCustomer.java
+++ b/src/main/java/one/talon/model/AudienceCustomer.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -24,7 +24,9 @@
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import one.talon.model.AudienceMembership;
import one.talon.model.LoyaltyMembership;
import com.google.gson.JsonElement;
@@ -75,7 +77,7 @@ public class AudienceCustomer {
public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes";
@SerializedName(SERIALIZED_NAME_ATTRIBUTES)
@javax.annotation.Nullable
- private Object attributes;
+ private Map attributes;
public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -182,21 +184,29 @@ public void setIntegrationId(@javax.annotation.Nonnull String integrationId) {
}
- public AudienceCustomer attributes(@javax.annotation.Nullable Object attributes) {
+ public AudienceCustomer attributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
return this;
}
+ public AudienceCustomer putAttributesItem(String key, Object attributesItem) {
+ if (this.attributes == null) {
+ this.attributes = new HashMap<>();
+ }
+ this.attributes.put(key, attributesItem);
+ return this;
+ }
+
/**
* Arbitrary properties associated with this item.
* @return attributes
*/
@javax.annotation.Nullable
- public Object getAttributes() {
+ public Map getAttributes() {
return attributes;
}
- public void setAttributes(@javax.annotation.Nullable Object attributes) {
+ public void setAttributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
}
@@ -318,7 +328,7 @@ public AudienceCustomer lastActivity(@javax.annotation.Nonnull OffsetDateTime la
}
/**
- * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.
+ * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field.
* @return lastActivity
*/
@javax.annotation.Nonnull
diff --git a/src/main/java/one/talon/model/AudienceIntegrationID.java b/src/main/java/one/talon/model/AudienceIntegrationID.java
index 8c3c7d49..67b82fab 100644
--- a/src/main/java/one/talon/model/AudienceIntegrationID.java
+++ b/src/main/java/one/talon/model/AudienceIntegrationID.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AudienceMembership.java b/src/main/java/one/talon/model/AudienceMembership.java
index f8311e06..17b88b46 100644
--- a/src/main/java/one/talon/model/AudienceMembership.java
+++ b/src/main/java/one/talon/model/AudienceMembership.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AudienceReference.java b/src/main/java/one/talon/model/AudienceReference.java
index 900f6b0e..440de8e2 100644
--- a/src/main/java/one/talon/model/AudienceReference.java
+++ b/src/main/java/one/talon/model/AudienceReference.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/AwardGiveawayEffectProps.java b/src/main/java/one/talon/model/AwardGiveawayEffectProps.java
index 4b436f09..05fcbfe0 100644
--- a/src/main/java/one/talon/model/AwardGiveawayEffectProps.java
+++ b/src/main/java/one/talon/model/AwardGiveawayEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseCampaign.java b/src/main/java/one/talon/model/BaseCampaign.java
index d354c3b2..99dd9a19 100644
--- a/src/main/java/one/talon/model/BaseCampaign.java
+++ b/src/main/java/one/talon/model/BaseCampaign.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -302,6 +302,11 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti
@javax.annotation.Nullable
private List linkedStoreIds;
+ public static final String SERIALIZED_NAME_COUPON_ATTRIBUTES = "couponAttributes";
+ @SerializedName(SERIALIZED_NAME_COUPON_ATTRIBUTES)
+ @javax.annotation.Nullable
+ private Object couponAttributes;
+
public BaseCampaign() {
}
@@ -425,7 +430,7 @@ public BaseCampaign activeRulesetId(@javax.annotation.Nullable Long activeRulese
}
/**
- * [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.
+ * [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation.
* @return activeRulesetId
*/
@javax.annotation.Nullable
@@ -649,6 +654,25 @@ public void setLinkedStoreIds(@javax.annotation.Nullable List linkedStoreI
}
+ public BaseCampaign couponAttributes(@javax.annotation.Nullable Object couponAttributes) {
+ this.couponAttributes = couponAttributes;
+ return this;
+ }
+
+ /**
+ * Arbitrary properties associated with coupons in this campaign.
+ * @return couponAttributes
+ */
+ @javax.annotation.Nullable
+ public Object getCouponAttributes() {
+ return couponAttributes;
+ }
+
+ public void setCouponAttributes(@javax.annotation.Nullable Object couponAttributes) {
+ this.couponAttributes = couponAttributes;
+ }
+
+
@Override
public boolean equals(Object o) {
@@ -674,12 +698,13 @@ public boolean equals(Object o) {
Objects.equals(this.limits, baseCampaign.limits) &&
Objects.equals(this.campaignGroups, baseCampaign.campaignGroups) &&
Objects.equals(this.type, baseCampaign.type) &&
- Objects.equals(this.linkedStoreIds, baseCampaign.linkedStoreIds);
+ Objects.equals(this.linkedStoreIds, baseCampaign.linkedStoreIds) &&
+ Objects.equals(this.couponAttributes, baseCampaign.couponAttributes);
}
@Override
public int hashCode() {
- return Objects.hash(name, description, startTime, endTime, attributes, state, activeRulesetId, tags, reevaluateOnReturn, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds);
+ return Objects.hash(name, description, startTime, endTime, attributes, state, activeRulesetId, tags, reevaluateOnReturn, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds, couponAttributes);
}
@Override
@@ -702,6 +727,7 @@ public String toString() {
sb.append(" campaignGroups: ").append(toIndentedString(campaignGroups)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" linkedStoreIds: ").append(toIndentedString(linkedStoreIds)).append("\n");
+ sb.append(" couponAttributes: ").append(toIndentedString(couponAttributes)).append("\n");
sb.append("}");
return sb.toString();
}
@@ -723,7 +749,7 @@ private String toIndentedString(Object o) {
static {
// a set of all properties/fields (JSON key names)
- openapiFields = new HashSet(Arrays.asList("name", "description", "startTime", "endTime", "attributes", "state", "activeRulesetId", "tags", "reevaluateOnReturn", "features", "couponSettings", "referralSettings", "limits", "campaignGroups", "type", "linkedStoreIds"));
+ openapiFields = new HashSet(Arrays.asList("name", "description", "startTime", "endTime", "attributes", "state", "activeRulesetId", "tags", "reevaluateOnReturn", "features", "couponSettings", "referralSettings", "limits", "campaignGroups", "type", "linkedStoreIds", "couponAttributes"));
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet(Arrays.asList("name", "state", "tags", "features", "limits"));
diff --git a/src/main/java/one/talon/model/BaseLoyaltyProgram.java b/src/main/java/one/talon/model/BaseLoyaltyProgram.java
index 6e05619a..16313914 100644
--- a/src/main/java/one/talon/model/BaseLoyaltyProgram.java
+++ b/src/main/java/one/talon/model/BaseLoyaltyProgram.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseNotification.java b/src/main/java/one/talon/model/BaseNotification.java
index 2fa51a22..1e28e037 100644
--- a/src/main/java/one/talon/model/BaseNotification.java
+++ b/src/main/java/one/talon/model/BaseNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseNotificationEntity.java b/src/main/java/one/talon/model/BaseNotificationEntity.java
index 39082608..4f60e43d 100644
--- a/src/main/java/one/talon/model/BaseNotificationEntity.java
+++ b/src/main/java/one/talon/model/BaseNotificationEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseNotificationWebhook.java b/src/main/java/one/talon/model/BaseNotificationWebhook.java
index 8094e2cd..ec953611 100644
--- a/src/main/java/one/talon/model/BaseNotificationWebhook.java
+++ b/src/main/java/one/talon/model/BaseNotificationWebhook.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseNotifications.java b/src/main/java/one/talon/model/BaseNotifications.java
index 556adf06..96c17b1e 100644
--- a/src/main/java/one/talon/model/BaseNotifications.java
+++ b/src/main/java/one/talon/model/BaseNotifications.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BaseSamlConnection.java b/src/main/java/one/talon/model/BaseSamlConnection.java
index 66df51bf..5e0e13e0 100644
--- a/src/main/java/one/talon/model/BaseSamlConnection.java
+++ b/src/main/java/one/talon/model/BaseSamlConnection.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BestPriorPrice.java b/src/main/java/one/talon/model/BestPriorPrice.java
index 74be6e8b..315d56f9 100644
--- a/src/main/java/one/talon/model/BestPriorPrice.java
+++ b/src/main/java/one/talon/model/BestPriorPrice.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BestPriorPriceMetadata.java b/src/main/java/one/talon/model/BestPriorPriceMetadata.java
index af593216..c677489e 100644
--- a/src/main/java/one/talon/model/BestPriorPriceMetadata.java
+++ b/src/main/java/one/talon/model/BestPriorPriceMetadata.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BestPriorPriceRequest.java b/src/main/java/one/talon/model/BestPriorPriceRequest.java
index 8b6095d1..f94f9522 100644
--- a/src/main/java/one/talon/model/BestPriorPriceRequest.java
+++ b/src/main/java/one/talon/model/BestPriorPriceRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BestPriorTarget.java b/src/main/java/one/talon/model/BestPriorTarget.java
index eeecd8a5..cf8ba4d4 100644
--- a/src/main/java/one/talon/model/BestPriorTarget.java
+++ b/src/main/java/one/talon/model/BestPriorTarget.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Binding.java b/src/main/java/one/talon/model/Binding.java
index 0c09ce00..550ba90d 100644
--- a/src/main/java/one/talon/model/Binding.java
+++ b/src/main/java/one/talon/model/Binding.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Blueprint.java b/src/main/java/one/talon/model/Blueprint.java
index 52f8f263..d5b7e3d7 100644
--- a/src/main/java/one/talon/model/Blueprint.java
+++ b/src/main/java/one/talon/model/Blueprint.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BulkApplicationNotification.java b/src/main/java/one/talon/model/BulkApplicationNotification.java
index 0de2a088..94f76282 100644
--- a/src/main/java/one/talon/model/BulkApplicationNotification.java
+++ b/src/main/java/one/talon/model/BulkApplicationNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java
index eefa9af1..7d373719 100644
--- a/src/main/java/one/talon/model/BulkOperationOnCampaigns.java
+++ b/src/main/java/one/talon/model/BulkOperationOnCampaigns.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Campaign.java b/src/main/java/one/talon/model/Campaign.java
index f5c97502..d8b9a29c 100644
--- a/src/main/java/one/talon/model/Campaign.java
+++ b/src/main/java/one/talon/model/Campaign.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -324,6 +324,11 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti
@javax.annotation.Nullable
private List linkedStoreIds;
+ public static final String SERIALIZED_NAME_COUPON_ATTRIBUTES = "couponAttributes";
+ @SerializedName(SERIALIZED_NAME_COUPON_ATTRIBUTES)
+ @javax.annotation.Nullable
+ private Object couponAttributes;
+
public static final String SERIALIZED_NAME_BUDGETS = "budgets";
@SerializedName(SERIALIZED_NAME_BUDGETS)
@javax.annotation.Nullable
@@ -795,7 +800,7 @@ public Campaign activeRulesetId(@javax.annotation.Nullable Long activeRulesetId)
}
/**
- * [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.
+ * [ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation.
* @return activeRulesetId
*/
@javax.annotation.Nullable
@@ -1019,6 +1024,25 @@ public void setLinkedStoreIds(@javax.annotation.Nullable List linkedStoreI
}
+ public Campaign couponAttributes(@javax.annotation.Nullable Object couponAttributes) {
+ this.couponAttributes = couponAttributes;
+ return this;
+ }
+
+ /**
+ * Arbitrary properties associated with coupons in this campaign.
+ * @return couponAttributes
+ */
+ @javax.annotation.Nullable
+ public Object getCouponAttributes() {
+ return couponAttributes;
+ }
+
+ public void setCouponAttributes(@javax.annotation.Nullable Object couponAttributes) {
+ this.couponAttributes = couponAttributes;
+ }
+
+
public Campaign budgets(@javax.annotation.Nullable List budgets) {
this.budgets = budgets;
return this;
@@ -1673,6 +1697,7 @@ public boolean equals(Object o) {
Objects.equals(this.campaignGroups, campaign.campaignGroups) &&
Objects.equals(this.type, campaign.type) &&
Objects.equals(this.linkedStoreIds, campaign.linkedStoreIds) &&
+ Objects.equals(this.couponAttributes, campaign.couponAttributes) &&
Objects.equals(this.budgets, campaign.budgets) &&
Objects.equals(this.couponRedemptionCount, campaign.couponRedemptionCount) &&
Objects.equals(this.referralRedemptionCount, campaign.referralRedemptionCount) &&
@@ -1709,7 +1734,7 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
- return Objects.hash(id, created, applicationId, userId, name, description, startTime, endTime, attributes, state, activeRulesetId, tags, reevaluateOnReturn, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds, budgets, couponRedemptionCount, referralRedemptionCount, discountCount, discountEffectCount, couponCreationCount, customEffectCount, referralCreationCount, addFreeItemEffectCount, awardedGiveawaysCount, createdLoyaltyPointsCount, createdLoyaltyPointsEffectCount, redeemedLoyaltyPointsCount, redeemedLoyaltyPointsEffectCount, callApiEffectCount, reservecouponEffectCount, lastActivity, updated, createdBy, updatedBy, templateId, frontendState, storesImported, valueMapsIds, experimentId, revisionFrontendState, activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision);
+ return Objects.hash(id, created, applicationId, userId, name, description, startTime, endTime, attributes, state, activeRulesetId, tags, reevaluateOnReturn, features, couponSettings, referralSettings, limits, campaignGroups, type, linkedStoreIds, couponAttributes, budgets, couponRedemptionCount, referralRedemptionCount, discountCount, discountEffectCount, couponCreationCount, customEffectCount, referralCreationCount, addFreeItemEffectCount, awardedGiveawaysCount, createdLoyaltyPointsCount, createdLoyaltyPointsEffectCount, redeemedLoyaltyPointsCount, redeemedLoyaltyPointsEffectCount, callApiEffectCount, reservecouponEffectCount, lastActivity, updated, createdBy, updatedBy, templateId, frontendState, storesImported, valueMapsIds, experimentId, revisionFrontendState, activeRevisionId, activeRevisionVersionId, version, currentRevisionId, currentRevisionVersionId, stageRevision);
}
@Override
@@ -1736,6 +1761,7 @@ public String toString() {
sb.append(" campaignGroups: ").append(toIndentedString(campaignGroups)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" linkedStoreIds: ").append(toIndentedString(linkedStoreIds)).append("\n");
+ sb.append(" couponAttributes: ").append(toIndentedString(couponAttributes)).append("\n");
sb.append(" budgets: ").append(toIndentedString(budgets)).append("\n");
sb.append(" couponRedemptionCount: ").append(toIndentedString(couponRedemptionCount)).append("\n");
sb.append(" referralRedemptionCount: ").append(toIndentedString(referralRedemptionCount)).append("\n");
@@ -1789,7 +1815,7 @@ private String toIndentedString(Object o) {
static {
// a set of all properties/fields (JSON key names)
- openapiFields = new HashSet(Arrays.asList("id", "created", "applicationId", "userId", "name", "description", "startTime", "endTime", "attributes", "state", "activeRulesetId", "tags", "reevaluateOnReturn", "features", "couponSettings", "referralSettings", "limits", "campaignGroups", "type", "linkedStoreIds", "budgets", "couponRedemptionCount", "referralRedemptionCount", "discountCount", "discountEffectCount", "couponCreationCount", "customEffectCount", "referralCreationCount", "addFreeItemEffectCount", "awardedGiveawaysCount", "createdLoyaltyPointsCount", "createdLoyaltyPointsEffectCount", "redeemedLoyaltyPointsCount", "redeemedLoyaltyPointsEffectCount", "callApiEffectCount", "reservecouponEffectCount", "lastActivity", "updated", "createdBy", "updatedBy", "templateId", "frontendState", "storesImported", "valueMapsIds", "experimentId", "revisionFrontendState", "activeRevisionId", "activeRevisionVersionId", "version", "currentRevisionId", "currentRevisionVersionId", "stageRevision"));
+ openapiFields = new HashSet(Arrays.asList("id", "created", "applicationId", "userId", "name", "description", "startTime", "endTime", "attributes", "state", "activeRulesetId", "tags", "reevaluateOnReturn", "features", "couponSettings", "referralSettings", "limits", "campaignGroups", "type", "linkedStoreIds", "couponAttributes", "budgets", "couponRedemptionCount", "referralRedemptionCount", "discountCount", "discountEffectCount", "couponCreationCount", "customEffectCount", "referralCreationCount", "addFreeItemEffectCount", "awardedGiveawaysCount", "createdLoyaltyPointsCount", "createdLoyaltyPointsEffectCount", "redeemedLoyaltyPointsCount", "redeemedLoyaltyPointsEffectCount", "callApiEffectCount", "reservecouponEffectCount", "lastActivity", "updated", "createdBy", "updatedBy", "templateId", "frontendState", "storesImported", "valueMapsIds", "experimentId", "revisionFrontendState", "activeRevisionId", "activeRevisionVersionId", "version", "currentRevisionId", "currentRevisionVersionId", "stageRevision"));
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet(Arrays.asList("id", "created", "applicationId", "userId", "name", "state", "tags", "reevaluateOnReturn", "features", "limits", "frontendState", "storesImported"));
diff --git a/src/main/java/one/talon/model/CampaignActivationRequest.java b/src/main/java/one/talon/model/CampaignActivationRequest.java
index 2bce7491..02813cc3 100644
--- a/src/main/java/one/talon/model/CampaignActivationRequest.java
+++ b/src/main/java/one/talon/model/CampaignActivationRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignAnalytics.java b/src/main/java/one/talon/model/CampaignAnalytics.java
index 59c95427..2fdff014 100644
--- a/src/main/java/one/talon/model/CampaignAnalytics.java
+++ b/src/main/java/one/talon/model/CampaignAnalytics.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignBudget.java b/src/main/java/one/talon/model/CampaignBudget.java
index efdaca7f..96444385 100644
--- a/src/main/java/one/talon/model/CampaignBudget.java
+++ b/src/main/java/one/talon/model/CampaignBudget.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCollection.java b/src/main/java/one/talon/model/CampaignCollection.java
index 9bd8dc3b..947fe227 100644
--- a/src/main/java/one/talon/model/CampaignCollection.java
+++ b/src/main/java/one/talon/model/CampaignCollection.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java b/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java
index a58781e0..996f3345 100644
--- a/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java
+++ b/src/main/java/one/talon/model/CampaignCollectionEditedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java b/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java
index 6f9c4ce2..54f369dc 100644
--- a/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignCollectionEditedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java
index ad3701b3..bb9d87d6 100644
--- a/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java
+++ b/src/main/java/one/talon/model/CampaignCollectionWithoutPayload.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCopy.java b/src/main/java/one/talon/model/CampaignCopy.java
index 4087f83c..521789c4 100644
--- a/src/main/java/one/talon/model/CampaignCopy.java
+++ b/src/main/java/one/talon/model/CampaignCopy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCreatedNotification.java b/src/main/java/one/talon/model/CampaignCreatedNotification.java
index b9cb7a00..003505e5 100644
--- a/src/main/java/one/talon/model/CampaignCreatedNotification.java
+++ b/src/main/java/one/talon/model/CampaignCreatedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java b/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java
index d0d3eb96..27c54a96 100644
--- a/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignCreatedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignDeactivationRequest.java b/src/main/java/one/talon/model/CampaignDeactivationRequest.java
index c80fcb0a..06d4708d 100644
--- a/src/main/java/one/talon/model/CampaignDeactivationRequest.java
+++ b/src/main/java/one/talon/model/CampaignDeactivationRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignDeletedNotification.java b/src/main/java/one/talon/model/CampaignDeletedNotification.java
index beca6af5..71fe08be 100644
--- a/src/main/java/one/talon/model/CampaignDeletedNotification.java
+++ b/src/main/java/one/talon/model/CampaignDeletedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java b/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java
index de631b44..031ca8c9 100644
--- a/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignDeletedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignDetail.java b/src/main/java/one/talon/model/CampaignDetail.java
index cebfb27e..4660713d 100644
--- a/src/main/java/one/talon/model/CampaignDetail.java
+++ b/src/main/java/one/talon/model/CampaignDetail.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEditedNotification.java b/src/main/java/one/talon/model/CampaignEditedNotification.java
index bbd7489a..6b0cc6f1 100644
--- a/src/main/java/one/talon/model/CampaignEditedNotification.java
+++ b/src/main/java/one/talon/model/CampaignEditedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEditedNotificationItem.java b/src/main/java/one/talon/model/CampaignEditedNotificationItem.java
index acc936b5..ae71ba2b 100644
--- a/src/main/java/one/talon/model/CampaignEditedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignEditedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEntity.java b/src/main/java/one/talon/model/CampaignEntity.java
index 5a02923e..28983bbe 100644
--- a/src/main/java/one/talon/model/CampaignEntity.java
+++ b/src/main/java/one/talon/model/CampaignEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEvaluationGroup.java b/src/main/java/one/talon/model/CampaignEvaluationGroup.java
index 468fc460..0d3c7b2a 100644
--- a/src/main/java/one/talon/model/CampaignEvaluationGroup.java
+++ b/src/main/java/one/talon/model/CampaignEvaluationGroup.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEvaluationPosition.java b/src/main/java/one/talon/model/CampaignEvaluationPosition.java
index 9982c26c..d4b80f86 100644
--- a/src/main/java/one/talon/model/CampaignEvaluationPosition.java
+++ b/src/main/java/one/talon/model/CampaignEvaluationPosition.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java
index 4b16ceef..514d0913 100644
--- a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java
+++ b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedMessage.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java
index ec340288..33f46ff5 100644
--- a/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java
+++ b/src/main/java/one/talon/model/CampaignEvaluationTreeChangedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignGroup.java b/src/main/java/one/talon/model/CampaignGroup.java
index 765ed062..3b6a759d 100644
--- a/src/main/java/one/talon/model/CampaignGroup.java
+++ b/src/main/java/one/talon/model/CampaignGroup.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignGroupEntity.java b/src/main/java/one/talon/model/CampaignGroupEntity.java
index 0a615e1f..a48245d3 100644
--- a/src/main/java/one/talon/model/CampaignGroupEntity.java
+++ b/src/main/java/one/talon/model/CampaignGroupEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignLogSummary.java b/src/main/java/one/talon/model/CampaignLogSummary.java
index 21a765a3..8fbda24e 100644
--- a/src/main/java/one/talon/model/CampaignLogSummary.java
+++ b/src/main/java/one/talon/model/CampaignLogSummary.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignNotificationBase.java b/src/main/java/one/talon/model/CampaignNotificationBase.java
index 2f977bc2..f274f06f 100644
--- a/src/main/java/one/talon/model/CampaignNotificationBase.java
+++ b/src/main/java/one/talon/model/CampaignNotificationBase.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignNotificationGeneric.java b/src/main/java/one/talon/model/CampaignNotificationGeneric.java
index 46a60c23..d38590e5 100644
--- a/src/main/java/one/talon/model/CampaignNotificationGeneric.java
+++ b/src/main/java/one/talon/model/CampaignNotificationGeneric.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignNotificationItemBase.java b/src/main/java/one/talon/model/CampaignNotificationItemBase.java
index 26b8b30b..9ba79cc5 100644
--- a/src/main/java/one/talon/model/CampaignNotificationItemBase.java
+++ b/src/main/java/one/talon/model/CampaignNotificationItemBase.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignNotificationPolicy.java b/src/main/java/one/talon/model/CampaignNotificationPolicy.java
index 5ff49313..3409cd7c 100644
--- a/src/main/java/one/talon/model/CampaignNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CampaignNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java b/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java
index d90a6ef3..c3d49337 100644
--- a/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java
+++ b/src/main/java/one/talon/model/CampaignRulesetChangedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java b/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java
index f7a387a4..5fdf5a09 100644
--- a/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignRulesetChangedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignSearch.java b/src/main/java/one/talon/model/CampaignSearch.java
index 610e2783..b58ae97f 100644
--- a/src/main/java/one/talon/model/CampaignSearch.java
+++ b/src/main/java/one/talon/model/CampaignSearch.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignSet.java b/src/main/java/one/talon/model/CampaignSet.java
index ac57582e..412e1ce6 100644
--- a/src/main/java/one/talon/model/CampaignSet.java
+++ b/src/main/java/one/talon/model/CampaignSet.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignSetBranchNode.java b/src/main/java/one/talon/model/CampaignSetBranchNode.java
index 4720017a..6ff30ffd 100644
--- a/src/main/java/one/talon/model/CampaignSetBranchNode.java
+++ b/src/main/java/one/talon/model/CampaignSetBranchNode.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignSetLeafNode.java b/src/main/java/one/talon/model/CampaignSetLeafNode.java
index 459ba398..39953ac7 100644
--- a/src/main/java/one/talon/model/CampaignSetLeafNode.java
+++ b/src/main/java/one/talon/model/CampaignSetLeafNode.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignSetNode.java b/src/main/java/one/talon/model/CampaignSetNode.java
index 9b7ee9e9..25abfaaf 100644
--- a/src/main/java/one/talon/model/CampaignSetNode.java
+++ b/src/main/java/one/talon/model/CampaignSetNode.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignStateChangedNotification.java b/src/main/java/one/talon/model/CampaignStateChangedNotification.java
index bed23556..19e32d37 100644
--- a/src/main/java/one/talon/model/CampaignStateChangedNotification.java
+++ b/src/main/java/one/talon/model/CampaignStateChangedNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java b/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java
index ff5a9ba6..f4eabce4 100644
--- a/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java
+++ b/src/main/java/one/talon/model/CampaignStateChangedNotificationItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignStoreBudget.java b/src/main/java/one/talon/model/CampaignStoreBudget.java
index 157a0234..b73e6fea 100644
--- a/src/main/java/one/talon/model/CampaignStoreBudget.java
+++ b/src/main/java/one/talon/model/CampaignStoreBudget.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java b/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java
index 1d0216dc..fb9f73f9 100644
--- a/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java
+++ b/src/main/java/one/talon/model/CampaignStoreBudgetLimitConfig.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignTemplate.java b/src/main/java/one/talon/model/CampaignTemplate.java
index d25a24b3..f9b7b3ba 100644
--- a/src/main/java/one/talon/model/CampaignTemplate.java
+++ b/src/main/java/one/talon/model/CampaignTemplate.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignTemplateCollection.java b/src/main/java/one/talon/model/CampaignTemplateCollection.java
index 2e655af6..f54f123b 100644
--- a/src/main/java/one/talon/model/CampaignTemplateCollection.java
+++ b/src/main/java/one/talon/model/CampaignTemplateCollection.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java
index 78c149e6..06ecf09a 100644
--- a/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java
+++ b/src/main/java/one/talon/model/CampaignTemplateCouponReservationSettings.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignTemplateParams.java b/src/main/java/one/talon/model/CampaignTemplateParams.java
index a4212d16..9174730c 100644
--- a/src/main/java/one/talon/model/CampaignTemplateParams.java
+++ b/src/main/java/one/talon/model/CampaignTemplateParams.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CampaignVersions.java b/src/main/java/one/talon/model/CampaignVersions.java
index e80c77f8..826e788c 100644
--- a/src/main/java/one/talon/model/CampaignVersions.java
+++ b/src/main/java/one/talon/model/CampaignVersions.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java
index 4c90c374..2f188760 100644
--- a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java
+++ b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java
index 88ac53e7..8f4320e3 100644
--- a/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CardAddedDeductedPointsBalancesNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java b/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java
index c34dc353..865f1e2b 100644
--- a/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java
+++ b/src/main/java/one/talon/model/CardAddedDeductedPointsNotification.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java b/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java
index 2843a13a..5bd8abae 100644
--- a/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CardAddedDeductedPointsNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java b/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java
index 91cada1a..b77d4d3d 100644
--- a/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CardExpiringPointsNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java b/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java
index 812afea0..383ad7a1 100644
--- a/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java
+++ b/src/main/java/one/talon/model/CardExpiringPointsNotificationTrigger.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java b/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java
index cc2651df..6a5f1bf3 100644
--- a/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java
+++ b/src/main/java/one/talon/model/CardLedgerPointsEntryIntegrationAPI.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java b/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java
index 503982ef..3dfe669b 100644
--- a/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java
+++ b/src/main/java/one/talon/model/CardLedgerTransactionLogEntry.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java b/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java
index f1c80f58..d127a889 100644
--- a/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java
+++ b/src/main/java/one/talon/model/CardLedgerTransactionLogEntryIntegrationAPI.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CartItem.java b/src/main/java/one/talon/model/CartItem.java
index 5f9ff5c0..bafe4275 100644
--- a/src/main/java/one/talon/model/CartItem.java
+++ b/src/main/java/one/talon/model/CartItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -167,6 +167,29 @@ public class CartItem {
public CartItem() {
}
+ public CartItem(
+ Long returnedQuantity,
+ Long remainingQuantity,
+ BigDecimal position,
+ Long catalogItemID,
+ String selectedPriceType,
+ UUID adjustmentReferenceId,
+ OffsetDateTime adjustmentEffectiveFrom,
+ OffsetDateTime adjustmentEffectiveUntil,
+ Map prices
+ ) {
+ this();
+ this.returnedQuantity = returnedQuantity;
+ this.remainingQuantity = remainingQuantity;
+ this.position = position;
+ this.catalogItemID = catalogItemID;
+ this.selectedPriceType = selectedPriceType;
+ this.adjustmentReferenceId = adjustmentReferenceId;
+ this.adjustmentEffectiveFrom = adjustmentEffectiveFrom;
+ this.adjustmentEffectiveUntil = adjustmentEffectiveUntil;
+ this.prices = prices;
+ }
+
public CartItem name(@javax.annotation.Nullable String name) {
this.name = name;
return this;
@@ -225,11 +248,6 @@ public void setQuantity(@javax.annotation.Nonnull Long quantity) {
}
- public CartItem returnedQuantity(@javax.annotation.Nullable Long returnedQuantity) {
- this.returnedQuantity = returnedQuantity;
- return this;
- }
-
/**
* Number of returned items, calculated internally based on returns of this item.
* @return returnedQuantity
@@ -239,16 +257,8 @@ public Long getReturnedQuantity() {
return returnedQuantity;
}
- public void setReturnedQuantity(@javax.annotation.Nullable Long returnedQuantity) {
- this.returnedQuantity = returnedQuantity;
- }
- public CartItem remainingQuantity(@javax.annotation.Nullable Long remainingQuantity) {
- this.remainingQuantity = remainingQuantity;
- return this;
- }
-
/**
* Remaining quantity of the item, calculated internally based on returns of this item.
* @return remainingQuantity
@@ -258,9 +268,6 @@ public Long getRemainingQuantity() {
return remainingQuantity;
}
- public void setRemainingQuantity(@javax.annotation.Nullable Long remainingQuantity) {
- this.remainingQuantity = remainingQuantity;
- }
public CartItem price(@javax.annotation.Nullable BigDecimal price) {
@@ -396,11 +403,6 @@ public void setLength(@javax.annotation.Nullable BigDecimal length) {
}
- public CartItem position(@javax.annotation.Nullable BigDecimal position) {
- this.position = position;
- return this;
- }
-
/**
* Position of the Cart Item in the Cart (calculated internally).
* @return position
@@ -410,9 +412,6 @@ public BigDecimal getPosition() {
return position;
}
- public void setPosition(@javax.annotation.Nullable BigDecimal position) {
- this.position = position;
- }
public CartItem attributes(@javax.annotation.Nullable Object attributes) {
@@ -461,11 +460,6 @@ public void setAdditionalCosts(@javax.annotation.Nullable Map prices) {
- this.prices = prices;
- return this;
- }
-
- public CartItem putPricesItem(String key, PriceDetail pricesItem) {
- if (this.prices == null) {
- this.prices = new HashMap<>();
- }
- this.prices.put(key, pricesItem);
- return this;
- }
-
/**
* A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names.
* @return prices
@@ -578,9 +524,6 @@ public Map getPrices() {
return prices;
}
- public void setPrices(@javax.annotation.Nullable Map prices) {
- this.prices = prices;
- }
diff --git a/src/main/java/one/talon/model/CartItemFilterTemplate.java b/src/main/java/one/talon/model/CartItemFilterTemplate.java
index 15e666ef..552c9e01 100644
--- a/src/main/java/one/talon/model/CartItemFilterTemplate.java
+++ b/src/main/java/one/talon/model/CartItemFilterTemplate.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Catalog.java b/src/main/java/one/talon/model/Catalog.java
index d6b00d53..41160d41 100644
--- a/src/main/java/one/talon/model/Catalog.java
+++ b/src/main/java/one/talon/model/Catalog.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CatalogActionFilter.java b/src/main/java/one/talon/model/CatalogActionFilter.java
index 6eccc24a..f4348334 100644
--- a/src/main/java/one/talon/model/CatalogActionFilter.java
+++ b/src/main/java/one/talon/model/CatalogActionFilter.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CatalogItem.java b/src/main/java/one/talon/model/CatalogItem.java
index 0439d400..0ba82830 100644
--- a/src/main/java/one/talon/model/CatalogItem.java
+++ b/src/main/java/one/talon/model/CatalogItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CatalogRule.java b/src/main/java/one/talon/model/CatalogRule.java
index cf1072a0..0d1f41a5 100644
--- a/src/main/java/one/talon/model/CatalogRule.java
+++ b/src/main/java/one/talon/model/CatalogRule.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CatalogSyncRequest.java b/src/main/java/one/talon/model/CatalogSyncRequest.java
index 5a8dbb86..cdefa4be 100644
--- a/src/main/java/one/talon/model/CatalogSyncRequest.java
+++ b/src/main/java/one/talon/model/CatalogSyncRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java b/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java
index 32ece377..6ab5c1a9 100644
--- a/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CatalogsStrikethroughNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Change.java b/src/main/java/one/talon/model/Change.java
index 12882c8f..6333e135 100644
--- a/src/main/java/one/talon/model/Change.java
+++ b/src/main/java/one/talon/model/Change.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java b/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java
index 9834b3f8..df1205d3 100644
--- a/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java
+++ b/src/main/java/one/talon/model/ChangeLoyaltyTierLevelEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ChangeProfilePassword.java b/src/main/java/one/talon/model/ChangeProfilePassword.java
index ab0348d1..23e07808 100644
--- a/src/main/java/one/talon/model/ChangeProfilePassword.java
+++ b/src/main/java/one/talon/model/ChangeProfilePassword.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CodeGeneratorSettings.java b/src/main/java/one/talon/model/CodeGeneratorSettings.java
index 246b55f2..0ceab499 100644
--- a/src/main/java/one/talon/model/CodeGeneratorSettings.java
+++ b/src/main/java/one/talon/model/CodeGeneratorSettings.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Collection.java b/src/main/java/one/talon/model/Collection.java
index 9c15c20e..d8853deb 100644
--- a/src/main/java/one/talon/model/Collection.java
+++ b/src/main/java/one/talon/model/Collection.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CollectionItem.java b/src/main/java/one/talon/model/CollectionItem.java
index 5f0f9911..89c65be1 100644
--- a/src/main/java/one/talon/model/CollectionItem.java
+++ b/src/main/java/one/talon/model/CollectionItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CollectionWithoutPayload.java b/src/main/java/one/talon/model/CollectionWithoutPayload.java
index 01e933ad..dd0db9d9 100644
--- a/src/main/java/one/talon/model/CollectionWithoutPayload.java
+++ b/src/main/java/one/talon/model/CollectionWithoutPayload.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Coupon.java b/src/main/java/one/talon/model/Coupon.java
index 6ac1f761..86b5d09c 100644
--- a/src/main/java/one/talon/model/Coupon.java
+++ b/src/main/java/one/talon/model/Coupon.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponConstraints.java b/src/main/java/one/talon/model/CouponConstraints.java
index 1ee546fa..921f1eab 100644
--- a/src/main/java/one/talon/model/CouponConstraints.java
+++ b/src/main/java/one/talon/model/CouponConstraints.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponCreatedEffectProps.java b/src/main/java/one/talon/model/CouponCreatedEffectProps.java
index f8ba9f80..c65815a4 100644
--- a/src/main/java/one/talon/model/CouponCreatedEffectProps.java
+++ b/src/main/java/one/talon/model/CouponCreatedEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponCreationJob.java b/src/main/java/one/talon/model/CouponCreationJob.java
index af46333a..a919b3d8 100644
--- a/src/main/java/one/talon/model/CouponCreationJob.java
+++ b/src/main/java/one/talon/model/CouponCreationJob.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponDeletionFilters.java b/src/main/java/one/talon/model/CouponDeletionFilters.java
index ea00436b..93533af4 100644
--- a/src/main/java/one/talon/model/CouponDeletionFilters.java
+++ b/src/main/java/one/talon/model/CouponDeletionFilters.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponDeletionJob.java b/src/main/java/one/talon/model/CouponDeletionJob.java
index ca4e302f..d20a89d8 100644
--- a/src/main/java/one/talon/model/CouponDeletionJob.java
+++ b/src/main/java/one/talon/model/CouponDeletionJob.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponEntity.java b/src/main/java/one/talon/model/CouponEntity.java
index 2f80b28f..e2eb1972 100644
--- a/src/main/java/one/talon/model/CouponEntity.java
+++ b/src/main/java/one/talon/model/CouponEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponFailureSummary.java b/src/main/java/one/talon/model/CouponFailureSummary.java
index 71446005..3449d147 100644
--- a/src/main/java/one/talon/model/CouponFailureSummary.java
+++ b/src/main/java/one/talon/model/CouponFailureSummary.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponLimitConfigs.java b/src/main/java/one/talon/model/CouponLimitConfigs.java
index 9e126755..0f34cd73 100644
--- a/src/main/java/one/talon/model/CouponLimitConfigs.java
+++ b/src/main/java/one/talon/model/CouponLimitConfigs.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponRejectionReason.java b/src/main/java/one/talon/model/CouponRejectionReason.java
index bfb42f7f..52d1d236 100644
--- a/src/main/java/one/talon/model/CouponRejectionReason.java
+++ b/src/main/java/one/talon/model/CouponRejectionReason.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponReservations.java b/src/main/java/one/talon/model/CouponReservations.java
index 35667011..a92a0ef5 100644
--- a/src/main/java/one/talon/model/CouponReservations.java
+++ b/src/main/java/one/talon/model/CouponReservations.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponSearch.java b/src/main/java/one/talon/model/CouponSearch.java
index 9a88cf69..72e7cb2e 100644
--- a/src/main/java/one/talon/model/CouponSearch.java
+++ b/src/main/java/one/talon/model/CouponSearch.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponValue.java b/src/main/java/one/talon/model/CouponValue.java
index f83da703..62f7fc7e 100644
--- a/src/main/java/one/talon/model/CouponValue.java
+++ b/src/main/java/one/talon/model/CouponValue.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponWithApplication.java b/src/main/java/one/talon/model/CouponWithApplication.java
index e4eee81c..87a7f9de 100644
--- a/src/main/java/one/talon/model/CouponWithApplication.java
+++ b/src/main/java/one/talon/model/CouponWithApplication.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponsNotificationData.java b/src/main/java/one/talon/model/CouponsNotificationData.java
index 569d17cc..8903f821 100644
--- a/src/main/java/one/talon/model/CouponsNotificationData.java
+++ b/src/main/java/one/talon/model/CouponsNotificationData.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CouponsNotificationPolicy.java b/src/main/java/one/talon/model/CouponsNotificationPolicy.java
index 273ec8e1..a2000a6b 100644
--- a/src/main/java/one/talon/model/CouponsNotificationPolicy.java
+++ b/src/main/java/one/talon/model/CouponsNotificationPolicy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateAchievement.java b/src/main/java/one/talon/model/CreateAchievement.java
index d28fa436..a6ad459a 100644
--- a/src/main/java/one/talon/model/CreateAchievement.java
+++ b/src/main/java/one/talon/model/CreateAchievement.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateAchievementV2.java b/src/main/java/one/talon/model/CreateAchievementV2.java
index edab1a22..f1e291e9 100644
--- a/src/main/java/one/talon/model/CreateAchievementV2.java
+++ b/src/main/java/one/talon/model/CreateAchievementV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateApplicationAPIKey.java b/src/main/java/one/talon/model/CreateApplicationAPIKey.java
index 0000b39c..1ecd1b0b 100644
--- a/src/main/java/one/talon/model/CreateApplicationAPIKey.java
+++ b/src/main/java/one/talon/model/CreateApplicationAPIKey.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateCouponData.java b/src/main/java/one/talon/model/CreateCouponData.java
index 08a5c73e..fc7b49fe 100644
--- a/src/main/java/one/talon/model/CreateCouponData.java
+++ b/src/main/java/one/talon/model/CreateCouponData.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateCoupons200Response.java b/src/main/java/one/talon/model/CreateCoupons200Response.java
index 2e19ebf1..63bbf2c4 100644
--- a/src/main/java/one/talon/model/CreateCoupons200Response.java
+++ b/src/main/java/one/talon/model/CreateCoupons200Response.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateManagementKey.java b/src/main/java/one/talon/model/CreateManagementKey.java
index 953141fb..9596050b 100644
--- a/src/main/java/one/talon/model/CreateManagementKey.java
+++ b/src/main/java/one/talon/model/CreateManagementKey.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java b/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java
index c64af870..fba40d63 100644
--- a/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java
+++ b/src/main/java/one/talon/model/CreateReferralsForMultipleAdvocates201Response.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateTemplateCampaign.java b/src/main/java/one/talon/model/CreateTemplateCampaign.java
index d35b8282..28d5181d 100644
--- a/src/main/java/one/talon/model/CreateTemplateCampaign.java
+++ b/src/main/java/one/talon/model/CreateTemplateCampaign.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java b/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java
index dbff6cf3..76b08373 100644
--- a/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java
+++ b/src/main/java/one/talon/model/CreateTemplateCampaignResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomEffect.java b/src/main/java/one/talon/model/CustomEffect.java
index 2ed80e86..82fefdf1 100644
--- a/src/main/java/one/talon/model/CustomEffect.java
+++ b/src/main/java/one/talon/model/CustomEffect.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomEffectProps.java b/src/main/java/one/talon/model/CustomEffectProps.java
index a8a550b5..b5d622fd 100644
--- a/src/main/java/one/talon/model/CustomEffectProps.java
+++ b/src/main/java/one/talon/model/CustomEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerActivityReport.java b/src/main/java/one/talon/model/CustomerActivityReport.java
index d4c34553..96961cf8 100644
--- a/src/main/java/one/talon/model/CustomerActivityReport.java
+++ b/src/main/java/one/talon/model/CustomerActivityReport.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerAnalytics.java b/src/main/java/one/talon/model/CustomerAnalytics.java
index 514936a0..24888419 100644
--- a/src/main/java/one/talon/model/CustomerAnalytics.java
+++ b/src/main/java/one/talon/model/CustomerAnalytics.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerInventory.java b/src/main/java/one/talon/model/CustomerInventory.java
index 843e39b0..2c244b81 100644
--- a/src/main/java/one/talon/model/CustomerInventory.java
+++ b/src/main/java/one/talon/model/CustomerInventory.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerProfile.java b/src/main/java/one/talon/model/CustomerProfile.java
index 39f6f6d7..576ae6a8 100644
--- a/src/main/java/one/talon/model/CustomerProfile.java
+++ b/src/main/java/one/talon/model/CustomerProfile.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -24,7 +24,9 @@
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import one.talon.model.AudienceMembership;
import one.talon.model.LoyaltyMembership;
import com.google.gson.JsonElement;
@@ -75,7 +77,7 @@ public class CustomerProfile {
public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes";
@SerializedName(SERIALIZED_NAME_ATTRIBUTES)
@javax.annotation.Nullable
- private Object attributes;
+ private Map attributes;
public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -172,21 +174,29 @@ public void setIntegrationId(@javax.annotation.Nonnull String integrationId) {
}
- public CustomerProfile attributes(@javax.annotation.Nullable Object attributes) {
+ public CustomerProfile attributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
return this;
}
+ public CustomerProfile putAttributesItem(String key, Object attributesItem) {
+ if (this.attributes == null) {
+ this.attributes = new HashMap<>();
+ }
+ this.attributes.put(key, attributesItem);
+ return this;
+ }
+
/**
* Arbitrary properties associated with this item.
* @return attributes
*/
@javax.annotation.Nullable
- public Object getAttributes() {
+ public Map getAttributes() {
return attributes;
}
- public void setAttributes(@javax.annotation.Nullable Object attributes) {
+ public void setAttributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
}
@@ -308,7 +318,7 @@ public CustomerProfile lastActivity(@javax.annotation.Nonnull OffsetDateTime las
}
/**
- * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.
+ * Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field.
* @return lastActivity
*/
@javax.annotation.Nonnull
diff --git a/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java b/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java
index 9f6a17f3..9a9cabf5 100644
--- a/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java
+++ b/src/main/java/one/talon/model/CustomerProfileAudienceRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java b/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java
index fd030812..d9f6ba7d 100644
--- a/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java
+++ b/src/main/java/one/talon/model/CustomerProfileAudienceRequestItem.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -165,7 +165,7 @@ public CustomerProfileAudienceRequestItem audienceId(@javax.annotation.Nonnull L
}
/**
- * The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+ * The ID of the audience. You get it via the `id` property when [creating an audience](#tag/Audiences/operation/createAudienceV2).
* @return audienceId
*/
@javax.annotation.Nonnull
diff --git a/src/main/java/one/talon/model/CustomerProfileEntity.java b/src/main/java/one/talon/model/CustomerProfileEntity.java
index ae19ab71..ae99d292 100644
--- a/src/main/java/one/talon/model/CustomerProfileEntity.java
+++ b/src/main/java/one/talon/model/CustomerProfileEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java b/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java
index 4fd2933e..7505c288 100644
--- a/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java
+++ b/src/main/java/one/talon/model/CustomerProfileIntegrationRequestV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -22,7 +22,9 @@
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import one.talon.model.ProfileAudiencesChanges;
import com.google.gson.JsonElement;
@@ -57,7 +59,7 @@ public class CustomerProfileIntegrationRequestV2 {
public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes";
@SerializedName(SERIALIZED_NAME_ATTRIBUTES)
@javax.annotation.Nullable
- private Object attributes;
+ private Map attributes;
public static final String SERIALIZED_NAME_EVALUABLE_CAMPAIGN_IDS = "evaluableCampaignIds";
@SerializedName(SERIALIZED_NAME_EVALUABLE_CAMPAIGN_IDS)
@@ -137,21 +139,29 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti
public CustomerProfileIntegrationRequestV2() {
}
- public CustomerProfileIntegrationRequestV2 attributes(@javax.annotation.Nullable Object attributes) {
+ public CustomerProfileIntegrationRequestV2 attributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
return this;
}
+ public CustomerProfileIntegrationRequestV2 putAttributesItem(String key, Object attributesItem) {
+ if (this.attributes == null) {
+ this.attributes = new HashMap<>();
+ }
+ this.attributes.put(key, attributesItem);
+ return this;
+ }
+
/**
* Arbitrary properties associated with this item.
* @return attributes
*/
@javax.annotation.Nullable
- public Object getAttributes() {
+ public Map getAttributes() {
return attributes;
}
- public void setAttributes(@javax.annotation.Nullable Object attributes) {
+ public void setAttributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
}
diff --git a/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java b/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java
index b80da072..be3de1dc 100644
--- a/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java
+++ b/src/main/java/one/talon/model/CustomerProfileIntegrationResponseV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerProfileSearchQuery.java b/src/main/java/one/talon/model/CustomerProfileSearchQuery.java
index fe4d0cf7..85dd18d2 100644
--- a/src/main/java/one/talon/model/CustomerProfileSearchQuery.java
+++ b/src/main/java/one/talon/model/CustomerProfileSearchQuery.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java b/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java
index 57d59c29..f6269e1e 100644
--- a/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java
+++ b/src/main/java/one/talon/model/CustomerProfileUpdateV2Response.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerSession.java b/src/main/java/one/talon/model/CustomerSession.java
index 74044ec6..527b5fcc 100644
--- a/src/main/java/one/talon/model/CustomerSession.java
+++ b/src/main/java/one/talon/model/CustomerSession.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/CustomerSessionV2.java b/src/main/java/one/talon/model/CustomerSessionV2.java
index 25c883bf..269311d6 100644
--- a/src/main/java/one/talon/model/CustomerSessionV2.java
+++ b/src/main/java/one/talon/model/CustomerSessionV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
@@ -194,7 +194,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti
public static final String SERIALIZED_NAME_ATTRIBUTES = "attributes";
@SerializedName(SERIALIZED_NAME_ATTRIBUTES)
@javax.annotation.Nullable
- private Object attributes;
+ private Map attributes;
public static final String SERIALIZED_NAME_FIRST_SESSION = "firstSession";
@SerializedName(SERIALIZED_NAME_FIRST_SESSION)
@@ -570,21 +570,29 @@ public void setIdentifiers(@javax.annotation.Nullable List identifiers)
}
- public CustomerSessionV2 attributes(@javax.annotation.Nullable Object attributes) {
+ public CustomerSessionV2 attributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
return this;
}
+ public CustomerSessionV2 putAttributesItem(String key, Object attributesItem) {
+ if (this.attributes == null) {
+ this.attributes = new HashMap<>();
+ }
+ this.attributes.put(key, attributesItem);
+ return this;
+ }
+
/**
* Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property.
* @return attributes
*/
@javax.annotation.Nullable
- public Object getAttributes() {
+ public Map getAttributes() {
return attributes;
}
- public void setAttributes(@javax.annotation.Nullable Object attributes) {
+ public void setAttributes(@javax.annotation.Nullable Map attributes) {
this.attributes = attributes;
}
diff --git a/src/main/java/one/talon/model/DeactivateUserRequest.java b/src/main/java/one/talon/model/DeactivateUserRequest.java
index 48f280f3..80572a43 100644
--- a/src/main/java/one/talon/model/DeactivateUserRequest.java
+++ b/src/main/java/one/talon/model/DeactivateUserRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/DeductLoyaltyPoints.java b/src/main/java/one/talon/model/DeductLoyaltyPoints.java
index 8370c80c..99712c75 100644
--- a/src/main/java/one/talon/model/DeductLoyaltyPoints.java
+++ b/src/main/java/one/talon/model/DeductLoyaltyPoints.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java b/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java
index a433b461..6b968096 100644
--- a/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java
+++ b/src/main/java/one/talon/model/DeductLoyaltyPointsEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/DeleteCouponsData.java b/src/main/java/one/talon/model/DeleteCouponsData.java
index 053a8211..4309d0bc 100644
--- a/src/main/java/one/talon/model/DeleteCouponsData.java
+++ b/src/main/java/one/talon/model/DeleteCouponsData.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java b/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java
index b115532d..aad83911 100644
--- a/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java
+++ b/src/main/java/one/talon/model/DeleteLoyaltyTransactionsRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/DeleteUserRequest.java b/src/main/java/one/talon/model/DeleteUserRequest.java
index 66e4107f..1da20063 100644
--- a/src/main/java/one/talon/model/DeleteUserRequest.java
+++ b/src/main/java/one/talon/model/DeleteUserRequest.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Effect.java b/src/main/java/one/talon/model/Effect.java
index 96e24e0c..e228c8d4 100644
--- a/src/main/java/one/talon/model/Effect.java
+++ b/src/main/java/one/talon/model/Effect.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EffectEntity.java b/src/main/java/one/talon/model/EffectEntity.java
index 520ffdf9..34427a97 100644
--- a/src/main/java/one/talon/model/EffectEntity.java
+++ b/src/main/java/one/talon/model/EffectEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EmailEntity.java b/src/main/java/one/talon/model/EmailEntity.java
index 3063e2eb..fb1b4dfc 100644
--- a/src/main/java/one/talon/model/EmailEntity.java
+++ b/src/main/java/one/talon/model/EmailEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java b/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java
new file mode 100644
index 00000000..3199456d
--- /dev/null
+++ b/src/main/java/one/talon/model/EmbeddedAnalyticsConfiguration.java
@@ -0,0 +1,213 @@
+/*
+ * 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 one.talon.model.EmbeddedAnalyticsConfigurationDashboards;
+import com.google.gson.JsonElement;
+
+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;
+
+/**
+ * EmbeddedAnalyticsConfiguration
+ */
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.21.0")
+public class EmbeddedAnalyticsConfiguration {
+ public static final String SERIALIZED_NAME_DASHBOARDS = "dashboards";
+ @SerializedName(SERIALIZED_NAME_DASHBOARDS)
+ @javax.annotation.Nonnull
+ private EmbeddedAnalyticsConfigurationDashboards dashboards;
+
+ public EmbeddedAnalyticsConfiguration() {
+ }
+
+ public EmbeddedAnalyticsConfiguration dashboards(@javax.annotation.Nonnull EmbeddedAnalyticsConfigurationDashboards dashboards) {
+ this.dashboards = dashboards;
+ return this;
+ }
+
+ /**
+ * Get dashboards
+ * @return dashboards
+ */
+ @javax.annotation.Nonnull
+ public EmbeddedAnalyticsConfigurationDashboards getDashboards() {
+ return dashboards;
+ }
+
+ public void setDashboards(@javax.annotation.Nonnull EmbeddedAnalyticsConfigurationDashboards dashboards) {
+ this.dashboards = dashboards;
+ }
+
+
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ EmbeddedAnalyticsConfiguration embeddedAnalyticsConfiguration = (EmbeddedAnalyticsConfiguration) o;
+ return Objects.equals(this.dashboards, embeddedAnalyticsConfiguration.dashboards);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(dashboards);
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class EmbeddedAnalyticsConfiguration {\n");
+ sb.append(" dashboards: ").append(toIndentedString(dashboards)).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) {
+ if (o == null) {
+ return "null";
+ }
+ return 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("dashboards"));
+
+ // a set of required properties/fields (JSON key names)
+ openapiRequiredFields = new HashSet(Arrays.asList("dashboards"));
+ }
+
+ /**
+ * 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 EmbeddedAnalyticsConfiguration
+ */
+ public static void validateJsonElement(JsonElement jsonElement) throws IOException {
+ if (jsonElement == null) {
+ if (!EmbeddedAnalyticsConfiguration.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 EmbeddedAnalyticsConfiguration is not found in the empty JSON string", EmbeddedAnalyticsConfiguration.openapiRequiredFields.toString()));
+ }
+ }
+
+ Set> entries = jsonElement.getAsJsonObject().entrySet();
+ // check to see if the JSON string contains additional fields
+ for (Map.Entry entry : entries) {
+ if (!EmbeddedAnalyticsConfiguration.openapiFields.contains(entry.getKey())) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` in the JSON string is not defined in the `EmbeddedAnalyticsConfiguration` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
+ }
+ }
+
+ // check to make sure all required properties/fields are present in the JSON string
+ for (String requiredField : EmbeddedAnalyticsConfiguration.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 `dashboards`
+ EmbeddedAnalyticsConfigurationDashboards.validateJsonElement(jsonObj.get("dashboards"));
+ }
+
+ public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
+ @SuppressWarnings("unchecked")
+ @Override
+ public TypeAdapter create(Gson gson, TypeToken type) {
+ if (!EmbeddedAnalyticsConfiguration.class.isAssignableFrom(type.getRawType())) {
+ return null; // this class only serializes 'EmbeddedAnalyticsConfiguration' and its subtypes
+ }
+ final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
+ final TypeAdapter thisAdapter
+ = gson.getDelegateAdapter(this, TypeToken.get(EmbeddedAnalyticsConfiguration.class));
+
+ return (TypeAdapter) new TypeAdapter() {
+ @Override
+ public void write(JsonWriter out, EmbeddedAnalyticsConfiguration value) throws IOException {
+ JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
+ elementAdapter.write(out, obj);
+ }
+
+ @Override
+ public EmbeddedAnalyticsConfiguration read(JsonReader in) throws IOException {
+ JsonElement jsonElement = elementAdapter.read(in);
+ validateJsonElement(jsonElement);
+ return thisAdapter.fromJsonTree(jsonElement);
+ }
+
+ }.nullSafe();
+ }
+ }
+
+ /**
+ * Create an instance of EmbeddedAnalyticsConfiguration given an JSON string
+ *
+ * @param jsonString JSON string
+ * @return An instance of EmbeddedAnalyticsConfiguration
+ * @throws IOException if the JSON string is invalid with respect to EmbeddedAnalyticsConfiguration
+ */
+ public static EmbeddedAnalyticsConfiguration fromJson(String jsonString) throws IOException {
+ return JSON.getGson().fromJson(jsonString, EmbeddedAnalyticsConfiguration.class);
+ }
+
+ /**
+ * Convert an instance of EmbeddedAnalyticsConfiguration to an JSON string
+ *
+ * @return JSON string
+ */
+ public String toJson() {
+ return JSON.getGson().toJson(this);
+ }
+}
+
diff --git a/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java b/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java
new file mode 100644
index 00000000..2b423f31
--- /dev/null
+++ b/src/main/java/one/talon/model/EmbeddedAnalyticsConfigurationDashboards.java
@@ -0,0 +1,208 @@
+/*
+ * 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 one.talon.model.EmbeddedDashboardConfiguration;
+import com.google.gson.JsonElement;
+
+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;
+
+/**
+ * EmbeddedAnalyticsConfigurationDashboards
+ */
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.21.0")
+public class EmbeddedAnalyticsConfigurationDashboards {
+ public static final String SERIALIZED_NAME_CAMPAIGN_INSIGHTS = "campaignInsights";
+ @SerializedName(SERIALIZED_NAME_CAMPAIGN_INSIGHTS)
+ @javax.annotation.Nullable
+ private EmbeddedDashboardConfiguration campaignInsights;
+
+ public EmbeddedAnalyticsConfigurationDashboards() {
+ }
+
+ public EmbeddedAnalyticsConfigurationDashboards campaignInsights(@javax.annotation.Nullable EmbeddedDashboardConfiguration campaignInsights) {
+ this.campaignInsights = campaignInsights;
+ return this;
+ }
+
+ /**
+ * The configuration of the embedded Insights dashboard for campaigns.
+ * @return campaignInsights
+ */
+ @javax.annotation.Nullable
+ public EmbeddedDashboardConfiguration getCampaignInsights() {
+ return campaignInsights;
+ }
+
+ public void setCampaignInsights(@javax.annotation.Nullable EmbeddedDashboardConfiguration campaignInsights) {
+ this.campaignInsights = campaignInsights;
+ }
+
+
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ EmbeddedAnalyticsConfigurationDashboards embeddedAnalyticsConfigurationDashboards = (EmbeddedAnalyticsConfigurationDashboards) o;
+ return Objects.equals(this.campaignInsights, embeddedAnalyticsConfigurationDashboards.campaignInsights);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(campaignInsights);
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class EmbeddedAnalyticsConfigurationDashboards {\n");
+ sb.append(" campaignInsights: ").append(toIndentedString(campaignInsights)).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) {
+ if (o == null) {
+ return "null";
+ }
+ return 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("campaignInsights"));
+
+ // a set of required properties/fields (JSON key names)
+ openapiRequiredFields = new HashSet(0);
+ }
+
+ /**
+ * 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 EmbeddedAnalyticsConfigurationDashboards
+ */
+ public static void validateJsonElement(JsonElement jsonElement) throws IOException {
+ if (jsonElement == null) {
+ if (!EmbeddedAnalyticsConfigurationDashboards.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 EmbeddedAnalyticsConfigurationDashboards is not found in the empty JSON string", EmbeddedAnalyticsConfigurationDashboards.openapiRequiredFields.toString()));
+ }
+ }
+
+ Set> entries = jsonElement.getAsJsonObject().entrySet();
+ // check to see if the JSON string contains additional fields
+ for (Map.Entry entry : entries) {
+ if (!EmbeddedAnalyticsConfigurationDashboards.openapiFields.contains(entry.getKey())) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` in the JSON string is not defined in the `EmbeddedAnalyticsConfigurationDashboards` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
+ }
+ }
+ JsonObject jsonObj = jsonElement.getAsJsonObject();
+ // validate the optional field `campaignInsights`
+ if (jsonObj.get("campaignInsights") != null && !jsonObj.get("campaignInsights").isJsonNull()) {
+ EmbeddedDashboardConfiguration.validateJsonElement(jsonObj.get("campaignInsights"));
+ }
+ }
+
+ public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
+ @SuppressWarnings("unchecked")
+ @Override
+ public TypeAdapter create(Gson gson, TypeToken type) {
+ if (!EmbeddedAnalyticsConfigurationDashboards.class.isAssignableFrom(type.getRawType())) {
+ return null; // this class only serializes 'EmbeddedAnalyticsConfigurationDashboards' and its subtypes
+ }
+ final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
+ final TypeAdapter thisAdapter
+ = gson.getDelegateAdapter(this, TypeToken.get(EmbeddedAnalyticsConfigurationDashboards.class));
+
+ return (TypeAdapter) new TypeAdapter() {
+ @Override
+ public void write(JsonWriter out, EmbeddedAnalyticsConfigurationDashboards value) throws IOException {
+ JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
+ elementAdapter.write(out, obj);
+ }
+
+ @Override
+ public EmbeddedAnalyticsConfigurationDashboards read(JsonReader in) throws IOException {
+ JsonElement jsonElement = elementAdapter.read(in);
+ validateJsonElement(jsonElement);
+ return thisAdapter.fromJsonTree(jsonElement);
+ }
+
+ }.nullSafe();
+ }
+ }
+
+ /**
+ * Create an instance of EmbeddedAnalyticsConfigurationDashboards given an JSON string
+ *
+ * @param jsonString JSON string
+ * @return An instance of EmbeddedAnalyticsConfigurationDashboards
+ * @throws IOException if the JSON string is invalid with respect to EmbeddedAnalyticsConfigurationDashboards
+ */
+ public static EmbeddedAnalyticsConfigurationDashboards fromJson(String jsonString) throws IOException {
+ return JSON.getGson().fromJson(jsonString, EmbeddedAnalyticsConfigurationDashboards.class);
+ }
+
+ /**
+ * Convert an instance of EmbeddedAnalyticsConfigurationDashboards to an JSON string
+ *
+ * @return JSON string
+ */
+ public String toJson() {
+ return JSON.getGson().toJson(this);
+ }
+}
+
diff --git a/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java b/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java
new file mode 100644
index 00000000..be8677fc
--- /dev/null
+++ b/src/main/java/one/talon/model/EmbeddedDashboardConfiguration.java
@@ -0,0 +1,242 @@
+/*
+ * 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.JsonElement;
+
+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;
+
+/**
+ * EmbeddedDashboardConfiguration
+ */
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.21.0")
+public class EmbeddedDashboardConfiguration {
+ public static final String SERIALIZED_NAME_WORKSPACE_ID = "workspaceId";
+ @SerializedName(SERIALIZED_NAME_WORKSPACE_ID)
+ @javax.annotation.Nonnull
+ private String workspaceId;
+
+ public static final String SERIALIZED_NAME_DASHBOARD_ID = "dashboardId";
+ @SerializedName(SERIALIZED_NAME_DASHBOARD_ID)
+ @javax.annotation.Nonnull
+ private String dashboardId;
+
+ public EmbeddedDashboardConfiguration() {
+ }
+
+ public EmbeddedDashboardConfiguration workspaceId(@javax.annotation.Nonnull String workspaceId) {
+ this.workspaceId = workspaceId;
+ return this;
+ }
+
+ /**
+ * The ID of the workspace that contains dashboards.
+ * @return workspaceId
+ */
+ @javax.annotation.Nonnull
+ public String getWorkspaceId() {
+ return workspaceId;
+ }
+
+ public void setWorkspaceId(@javax.annotation.Nonnull String workspaceId) {
+ this.workspaceId = workspaceId;
+ }
+
+
+ public EmbeddedDashboardConfiguration dashboardId(@javax.annotation.Nonnull String dashboardId) {
+ this.dashboardId = dashboardId;
+ return this;
+ }
+
+ /**
+ * The ID of the dashboard that contains metrics.
+ * @return dashboardId
+ */
+ @javax.annotation.Nonnull
+ public String getDashboardId() {
+ return dashboardId;
+ }
+
+ public void setDashboardId(@javax.annotation.Nonnull String dashboardId) {
+ this.dashboardId = dashboardId;
+ }
+
+
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ EmbeddedDashboardConfiguration embeddedDashboardConfiguration = (EmbeddedDashboardConfiguration) o;
+ return Objects.equals(this.workspaceId, embeddedDashboardConfiguration.workspaceId) &&
+ Objects.equals(this.dashboardId, embeddedDashboardConfiguration.dashboardId);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(workspaceId, dashboardId);
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class EmbeddedDashboardConfiguration {\n");
+ sb.append(" workspaceId: ").append(toIndentedString(workspaceId)).append("\n");
+ sb.append(" dashboardId: ").append(toIndentedString(dashboardId)).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) {
+ if (o == null) {
+ return "null";
+ }
+ return 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("workspaceId", "dashboardId"));
+
+ // a set of required properties/fields (JSON key names)
+ openapiRequiredFields = new HashSet(Arrays.asList("workspaceId", "dashboardId"));
+ }
+
+ /**
+ * 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 EmbeddedDashboardConfiguration
+ */
+ public static void validateJsonElement(JsonElement jsonElement) throws IOException {
+ if (jsonElement == null) {
+ if (!EmbeddedDashboardConfiguration.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 EmbeddedDashboardConfiguration is not found in the empty JSON string", EmbeddedDashboardConfiguration.openapiRequiredFields.toString()));
+ }
+ }
+
+ Set> entries = jsonElement.getAsJsonObject().entrySet();
+ // check to see if the JSON string contains additional fields
+ for (Map.Entry entry : entries) {
+ if (!EmbeddedDashboardConfiguration.openapiFields.contains(entry.getKey())) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` in the JSON string is not defined in the `EmbeddedDashboardConfiguration` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
+ }
+ }
+
+ // check to make sure all required properties/fields are present in the JSON string
+ for (String requiredField : EmbeddedDashboardConfiguration.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("workspaceId").isJsonPrimitive()) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `workspaceId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("workspaceId").toString()));
+ }
+ if (!jsonObj.get("dashboardId").isJsonPrimitive()) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `dashboardId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("dashboardId").toString()));
+ }
+ }
+
+ public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
+ @SuppressWarnings("unchecked")
+ @Override
+ public TypeAdapter create(Gson gson, TypeToken type) {
+ if (!EmbeddedDashboardConfiguration.class.isAssignableFrom(type.getRawType())) {
+ return null; // this class only serializes 'EmbeddedDashboardConfiguration' and its subtypes
+ }
+ final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
+ final TypeAdapter thisAdapter
+ = gson.getDelegateAdapter(this, TypeToken.get(EmbeddedDashboardConfiguration.class));
+
+ return (TypeAdapter) new TypeAdapter() {
+ @Override
+ public void write(JsonWriter out, EmbeddedDashboardConfiguration value) throws IOException {
+ JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
+ elementAdapter.write(out, obj);
+ }
+
+ @Override
+ public EmbeddedDashboardConfiguration read(JsonReader in) throws IOException {
+ JsonElement jsonElement = elementAdapter.read(in);
+ validateJsonElement(jsonElement);
+ return thisAdapter.fromJsonTree(jsonElement);
+ }
+
+ }.nullSafe();
+ }
+ }
+
+ /**
+ * Create an instance of EmbeddedDashboardConfiguration given an JSON string
+ *
+ * @param jsonString JSON string
+ * @return An instance of EmbeddedDashboardConfiguration
+ * @throws IOException if the JSON string is invalid with respect to EmbeddedDashboardConfiguration
+ */
+ public static EmbeddedDashboardConfiguration fromJson(String jsonString) throws IOException {
+ return JSON.getGson().fromJson(jsonString, EmbeddedDashboardConfiguration.class);
+ }
+
+ /**
+ * Convert an instance of EmbeddedDashboardConfiguration to an JSON string
+ *
+ * @return JSON string
+ */
+ public String toJson() {
+ return JSON.getGson().toJson(this);
+ }
+}
+
diff --git a/src/main/java/one/talon/model/Endpoint.java b/src/main/java/one/talon/model/Endpoint.java
index 80ce4a5c..3bb3e13e 100644
--- a/src/main/java/one/talon/model/Endpoint.java
+++ b/src/main/java/one/talon/model/Endpoint.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Entity.java b/src/main/java/one/talon/model/Entity.java
index a4d921dc..bf57b23e 100644
--- a/src/main/java/one/talon/model/Entity.java
+++ b/src/main/java/one/talon/model/Entity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EntityWithTalangVisibleID.java b/src/main/java/one/talon/model/EntityWithTalangVisibleID.java
index b3539eec..23339e4d 100644
--- a/src/main/java/one/talon/model/EntityWithTalangVisibleID.java
+++ b/src/main/java/one/talon/model/EntityWithTalangVisibleID.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Environment.java b/src/main/java/one/talon/model/Environment.java
index 1de80320..6b18c208 100644
--- a/src/main/java/one/talon/model/Environment.java
+++ b/src/main/java/one/talon/model/Environment.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ErrorEffectProps.java b/src/main/java/one/talon/model/ErrorEffectProps.java
index 146695c7..c3c575b9 100644
--- a/src/main/java/one/talon/model/ErrorEffectProps.java
+++ b/src/main/java/one/talon/model/ErrorEffectProps.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ErrorResponse.java b/src/main/java/one/talon/model/ErrorResponse.java
index abb17237..410036f4 100644
--- a/src/main/java/one/talon/model/ErrorResponse.java
+++ b/src/main/java/one/talon/model/ErrorResponse.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ErrorResponseWithStatus.java b/src/main/java/one/talon/model/ErrorResponseWithStatus.java
index cc3fef3f..55dc8ad2 100644
--- a/src/main/java/one/talon/model/ErrorResponseWithStatus.java
+++ b/src/main/java/one/talon/model/ErrorResponseWithStatus.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ErrorSource.java b/src/main/java/one/talon/model/ErrorSource.java
index ee238fde..962cc4b5 100644
--- a/src/main/java/one/talon/model/ErrorSource.java
+++ b/src/main/java/one/talon/model/ErrorSource.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EvaluableCampaignIds.java b/src/main/java/one/talon/model/EvaluableCampaignIds.java
index 3c624066..b5407b34 100644
--- a/src/main/java/one/talon/model/EvaluableCampaignIds.java
+++ b/src/main/java/one/talon/model/EvaluableCampaignIds.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Event.java b/src/main/java/one/talon/model/Event.java
index 8f8dfffd..c884dec5 100644
--- a/src/main/java/one/talon/model/Event.java
+++ b/src/main/java/one/talon/model/Event.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EventAttributesEntity.java b/src/main/java/one/talon/model/EventAttributesEntity.java
index 6a818967..9165d7f9 100644
--- a/src/main/java/one/talon/model/EventAttributesEntity.java
+++ b/src/main/java/one/talon/model/EventAttributesEntity.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EventType.java b/src/main/java/one/talon/model/EventType.java
index 32c83d84..01232e97 100644
--- a/src/main/java/one/talon/model/EventType.java
+++ b/src/main/java/one/talon/model/EventType.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EventV2.java b/src/main/java/one/talon/model/EventV2.java
index 5ba538c8..d1fcfa38 100644
--- a/src/main/java/one/talon/model/EventV2.java
+++ b/src/main/java/one/talon/model/EventV2.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/EventV3.java b/src/main/java/one/talon/model/EventV3.java
index 7a0d1a4f..aa149cba 100644
--- a/src/main/java/one/talon/model/EventV3.java
+++ b/src/main/java/one/talon/model/EventV3.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/Experiment.java b/src/main/java/one/talon/model/Experiment.java
index e3cd712b..3a35748d 100644
--- a/src/main/java/one/talon/model/Experiment.java
+++ b/src/main/java/one/talon/model/Experiment.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ExperimentCampaignCopy.java b/src/main/java/one/talon/model/ExperimentCampaignCopy.java
index e032673c..eb47dd1b 100644
--- a/src/main/java/one/talon/model/ExperimentCampaignCopy.java
+++ b/src/main/java/one/talon/model/ExperimentCampaignCopy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ExperimentCopy.java b/src/main/java/one/talon/model/ExperimentCopy.java
index 7e69e72d..e013592e 100644
--- a/src/main/java/one/talon/model/ExperimentCopy.java
+++ b/src/main/java/one/talon/model/ExperimentCopy.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ExperimentCopyExperiment.java b/src/main/java/one/talon/model/ExperimentCopyExperiment.java
index 014c8784..f06743d5 100644
--- a/src/main/java/one/talon/model/ExperimentCopyExperiment.java
+++ b/src/main/java/one/talon/model/ExperimentCopyExperiment.java
@@ -1,6 +1,6 @@
/*
* Talon.One API
- * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ * 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:
*
diff --git a/src/main/java/one/talon/model/ExperimentListResults.java b/src/main/java/one/talon/model/ExperimentListResults.java
new file mode 100644
index 00000000..82e29a52
--- /dev/null
+++ b/src/main/java/one/talon/model/ExperimentListResults.java
@@ -0,0 +1,228 @@
+/*
+ * 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.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import one.talon.model.ExperimentResult;
+import com.google.gson.JsonElement;
+
+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;
+
+/**
+ * ExperimentListResults
+ */
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.21.0")
+public class ExperimentListResults {
+ public static final String SERIALIZED_NAME_RESULTS = "results";
+ @SerializedName(SERIALIZED_NAME_RESULTS)
+ @javax.annotation.Nullable
+ private List results;
+
+ public ExperimentListResults() {
+ }
+
+ public ExperimentListResults results(@javax.annotation.Nullable List results) {
+ this.results = results;
+ return this;
+ }
+
+ public ExperimentListResults addResultsItem(ExperimentResult resultsItem) {
+ if (this.results == null) {
+ this.results = new ArrayList<>();
+ }
+ this.results.add(resultsItem);
+ return this;
+ }
+
+ /**
+ * Get results
+ * @return results
+ */
+ @javax.annotation.Nullable
+ public List getResults() {
+ return results;
+ }
+
+ public void setResults(@javax.annotation.Nullable List results) {
+ this.results = results;
+ }
+
+
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ ExperimentListResults experimentListResults = (ExperimentListResults) o;
+ return Objects.equals(this.results, experimentListResults.results);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(results);
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class ExperimentListResults {\n");
+ sb.append(" results: ").append(toIndentedString(results)).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) {
+ if (o == null) {
+ return "null";
+ }
+ return 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("results"));
+
+ // a set of required properties/fields (JSON key names)
+ openapiRequiredFields = new HashSet(0);
+ }
+
+ /**
+ * 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 ExperimentListResults
+ */
+ public static void validateJsonElement(JsonElement jsonElement) throws IOException {
+ if (jsonElement == null) {
+ if (!ExperimentListResults.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 ExperimentListResults is not found in the empty JSON string", ExperimentListResults.openapiRequiredFields.toString()));
+ }
+ }
+
+ Set> entries = jsonElement.getAsJsonObject().entrySet();
+ // check to see if the JSON string contains additional fields
+ for (Map.Entry entry : entries) {
+ if (!ExperimentListResults.openapiFields.contains(entry.getKey())) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The field `%s` in the JSON string is not defined in the `ExperimentListResults` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
+ }
+ }
+ JsonObject jsonObj = jsonElement.getAsJsonObject();
+ if (jsonObj.get("results") != null && !jsonObj.get("results").isJsonNull()) {
+ JsonArray jsonArrayresults = jsonObj.getAsJsonArray("results");
+ if (jsonArrayresults != null) {
+ // ensure the json data is an array
+ if (!jsonObj.get("results").isJsonArray()) {
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "Expected the field `results` to be an array in the JSON string but got `%s`", jsonObj.get("results").toString()));
+ }
+
+ // validate the optional field `results` (array)
+ for (int i = 0; i < jsonArrayresults.size(); i++) {
+ ExperimentResult.validateJsonElement(jsonArrayresults.get(i));
+ };
+ }
+ }
+ }
+
+ public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
+ @SuppressWarnings("unchecked")
+ @Override
+ public TypeAdapter create(Gson gson, TypeToken type) {
+ if (!ExperimentListResults.class.isAssignableFrom(type.getRawType())) {
+ return null; // this class only serializes 'ExperimentListResults' and its subtypes
+ }
+ final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
+ final TypeAdapter thisAdapter
+ = gson.getDelegateAdapter(this, TypeToken.get(ExperimentListResults.class));
+
+ return (TypeAdapter