Important
-
With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.
+
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
@@ -3963,6 +3974,9 @@ paths:
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.
@@ -4653,7 +4667,7 @@ paths:
- `identifier` (required): The alphanumeric identifier of the loyalty card.
- `state` (required): The state of the loyalty card. It can be `active` or `inactive`.
- - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card.
+ - `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.
@@ -6450,7 +6464,7 @@ paths:
Display the health of the Application and show the last time the Application
was used.
- You can also display this information from the **Settings** of an Application, in the **Developer Settings** menu.
+ You can also find this information in the Campaign Manager. In your Application, click **Settings** > **Integration API Keys**.
See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
operationId: getApplicationApiHealth
parameters:
@@ -6568,93 +6582,6 @@ paths:
tags:
- management
x-accepts: application/json
- /v1/access_logs:
- get:
- description: |
- Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
- operationId: getAllAccessLogs
- parameters:
- - 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.
- in: query
- name: rangeStart
- schema:
- format: date-time
- type: string
- - 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.
- in: query
- name: rangeEnd
- schema:
- format: date-time
- type: string
- - description: Only return results where the request path matches the given
- regular expression.
- in: query
- name: path
- schema:
- type: string
- - description: Only return results where the request method matches the given
- regular expression.
- in: query
- name: method
- schema:
- enum:
- - get
- - put
- - post
- - delete
- - patch
- type: string
- - description: Filter results by HTTP status codes.
- in: query
- name: status
- schema:
- enum:
- - success
- - error
- type: string
- - description: The number of items in the response.
- in: query
- name: pageSize
- schema:
- default: 1000
- maximum: 1000
- minimum: 1
- type: integer
- - description: The number of items to skip when paging through large result
- sets.
- in: query
- name: skip
- schema:
- type: integer
- - description: |
- The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
-
- **Note:** This parameter works only with numeric fields.
- in: query
- name: sort
- schema:
- type: string
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/inline_response_200_20'
- description: OK
- summary: List access logs
- tags:
- - management
- x-accepts: application/json
/v1/applications/{applicationId}/campaigns/{campaignId}/analytics:
get:
description: Retrieve statistical data about the performance of the given campaign.
@@ -6714,7 +6641,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_21'
+ $ref: '#/components/schemas/inline_response_200_20'
description: OK
summary: Get analytics of campaigns
tags:
@@ -6766,7 +6693,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_22'
+ $ref: '#/components/schemas/inline_response_200_21'
description: OK
summary: List application's customers
tags:
@@ -6822,7 +6749,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_23'
+ $ref: '#/components/schemas/inline_response_200_22'
description: OK
summary: List application customers matching the given attributes
tags:
@@ -6870,7 +6797,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_24'
+ $ref: '#/components/schemas/inline_response_200_23'
description: OK
summary: List customer profiles matching the given attributes
tags:
@@ -6943,7 +6870,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_25'
+ $ref: '#/components/schemas/inline_response_200_24'
description: OK
summary: List customer profiles
tags:
@@ -7067,7 +6994,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_26'
+ $ref: '#/components/schemas/inline_response_200_25'
description: OK
summary: Get Activity Reports for Application Customers
tags:
@@ -7286,7 +7213,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_27'
+ $ref: '#/components/schemas/inline_response_200_26'
description: OK
summary: List Application sessions
tags:
@@ -7427,7 +7354,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_28'
+ $ref: '#/components/schemas/inline_response_200_27'
description: OK
summary: List Applications events
tags:
@@ -7475,7 +7402,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_29'
+ $ref: '#/components/schemas/inline_response_200_28'
description: OK
summary: List Applications event types
tags:
@@ -7523,7 +7450,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_30'
+ $ref: '#/components/schemas/inline_response_200_29'
description: OK
summary: List audiences
tags:
@@ -7555,7 +7482,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_31'
+ $ref: '#/components/schemas/inline_response_200_30'
description: OK
summary: List audience analytics
tags:
@@ -7607,7 +7534,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_32'
+ $ref: '#/components/schemas/inline_response_200_31'
description: OK
"404":
content:
@@ -7787,7 +7714,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_33'
+ $ref: '#/components/schemas/inline_response_200_32'
description: OK
summary: List friends referred by customer profile
tags:
@@ -7831,7 +7758,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_34'
+ $ref: '#/components/schemas/inline_response_200_33'
description: OK
summary: List custom attributes
tags:
@@ -8064,7 +7991,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_35'
+ $ref: '#/components/schemas/inline_response_200_34'
description: OK
summary: List items in a catalog
tags:
@@ -8401,7 +8328,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_36'
+ $ref: '#/components/schemas/inline_response_200_35'
description: OK
summary: List additional costs
tags:
@@ -8556,7 +8483,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_37'
+ $ref: '#/components/schemas/inline_response_200_36'
description: OK
summary: List webhooks
tags:
@@ -8653,7 +8580,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_38'
+ $ref: '#/components/schemas/inline_response_200_37'
description: OK
summary: List webhook activation log entries
tags:
@@ -8735,7 +8662,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_39'
+ $ref: '#/components/schemas/inline_response_200_38'
description: OK
summary: List webhook log entries
tags:
@@ -8786,7 +8713,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_40'
+ $ref: '#/components/schemas/inline_response_200_39'
description: OK
summary: List event types
tags:
@@ -9396,7 +9323,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_41'
+ $ref: '#/components/schemas/inline_response_200_40'
description: OK
summary: List users in account
tags:
@@ -9864,7 +9791,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_42'
+ $ref: '#/components/schemas/inline_response_200_41'
description: OK
summary: Get audit logs for an account
tags:
@@ -10126,7 +10053,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_43'
+ $ref: '#/components/schemas/inline_response_200_42'
description: OK
summary: Get exports
tags:
@@ -10141,7 +10068,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_44'
+ $ref: '#/components/schemas/inline_response_200_43'
description: OK
summary: List roles
tags:
@@ -10274,7 +10201,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_45'
+ $ref: '#/components/schemas/inline_response_200_44'
description: OK
summary: List stores
tags:
@@ -10658,7 +10585,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_46'
+ $ref: '#/components/schemas/inline_response_200_45'
description: OK
summary: List achievements
tags:
@@ -10995,7 +10922,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_47'
+ $ref: '#/components/schemas/inline_response_200_46'
description: OK
"400":
content:
@@ -11190,6 +11117,16 @@ components:
description: The ID of the loyalty program that owns this entity.
example: 125
type: integer
+ programName:
+ description: The integration name of the loyalty program that owns this
+ entity.
+ example: Loyalty_program
+ type: string
+ programTitle:
+ description: The Campaign Manager-displayed name of the loyalty program
+ that owns this entity.
+ example: Loyalty program
+ type: string
required:
- programID
type: object
@@ -11745,12 +11682,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -11827,12 +11764,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -13382,6 +13319,30 @@ components:
type: string
type: array
type: object
+ NewValueMap:
+ type: object
+ ValueMap:
+ properties:
+ id:
+ description: Unique ID for this entity. Not to be confused with the Integration
+ ID, which is set by your integration layer and used in most endpoints.
+ example: 6
+ type: integer
+ created:
+ example: 2021-07-20T22:00:00Z
+ format: date-time
+ type: string
+ createdBy:
+ description: The ID of the user who created the value map.
+ example: 216
+ type: integer
+ campaignId:
+ example: 244
+ type: integer
+ required:
+ - campaignId
+ - id
+ type: object
CampaignBudget:
example:
limit: 1000.0
@@ -13973,6 +13934,7 @@ components:
- Profile
- Identifier
- Store
+ - Session
type: string
type: array
required:
@@ -14022,6 +13984,7 @@ components:
- Profile
- Identifier
- Store
+ - Session
type: string
type: array
required:
@@ -16449,7 +16412,7 @@ components:
- 71
isAdmin: false
accountId: 3886
- applicationNotificationSubscriptions: '{}'
+ applicationNotificationSubscriptions: {}
inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
name: John Doe
modified: 2021-09-12T10:12:42Z
@@ -16462,7 +16425,7 @@ components:
email: john.doe@example.com
policy:
Role: 127
- additionalAttributes: '{}'
+ additionalAttributes: {}
properties:
id:
description: Internal ID of this entity.
@@ -16529,6 +16492,7 @@ components:
type: string
applicationNotificationSubscriptions:
description: Application notifications that the user is subscribed to.
+ example: {}
properties: {}
type: object
lastSignedIn:
@@ -16549,6 +16513,7 @@ components:
additionalAttributes:
description: Additional user attributes, created and used by external identity
providers.
+ example: {}
properties: {}
type: object
required:
@@ -16764,7 +16729,7 @@ components:
Resources:
- active: true
displayName: John Doe
- id: 283
+ id: "283"
meta:
resourceType: User
created: 2024-06-25T17:43:46+02:00
@@ -16822,7 +16787,7 @@ components:
Operations:
- op: replace
path: active
- value: false
+ value: test
- op: add
path: nickName
value: johndoe
@@ -16950,8 +16915,8 @@ components:
description: Parameters for inviting a new user.
example:
roles:
- - 0
- - 0
+ - 13
+ - 13
name: John Doe
isAdmin: false
acl: acl
@@ -16973,6 +16938,7 @@ components:
roles:
description: A list of the IDs of the roles assigned to the user.
items:
+ example: 13
type: integer
type: array
acl:
@@ -17027,7 +16993,7 @@ components:
- loyalty
id: 6727
created: 2020-06-10T09:05:27.993483Z
- old: '{}'
+ old: {}
id: 6
applicationId: 359
userId: 388
@@ -17057,6 +17023,7 @@ components:
type: string
old:
description: Resource before the change occurred.
+ example: {}
properties: {}
type: object
new:
@@ -17229,12 +17196,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -17457,12 +17424,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
items:
$ref: '#/components/schemas/LoyaltyTier'
type: array
@@ -17543,6 +17510,16 @@ components:
description: The ID of the loyalty program that owns this entity.
example: 125
type: integer
+ programName:
+ description: The integration name of the loyalty program that owns this
+ entity.
+ example: Loyalty_program
+ type: string
+ programTitle:
+ description: The Campaign Manager-displayed name of the loyalty program
+ that owns this entity.
+ example: Loyalty program
+ type: string
name:
description: The name of the tier.
example: Gold
@@ -17550,7 +17527,6 @@ components:
minPoints:
description: The minimum amount of points required to enter the tier.
example: 300.0
- exclusiveMaximum: false
maximum: 999999999999.99
minimum: 0
type: number
@@ -17571,7 +17547,6 @@ components:
minPoints:
description: The minimum amount of points required to enter the tier.
example: 300.0
- exclusiveMaximum: false
maximum: 999999999999.99
minimum: 0
type: number
@@ -18018,7 +17993,6 @@ components:
minPoints:
description: The minimum amount of points required to enter the tier.
example: 300.0
- exclusiveMaximum: false
maximum: 999999999999.99
minimum: 0
type: number
@@ -18475,10 +18449,11 @@ components:
startDate: 2021-07-20T22:00:00Z
subLedgers:
mysubledger:
- activePoints: 286
- pendingPoints: 50
- spentPoints: 150
- expiredPoints: 25
+ total: 0
+ totalActivePoints: 286
+ totalPendingPoints: 50
+ totalSpentPoints: 150
+ totalExpiredPoints: 25
properties:
ledger:
$ref: '#/components/schemas/LoyaltySubLedger'
@@ -18488,10 +18463,11 @@ components:
description: A map containing a list of all loyalty subledger balances.
example:
mysubledger:
- activePoints: 286
- pendingPoints: 50
- spentPoints: 150
- expiredPoints: 25
+ total: 0
+ totalActivePoints: 286
+ totalPendingPoints: 50
+ totalSpentPoints: 150
+ totalExpiredPoints: 25
type: object
required:
- ledger
@@ -18757,6 +18733,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -18802,6 +18780,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -18969,17 +18949,18 @@ components:
title: Spent balance
type: number
tentativeCurrentBalance:
- description: Sum of the tentative active points (including additions and
- deductions) inside the currently open session. The `currentBalance` is
- updated to this value when you close the session, and the effects are
- applied.
+ description: |
+ The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.
+
+ **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
example: 100.0
title: Tentative current balance
type: number
tentativePendingBalance:
- description: Sum of pending points (including additions and deductions)
- inside the currently open session. The `pendingBalance` is updated to
- this value when you close the session, and the effects are applied.
+ description: |
+ The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.
+
+ **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
example: 20.0
title: Tentative pending balance
type: number
@@ -19189,6 +19170,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -19209,6 +19192,16 @@ components:
description: The ID of the loyalty program that owns this entity.
example: 125
type: integer
+ programName:
+ description: The integration name of the loyalty program that owns this
+ entity.
+ example: Loyalty_program
+ type: string
+ programTitle:
+ description: The Campaign Manager-displayed name of the loyalty program
+ that owns this entity.
+ example: Loyalty program
+ type: string
status:
description: |
Status of the loyalty card. Can be `active` or `inactive`.
@@ -19947,17 +19940,18 @@ components:
title: Spent balance
type: number
tentativeCurrentBalance:
- description: Sum of the tentative active points (including additions and
- deductions) inside the currently open session. The `currentBalance` is
- updated to this value when you close the session, and the effects are
- applied.
+ description: |
+ The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.
+
+ **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
example: 100.0
title: Tentative current balance
type: number
tentativePendingBalance:
- description: Sum of pending points (including additions and deductions)
- inside the currently open session. The `pendingBalance` is updated to
- this value when you close the session, and the effects are applied.
+ description: |
+ The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.
+
+ **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
example: 20.0
title: Tentative pending balance
type: number
@@ -20317,6 +20311,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -20362,6 +20358,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -20703,7 +20701,7 @@ components:
**Important - for requests only**:
- If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it.
- - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely.
+ - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely.
example:
- XMAS-20-2021
items:
@@ -20718,7 +20716,7 @@ components:
**Important - for requests only**:
- If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it.
- - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely.
+ - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely.
example: NT2K54D9
maxLength: 100
title: Referral code entered in session
@@ -21046,6 +21044,7 @@ components:
identifiers:
- d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea
integrationId: URNGV8294NV
+ closurePrediction: 0.283
total: 119.99
loyaltyCards:
- loyalty-card-1
@@ -21163,7 +21162,7 @@ components:
**Important - for requests only**:
- If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it.
- - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely.
+ - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely.
example:
- XMAS-20-2021
items:
@@ -21178,7 +21177,7 @@ components:
**Important - for requests only**:
- If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it.
- - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely.
+ - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely.
example: NT2K54D9
maxLength: 100
title: Referral code entered in session
@@ -21264,7 +21263,7 @@ components:
type: object
firstSession:
description: Indicates whether this is the first session for the customer's
- profile. Will always be true for anonymous sessions.
+ profile. It's always `true` for anonymous sessions.
example: true
title: First session ever?
type: boolean
@@ -21291,6 +21290,12 @@ components:
format: date-time
title: Last activity on the session
type: string
+ closurePrediction:
+ description: The likelihood of the customer session closing based on predictive
+ modeling, expressed as a decimal between `0` and `1`.
+ example: 0.283
+ title: Session Closure Probability
+ type: number
required:
- additionalCostTotal
- applicationId
@@ -21892,6 +21897,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -21937,6 +21944,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -22513,6 +22522,7 @@ components:
identifiers:
- d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea
integrationId: URNGV8294NV
+ closurePrediction: 0.283
total: 119.99
loyaltyCards:
- loyalty-card-1
@@ -23144,6 +23154,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -23189,6 +23201,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -23853,6 +23867,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -23898,6 +23914,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -24278,6 +24296,7 @@ components:
identifiers:
- d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea
integrationId: URNGV8294NV
+ closurePrediction: 0.283
total: 119.99
loyaltyCards:
- loyalty-card-1
@@ -24346,6 +24365,10 @@ components:
customerSession:
$ref: '#/components/schemas/CustomerSessionV2'
effects:
+ description: |
+ The returned effects.
+
+ **Note:** This endpoint returns only the effects that are valid after any rollback effects and their corresponding non-rollback effects are removed.
items:
$ref: '#/components/schemas/Effect'
type: array
@@ -25528,6 +25551,9 @@ components:
this argument.
properties: {}
type: object
+ key:
+ description: The identifier for the associated value within the JSON object.
+ type: string
picklistID:
description: ID of the picklist linked to a template.
type: integer
@@ -27224,10 +27250,11 @@ components:
NewWebhook:
properties:
applicationIds:
- description: The IDs of the Applications that are related to this entity.
+ description: |
+ The IDs of the Applications in which this webhook is available.
+ An empty array means the webhook is available in `All Applications`.
items:
type: integer
- minItems: 1
type: array
title:
description: Name or title for this webhook.
@@ -27319,10 +27346,11 @@ components:
format: date-time
type: string
applicationIds:
- description: The IDs of the Applications that are related to this entity.
+ description: |
+ The IDs of the Applications in which this webhook is available.
+ An empty array means the webhook is available in `All Applications`.
items:
type: integer
- minItems: 1
type: array
title:
description: Name or title for this webhook.
@@ -27420,10 +27448,11 @@ components:
format: date-time
type: string
applicationIds:
- description: The IDs of the Applications that are related to this entity.
+ description: |
+ The IDs of the Applications in which this webhook is available.
+ An empty array means the webhook is available in `All Applications`.
items:
type: integer
- minItems: 1
type: array
title:
description: Name or title for this webhook.
@@ -30793,7 +30822,10 @@ components:
action:
description: |
Defines the action to perform:
- - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created.
+ - `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.
enum:
- add
@@ -31128,7 +31160,7 @@ components:
- boolean
- number
- time
- example: 2012-11-01T22:08:41+00:00
+ example: string
type: string
values:
description: The list of allowed values provided by this picklist.
@@ -31163,7 +31195,7 @@ components:
- boolean
- number
- time
- example: 2012-11-01T22:08:41+00:00
+ example: string
type: string
values:
description: The list of allowed values provided by this picklist.
@@ -31209,7 +31241,7 @@ components:
- boolean
- number
- time
- example: 2012-11-01T22:08:41+00:00
+ example: string
type: string
values:
description: The list of allowed values provided by this picklist.
@@ -34065,7 +34097,7 @@ components:
name: sample_product
properties:
name:
- description: The name of the product.
+ description: The product the item belongs to.
example: sample_product
maxLength: 50
type: string
@@ -35127,23 +35159,23 @@ components:
type: object
GenerateCampaignDescription:
properties:
- campaignID:
- description: ID of the campaign.
+ rulesetID:
+ description: ID of a ruleset.
type: integer
currency:
description: Currency for the campaign.
type: string
required:
- - campaignID
- currency
+ - rulesetID
type: object
GenerateCampaignTags:
properties:
- campaignID:
- description: ID of the campaign.
+ rulesetID:
+ description: ID of a ruleset.
type: integer
required:
- - campaignID
+ - rulesetID
type: object
GenerateRuleTitle:
properties:
@@ -35182,6 +35214,137 @@ components:
required:
- itemFilter
type: object
+ StrikethroughDebugResponse:
+ properties:
+ campaignsIDs:
+ description: The campaign IDs that got fetched for the evaluation process.
+ items:
+ type: integer
+ type: array
+ effects:
+ description: The strikethrough effects that are returned from the evaluation
+ process.
+ items:
+ $ref: '#/components/schemas/StrikethroughEffect'
+ type: array
+ type: object
+ ProductSearchMatch:
+ properties:
+ productId:
+ description: The ID of the product.
+ example: 1
+ type: integer
+ value:
+ description: The string matching the given value. Either a product name
+ or SKU.
+ example: MyProduct
+ type: string
+ productSkuId:
+ description: The ID of the SKU linked to a product. If empty, this is an
+ analytics-level product.
+ example: 1
+ type: integer
+ required:
+ - productId
+ - value
+ type: object
+ AnalyticsProduct:
+ properties:
+ id:
+ description: The ID of the analytics-level product.
+ example: 1
+ type: integer
+ isPreliminary:
+ description: Indicates whether the analytics-level product is connected
+ to a catalog and also has a product name.
+ example: false
+ type: boolean
+ name:
+ description: The name of the analytics-level product.
+ example: MyProduct
+ type: string
+ catalogId:
+ description: |
+ The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
+ example: 1
+ type: integer
+ required:
+ - id
+ - isPreliminary
+ - name
+ type: object
+ AnalyticsProductSKU:
+ properties:
+ id:
+ description: The ID of the SKU linked to the analytics-level product.
+ example: 1
+ type: integer
+ sku:
+ description: The SKU linked to the analytics-level product.
+ example: SKU-123
+ type: string
+ lastUpdated:
+ description: Values in UTC for the date the SKU linked to the analytics-level
+ product was last updated.
+ example: 2024-02-01T00:00:00Z
+ format: date-time
+ type: string
+ required:
+ - id
+ - lastUpdated
+ - sku
+ type: object
+ ProductUnitAnalytics:
+ properties:
+ startTime:
+ description: The start of the aggregation time frame in UTC.
+ example: 2024-02-01T00:00:00Z
+ format: date-time
+ type: string
+ endTime:
+ description: The end of the aggregation time frame in UTC.
+ format: date-time
+ type: string
+ purchasedUnits:
+ $ref: '#/components/schemas/AnalyticsDataPointWithTrend'
+ productId:
+ description: The ID of the analytics-level product.
+ example: 1
+ type: integer
+ productName:
+ description: The name of the analytics-level product.
+ example: MyProduct
+ type: string
+ required:
+ - endTime
+ - productId
+ - productName
+ - purchasedUnits
+ - startTime
+ type: object
+ ProductSkuUnitAnalytics:
+ properties:
+ startTime:
+ description: The start of the aggregation time frame in UTC.
+ example: 2024-02-01T00:00:00Z
+ format: date-time
+ type: string
+ endTime:
+ description: The end of the aggregation time frame in UTC.
+ format: date-time
+ type: string
+ purchasedUnits:
+ $ref: '#/components/schemas/AnalyticsDataPointWithTrend'
+ sku:
+ description: The SKU linked to the analytics-level product.
+ example: SKU-123
+ type: string
+ required:
+ - endTime
+ - purchasedUnits
+ - sku
+ - startTime
+ type: object
inline_response_201:
example:
data:
@@ -35464,12 +35627,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -35546,12 +35709,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -35667,12 +35830,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -35749,12 +35912,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -37010,12 +37173,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -37092,12 +37255,12 @@ components:
minPoints: 200
id: 2
created: 2021-06-10T09:04:59.355258Z
- programId: 139
+ programID: 139
- name: Bronze
minPoints: 100
id: 1
created: 2021-06-10T09:04:39.355258Z
- programId: 139
+ programID: 139
canUpdateTiers: true
usersPerCardLimit: 111
tierCycleStartDate: 2021-09-12T10:12:42Z
@@ -37268,6 +37431,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -37313,6 +37478,8 @@ components:
id: 11
startDate: 2000-01-23T04:56:07.000+00:00
batchId: wdefpov
+ programTitle: Loyalty program
+ programName: Loyalty_program
modified: 2021-09-12T10:12:42Z
id: 6
blockReason: Current card lost. Customer needs a new card.
@@ -37476,47 +37643,6 @@ components:
- data
- hasMore
inline_response_200_20:
- example:
- data:
- - method: PUT
- requestPayload: |-
- {
- "customerSession": {
- "profileId": "customer123",
- "state": "closed",
- ...
- }
- responsePayload: '{"coupons":[],"createdCoupons":[],...}'
- requestUri: /v2/customer_sessions/Session136667
- time: 2023-01-16T16:00:00.700763Z
- uuid: 606e7d34-2d36-4d53-ac71-d4442c325985
- status: 200
- - method: PUT
- requestPayload: |-
- {
- "customerSession": {
- "profileId": "customer123",
- "state": "closed",
- ...
- }
- responsePayload: '{"coupons":[],"createdCoupons":[],...}'
- requestUri: /v2/customer_sessions/Session136667
- time: 2023-01-16T16:00:00.700763Z
- uuid: 606e7d34-2d36-4d53-ac71-d4442c325985
- status: 200
- totalResultSize: 1
- properties:
- totalResultSize:
- example: 1
- type: integer
- data:
- items:
- $ref: '#/components/schemas/AccessLogEntry'
- type: array
- required:
- - data
- - totalResultSize
- inline_response_200_21:
example:
data:
- date: 2021-10-12T10:12:42Z
@@ -37581,7 +37707,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_22:
+ inline_response_200_21:
example:
data:
- accountId: 31
@@ -37642,7 +37768,7 @@ components:
type: array
required:
- data
- inline_response_200_23:
+ inline_response_200_22:
example:
data:
- accountId: 31
@@ -37702,7 +37828,7 @@ components:
type: array
required:
- data
- inline_response_200_24:
+ inline_response_200_23:
example:
data:
- accountId: 31
@@ -37760,7 +37886,7 @@ components:
type: array
required:
- data
- inline_response_200_25:
+ inline_response_200_24:
example:
data:
- accountId: 31
@@ -37816,7 +37942,7 @@ components:
required:
- data
- hasMore
- inline_response_200_26:
+ inline_response_200_25:
example:
data:
- couponUseAttempts: 1
@@ -37856,7 +37982,7 @@ components:
required:
- data
- hasMore
- inline_response_200_27:
+ inline_response_200_26:
example:
data:
- coupon: BKDB946
@@ -37985,7 +38111,7 @@ components:
type: array
required:
- data
- inline_response_200_28:
+ inline_response_200_27:
example:
data:
- effects:
@@ -38129,7 +38255,7 @@ components:
required:
- data
- hasMore
- inline_response_200_29:
+ inline_response_200_28:
example:
data:
- data
@@ -38146,7 +38272,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_30:
+ inline_response_200_29:
example:
data:
- accountId: 3886
@@ -38183,7 +38309,7 @@ components:
type: array
required:
- data
- inline_response_200_31:
+ inline_response_200_30:
example:
data:
- membersCount: 1234
@@ -38200,7 +38326,7 @@ components:
type: array
required:
- data
- inline_response_200_32:
+ inline_response_200_31:
example:
data:
- accountId: 31
@@ -38255,7 +38381,7 @@ components:
type: array
required:
- data
- inline_response_200_33:
+ inline_response_200_32:
example:
data:
- friendIntegrationId: friendIntegrationId
@@ -38284,7 +38410,7 @@ components:
type: array
required:
- data
- inline_response_200_34:
+ inline_response_200_33:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -38357,7 +38483,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_35:
+ inline_response_200_34:
example:
data:
- product:
@@ -38404,7 +38530,7 @@ components:
type: array
required:
- data
- inline_response_200_36:
+ inline_response_200_35:
example:
data:
- accountId: 3886
@@ -38439,7 +38565,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_37:
+ inline_response_200_36:
example:
data:
- headers:
@@ -38492,7 +38618,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_38:
+ inline_response_200_37:
example:
data:
- webhookId: 1
@@ -38517,7 +38643,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_39:
+ inline_response_200_38:
example:
data:
- requestTime: 2021-07-20T22:00:00Z
@@ -38558,7 +38684,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_40:
+ inline_response_200_39:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -38583,7 +38709,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_41:
+ inline_response_200_40:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -38591,7 +38717,7 @@ components:
- 71
isAdmin: false
accountId: 3886
- applicationNotificationSubscriptions: '{}'
+ applicationNotificationSubscriptions: {}
inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
name: John Doe
modified: 2021-09-12T10:12:42Z
@@ -38604,13 +38730,13 @@ components:
email: john.doe@example.com
policy:
Role: 127
- additionalAttributes: '{}'
+ additionalAttributes: {}
- created: 2020-06-10T09:05:27.993483Z
roles:
- 71
isAdmin: false
accountId: 3886
- applicationNotificationSubscriptions: '{}'
+ applicationNotificationSubscriptions: {}
inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
name: John Doe
modified: 2021-09-12T10:12:42Z
@@ -38623,7 +38749,7 @@ components:
email: john.doe@example.com
policy:
Role: 127
- additionalAttributes: '{}'
+ additionalAttributes: {}
totalResultSize: 1
properties:
totalResultSize:
@@ -38636,7 +38762,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_42:
+ inline_response_200_41:
example:
data:
- new:
@@ -38650,7 +38776,7 @@ components:
- loyalty
id: 6727
created: 2020-06-10T09:05:27.993483Z
- old: '{}'
+ old: {}
id: 6
applicationId: 359
userId: 388
@@ -38667,7 +38793,7 @@ components:
- loyalty
id: 6727
created: 2020-06-10T09:05:27.993483Z
- old: '{}'
+ old: {}
id: 6
applicationId: 359
userId: 388
@@ -38687,7 +38813,7 @@ components:
type: array
required:
- data
- inline_response_200_43:
+ inline_response_200_42:
example:
data:
- filter: '{}'
@@ -38714,7 +38840,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_44:
+ inline_response_200_43:
example:
data:
- accountId: 3886
@@ -38821,7 +38947,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_45:
+ inline_response_200_44:
example:
data:
- linkedCampaignIds:
@@ -38866,7 +38992,7 @@ components:
type: array
required:
- data
- inline_response_200_46:
+ inline_response_200_45:
example:
data:
- period: 1Y
@@ -38921,7 +39047,7 @@ components:
type: array
required:
- data
- inline_response_200_47:
+ inline_response_200_46:
example:
data:
- endDate: 2000-01-23T04:56:07.000+00:00
@@ -39052,13 +39178,13 @@ components:
securitySchemes:
api_key_v1:
description: |
- To authenticate to use the Integration API, generate an API key in the Campaign Manager
- then prefix it with `ApiKey-v1`.
+ To authenticate with the Integration API, generate an API key in the Campaign Manager
+ and prefix it with `ApiKey-v1`.
To generate an API key:
- 1. Log into the Campaign Manager and open the Application of your choice, or create one.
- 1. Click **Settings** > **Developer settings**.
+ 1. Sign in to the Campaign Manager and open the Application of your choice, or create one.
+ 1. Click **Settings** > **Integration API Keys**.
1. Click **Create API Key** and give it a name and an expiration date, then click **Create API Key**.
You can now use the API key in the HTTP header, prefixing it with `ApiKey-v1`:
@@ -39101,7 +39227,7 @@ components:
The key must be generated by an admin and given to the developer that requires it:
- 1. Log into the Campaign Manager and click **Account** > **Management API keys**.
+ 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.
1. Choose the endpoints the key should give access to.
diff --git a/build.gradle b/build.gradle
index b4d4c51..2cf054e 100644
--- a/build.gradle
+++ b/build.gradle
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'java'
group = 'one.talon'
-version = '9.1.0'
+version = '10.0.0'
buildscript {
repositories {
diff --git a/build.sbt b/build.sbt
index 8fe4e41..edfd30e 100644
--- a/build.sbt
+++ b/build.sbt
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "one.talon",
name := "talon-one-client",
- version := "9.1.0",
+ version := "10.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
diff --git a/docs/AnalyticsProduct.md b/docs/AnalyticsProduct.md
new file mode 100644
index 0000000..02672ac
--- /dev/null
+++ b/docs/AnalyticsProduct.md
@@ -0,0 +1,15 @@
+
+
+# AnalyticsProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the analytics-level product. |
+**isPreliminary** | **Boolean** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. |
+**name** | **String** | The name of the analytics-level product. |
+**catalogId** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | [optional]
+
+
+
diff --git a/docs/AnalyticsProductSKU.md b/docs/AnalyticsProductSKU.md
new file mode 100644
index 0000000..3636506
--- /dev/null
+++ b/docs/AnalyticsProductSKU.md
@@ -0,0 +1,14 @@
+
+
+# AnalyticsProductSKU
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the SKU linked to the analytics-level product. |
+**sku** | **String** | The SKU linked to the analytics-level product. |
+**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | Values in UTC for the date the SKU linked to the analytics-level product was last updated. |
+
+
+
diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md
index e038b75..35b4a2e 100644
--- a/docs/CustomerProfileAudienceRequestItem.md
+++ b/docs/CustomerProfileAudienceRequestItem.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**action** | [**ActionEnum**](#ActionEnum) | Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. |
+**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** | **Integer** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md
index 6ddc178..58b9f85 100644
--- a/docs/CustomerSessionV2.md
+++ b/docs/CustomerSessionV2.md
@@ -14,19 +14,20 @@ Name | Type | Description | Notes
**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
**evaluableCampaignIds** | **List<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
-**couponCodes** | **List<String>** | Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely. | [optional]
-**referralCode** | **String** | Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely. | [optional]
+**couponCodes** | **List<String>** | Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. | [optional]
+**referralCode** | **String** | Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. | [optional]
**loyaltyCards** | **List<String>** | Identifier of a loyalty card. | [optional]
**state** | [**StateEnum**](#StateEnum) | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). |
**cartItems** | [**List<CartItem>**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. |
**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
**identifiers** | **List<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). - We recommend passing an anonymized (hashed) version of the identifier value. | [optional]
**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. |
-**firstSession** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. |
+**firstSession** | **Boolean** | Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions. |
**total** | [**BigDecimal**](BigDecimal.md) | The total value of cart items and additional costs in the session, before any discounts are applied. |
**cartItemTotal** | [**BigDecimal**](BigDecimal.md) | The total value of cart items, before any discounts are applied. |
**additionalCostTotal** | [**BigDecimal**](BigDecimal.md) | The total value of additional costs, before any discounts are applied. |
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received on this session. |
+**closurePrediction** | [**BigDecimal**](BigDecimal.md) | The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. | [optional]
diff --git a/docs/GenerateCampaignDescription.md b/docs/GenerateCampaignDescription.md
index e374b2f..09e950e 100644
--- a/docs/GenerateCampaignDescription.md
+++ b/docs/GenerateCampaignDescription.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignID** | **Integer** | ID of the campaign. |
+**rulesetID** | **Integer** | ID of a ruleset. |
**currency** | **String** | Currency for the campaign. |
diff --git a/docs/GenerateCampaignTags.md b/docs/GenerateCampaignTags.md
index abcf31e..29620da 100644
--- a/docs/GenerateCampaignTags.md
+++ b/docs/GenerateCampaignTags.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignID** | **Integer** | ID of the campaign. |
+**rulesetID** | **Integer** | ID of a ruleset. |
diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md
index 9f2be59..0c82671 100644
--- a/docs/InlineResponse20020.md
+++ b/docs/InlineResponse20020.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<AccessLogEntry>**](AccessLogEntry.md) | |
+**data** | [**List<CampaignAnalytics>**](CampaignAnalytics.md) | |
diff --git a/docs/InlineResponse20021.md b/docs/InlineResponse20021.md
index 97f7599..bd67e52 100644
--- a/docs/InlineResponse20021.md
+++ b/docs/InlineResponse20021.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<CampaignAnalytics>**](CampaignAnalytics.md) | |
+**totalResultSize** | **Integer** | | [optional]
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<ApplicationCustomer>**](ApplicationCustomer.md) | |
diff --git a/docs/InlineResponse20022.md b/docs/InlineResponse20022.md
index 5428c22..09c7489 100644
--- a/docs/InlineResponse20022.md
+++ b/docs/InlineResponse20022.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | | [optional]
**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<ApplicationCustomer>**](ApplicationCustomer.md) | |
diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md
index d9008a4..9b854a2 100644
--- a/docs/InlineResponse20023.md
+++ b/docs/InlineResponse20023.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<ApplicationCustomer>**](ApplicationCustomer.md) | |
+**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md
index 27c23e9..a75bad5 100644
--- a/docs/InlineResponse20024.md
+++ b/docs/InlineResponse20024.md
@@ -6,8 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
+**hasMore** | **Boolean** | |
**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md
index 537857f..1236a77 100644
--- a/docs/InlineResponse20025.md
+++ b/docs/InlineResponse20025.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | |
-**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
+**data** | [**List<CustomerActivityReport>**](CustomerActivityReport.md) | |
diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md
index d294ce9..2c83edb 100644
--- a/docs/InlineResponse20026.md
+++ b/docs/InlineResponse20026.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<CustomerActivityReport>**](CustomerActivityReport.md) | |
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<ApplicationSession>**](ApplicationSession.md) | |
diff --git a/docs/InlineResponse20027.md b/docs/InlineResponse20027.md
index d4b0fcf..01169de 100644
--- a/docs/InlineResponse20027.md
+++ b/docs/InlineResponse20027.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**data** | [**List<ApplicationSession>**](ApplicationSession.md) | |
+**hasMore** | **Boolean** | |
+**data** | [**List<ApplicationEvent>**](ApplicationEvent.md) | |
diff --git a/docs/InlineResponse20028.md b/docs/InlineResponse20028.md
index baaa5c5..582d050 100644
--- a/docs/InlineResponse20028.md
+++ b/docs/InlineResponse20028.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<ApplicationEvent>**](ApplicationEvent.md) | |
+**totalResultSize** | **Integer** | |
+**data** | **List<String>** | |
diff --git a/docs/InlineResponse20029.md b/docs/InlineResponse20029.md
index 3c194b5..591dd3d 100644
--- a/docs/InlineResponse20029.md
+++ b/docs/InlineResponse20029.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | **List<String>** | |
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<Audience>**](Audience.md) | |
diff --git a/docs/InlineResponse20030.md b/docs/InlineResponse20030.md
index d3189f7..d0bdfd5 100644
--- a/docs/InlineResponse20030.md
+++ b/docs/InlineResponse20030.md
@@ -7,8 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<Audience>**](Audience.md) | |
+**data** | [**List<AudienceAnalytics>**](AudienceAnalytics.md) | |
diff --git a/docs/InlineResponse20031.md b/docs/InlineResponse20031.md
index 8a81df7..b822a40 100644
--- a/docs/InlineResponse20031.md
+++ b/docs/InlineResponse20031.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**data** | [**List<AudienceAnalytics>**](AudienceAnalytics.md) | |
+**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse20032.md b/docs/InlineResponse20032.md
index 9256aac..b50af52 100644
--- a/docs/InlineResponse20032.md
+++ b/docs/InlineResponse20032.md
@@ -7,7 +7,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<ApplicationReferee>**](ApplicationReferee.md) | |
diff --git a/docs/InlineResponse20033.md b/docs/InlineResponse20033.md
index 7c126f9..ba45f56 100644
--- a/docs/InlineResponse20033.md
+++ b/docs/InlineResponse20033.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<ApplicationReferee>**](ApplicationReferee.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<Attribute>**](Attribute.md) | |
diff --git a/docs/InlineResponse20034.md b/docs/InlineResponse20034.md
index 5704e93..8e73427 100644
--- a/docs/InlineResponse20034.md
+++ b/docs/InlineResponse20034.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<Attribute>**](Attribute.md) | |
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<CatalogItem>**](CatalogItem.md) | |
diff --git a/docs/InlineResponse20035.md b/docs/InlineResponse20035.md
index 27b24f5..2ea9a4c 100644
--- a/docs/InlineResponse20035.md
+++ b/docs/InlineResponse20035.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<CatalogItem>**](CatalogItem.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
diff --git a/docs/InlineResponse20036.md b/docs/InlineResponse20036.md
index b9c287f..690ac5a 100644
--- a/docs/InlineResponse20036.md
+++ b/docs/InlineResponse20036.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
+**data** | [**List<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
diff --git a/docs/InlineResponse20037.md b/docs/InlineResponse20037.md
index 4b01936..1fc4307 100644
--- a/docs/InlineResponse20037.md
+++ b/docs/InlineResponse20037.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
+**data** | [**List<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
diff --git a/docs/InlineResponse20038.md b/docs/InlineResponse20038.md
index 2c92f13..aa9c7ea 100644
--- a/docs/InlineResponse20038.md
+++ b/docs/InlineResponse20038.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
+**data** | [**List<WebhookLogEntry>**](WebhookLogEntry.md) | |
diff --git a/docs/InlineResponse20039.md b/docs/InlineResponse20039.md
index 4531663..58d5ef1 100644
--- a/docs/InlineResponse20039.md
+++ b/docs/InlineResponse20039.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookLogEntry>**](WebhookLogEntry.md) | |
+**data** | [**List<EventType>**](EventType.md) | |
diff --git a/docs/InlineResponse20040.md b/docs/InlineResponse20040.md
index 724895c..f947020 100644
--- a/docs/InlineResponse20040.md
+++ b/docs/InlineResponse20040.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<EventType>**](EventType.md) | |
+**data** | [**List<User>**](User.md) | |
diff --git a/docs/InlineResponse20041.md b/docs/InlineResponse20041.md
index 9514383..604a12f 100644
--- a/docs/InlineResponse20041.md
+++ b/docs/InlineResponse20041.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<User>**](User.md) | |
+**totalResultSize** | **Integer** | | [optional]
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<Change>**](Change.md) | |
diff --git a/docs/InlineResponse20042.md b/docs/InlineResponse20042.md
index d8183c1..5e572b6 100644
--- a/docs/InlineResponse20042.md
+++ b/docs/InlineResponse20042.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | | [optional]
-**hasMore** | **Boolean** | | [optional]
-**data** | [**List<Change>**](Change.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<Export>**](Export.md) | |
diff --git a/docs/InlineResponse20043.md b/docs/InlineResponse20043.md
index f8106df..0e862ef 100644
--- a/docs/InlineResponse20043.md
+++ b/docs/InlineResponse20043.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<Export>**](Export.md) | |
+**data** | [**List<RoleV2>**](RoleV2.md) | |
diff --git a/docs/InlineResponse20044.md b/docs/InlineResponse20044.md
index 29f58c0..c654f2e 100644
--- a/docs/InlineResponse20044.md
+++ b/docs/InlineResponse20044.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<RoleV2>**](RoleV2.md) | |
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<Store>**](Store.md) | |
diff --git a/docs/InlineResponse20045.md b/docs/InlineResponse20045.md
index 2645677..0093915 100644
--- a/docs/InlineResponse20045.md
+++ b/docs/InlineResponse20045.md
@@ -7,8 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<Store>**](Store.md) | |
+**data** | [**List<Achievement>**](Achievement.md) | |
diff --git a/docs/InlineResponse20046.md b/docs/InlineResponse20046.md
index 969d2c3..9280050 100644
--- a/docs/InlineResponse20046.md
+++ b/docs/InlineResponse20046.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**data** | [**List<Achievement>**](Achievement.md) | |
+**hasMore** | **Boolean** | |
+**data** | [**List<AchievementProgress>**](AchievementProgress.md) | |
diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md
index 46d5e8b..b1b2ae7 100644
--- a/docs/IntegrationApi.md
+++ b/docs/IntegrationApi.md
@@ -1,6 +1,6 @@
# IntegrationApi
-All URIs are relative to *https://yourbaseurl.talon.one*
+All URLs are relative to `https://yourbaseurl.talon.one`.
Method | HTTP request | Description
------------- | ------------- | -------------
@@ -35,8 +35,9 @@ Method | HTTP request | Description
[**updateCustomerSessionV2**](IntegrationApi.md#updateCustomerSessionV2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update customer session
-