```json
@@ -7816,7 +8172,7 @@ paths:
Returns all the defined additional costs for the account.
operationId: getAdditionalCosts
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -7843,7 +8199,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_34'
+ $ref: '#/components/schemas/inline_response_200_36'
description: OK
summary: List additional costs
tags:
@@ -7949,7 +8305,7 @@ paths:
name: sort
schema:
type: string
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -7995,7 +8351,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_35'
+ $ref: '#/components/schemas/inline_response_200_37'
description: OK
summary: List webhooks
tags:
@@ -8031,7 +8387,7 @@ paths:
triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks).
operationId: getWebhookActivationLogs
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -8092,7 +8448,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_36'
+ $ref: '#/components/schemas/inline_response_200_38'
description: OK
summary: List webhook activation log entries
tags:
@@ -8103,7 +8459,7 @@ paths:
description: Retrieve all webhook log entries.
operationId: getWebhookLogs
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -8174,7 +8530,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_37'
+ $ref: '#/components/schemas/inline_response_200_39'
description: OK
summary: List webhook log entries
tags:
@@ -8198,7 +8554,7 @@ paths:
schema:
default: false
type: boolean
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -8225,7 +8581,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_38'
+ $ref: '#/components/schemas/inline_response_200_40'
description: OK
summary: List event types
tags:
@@ -8280,14 +8636,20 @@ paths:
required: true
schema:
type: integer
+ - description: |
+ An indicator of whether to skip duplicate coupon values instead of causing an error.
+ Duplicate values are ignored when `skipDuplicates=true`.
+ in: query
+ name: skipDuplicates
+ schema:
+ type: boolean
requestBody:
content:
multipart/form-data:
schema:
properties:
upFile:
- description: The file with the information about the data that should
- be imported.
+ description: The file containing the data that is being imported.
format: csv
type: string
responses:
@@ -8732,7 +9094,7 @@ paths:
application/csv:
example: |
id,firstsession,integrationid,applicationid,profileid,profileintegrationid,created,state,cartitems,discounts,total,attributes,closedat,cancelledat,referral,identifiers,additional_costs,updated,store_integration_id,coupons
- 12327,true,62791173fbf323ee5cfd96f3,270,6111,dxclwds,2022-05-09T13:05:31Z,open,"[{""sku"": ""B00004TKVY"", ""name"": ""Gravel bike - \""Aisle of Man\"""", ""price"": 1800, ""weight"": 6, ""category"": ""gravelbikes"", ""position"": 0, ""quantity"": 1, ""attributes"": {""color"": [""black,white""], ""material"": ""titanium""}, ""returnedQuantity"": 0, ""remainingQuantity"": 1}]","{}",1850.00,"{""ShippingCost"": 50, ""PaymentMethod"": ""creditcard"", ""ShippingMethod"": ""Standard""}",0001-01-01T00:00:00Z,0001-01-01T00:00:00Z,,"null","{""ShippingCost"": {""price"": 50}}",2022-05-09T13:13:28Z,"STORE-001","[""SORRY5QMUJRWA""]"
+ 12328,true,62791173fbf323ee5cfd96f3,270,6111,dxclwds,2022-05-09T13:05:31Z,open,"[{""sku"": ""B00004TKVY"", ""name"": ""Gravel bike - \""Aisle of Man\"""", ""price"": 1800, ""weight"": 6, ""category"": ""gravelbikes"", ""position"": 0, ""quantity"": 1, ""attributes"": {""color"": [""black,white""], ""material"": ""titanium""}, ""returnedQuantity"": 0, ""remainingQuantity"": 1}]","{}",1850.00,"{""ShippingCost"": 50, ""PaymentMethod"": ""creditcard"", ""ShippingMethod"": ""Standard""}",0001-01-01T00:00:00Z,0001-01-01T00:00:00Z,,"null","{""ShippingCost"": {""price"": 50}}",2022-05-09T13:13:28Z,"STORE-001","[""SORRY5QMUJRWA""]"
schema:
format: csv
type: string
@@ -8797,8 +9159,7 @@ paths:
schema:
properties:
upFile:
- description: The file with the information about the data that should
- be imported.
+ description: The file containing the data that is being imported.
format: csv
type: string
responses:
@@ -8819,7 +9180,7 @@ paths:
Retrieve all users in your account.
operationId: getUsers
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -8846,13 +9207,31 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_39'
+ $ref: '#/components/schemas/inline_response_200_41'
description: OK
summary: List users in account
tags:
- management
x-accepts: application/json
/v1/users/{userId}:
+ delete:
+ description: Delete a specific user.
+ operationId: deleteUser
+ parameters:
+ - description: The ID of the user.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "204":
+ content: {}
+ description: No Content
+ summary: Delete user
+ tags:
+ - management
+ x-accepts: application/json
get:
description: |
Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
@@ -8875,13 +9254,87 @@ paths:
tags:
- management
x-accepts: application/json
+ put:
+ description: Update the details of a specific user.
+ operationId: updateUser
+ parameters:
+ - description: The ID of the user.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateUser'
+ description: body
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ description: OK
+ summary: Update user
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/users/delete:
+ post:
+ description: |
+ Delete a specific user by their email address.
+ operationId: deleteUserByEmail
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeleteUserRequest'
+ description: body
+ required: true
+ responses:
+ "204":
+ content: {}
+ description: No Content
+ summary: Delete user by email address
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/users/deactivate:
+ post:
+ description: |
+ Deactivate a specific user by their email address.
+ operationId: deactivateUserByEmail
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeactivateUserRequest'
+ description: body
+ required: true
+ responses:
+ "204":
+ content: {}
+ description: No Content
+ summary: Deactivate user by email address
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
/v1/changes:
get:
description: |
Retrieve the audit logs displayed in **Accounts > Audit logs**.
operationId: getChanges
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -8960,12 +9413,66 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_40'
+ $ref: '#/components/schemas/inline_response_200_42'
description: OK
summary: Get audit logs for an account
tags:
- management
x-accepts: application/json
+ /v2/invites:
+ post:
+ description: |
+ 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.
+ operationId: createInviteV2
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NewInvitation'
+ description: body
+ required: true
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ description: Created
+ summary: Invite user
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/invite_emails:
+ post:
+ description: |
+ Resend an email invitation to an existing user.
+
+ **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ operationId: createInviteEmail
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NewInviteEmail'
+ description: body
+ required: true
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NewInviteEmail'
+ description: Created
+ summary: Resend invitation email
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
/v1/password_recovery_emails:
post:
description: |
@@ -9125,7 +9632,7 @@ paths:
List all past exports
operationId: getExports
parameters:
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -9168,7 +9675,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_41'
+ $ref: '#/components/schemas/inline_response_200_43'
description: OK
summary: Get exports
tags:
@@ -9183,7 +9690,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_42'
+ $ref: '#/components/schemas/inline_response_200_44'
description: OK
summary: List roles
tags:
@@ -9195,7 +9702,10 @@ paths:
Get the details of a specific role. To see all the roles, use [List roles](#operation/getAllRoles).
operationId: getRole
parameters:
- - description: 'The ID of role. '
+ - description: |
+ ID of role.
+
+ **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint.
in: path
name: roleId
required: true
@@ -9212,6 +9722,37 @@ paths:
tags:
- management
x-accepts: application/json
+ /v2/roles/{roleId}:
+ put:
+ description: Update a specific role.
+ operationId: updateRoleV2
+ parameters:
+ - description: 'The ID of role. '
+ in: path
+ name: roleId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateRoleV2'
+ description: body
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RoleV2'
+ description: OK
+ summary: Update role
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
/v1/applications/{applicationId}/stores:
get:
description: List all stores for a specific Application.
@@ -9224,7 +9765,7 @@ paths:
required: true
schema:
type: integer
- - description: The number of items in this response.
+ - description: The number of items in the response.
in: query
name: pageSize
schema:
@@ -9270,12 +9811,17 @@ paths:
name: integrationId
schema:
type: string
+ - description: Filter results by `name` or `integrationId`.
+ in: query
+ name: query
+ schema:
+ type: string
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_43'
+ $ref: '#/components/schemas/inline_response_200_45'
description: OK
summary: List stores
tags:
@@ -9446,6 +9992,411 @@ paths:
x-codegen-request-body-name: body
x-contentType: application/json
x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/achievements:
+ get:
+ description: List all the achievements for a specific campaign.
+ operationId: listAchievements
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ - description: The number of items in the response.
+ in: query
+ name: pageSize
+ schema:
+ default: 50
+ maximum: 50
+ 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: |
+ Filter by the display name for the achievement in the campaign manager.
+
+ **Note**: If no `title` is provided, all the achievements from the campaign are returned.
+ in: query
+ name: title
+ schema:
+ type: string
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/inline_response_200_46'
+ description: OK
+ summary: List achievements
+ tags:
+ - management
+ x-accepts: application/json
+ post:
+ description: Create a new achievement in a specific campaign.
+ operationId: createAchievement
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateAchievement'
+ description: body
+ required: true
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Achievement'
+ description: Created
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Bad request
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ "409":
+ content: {}
+ description: Conflict. An achievement with this name or title already exists.
+ summary: Create achievement
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}:
+ delete:
+ description: Delete the specified achievement.
+ operationId: deleteAchievement
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the achievement. You can get this ID with the [List
+ achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements)
+ endpoint.
+ in: path
+ name: achievementId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "204":
+ content: {}
+ description: No Content
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Not found
+ summary: Delete achievement
+ tags:
+ - management
+ x-accepts: application/json
+ get:
+ description: Get the details of a specific achievement.
+ operationId: getAchievement
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the achievement. You can get this ID with the [List
+ achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements)
+ endpoint.
+ in: path
+ name: achievementId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Achievement'
+ description: OK
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Not found
+ summary: Get achievement
+ tags:
+ - management
+ x-accepts: application/json
+ put:
+ description: Update the details of a specific achievement.
+ operationId: updateAchievement
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the achievement. You can get this ID with the [List
+ achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements)
+ endpoint.
+ in: path
+ name: achievementId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateAchievement'
+ description: body
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Achievement'
+ description: OK
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Bad request
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Not found
+ summary: Update achievement
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export:
+ get:
+ description: |
+ Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement.
+
+ The CSV file contains the following columns:
+ - `profileIntegrationID`: The integration ID of the customer profile participating in the achievement.
+ - `title`: The display name of the achievement in the Campaign Manager.
+ - `target`: The required number of actions or the transactional milestone to complete the achievement.
+ - `progress`: The current progress of the customer in the achievement.
+ - `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired'].
+ - `startDate`: The date on which the customer profile started the achievement in RFC3339.
+ - `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339.
+ - `completionDate`: The date on which the customer profile completed the achievement in RFC3339.
+ operationId: exportAchievements
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the campaign. It is displayed in your Talon.One deployment
+ URL.
+ in: path
+ name: campaignId
+ required: true
+ schema:
+ type: integer
+ - description: The ID of the achievement. You can get this ID with the [List
+ achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements)
+ endpoint.
+ in: path
+ name: achievementId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "200":
+ content:
+ application/csv:
+ example: |
+ profileIntegrationID,title,target,progress,status,startDate,endDate,completionDate
+ user1231,CoffeeFree10Orders,10.00,5,inprogress,2023-12-10T11:42:25+01:00,2024-01-10T11:42:25+01:00,
+ user341,CoffeeFree10Orders,10.00,10,completed,2023-12-10T11:42:25+01:00,2024-01-10T11:42:25+01:00,2023-12-20T10:24:34+01:00
+ schema:
+ format: csv
+ type: string
+ description: OK
+ "400":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Bad request
+ "401":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ "404":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Not found
+ summary: Export achievement customer data
+ tags:
+ - management
+ x-accepts: application/csv
+ /v1/applications/{applicationId}/achievement_progress/{integrationId}:
+ get:
+ description: |
+ For the given customer profile, list all the achievements that match your filter criteria.
+ operationId: getCustomerProfileAchievementProgress
+ parameters:
+ - description: The ID of the Application. It is displayed in your Talon.One
+ deployment URL.
+ in: path
+ name: applicationId
+ required: true
+ schema:
+ type: integer
+ - description: The identifier of the profile.
+ in: path
+ name: integrationId
+ required: true
+ schema:
+ type: string
+ - description: The number of items in the response.
+ in: query
+ name: pageSize
+ schema:
+ default: 50
+ maximum: 50
+ 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 ID of the achievement. You can get this ID with the [List
+ achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements)
+ endpoint.
+ in: query
+ name: achievementId
+ schema:
+ type: integer
+ - description: Filter results by the `title` of an achievement.
+ in: query
+ name: title
+ schema:
+ type: string
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/inline_response_200_47'
+ description: OK
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Bad request
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponseWithStatus'
+ description: Unauthorized
+ summary: List customer achievements
+ tags:
+ - management
+ x-accepts: application/json
components:
schemas:
ErrorResponse:
@@ -9600,7 +10551,7 @@ components:
EmailEntity:
properties:
email:
- description: The email address associated with your account.
+ description: The email address associated with the user profile.
example: john.doe@example.com
format: email
type: string
@@ -9911,7 +10862,7 @@ components:
email: john.doe@example.com
properties:
email:
- description: The email address associated with your account.
+ description: The email address associated with the user profile.
example: john.doe@example.com
format: email
type: string
@@ -10172,9 +11123,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -10208,9 +11162,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -10356,12 +11313,13 @@ components:
NewCampaignGroup:
properties:
name:
- description: The name of this campaign access group.
+ description: The name of the campaign access group.
+ example: Europe access group
minLength: 1
type: string
description:
description: A longer description of the campaign access group.
- example: My campaign access group.
+ example: A group that gives access to all the campaigns for the Europe market.
type: string
subscribedApplicationsIds:
description: A list of IDs of the Applications that this campaign access
@@ -10388,6 +11346,22 @@ components:
type: object
CampaignGroup:
description: ""
+ example:
+ accountId: 3886
+ created: 2020-06-10T09:05:27.993483Z
+ name: Europe access group
+ subscribedApplicationsIds:
+ - 1
+ - 2
+ - 3
+ modified: 2021-09-12T10:12:42Z
+ description: A group that gives access to all the campaigns for the Europe
+ market.
+ id: 6
+ campaignIds:
+ - 4
+ - 6
+ - 8
properties:
id:
description: Internal ID of this entity.
@@ -10408,12 +11382,13 @@ components:
example: 3886
type: integer
name:
- description: The name of this campaign access group.
+ description: The name of the campaign access group.
+ example: Europe access group
minLength: 1
type: string
description:
description: A longer description of the campaign access group.
- example: My campaign access group.
+ example: A group that gives access to all the campaigns for the Europe market.
type: string
subscribedApplicationsIds:
description: A list of IDs of the Applications that this campaign access
@@ -10446,12 +11421,13 @@ components:
description: ""
properties:
name:
- description: The name of this campaign access group.
+ description: The name of the campaign access group.
+ example: Europe access group
minLength: 1
type: string
description:
description: A longer description of the campaign access group.
- example: My campaign access group.
+ example: A group that gives access to all the campaigns for the Europe market.
type: string
subscribedApplicationsIds:
description: A list of IDs of the Applications that this campaign access
@@ -10542,6 +11518,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -10563,12 +11540,6 @@ components:
items:
type: integer
type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- title: Evaluation Group ID
- type: integer
type:
default: advanced
description: |
@@ -10595,6 +11566,12 @@ components:
items:
type: integer
type: array
+ evaluationGroupId:
+ description: The ID of the campaign evaluation group the campaign belongs
+ to.
+ example: 2
+ title: Evaluation Group ID
+ type: integer
required:
- features
- limits
@@ -10783,6 +11760,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -10904,6 +11882,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -10925,12 +11904,6 @@ components:
items:
type: integer
type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- title: Evaluation Group ID
- type: integer
type:
default: advanced
description: |
@@ -10964,133 +11937,6 @@ components:
- state
- tags
type: object
- BaseCampaignForNotification:
- properties:
- name:
- description: A user-facing name for this campaign.
- example: Summer promotions
- minLength: 1
- title: Campaign Name
- type: string
- description:
- description: A detailed description of the campaign.
- example: Campaign for all summer 2021 promotions
- title: Campaign Description
- type: string
- startTime:
- description: Timestamp when the campaign will become active.
- example: 2021-07-20T22:00:00Z
- format: date-time
- type: string
- endTime:
- description: Timestamp when the campaign will become inactive.
- example: 2021-09-22T22:00:00Z
- format: date-time
- type: string
- attributes:
- description: Arbitrary properties associated with this campaign.
- properties: {}
- type: object
- state:
- default: enabled
- description: |
- A disabled or archived campaign is not evaluated for rules or coupons.
- enum:
- - enabled
- - disabled
- - archived
- - draft
- - scheduled
- - running
- - expired
- example: enabled
- type: string
- activeRulesetId:
- description: |
- [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
- campaign applies on customer session evaluation.
- example: 6
- type: integer
- tags:
- description: A list of tags for the campaign.
- example:
- - summer
- items:
- maxLength: 50
- minLength: 1
- type: string
- maxItems: 50
- type: array
- features:
- description: The features enabled in this campaign.
- example:
- - coupons
- - referrals
- items:
- enum:
- - coupons
- - referrals
- - loyalty
- - giveaways
- - strikethrough
- type: string
- type: array
- couponSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- referralSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- limits:
- description: |
- The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.
- items:
- $ref: '#/components/schemas/LimitConfig'
- type: array
- campaignGroups:
- description: |
- The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.
- example:
- - 1
- - 3
- items:
- type: integer
- type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- type: integer
- type:
- default: advanced
- description: |
- 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.
- enum:
- - cartItem
- - advanced
- example: advanced
- type: string
- linkedStoreIds:
- description: |
- A list of store IDs that are linked to the campaign.
-
- **Note:** Campaigns with linked store IDs will only be evaluated when there is a
- [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
- that references a linked store.
- example:
- - 1
- - 2
- - 3
- items:
- type: integer
- type: array
- required:
- - features
- - limits
- - name
- - state
- - tags
- type: object
Campaign:
description: ""
example:
@@ -11105,7 +11951,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -11162,6 +12007,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -11316,6 +12162,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -11337,12 +12184,6 @@ components:
items:
type: integer
type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- title: Evaluation Group ID
- type: integer
type:
default: advanced
description: |
@@ -11491,286 +12332,22 @@ components:
description: The ID of the Campaign Template this Campaign was created from.
example: 3
type: integer
- required:
- - applicationId
- - budgets
- - created
- - description
- - features
- - id
- - limits
- - name
- - state
- - tags
- - type
- - userId
- type: object
- CampaignForNotification:
- description: ""
- properties:
- id:
- description: Unique ID for this entity.
- example: 4
- type: integer
- created:
- description: The exact moment this entity was created.
- example: 2020-06-10T09:05:27.993483Z
- format: date-time
- type: string
- applicationId:
- description: The ID of the application that owns this entity.
- example: 322
- type: integer
- userId:
- description: The ID of the user associated with this entity.
- example: 388
- type: integer
- name:
- description: A user-facing name for this campaign.
- example: Summer promotions
- minLength: 1
- title: Campaign Name
- type: string
- description:
- description: A detailed description of the campaign.
- example: Campaign for all summer 2021 promotions
- title: Campaign Description
- type: string
- startTime:
- description: Timestamp when the campaign will become active.
- example: 2021-07-20T22:00:00Z
- format: date-time
- type: string
- endTime:
- description: Timestamp when the campaign will become inactive.
- example: 2021-09-22T22:00:00Z
- format: date-time
- type: string
- attributes:
- description: Arbitrary properties associated with this campaign.
- properties: {}
- type: object
- state:
- default: enabled
- description: |
- A disabled or archived campaign is not evaluated for rules or coupons.
+ frontendState:
+ description: A campaign state described exactly as in the Campaign Manager.
enum:
- - enabled
- - disabled
- - archived
- - draft
+ - expired
- scheduled
- running
- - expired
- example: enabled
- type: string
- activeRulesetId:
- description: |
- [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
- campaign applies on customer session evaluation.
- example: 6
- type: integer
- tags:
- description: A list of tags for the campaign.
- example:
- - summer
- items:
- maxLength: 50
- minLength: 1
- type: string
- maxItems: 50
- type: array
- features:
- description: The features enabled in this campaign.
- example:
- - coupons
- - referrals
- items:
- enum:
- - coupons
- - referrals
- - loyalty
- - giveaways
- - strikethrough
- type: string
- type: array
- couponSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- referralSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- limits:
- description: |
- The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.
- items:
- $ref: '#/components/schemas/LimitConfig'
- type: array
- campaignGroups:
- description: |
- The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.
- example:
- - 1
- - 3
- items:
- type: integer
- type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- type: integer
- type:
- default: advanced
- description: |
- 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.
- enum:
- - cartItem
- - advanced
- example: advanced
- type: string
- linkedStoreIds:
- description: |
- A list of store IDs that are linked to the campaign.
-
- **Note:** Campaigns with linked store IDs will only be evaluated when there is a
- [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
- that references a linked store.
- example:
- - 1
- - 2
- - 3
- items:
- type: integer
- type: array
- budgets:
- description: |
- 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.
- items:
- $ref: '#/components/schemas/CampaignBudget'
- type: array
- couponRedemptionCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Number of coupons redeemed in the campaign.
- example: 163
- type: integer
- referralRedemptionCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Number of referral codes redeemed in the campaign.
- example: 3
- type: integer
- discountCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total amount of discounts redeemed in the campaign.
- example: 288.0
- type: number
- discountEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of times discounts were redeemed in this campaign.
- example: 343
- type: integer
- couponCreationCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of coupons created by rules in this campaign.
- example: 16
- type: integer
- customEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of custom effects triggered by rules in this campaign.
- example: 0
- type: integer
- referralCreationCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of referrals created by rules in this campaign.
- example: 8
- type: integer
- addFreeItemEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.
- example: 0
- type: integer
- awardedGiveawaysCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of giveaways awarded by rules in this campaign.
- example: 9
- type: integer
- createdLoyaltyPointsCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty points created by rules in this campaign.
- example: 9.0
- type: number
- createdLoyaltyPointsEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty point creation effects triggered by rules in this campaign.
- example: 2
- type: integer
- redeemedLoyaltyPointsCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty points redeemed by rules in this campaign.
- example: 8.0
- type: number
- redeemedLoyaltyPointsEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty point redemption effects triggered by rules in this campaign.
- example: 9
- type: integer
- callApiEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of webhooks triggered by rules in this campaign.
- example: 0
- type: integer
- reservecouponEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of reserve coupon effects triggered by rules in this campaign.
- example: 9
- type: integer
- lastActivity:
- description: Timestamp of the most recent event received by this campaign.
- example: 2022-11-10T23:00:00Z
- format: date-time
- type: string
- updated:
- description: |
- Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign
- are **not** registered by this property, such as collection or coupon updates.
- format: date-time
- type: string
- createdBy:
- description: Name of the user who created this campaign if available.
- example: John Doe
- type: string
- updatedBy:
- description: Name of the user who last updated this campaign if available.
- example: Jane Doe
+ - draft
+ example: running
type: string
- templateId:
- description: The ID of the Campaign Template this Campaign was created from.
- example: 3
- type: integer
required:
- applicationId
- budgets
- created
- description
- features
+ - frontendState
- id
- limits
- name
@@ -11934,8 +12511,18 @@ components:
description: The ID of the Campaign Template this Campaign was created from.
example: 3
type: integer
+ frontendState:
+ description: A campaign state described exactly as in the Campaign Manager.
+ enum:
+ - expired
+ - scheduled
+ - running
+ - draft
+ example: running
+ type: string
required:
- budgets
+ - frontendState
type: object
NewRuleset:
properties:
@@ -13403,7 +13990,7 @@ components:
minLength: 3
type: string
isReservationMandatory:
- default: true
+ default: false
description: Whether the reservation effect actually created a new reservation.
example: false
title: Is reservation mandatory
@@ -13631,7 +14218,7 @@ components:
properties: {}
type: object
isReservationMandatory:
- default: true
+ default: false
description: Whether the reservation effect actually created a new reservation.
example: false
title: Is reservation mandatory
@@ -13857,7 +14444,7 @@ components:
title: Batch ID
type: string
isReservationMandatory:
- default: true
+ default: false
description: Whether the reservation effect actually created a new reservation.
example: false
title: Is reservation mandatory
@@ -14034,7 +14621,7 @@ components:
title: Batch ID
type: string
isReservationMandatory:
- default: true
+ default: false
description: Whether the reservation effect actually created a new reservation.
example: false
title: Is reservation mandatory
@@ -14059,6 +14646,26 @@ components:
- usageLimit
- value
type: object
+ GetIntegrationCouponRequest:
+ properties:
+ campaignIds:
+ description: A list of IDs of the campaigns to get coupons from.
+ example:
+ - 1
+ - 2
+ - 3
+ items:
+ type: integer
+ type: array
+ limit:
+ description: The maximum number of coupons included in the response.
+ maximum: 1E+3
+ minimum: 1
+ type: integer
+ required:
+ - campaignIds
+ - limit
+ type: object
InventoryCoupon:
description: ""
example:
@@ -14218,7 +14825,7 @@ components:
title: Batch ID
type: string
isReservationMandatory:
- default: true
+ default: false
description: Whether the reservation effect actually created a new reservation.
example: false
title: Is reservation mandatory
@@ -14646,6 +15253,126 @@ components:
- url
- webhookId
type: object
+ MessageLogEntries:
+ properties:
+ nextCursor:
+ description: |
+ The next value in the database.
+
+ **Note:** If this value is not present, it means that there are no more values in the database for this combination of request parameters.
+ example: SmJlNERRMHdyNWFsTmRDZDVYU0c=
+ format: byte
+ pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
+ type: string
+ data:
+ description: List of message logs.
+ items:
+ $ref: '#/components/schemas/MessageLogEntry'
+ type: array
+ required:
+ - data
+ type: object
+ MessageLogEntry:
+ description: Message Log.
+ properties:
+ id:
+ description: Unique identifier of the message.
+ example: 123e4567-e89b-12d3-a456-426614174000
+ type: string
+ service:
+ description: Name of the service that generated the log entry.
+ example: NotificationService
+ type: string
+ changeType:
+ description: Type of change that triggered the notification.
+ example: Update
+ type: string
+ notificationId:
+ description: ID of the notification.
+ example: 101
+ type: integer
+ notificationName:
+ description: The name of the notification.
+ example: My campaign notification
+ type: string
+ request:
+ $ref: '#/components/schemas/MessageLogRequest'
+ response:
+ $ref: '#/components/schemas/MessageLogResponse'
+ createdAt:
+ description: Timestamp when the log entry was created.
+ example: 2021-07-20T22:00:00Z
+ format: date-time
+ type: string
+ entityType:
+ description: |
+ The entity type the log is related to.
+ enum:
+ - application
+ - loyalty_program
+ - webhook
+ example: loyalty_program
+ type: string
+ url:
+ description: The target URL of the request.
+ example: www.my-company.com/my-endpoint-name
+ type: string
+ applicationId:
+ description: Identifier of the Application.
+ example: 5
+ minimum: 1
+ type: integer
+ loyaltyProgramId:
+ description: Identifier of the loyalty program.
+ example: 2
+ minimum: 1
+ type: integer
+ required:
+ - createdAt
+ - id
+ - service
+ type: object
+ MessageLogRequest:
+ description: Details of the request.
+ properties:
+ createdAt:
+ description: Timestamp when the request was made.
+ example: 2021-07-20T21:59:00Z
+ format: date-time
+ type: string
+ request:
+ description: Raw request data.
+ example: SGVsbG8sIHdvcmxkIQ==
+ format: byte
+ pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
+ type: string
+ required:
+ - createdAt
+ - request
+ type: object
+ MessageLogResponse:
+ description: Details of the response.
+ properties:
+ createdAt:
+ description: Timestamp when the response was received.
+ example: 2021-07-20T22:00:50Z
+ format: date-time
+ type: string
+ response:
+ description: Raw response data.
+ example: UmVzcG9uc2UgY29udGVudA==
+ format: byte
+ pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
+ type: string
+ status:
+ description: HTTP status code of the response.
+ example: 200
+ type: integer
+ required:
+ - createdAt
+ - response
+ - status
+ type: object
WebhookActivationLogEntry:
description: Log of activated webhooks.
example:
@@ -14699,8 +15426,8 @@ components:
lastAccessed: 2021-09-12T10:14:42Z
id: 6
state: invited
- latestFeedTimestamp: 2020-06-01T00:00:00Z
authMethod: basic_auth
+ latestFeedTimestamp: 2020-06-01T00:00:00Z
lastSignedIn: 2021-09-12T10:12:42Z
email: john.doe@example.com
policy:
@@ -14721,7 +15448,7 @@ components:
format: date-time
type: string
email:
- description: The email address associated with your account.
+ description: The email address associated with the user profile.
example: john.doe@example.com
format: email
type: string
@@ -14729,62 +15456,65 @@ components:
description: The ID of the account that owns this entity.
example: 3886
type: integer
- inviteToken:
- description: Invite token, empty if the user as already accepted their invite.
- example: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
+ name:
+ description: Name of the user.
+ example: John Doe
type: string
state:
- description: Current user state.
+ description: State of the user.
enum:
- invited
- active
- deactivated
example: invited
type: string
- name:
- description: Full name
- example: John Doe
+ inviteToken:
+ description: |
+ Invitation token of the user.
+
+ **Note**: If the user has already accepted their invitation, this is `null`.
+ example: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
type: string
+ isAdmin:
+ description: Indicates whether the user is an `admin`.
+ example: false
+ type: boolean
policy:
- description: User ACL Policy
+ description: Access level of the user.
example:
Role: 127
properties: {}
type: object
- latestFeedTimestamp:
- description: Latest timestamp the user has been notified for feed.
- example: 2020-06-01T00:00:00Z
- format: date-time
- type: string
roles:
- description: Contains a list of all roles the user is a member of.
+ description: A list of the IDs of the roles assigned to the user.
example:
- 71
items:
type: integer
type: array
- applicationNotificationSubscriptions:
- properties: {}
- type: object
authMethod:
- description: The Authentication method for this user.
+ description: Authentication method for this user.
example: basic_auth
type: string
- isAdmin:
- description: An indication of whether the user has admin permissions.
- example: false
- type: boolean
+ applicationNotificationSubscriptions:
+ description: Application notifications that the user is subscribed to.
+ properties: {}
+ type: object
lastSignedIn:
- description: Date and time when the user last signed in to Talon.One.
+ description: Timestamp when the user last signed in to Talon.One.
example: 2021-09-12T10:12:42Z
format: date-time
type: string
lastAccessed:
- description: Date and time of the user's last activity after signing in
- to Talon.One.
+ description: Timestamp of the user's last activity after signing in to Talon.One.
example: 2021-09-12T10:14:42Z
format: date-time
type: string
+ latestFeedTimestamp:
+ description: Timestamp when the user was notified for feed.
+ example: 2020-06-01T00:00:00Z
+ format: date-time
+ type: string
required:
- accountId
- created
@@ -14796,35 +15526,64 @@ components:
- policy
- state
type: object
+ DeactivateUserRequest:
+ description: ""
+ example:
+ email: john.doe@example.com
+ properties:
+ email:
+ description: The email address associated with the user profile.
+ example: john.doe@example.com
+ format: email
+ type: string
+ required:
+ - email
+ type: object
+ DeleteUserRequest:
+ description: ""
+ example:
+ email: john.doe@example.com
+ properties:
+ email:
+ description: The email address associated with the user profile.
+ example: john.doe@example.com
+ format: email
+ type: string
+ required:
+ - email
+ type: object
NewInvitation:
description: Parameters for inviting a new user.
+ example:
+ roles:
+ - 0
+ - 0
+ name: John Doe
+ isAdmin: false
+ acl: acl
+ email: john.doe@example.com
properties:
name:
- description: Name of the user being invited.
+ description: Name of the user.
example: John Doe
type: string
email:
+ description: Email address of the user.
example: john.doe@example.com
format: email
type: string
- acl:
- description: |
- The `Access Control List` json defining the role of the user. This represents the access control on the user level.
- Use one of the following:
- - normal user: `{"Role": 0}`
- - admin: `{"Role": 127}`
- example: '{"Role":0}'
- type: string
isAdmin:
- description: |
- An indication of whether the user has admin permissions. We recommend using this flag over using the `acl` with value `{"Role": 127}`.
+ description: Indicates whether the user is an `admin`.
example: false
type: boolean
roles:
- description: An array of role IDs to assign to the new user.
+ description: A list of the IDs of the roles assigned to the user.
items:
type: integer
type: array
+ acl:
+ description: Indicates the access level of the user.
+ type: string
required:
- email
type: object
@@ -15058,9 +15817,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -15128,9 +15890,18 @@ components:
example: true
title: Sandbox
type: boolean
+ tiersExpirationPolicy:
+ description: |
+ The policy that defines which date is used to calculate the expiration date of a customer's current tier.
+ - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.
+ - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
+ enum:
+ - tier_start_date
+ - program_join_date
+ type: string
tiersExpireIn:
description: |
- The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time.
+ The amount of time after which the tier expires.
The time format is an **integer** followed by one letter indicating the time unit.
Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
@@ -15159,6 +15930,19 @@ components:
- one_down
- balance_based
type: string
+ programJoinPolicy:
+ description: |
+ The policy that defines when the customer joins the loyalty program.
+ - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.
+
+ **Note**: The customer does not have a program join date.
+ - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.
+ - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
+ enum:
+ - not_join
+ - points_activated
+ - points_earned
+ type: string
accountID:
description: The ID of the Talon.One account that owns this program.
example: 1
@@ -15208,6 +15992,11 @@ components:
`True` if the tier definitions can be updated.
example: true
type: boolean
+ canUpdateJoinPolicy:
+ description: |
+ Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`.
+ example: true
+ type: boolean
canUpgradeToAdvancedTiers:
default: false
description: |
@@ -15335,9 +16124,125 @@ components:
example: true
title: Sandbox
type: boolean
+ tiersExpirationPolicy:
+ description: |
+ The policy that defines which date is used to calculate the expiration date of a customer's current tier.
+ - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.
+ - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
+ enum:
+ - tier_start_date
+ - program_join_date
+ type: string
+ tiersExpireIn:
+ description: |
+ The amount of time after which the tier expires.
+
+ 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.
+ example: 27W_U
+ type: string
+ tiersDowngradePolicy:
+ description: |
+ Customers's tier downgrade policy.
+ - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.
+ - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.
+ enum:
+ - one_down
+ - balance_based
+ type: string
+ programJoinPolicy:
+ description: |
+ The policy that defines when the customer joins the loyalty program.
+ - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.
+
+ **Note**: The customer does not have a program join date.
+ - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.
+ - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
+ enum:
+ - not_join
+ - points_activated
+ - points_earned
+ type: string
+ type: object
+ NewLoyaltyProgram:
+ description: ""
+ properties:
+ title:
+ description: The display title for the Loyalty Program.
+ example: Point collection
+ type: string
+ description:
+ description: Description of our Loyalty Program.
+ example: Customers collect 10 points per 1$ spent
+ type: string
+ subscribedApplications:
+ description: A list containing the IDs of all applications that are subscribed
+ to this Loyalty Program.
+ example:
+ - 132
+ - 97
+ items:
+ type: integer
+ type: array
+ defaultValidity:
+ description: |
+ The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time.
+ The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported:
+ - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day.
+ - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.
+ example: 2W_U
+ type: string
+ defaultPending:
+ description: |
+ The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time.
+ The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported:
+ - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day.
+ - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.
+ example: immediate
+ type: string
+ allowSubledger:
+ description: Indicates if this program supports subledgers inside the program.
+ example: false
+ type: boolean
+ usersPerCardLimit:
+ description: |
+ The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit.
+ This property is only used when `cardBased` is `true`.
+ example: 111
+ minimum: 0
+ type: integer
+ sandbox:
+ description: Indicates if this program is a live or sandbox program. Programs
+ of a given type can only be connected to Applications of the same type.
+ example: true
+ title: Sandbox
+ type: boolean
+ tiersExpirationPolicy:
+ description: |
+ The policy that defines which date is used to calculate the expiration date of a customer's current tier.
+ - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.
+ - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
+ enum:
+ - tier_start_date
+ - program_join_date
+ type: string
tiersExpireIn:
description: |
- The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time.
+ The amount of time after which the tier expires.
The time format is an **integer** followed by one letter indicating the time unit.
Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
@@ -15366,90 +16271,18 @@ components:
- one_down
- balance_based
type: string
- type: object
- NewLoyaltyProgram:
- description: ""
- properties:
- title:
- description: The display title for the Loyalty Program.
- example: Point collection
- type: string
- description:
- description: Description of our Loyalty Program.
- example: Customers collect 10 points per 1$ spent
- type: string
- subscribedApplications:
- description: A list containing the IDs of all applications that are subscribed
- to this Loyalty Program.
- example:
- - 132
- - 97
- items:
- type: integer
- type: array
- defaultValidity:
- description: |
- The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time.
- The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported:
- - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day.
- - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.
- example: 2W_U
- type: string
- defaultPending:
- description: |
- The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time.
- The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported:
- - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day.
- - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.
- example: immediate
- type: string
- allowSubledger:
- description: Indicates if this program supports subledgers inside the program.
- example: false
- type: boolean
- usersPerCardLimit:
- description: |
- The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit.
- This property is only used when `cardBased` is `true`.
- example: 111
- minimum: 0
- type: integer
- sandbox:
- description: Indicates if this program is a live or sandbox program. Programs
- of a given type can only be connected to Applications of the same type.
- example: true
- title: Sandbox
- type: boolean
- tiersExpireIn:
+ programJoinPolicy:
description: |
- The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time.
-
- The time format is an **integer** followed by one letter indicating the time unit.
- Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
-
- Available units:
-
- - `s`: seconds
- - `m`: minutes
- - `h`: hours
- - `D`: days
- - `W`: weeks
- - `M`: months
- - `Y`: years
+ The policy that defines when the customer joins the loyalty program.
+ - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.
- 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.
- example: 27W_U
- type: string
- tiersDowngradePolicy:
- description: |
- Customers's tier downgrade policy.
- - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.
- - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.
+ **Note**: The customer does not have a program join date.
+ - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.
+ - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
enum:
- - one_down
- - balance_based
+ - not_join
+ - points_activated
+ - points_earned
type: string
name:
description: The internal name for the Loyalty Program. This is an immutable
@@ -15536,9 +16369,18 @@ components:
example: true
title: Sandbox
type: boolean
+ tiersExpirationPolicy:
+ description: |
+ The policy that defines which date is used to calculate the expiration date of a customer's current tier.
+ - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.
+ - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
+ enum:
+ - tier_start_date
+ - program_join_date
+ type: string
tiersExpireIn:
description: |
- The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time.
+ The amount of time after which the tier expires.
The time format is an **integer** followed by one letter indicating the time unit.
Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
@@ -15567,6 +16409,19 @@ components:
- one_down
- balance_based
type: string
+ programJoinPolicy:
+ description: |
+ The policy that defines when the customer joins the loyalty program.
+ - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.
+
+ **Note**: The customer does not have a program join date.
+ - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.
+ - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
+ enum:
+ - not_join
+ - points_activated
+ - points_earned
+ type: string
tiers:
description: The tiers in this loyalty program.
items:
@@ -15577,7 +16432,8 @@ components:
description: List of loyalty ledger transactions.
properties:
hasMore:
- description: true means there is more data in the source collection to request.
+ description: If `true`, it means that there is more data to request in the
+ source collection.
example: true
type: boolean
data:
@@ -16231,6 +17087,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -16281,6 +17138,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -16311,6 +17169,13 @@ components:
description: Internal name of loyalty program.
example: program1
type: string
+ joinDate:
+ description: |
+ The date on which the customer joined the loyalty program in RFC3339.
+
+ **Note**: This is in the loyalty program's time zone.
+ format: date-time
+ type: string
ledger:
$ref: '#/components/schemas/LedgerInfo'
subLedgers:
@@ -16440,8 +17305,10 @@ components:
- name
type: object
TimePoint:
- description: The absolute duration after which the achievement is reset for
- a particular customer profile.
+ description: |
+ The absolute duration after which the achievement ends and resets for a particular customer profile.
+
+ **Note**: The duration follows the time zone of the Application this achievement belongs to.
example:
month: 11
dayOfMonth: 23
@@ -16451,7 +17318,7 @@ components:
properties:
month:
description: |
- The achievement is reset in this month.
+ The achievement ends and resets in this month.
**Note**: Only applicable if the period is set to `Y`.
example: 11
@@ -16460,31 +17327,31 @@ components:
type: integer
dayOfMonth:
description: |
- The achievement is reset on this day of the month.
+ The achievement ends and resets on this day of the month.
**Note**: Only applicable if the period is set to `Y` or `M`.
example: 23
- maximum: 28
+ maximum: 31
minimum: 1
type: integer
dayOfWeek:
description: |
- The achievement is reset on this day of the week. `1` represents `Monday` and `7` represents `Sunday`.
+ The achievement ends and resets on this day of the week. `1` represents `Monday` and `7` represents `Sunday`.
**Note**: Only applicable if the period is set to `W`.
maximum: 7
minimum: 1
type: integer
hour:
- description: The achievement is reset at this hour.
+ description: The achievement ends and resets at this hour.
example: 23
type: integer
minute:
- description: The achievement is reset at this minute.
+ description: The achievement ends and resets at this minute.
example: 59
type: integer
second:
- description: The achievement is reset at this second.
+ description: The achievement ends and resets at this second.
example: 59
type: integer
required:
@@ -17053,6 +17920,7 @@ components:
example:
rulesetId: 11
amount: 10.25
+ campaignId: 324
created: 2000-01-23T04:56:07.000+00:00
customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d
type: addition
@@ -17077,6 +17945,10 @@ components:
description: ID of the loyalty program.
example: 324
type: integer
+ campaignId:
+ description: ID of the campaign.
+ example: 324
+ type: integer
created:
description: Date and time the loyalty transaction occurred.
format: date-time
@@ -17419,7 +18291,7 @@ components:
type: string
sandbox:
description: |
- Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).
+ 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).
example: false
title: Sandbox
type: boolean
@@ -17435,6 +18307,27 @@ components:
type: object
CustomerInventory:
example:
+ achievements:
+ - endDate: 2000-01-23T04:56:07.000+00:00
+ campaignId: 3
+ name: FreeCoffee10Orders
+ achievementId: 3
+ progress: 10.0
+ completionDate: 2000-01-23T04:56:07.000+00:00
+ title: 50% off on 50th purchase.
+ startDate: 2000-01-23T04:56:07.000+00:00
+ status: completed
+ target: 10.0
+ - endDate: 2000-01-23T04:56:07.000+00:00
+ campaignId: 3
+ name: FreeCoffee10Orders
+ achievementId: 3
+ progress: 10.0
+ completionDate: 2000-01-23T04:56:07.000+00:00
+ title: 50% off on 50th purchase.
+ startDate: 2000-01-23T04:56:07.000+00:00
+ status: completed
+ target: 10.0
coupons:
- recipientIntegrationId: URNGV8294NV
implicitlyReserved: false
@@ -17660,6 +18553,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -17719,6 +18613,10 @@ components:
items:
$ref: '#/components/schemas/Giveaway'
type: array
+ achievements:
+ items:
+ $ref: '#/components/schemas/AchievementProgress'
+ type: array
type: object
NewCustomerSession:
description: ""
@@ -17813,6 +18711,8 @@ components:
state: open
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -17832,6 +18732,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -17901,7 +18803,7 @@ components:
title: Referral code entered in session
type: string
loyaltyCards:
- description: Any loyalty cards used.
+ description: Identifier of a loyalty card.
example:
- loyalty-card-1
items:
@@ -18242,6 +19144,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -18261,6 +19165,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -18352,7 +19258,7 @@ components:
title: Referral code entered in session
type: string
loyaltyCards:
- description: Any loyalty cards used.
+ description: Identifier of a loyalty card.
example:
- loyalty-card-1
items:
@@ -18476,6 +19382,8 @@ components:
CartItem:
example:
remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -18538,6 +19446,8 @@ components:
example: shoes
title: Item category
type: string
+ product:
+ $ref: '#/components/schemas/Product'
weight:
description: Weight of item in grams.
example: 1130.0
@@ -18935,6 +19845,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -19118,7 +20029,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -19175,6 +20085,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -19259,7 +20170,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -19316,6 +20226,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -19483,6 +20394,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -19502,6 +20415,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -19728,7 +20643,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -19785,6 +20699,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -19869,7 +20784,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -19926,6 +20840,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -20120,6 +21035,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -20398,7 +21314,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -20455,6 +21370,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -20539,7 +21455,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -20596,6 +21511,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -20790,6 +21706,7 @@ components:
downgradePolicy: one_down
name: bronze
id: 11
+ joinDate: 2000-01-23T04:56:07.000+00:00
subLedgers:
key:
pendingBalance: 10.0
@@ -21146,6 +22063,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -21165,6 +22084,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -21288,7 +22209,7 @@ components:
type: string
sandbox:
description: |
- Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).
+ 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).
example: false
title: Sandbox
type: boolean
@@ -21380,7 +22301,7 @@ components:
type: string
sandbox:
description: |
- Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).
+ 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).
example: false
title: Sandbox
type: boolean
@@ -21477,6 +22398,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -21496,6 +22419,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -22053,7 +22978,7 @@ components:
description: ""
properties:
email:
- description: The email address associated with your account.
+ description: The email address associated with the user profile.
example: john.doe@example.com
format: email
type: string
@@ -22073,7 +22998,7 @@ components:
description: ""
properties:
email:
- description: The email address associated with your account.
+ description: The email address associated with the user profile.
example: john.doe@example.com
format: email
type: string
@@ -22094,26 +23019,45 @@ components:
- password
type: object
UpdateUser:
+ example:
+ applicationNotificationSubscriptions: '{}'
+ roles:
+ - 1
+ - 3
+ name: John Doe
+ state: deactivated
+ isAdmin: false
+ policy: ""
properties:
name:
- description: The user name.
+ description: Name of the user.
example: John Doe
type: string
- policy:
- description: The `Access Control List` json defining the role of the user.
- This represents the access control on the user level.
- example: ""
- type: string
state:
- description: New state ("deactivated" or "active") for the user. Only usable
- by admins for the user.
+ description: |
+ The state of the user.
+ - `deactivated`: The user has been deactivated.
+ - `active`: The user is active.
+
+ **Note**: Only `admin` users can update the state of another user.
enum:
- deactivated
- active
example: deactivated
type: string
+ isAdmin:
+ description: Indicates whether the user is an `admin`.
+ example: false
+ type: boolean
+ policy:
+ description: Indicates the access level of the user.
+ example: ""
+ type: string
roles:
- description: List of roles to assign to the user.
+ description: |
+ A list of the IDs of the roles assigned to the user.
+
+ **Note**: Use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint to find the ID of a role.
example:
- 1
- 3
@@ -22121,12 +23065,9 @@ components:
type: integer
type: array
applicationNotificationSubscriptions:
+ description: Application notifications that the user is subscribed to.
properties: {}
type: object
- isAdmin:
- description: An indication of whether the user has admin permissions.
- example: false
- type: boolean
type: object
ChangeProfilePassword:
properties:
@@ -22143,13 +23084,18 @@ components:
- password
type: object
NewInviteEmail:
+ example:
+ email: john.doe@example.com
+ token: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
properties:
email:
+ description: Email address of the user.
+ example: john.doe@example.com
format: email
- minLength: 1
type: string
token:
- minLength: 1
+ description: Invitation token of the user.
+ example: Gy9b8w1irmQtEPo5RmbMmSPheL5h4
type: string
required:
- email
@@ -22228,6 +23174,12 @@ components:
items:
$ref: '#/components/schemas/LoyaltyProgram'
type: array
+ achievements:
+ description: The achievements, linked to the campaigns, belonging to the
+ application.
+ items:
+ $ref: '#/components/schemas/Achievement'
+ type: array
attributes:
description: The attributes that the application is subscribed to.
items:
@@ -22302,7 +23254,6 @@ components:
also be shown in the rule editor.
type: string
required:
- - description
- type
type: object
TemplateArgDef:
@@ -22340,7 +23291,6 @@ components:
(`picklist` property)
type: boolean
required:
- - description
- title
- type
- ui
@@ -22457,6 +23407,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -22561,6 +23512,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -22843,6 +23795,7 @@ components:
- loyalty
- giveaways
- strikethrough
+ - achievements
type: string
type: array
couponSettings:
@@ -23226,7 +24179,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -23283,6 +24235,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -24357,7 +25310,7 @@ components:
type: boolean
description:
description: A description of the audience.
- example: Travel audience 18-25
+ example: Travel audience 18-27
type: string
required:
- name
@@ -24369,7 +25322,7 @@ components:
name: Travel audience
sandbox: true
integration: mparticle
- description: Travel audience 18-25
+ description: Travel audience 18-27
integrationId: 382370BKDB946
createdIn3rdParty: false
properties:
@@ -24384,7 +25337,7 @@ components:
type: boolean
description:
description: A description of the audience.
- example: Travel audience 18-25
+ example: Travel audience 18-27
type: string
integration:
description: |
@@ -24437,7 +25390,7 @@ components:
name: Travel audience
sandbox: true
integration: mparticle
- description: Travel audience 18-25
+ description: Travel audience 18-27
integrationId: 382370BKDB946
id: 6
createdIn3rdParty: false
@@ -24466,7 +25419,7 @@ components:
type: boolean
description:
description: A description of the audience.
- example: Travel audience 18-25
+ example: Travel audience 18-27
type: string
integration:
description: |
@@ -24502,14 +25455,17 @@ components:
- name
type: object
AudienceAnalytics:
- description: The audiences and their members count.
+ description: The audiences and their member count.
+ example:
+ membersCount: 1234
+ audienceId: 1
properties:
audienceId:
description: The ID of the audience.
example: 1
type: integer
membersCount:
- description: The count of members under a single audience.
+ description: The member count of the audience.
example: 1234
type: integer
type: object
@@ -24707,6 +25663,7 @@ components:
- Referral
- Session
- Store
+ - Achievements
type: string
name:
description: |
@@ -24932,7 +25889,7 @@ components:
permissions:
$ref: '#/components/schemas/RoleV2Permissions'
members:
- description: A list of user identifiers the role is assigned to.
+ description: A list of user IDs the role is assigned to.
example:
- 10
- 12
@@ -24947,6 +25904,53 @@ components:
$ref: '#/components/schemas/RoleV2Base'
RoleV2:
description: ""
+ example:
+ accountId: 3886
+ created: 2020-06-10T09:05:27.993483Z
+ permissions:
+ permissionSets:
+ - name: Application permission set
+ logicalOperations:
+ - getApplicationOperations
+ - editApplicationOperations
+ - name: Campaign manager permission set
+ logicalOperations:
+ - getCampaignOperations
+ - createCampaignOperations
+ - updateCampaignOperations
+ - name: Campaign read-only permission set
+ logicalOperations:
+ - getCampaignOperations
+ - name: Loyalty program read-only permission set
+ logicalOperations:
+ - getLoyaltyProgramOperations
+ - name: Campaign access group manager permission set
+ logicalOperations:
+ - getCampaignAccessGroupOperations
+ - updateCampaignAccessGroupOperations
+ - deleteCampaignAccessGroupOperations
+ roles:
+ campaignAccessGroups:
+ "5": Campaign access group manager permission set
+ loyaltyPrograms:
+ "10": Loyalty program manager permission set
+ applications:
+ "1":
+ application: Application permission set
+ "3":
+ campaign: Campaign manager permission set
+ "4":
+ draftCampaign: Campaign read-only permission set
+ "5":
+ tools: Tools permission set
+ members:
+ - 10
+ - 12
+ name: Campaign and campaign access group manager
+ modified: 2021-09-12T10:12:42Z
+ description: Allows you to create and edit campaigns for specific Applications,
+ delete specific campaign access groups, and view loyalty programs.
+ id: 6
properties:
id:
description: Internal ID of this entity.
@@ -24978,7 +25982,7 @@ components:
permissions:
$ref: '#/components/schemas/RoleV2Permissions'
members:
- description: A list of user identifiers the role is assigned to.
+ description: A list of user IDs the role is assigned to.
example:
- 10
- 12
@@ -24992,6 +25996,49 @@ components:
- modified
type: object
RoleV2Base:
+ example:
+ permissions:
+ permissionSets:
+ - name: Application permission set
+ logicalOperations:
+ - getApplicationOperations
+ - editApplicationOperations
+ - name: Campaign manager permission set
+ logicalOperations:
+ - getCampaignOperations
+ - createCampaignOperations
+ - updateCampaignOperations
+ - name: Campaign read-only permission set
+ logicalOperations:
+ - getCampaignOperations
+ - name: Loyalty program read-only permission set
+ logicalOperations:
+ - getLoyaltyProgramOperations
+ - name: Campaign access group manager permission set
+ logicalOperations:
+ - getCampaignAccessGroupOperations
+ - updateCampaignAccessGroupOperations
+ - deleteCampaignAccessGroupOperations
+ roles:
+ campaignAccessGroups:
+ "5": Campaign access group manager permission set
+ loyaltyPrograms:
+ "10": Loyalty program manager permission set
+ applications:
+ "1":
+ application: Application permission set
+ "3":
+ campaign: Campaign manager permission set
+ "4":
+ draftCampaign: Campaign read-only permission set
+ "5":
+ tools: Tools permission set
+ members:
+ - 10
+ - 12
+ name: Campaign and campaign access group manager
+ description: Allows you to create and edit campaigns for specific Applications,
+ delete specific campaign access groups, and view loyalty programs.
properties:
name:
description: Name of the role.
@@ -25005,7 +26052,7 @@ components:
permissions:
$ref: '#/components/schemas/RoleV2Permissions'
members:
- description: A list of user identifiers the role is assigned to.
+ description: A list of user IDs the role is assigned to.
example:
- 10
- 12
@@ -25014,10 +26061,45 @@ components:
type: array
type: object
RoleV2Permissions:
+ example:
+ permissionSets:
+ - name: Application permission set
+ logicalOperations:
+ - getApplicationOperations
+ - editApplicationOperations
+ - name: Campaign manager permission set
+ logicalOperations:
+ - getCampaignOperations
+ - createCampaignOperations
+ - updateCampaignOperations
+ - name: Campaign read-only permission set
+ logicalOperations:
+ - getCampaignOperations
+ - name: Loyalty program read-only permission set
+ logicalOperations:
+ - getLoyaltyProgramOperations
+ - name: Campaign access group manager permission set
+ logicalOperations:
+ - getCampaignAccessGroupOperations
+ - updateCampaignAccessGroupOperations
+ - deleteCampaignAccessGroupOperations
+ roles:
+ campaignAccessGroups:
+ "5": Campaign access group manager permission set
+ loyaltyPrograms:
+ "10": Loyalty program manager permission set
+ applications:
+ "1":
+ application: Application permission set
+ "3":
+ campaign: Campaign manager permission set
+ "4":
+ draftCampaign: Campaign read-only permission set
+ "5":
+ tools: Tools permission set
properties:
permissionSets:
- description: List of grouped logical operations to use as a reference in
- the roles section. Each group of logical operations has a name.
+ description: List of grouped logical operations referenced by roles.
example:
- name: Application permission set
logicalOperations:
@@ -25041,12 +26123,26 @@ components:
- deleteCampaignAccessGroupOperations
items:
$ref: '#/components/schemas/RoleV2PermissionSet'
- maxItems: 100
+ maxItems: 500
type: array
roles:
$ref: '#/components/schemas/RoleV2RolesGroup'
type: object
RoleV2RolesGroup:
+ example:
+ campaignAccessGroups:
+ "5": Campaign access group manager permission set
+ loyaltyPrograms:
+ "10": Loyalty program manager permission set
+ applications:
+ "1":
+ application: Application permission set
+ "3":
+ campaign: Campaign manager permission set
+ "4":
+ draftCampaign: Campaign read-only permission set
+ "5":
+ tools: Tools permission set
properties:
applications:
additionalProperties:
@@ -25378,11 +26474,11 @@ components:
description: ""
properties:
title:
- description: Title for API Key.
+ description: Title of the API key.
example: My generated key
type: string
expires:
- description: The date the API key expired.
+ description: The date the API key expires.
example: 2023-08-24T14:00:00Z
format: date-time
type: string
@@ -25403,6 +26499,22 @@ components:
- emarsys
example: none
type: string
+ type:
+ description: |
+ The API key type. Can be empty or `staging`.
+
+ Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.
+
+ When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.
+ enum:
+ - staging
+ example: staging
+ type: string
+ timeOffset:
+ description: |
+ A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.
+ example: 100000
+ type: integer
id:
description: ID of the API Key.
example: 34
@@ -25437,11 +26549,11 @@ components:
description: ""
properties:
title:
- description: Title for API Key.
+ description: Title of the API key.
example: My generated key
type: string
expires:
- description: The date the API key expired.
+ description: The date the API key expires.
example: 2023-08-24T14:00:00Z
format: date-time
type: string
@@ -25462,6 +26574,22 @@ components:
- emarsys
example: none
type: string
+ type:
+ description: |
+ The API key type. Can be empty or `staging`.
+
+ Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.
+
+ When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.
+ enum:
+ - staging
+ example: staging
+ type: string
+ timeOffset:
+ description: |
+ A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.
+ example: 100000
+ type: integer
id:
description: ID of the API Key.
example: 34
@@ -25500,11 +26628,11 @@ components:
CreateApplicationAPIKey:
properties:
title:
- description: Title for API Key.
+ description: Title of the API key.
example: My generated key
type: string
expires:
- description: The date the API key expired.
+ description: The date the API key expires.
example: 2023-08-24T14:00:00Z
format: date-time
type: string
@@ -25525,10 +26653,36 @@ components:
- emarsys
example: none
type: string
+ type:
+ description: |
+ The API key type. Can be empty or `staging`.
+
+ Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.
+
+ When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.
+ enum:
+ - staging
+ example: staging
+ type: string
+ timeOffset:
+ description: |
+ A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.
+ example: 100000
+ type: integer
required:
- expires
- title
type: object
+ UpdateApplicationAPIKey:
+ properties:
+ timeOffset:
+ description: |
+ A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.
+ example: 100000
+ type: integer
+ required:
+ - timeOffset
+ type: object
CreateManagementKey:
properties:
name:
@@ -25699,10 +26853,40 @@ components:
- id
- name
type: object
+ NotificationListItem:
+ properties:
+ notificationId:
+ description: The ID of the notification.
+ example: 1
+ type: integer
+ notificationName:
+ description: The name of the notification.
+ example: My campaign notification
+ type: string
+ entityId:
+ description: |
+ The ID of the entity to which this notification belongs.
+ For example, in case of a loyalty notification, this value is the ID of the loyalty program.
+ example: 1
+ type: integer
+ enabled:
+ description: Indicates whether the notification is activated.
+ example: true
+ type: boolean
+ required:
+ - enabled
+ - entityId
+ - notificationId
+ - notificationName
+ type: object
Notifications:
items:
$ref: '#/components/schemas/Notification'
type: array
+ NotificationListItems:
+ items:
+ $ref: '#/components/schemas/NotificationListItem'
+ type: array
SamlConnection:
description: ""
properties:
@@ -25804,6 +26988,20 @@ components:
- signOnURL
- x509certificate
type: object
+ SamlConnectionInternal:
+ properties:
+ name:
+ description: ID of the SAML service.
+ minLength: 1
+ type: string
+ metadataDocument:
+ description: Identity Provider metadata XML document.
+ minLength: 1
+ type: string
+ required:
+ - metadataDocument
+ - name
+ type: object
SamlConnectionMetadata:
properties:
name:
@@ -25875,7 +27073,7 @@ components:
minLength: 1
type: string
loginURL:
- description: Single Sign-On URL.
+ description: The single sign-on URL.
minLength: 1
type: string
required:
@@ -26429,11 +27627,10 @@ components:
ChangeLoyaltyTierLevelEffectProps:
description: |
The properties specific to the "changeLoyaltyTierLevel" effect.
- This is triggered whenever the user's loyalty tier is upgraded or downgraded
- due to a validated rule that contained an "add loyalty points" effect.
+ This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an "addLoyaltyPoints" effect.
properties:
ruleTitle:
- description: The title of the rule that triggered the tier upgrade or downgrade.
+ description: The title of the rule that triggered the tier upgrade.
type: string
programId:
description: The ID of the loyalty program where these points were added.
@@ -26443,11 +27640,10 @@ components:
points were added.
type: string
previousTierName:
- description: The name of the tier from which the user was upgraded or downgraded.
+ description: The name of the tier from which the user was upgraded.
type: string
newTierName:
- description: The name of the tier to which the user has been upgraded or
- downgraded.
+ description: The name of the tier to which the user has been upgraded.
type: string
expiryDate:
description: The expiration date of the new tier.
@@ -26788,6 +27984,45 @@ components:
example: 150
type: integer
type: object
+ IncreaseAchievementProgressEffectProps:
+ description: The properties specific to the "increaseAchievementProgress" effect.
+ This gets triggered whenever a validated rule contained an "increase customer
+ progress" effect.
+ properties:
+ achievementId:
+ description: The internal ID of the achievement.
+ example: 10
+ type: integer
+ achievementName:
+ description: The name of the achievement.
+ example: FreeCoffee10Orders
+ type: string
+ progressTrackerId:
+ description: The internal ID of the achievement progress tracker.
+ type: integer
+ delta:
+ description: The value by which the customer's current progress in the achievement
+ is increased.
+ type: number
+ value:
+ description: The current progress of the customer in the achievement.
+ type: number
+ target:
+ description: The required number of actions or the transactional milestone
+ to complete the achievement.
+ type: number
+ isJustCompleted:
+ description: Indicates if the customer has completed the achievement in
+ the current session.
+ type: boolean
+ required:
+ - achievementId
+ - achievementName
+ - delta
+ - isJustCompleted
+ - target
+ - value
+ type: object
ErrorEffectProps:
description: Whenever an error occurred during evaluation, we return an error
effect. This should never happen for rules created in the rule builder.
@@ -26864,6 +28099,8 @@ components:
state: open
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -26883,6 +28120,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -27199,7 +28438,7 @@ components:
action:
description: |
Defines the action to perform:
- - `add`: Adds the customer profile to the audience.
+ - `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.
enum:
- add
@@ -28503,7 +29742,7 @@ components:
description: A notification regarding a campaign whose state changed.
properties:
campaign:
- $ref: '#/components/schemas/CampaignForNotification'
+ $ref: '#/components/schemas/Campaign'
oldState:
description: |
The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived']
@@ -28525,7 +29764,7 @@ components:
description: A notification regarding a campaign whose ruleset was changed.
properties:
campaign:
- $ref: '#/components/schemas/CampaignStateNotification'
+ $ref: '#/components/schemas/Campaign'
oldRuleset:
$ref: '#/components/schemas/Ruleset'
ruleset:
@@ -28537,9 +29776,9 @@ components:
description: A notification regarding a campaign which was edited.
properties:
campaign:
- $ref: '#/components/schemas/CampaignStateNotification'
+ $ref: '#/components/schemas/Campaign'
oldCampaign:
- $ref: '#/components/schemas/CampaignStateNotification'
+ $ref: '#/components/schemas/Campaign'
ruleset:
$ref: '#/components/schemas/Ruleset'
required:
@@ -28550,7 +29789,7 @@ components:
description: A notification regarding a campaign that was created.
properties:
campaign:
- $ref: '#/components/schemas/CampaignStateNotification'
+ $ref: '#/components/schemas/Campaign'
ruleset:
$ref: '#/components/schemas/Ruleset'
evaluationPosition:
@@ -28585,7 +29824,7 @@ components:
description: A notification regarding a campaign that was deleted.
properties:
campaign:
- $ref: '#/components/schemas/CampaignStateNotification'
+ $ref: '#/components/schemas/Campaign'
deletedAt:
description: Time when the campaign was deleted.
example: 2022-11-10T23:00:00Z
@@ -28595,289 +29834,6 @@ components:
- campaign
- deletedAt
type: object
- CampaignStateNotification:
- description: Campaign data and its state changes.
- properties:
- id:
- description: Unique ID for this entity.
- example: 4
- type: integer
- created:
- description: The exact moment this entity was created.
- example: 2020-06-10T09:05:27.993483Z
- format: date-time
- type: string
- applicationId:
- description: The ID of the application that owns this entity.
- example: 322
- type: integer
- userId:
- description: The ID of the user associated with this entity.
- example: 388
- type: integer
- name:
- description: A user-facing name for this campaign.
- example: Summer promotions
- minLength: 1
- title: Campaign Name
- type: string
- description:
- description: A detailed description of the campaign.
- example: Campaign for all summer 2021 promotions
- title: Campaign Description
- type: string
- startTime:
- description: Timestamp when the campaign will become active.
- example: 2021-07-20T22:00:00Z
- format: date-time
- type: string
- endTime:
- description: Timestamp when the campaign will become inactive.
- example: 2021-09-22T22:00:00Z
- format: date-time
- type: string
- attributes:
- description: Arbitrary properties associated with this campaign.
- properties: {}
- type: object
- state:
- default: enabled
- description: |
- A disabled or archived campaign is not evaluated for rules or coupons.
- enum:
- - enabled
- - disabled
- - archived
- example: enabled
- type: string
- activeRulesetId:
- description: |
- [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
- campaign applies on customer session evaluation.
- example: 6
- type: integer
- tags:
- description: A list of tags for the campaign.
- example:
- - summer
- items:
- maxLength: 50
- minLength: 1
- type: string
- maxItems: 50
- type: array
- features:
- description: The features enabled in this campaign.
- example:
- - coupons
- - referrals
- items:
- enum:
- - coupons
- - referrals
- - loyalty
- - giveaways
- - strikethrough
- type: string
- type: array
- couponSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- referralSettings:
- $ref: '#/components/schemas/CodeGeneratorSettings'
- limits:
- description: |
- The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.
- items:
- $ref: '#/components/schemas/LimitConfig'
- type: array
- campaignGroups:
- description: |
- The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.
- example:
- - 1
- - 3
- items:
- type: integer
- type: array
- evaluationGroupId:
- description: The ID of the campaign evaluation group the campaign belongs
- to.
- example: 2
- title: Evaluation Group ID
- type: integer
- type:
- default: advanced
- description: |
- 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.
- enum:
- - cartItem
- - advanced
- example: advanced
- title: Type
- type: string
- linkedStoreIds:
- 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.
- example:
- - 1
- - 2
- - 3
- items:
- type: integer
- type: array
- budgets:
- description: |
- 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.
- items:
- $ref: '#/components/schemas/CampaignBudget'
- type: array
- couponRedemptionCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Number of coupons redeemed in the campaign.
- example: 163
- type: integer
- referralRedemptionCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Number of referral codes redeemed in the campaign.
- example: 3
- type: integer
- discountCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total amount of discounts redeemed in the campaign.
- example: 288.0
- type: number
- discountEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of times discounts were redeemed in this campaign.
- example: 343
- type: integer
- couponCreationCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of coupons created by rules in this campaign.
- example: 16
- type: integer
- customEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of custom effects triggered by rules in this campaign.
- example: 0
- type: integer
- referralCreationCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of referrals created by rules in this campaign.
- example: 8
- type: integer
- addFreeItemEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.
- example: 0
- type: integer
- awardedGiveawaysCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of giveaways awarded by rules in this campaign.
- example: 9
- type: integer
- createdLoyaltyPointsCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty points created by rules in this campaign.
- example: 9.0
- type: number
- createdLoyaltyPointsEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty point creation effects triggered by rules in this campaign.
- example: 2
- type: integer
- redeemedLoyaltyPointsCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty points redeemed by rules in this campaign.
- example: 8.0
- type: number
- redeemedLoyaltyPointsEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of loyalty point redemption effects triggered by rules in this campaign.
- example: 9
- type: integer
- callApiEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of webhooks triggered by rules in this campaign.
- example: 0
- type: integer
- reservecouponEffectCount:
- description: |
- This property is **deprecated**. The count should be available under *budgets* property.
- Total number of reserve coupon effects triggered by rules in this campaign.
- example: 9
- type: integer
- lastActivity:
- description: Timestamp of the most recent event received by this campaign.
- example: 2022-11-10T23:00:00Z
- format: date-time
- type: string
- updated:
- description: |
- Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign
- are **not** registered by this property, such as collection or coupon updates.
- format: date-time
- type: string
- createdBy:
- description: Name of the user who created this campaign if available.
- example: John Doe
- type: string
- updatedBy:
- description: Name of the user who last updated this campaign if available.
- example: Jane Doe
- type: string
- templateId:
- description: The ID of the Campaign Template this Campaign was created from.
- example: 3
- type: integer
- frontendState:
- description: A campaign state described exactly as in the Campaign Manager.
- enum:
- - expired
- - scheduled
- - running
- - draft
- - disabled
- example: running
- type: string
- required:
- - applicationId
- - budgets
- - created
- - description
- - features
- - frontendState
- - id
- - limits
- - name
- - state
- - tags
- - type
- - userId
- type: object
CampaignEvaluationTreeChangedNotification:
description: Notification about an Application whose campaign evaluation tree
changed.
@@ -29079,7 +30035,9 @@ components:
description: ""
example:
webhook:
- headers: 'content-type: application/json'
+ headers:
+ - 'content-type: application/json'
+ - 'content-type: application/json'
url: www.my-company.com/my-endpoint-name
enabled: true
enabled: true
@@ -29110,6 +30068,28 @@ components:
type: object
BaseNotificationPolicy:
type: object
+ ExpiringCouponsNotificationPolicy:
+ properties:
+ name:
+ description: Notification name.
+ example: Notification to Google
+ minLength: 1
+ type: string
+ triggers:
+ items:
+ $ref: '#/components/schemas/ExpiringCouponsNotificationTrigger'
+ maxItems: 3
+ minItems: 1
+ type: array
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: true
+ type: boolean
+ required:
+ - name
+ - triggers
+ type: object
ExpiringPointsNotificationPolicy:
properties:
name:
@@ -29132,6 +30112,28 @@ components:
- name
- triggers
type: object
+ CardExpiringPointsNotificationPolicy:
+ properties:
+ name:
+ description: Notification name.
+ example: Notification to Google
+ minLength: 1
+ type: string
+ triggers:
+ items:
+ $ref: '#/components/schemas/CardExpiringPointsNotificationTrigger'
+ maxItems: 3
+ minItems: 1
+ type: array
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: true
+ type: boolean
+ required:
+ - name
+ - triggers
+ type: object
AddedDeductedPointsNotificationPolicy:
properties:
name:
@@ -29172,6 +30174,11 @@ components:
maxItems: 4
minItems: 1
type: array
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: true
+ type: boolean
required:
- name
- scopes
@@ -29193,6 +30200,11 @@ components:
example: Christmas Sale
minLength: 1
type: string
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: false
+ type: boolean
required:
- name
type: object
@@ -29203,6 +30215,11 @@ components:
example: Christmas Sale
minLength: 1
type: string
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: false
+ type: boolean
required:
- name
type: object
@@ -29213,6 +30230,11 @@ components:
example: Christmas Sale
minLength: 1
type: string
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: false
+ type: boolean
required:
- name
type: object
@@ -29233,6 +30255,11 @@ components:
example: Notification to Google
minLength: 1
type: string
+ batchingEnabled:
+ default: true
+ description: Indicates whether batching is activated.
+ example: false
+ type: boolean
triggers:
items:
$ref: '#/components/schemas/TierWillDowngradeNotificationTrigger'
@@ -29243,6 +30270,23 @@ components:
- name
- triggers
type: object
+ ExpiringCouponsNotificationTrigger:
+ properties:
+ amount:
+ description: The amount of period.
+ minimum: 0
+ type: integer
+ period:
+ description: Notification period indicated by a letter; "w" means week,
+ "d" means day.
+ enum:
+ - w
+ - d
+ type: string
+ required:
+ - amount
+ - period
+ type: object
ExpiringPointsNotificationTrigger:
properties:
amount:
@@ -29260,6 +30304,23 @@ components:
- amount
- period
type: object
+ CardExpiringPointsNotificationTrigger:
+ properties:
+ amount:
+ description: The amount of period.
+ minimum: 1
+ type: integer
+ period:
+ description: Notification period indicated by a letter; "w" means week,
+ "d" means day.
+ enum:
+ - w
+ - d
+ type: string
+ required:
+ - amount
+ - period
+ type: object
TierWillDowngradeNotificationTrigger:
properties:
amount:
@@ -29288,7 +30349,9 @@ components:
description: ""
example:
webhook:
- headers: 'content-type: application/json'
+ headers:
+ - 'content-type: application/json'
+ - 'content-type: application/json'
created: 2020-06-10T09:05:27.993483Z
modified: 2021-09-12T10:12:42Z
id: 6
@@ -29318,7 +30381,9 @@ components:
- campaign
- loyalty_added_deducted_points
- coupon
+ - expiring_coupons
- expiring_points
+ - card_expiring_points
- pending_to_active_points
- strikethrough_pricing
- tier_downgrade
@@ -29335,7 +30400,9 @@ components:
BaseNotificationWebhook:
description: ""
example:
- headers: 'content-type: application/json'
+ headers:
+ - 'content-type: application/json'
+ - 'content-type: application/json'
created: 2020-06-10T09:05:27.993483Z
modified: 2021-09-12T10:12:42Z
id: 6
@@ -29362,8 +30429,8 @@ components:
type: string
headers:
description: List of API HTTP headers for the given webhook-based notification.
- example: 'content-type: application/json'
items:
+ example: 'content-type: application/json'
pattern: ^[^:,]+:[^,]*$
type: string
type: array
@@ -29381,7 +30448,9 @@ components:
type: object
NewNotificationWebhook:
example:
- headers: 'content-type: application/json'
+ headers:
+ - 'content-type: application/json'
+ - 'content-type: application/json'
url: www.my-company.com/my-endpoint-name
enabled: true
properties:
@@ -29391,8 +30460,8 @@ components:
type: string
headers:
description: List of API HTTP headers for the given webhook-based notification.
- example: 'content-type: application/json'
items:
+ example: 'content-type: application/json'
pattern: ^[^:,]+:[^,]*$
type: string
type: array
@@ -29423,28 +30492,31 @@ components:
- campaign
- loyalty_added_deducted_points
- coupon
+ - expiring_coupons
- expiring_points
- pending_to_active_points
- strikethrough_pricing
- tier_downgrade
- tier_upgrade
- tier_will_downgrade
+ - card_expiring_points
example: loyalty_added_deducted_points
type: string
queryParams:
+ additionalProperties:
+ type: string
description: Array of query parameters.
example:
- - 'param1: value1'
- items:
- type: string
- type: array
+ param1: value1
+ param2: value2
+ type: object
headers:
- description: List of API HTTP headers for the given webhook-based notification.
- example: 'content-type: application/json'
- items:
- pattern: ^[^:,]+:[^,]*$
+ additionalProperties:
type: string
- type: array
+ description: List of API HTTP headers for the given webhook-based notification.
+ example:
+ content-type: application/json
+ type: object
verb:
description: API method for this notification.
enum:
@@ -29484,9 +30556,9 @@ components:
}
type: string
httpStatus:
- description: The returned http status code and status message.
- example: 200 OK
- type: string
+ description: The returned http status code.
+ example: 200
+ type: integer
required:
- httpResponse
- httpStatus
@@ -30252,7 +31324,8 @@ components:
- value
type: object
AddItemCatalogAction:
- description: The specific properties of the "ADD" catalog sync action.
+ description: |
+ The specific properties of the "ADD" catalog sync action.
properties:
sku:
description: The unique SKU of the item to add.
@@ -30269,17 +31342,28 @@ components:
color: blue
properties: {}
type: object
+ product:
+ $ref: '#/components/schemas/Product'
replaceIfExists:
default: false
- description: Indicates whether to replace the attributes of the item if
- the same SKU exists.
+ description: |
+ Indicates whether to replace the attributes of the item if the same SKU exists.
+
+ **Note**: When set to `true`:
+ - If you do not provide a new `price` value, the existing `price` value is retained.
+ - If you do not provide a new `product` value, the `product` value is set to `null`.
example: false
type: boolean
required:
- sku
type: object
PatchItemCatalogAction:
- description: The specific properties of the "PATCH" catalog sync action.
+ description: |
+ The specific properties of the "PATCH" catalog sync action.
+
+ **Note:**
+ - If you do not provide a new `price` value, the existing `price` value is retained.
+ - If you do not provide a new `product` value, the `product` value is set to `null`.
properties:
sku:
description: The unique SKU of the item to patch.
@@ -30292,6 +31376,8 @@ components:
description: The attributes of the item to patch.
properties: {}
type: object
+ product:
+ $ref: '#/components/schemas/Product'
createIfNotExists:
default: false
description: Indicates whether to create an item if the SKU does not exist.
@@ -30343,6 +31429,8 @@ components:
CatalogItem:
description: ""
example:
+ product:
+ name: sample_product
catalogid: 6
created: 2020-06-10T09:05:27.993483Z
price: 99.99
@@ -30388,6 +31476,8 @@ components:
items:
$ref: '#/components/schemas/ItemAttribute'
type: array
+ product:
+ $ref: '#/components/schemas/Product'
required:
- catalogid
- created
@@ -30395,6 +31485,20 @@ components:
- sku
- version
type: object
+ Product:
+ description: The specific properties of the product this item belongs to, if
+ available.
+ example:
+ name: sample_product
+ properties:
+ name:
+ description: The name of the product.
+ example: sample_product
+ maxLength: 50
+ type: string
+ required:
+ - name
+ type: object
ItemAttribute:
description: ""
example:
@@ -30495,19 +31599,6 @@ components:
- datetime
- total
type: object
- AccountDashboardStatisticApiCalls:
- properties:
- total:
- description: Total number of API calls received.
- type: number
- datetime:
- description: Values aggregated for the specified date.
- format: date-time
- type: string
- required:
- - datetime
- - total
- type: object
AccountDashboardStatisticCampaigns:
properties:
live:
@@ -30546,11 +31637,6 @@ components:
items:
$ref: '#/components/schemas/AccountDashboardStatisticReferrals'
type: array
- apiCalls:
- description: Aggregated statistic for the number of account API calls.
- items:
- $ref: '#/components/schemas/AccountDashboardStatisticApiCalls'
- type: array
campaigns:
$ref: '#/components/schemas/AccountDashboardStatisticCampaigns'
required:
@@ -30607,8 +31693,10 @@ components:
properties: {}
type: object
integrationId:
- description: The integration ID of the store. You choose this ID when you
- create a store.
+ description: |
+ The integration ID of the store. You choose this ID when you create a store.
+
+ **Note**: You cannot edit the `integrationId` after the store has been created.
example: STORE-001
format: string
maxLength: 1000
@@ -30664,8 +31752,10 @@ components:
properties: {}
type: object
integrationId:
- description: The integration ID of the store. You choose this ID when you
- create a store.
+ description: |
+ The integration ID of the store. You choose this ID when you create a store.
+
+ **Note**: You cannot edit the `integrationId` after the store has been created.
example: STORE-001
format: string
maxLength: 1000
@@ -30723,6 +31813,18 @@ components:
- operation
type: object
CreateAchievement:
+ example:
+ period: 1Y
+ name: Order50Discount
+ periodEndOverride:
+ month: 11
+ dayOfMonth: 23
+ hour: 23
+ minute: 59
+ second: 59
+ description: 50% off for every 50th purchase in a year.
+ title: 50% off on 50th purchase.
+ target: 50.0
properties:
name:
description: |
@@ -30744,13 +31846,13 @@ components:
format: string
type: string
target:
- description: The maximum number of times a specific action must be completed
- by a customer profile over a defined period of time.
+ description: The required number of actions or the transactional milestone
+ to complete the achievement.
example: 50.0
type: number
period:
description: |
- The relative duration after which the achievement is reset for a particular customer profile.
+ The relative duration after which the achievement ends and resets for a particular customer profile.
**Note**: The `period` does not start when the achievement is created.
@@ -30788,6 +31890,10 @@ components:
type: object
AchievementAdditionalProperties:
properties:
+ campaignId:
+ description: ID of the campaign, to which the achievement belongs to
+ example: 1
+ type: integer
userId:
description: ID of the user that created this achievement.
example: 1234
@@ -30799,12 +31905,34 @@ components:
**Note**: This is not available if the user has been deleted.
example: John Doe
type: string
+ hasProgress:
+ description: Indicates if a customer has made progress in the achievement.
+ type: boolean
required:
+ - campaignId
- createdBy
- userId
type: object
Achievement:
description: ""
+ example:
+ period: 1Y
+ createdBy: John Doe
+ created: 2020-06-10T09:05:27.993483Z
+ campaignId: 1
+ name: Order50Discount
+ periodEndOverride:
+ month: 11
+ dayOfMonth: 23
+ hour: 23
+ minute: 59
+ second: 59
+ description: 50% off for every 50th purchase in a year.
+ id: 6
+ title: 50% off on 50th purchase.
+ userId: 1234
+ hasProgress: true
+ target: 50.0
properties:
id:
description: Internal ID of this entity.
@@ -30835,13 +31963,13 @@ components:
format: string
type: string
target:
- description: The maximum number of times a specific action must be completed
- by a customer profile over a defined period of time.
+ description: The required number of actions or the transactional milestone
+ to complete the achievement.
example: 50.0
type: number
period:
description: |
- The relative duration after which the achievement is reset for a particular customer profile.
+ The relative duration after which the achievement ends and resets for a particular customer profile.
**Note**: The `period` does not start when the achievement is created.
@@ -30870,6 +31998,10 @@ components:
type: string
periodEndOverride:
$ref: '#/components/schemas/TimePoint'
+ campaignId:
+ description: ID of the campaign, to which the achievement belongs to
+ example: 1
+ type: integer
userId:
description: ID of the user that created this achievement.
example: 1234
@@ -30881,7 +32013,11 @@ components:
**Note**: This is not available if the user has been deleted.
example: John Doe
type: string
+ hasProgress:
+ description: Indicates if a customer has made progress in the achievement.
+ type: boolean
required:
+ - campaignId
- created
- createdBy
- description
@@ -30893,7 +32029,27 @@ components:
- userId
type: object
UpdateAchievement:
+ example:
+ period: 1Y
+ name: Order50Discount
+ periodEndOverride:
+ month: 11
+ dayOfMonth: 23
+ hour: 23
+ minute: 59
+ second: 59
+ description: 50% off for every 50th purchase in a year.
+ title: 50% off on 50th purchase.
+ target: 50.0
properties:
+ name:
+ description: |
+ The internal name of the achievement used in API requests.
+ example: Order50Discount
+ maxLength: 1000
+ minLength: 1
+ pattern: ^[a-zA-Z]\w+$
+ type: string
title:
description: The display name for the achievement in the Campaign Manager.
example: 50% off on 50th purchase.
@@ -30903,6 +32059,191 @@ components:
example: 50% off for every 50th purchase in a year.
format: string
type: string
+ target:
+ description: The required number of actions or the transactional milestone
+ to complete the achievement.
+ example: 50.0
+ type: number
+ period:
+ description: |
+ The relative duration after which the achievement ends and resets for a particular customer profile.
+ example: 1Y
+ type: string
+ periodEndOverride:
+ $ref: '#/components/schemas/TimePoint'
+ type: object
+ AchievementProgress:
+ example:
+ endDate: 2000-01-23T04:56:07.000+00:00
+ campaignId: 3
+ name: FreeCoffee10Orders
+ achievementId: 3
+ progress: 10.0
+ completionDate: 2000-01-23T04:56:07.000+00:00
+ title: 50% off on 50th purchase.
+ startDate: 2000-01-23T04:56:07.000+00:00
+ status: completed
+ target: 10.0
+ properties:
+ achievementId:
+ description: The internal ID of the achievement.
+ example: 3
+ type: integer
+ name:
+ description: |
+ The internal name of the achievement used in API requests.
+ example: FreeCoffee10Orders
+ maxLength: 1000
+ minLength: 1
+ pattern: ^[a-zA-Z]\w+$
+ type: string
+ title:
+ description: The display name of the achievement in the Campaign Manager.
+ example: 50% off on 50th purchase.
+ type: string
+ campaignId:
+ description: The ID of the campaign the achievement belongs to.
+ example: 3
+ type: integer
+ status:
+ description: The status of the achievement.
+ enum:
+ - inprogress
+ - completed
+ - expired
+ example: completed
+ type: string
+ target:
+ description: The required number of actions or the transactional milestone
+ to complete the achievement.
+ example: 10.0
+ type: number
+ progress:
+ description: The current progress of the customer in the achievement.
+ example: 10.0
+ type: number
+ startDate:
+ description: Timestamp at which the customer started the achievement.
+ format: date-time
+ type: string
+ completionDate:
+ description: Timestamp at which point the customer completed the achievement.
+ format: date-time
+ type: string
+ endDate:
+ description: Timestamp at which point the achievement ends and resets for
+ the customer.
+ format: date-time
+ type: string
+ required:
+ - achievementId
+ - campaignId
+ - endDate
+ - name
+ - progress
+ - startDate
+ - status
+ - title
+ type: object
+ ApplicationAnalyticsDataPoint:
+ 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
+ totalRevenue:
+ $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_totalRevenue'
+ sessionsCount:
+ $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_sessionsCount'
+ avgItemsPerSession:
+ $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_avgItemsPerSession'
+ avgSessionValue:
+ $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_avgSessionValue'
+ totalDiscounts:
+ description: The total value of discounts given for cart items in influenced
+ sessions.
+ example: 10.0
+ type: number
+ couponsCount:
+ description: The number of times a coupon was successfully redeemed in influenced
+ sessions.
+ example: 12.0
+ type: number
+ type: object
+ ApplicationCampaignAnalytics:
+ 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
+ campaignId:
+ description: The ID of the campaign.
+ example: 1
+ type: integer
+ campaignName:
+ description: The name of the campaign.
+ example: Summer promotions
+ type: string
+ campaignTags:
+ description: A list of tags for the campaign.
+ example:
+ - summer
+ items:
+ maxLength: 50
+ minLength: 1
+ type: string
+ maxItems: 50
+ type: array
+ campaignState:
+ default: enabled
+ description: |
+ The state of the campaign.
+
+ **Note:** A disabled or archived campaign is not evaluated for rules or coupons.
+ enum:
+ - enabled
+ - disabled
+ - archived
+ example: enabled
+ type: string
+ campaignActiveRulesetId:
+ description: |
+ The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
+ campaign applies on customer session evaluation.
+ example: 2
+ type: integer
+ campaignStartTime:
+ description: Date and time when the campaign becomes active.
+ example: 2021-07-20T22:00:00Z
+ format: date-time
+ type: string
+ campaignEndTime:
+ description: Date and time when the campaign becomes inactive.
+ example: 2021-10-01T02:00:00Z
+ format: date-time
+ type: string
+ totalRevenue:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_totalRevenue'
+ sessionsCount:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_sessionsCount'
+ avgItemsPerSession:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_avgItemsPerSession'
+ avgSessionValue:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_avgSessionValue'
+ totalDiscounts:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_totalDiscounts'
+ couponsCount:
+ $ref: '#/components/schemas/ApplicationCampaignAnalytics_couponsCount'
type: object
inline_response_201:
example:
@@ -31198,9 +32539,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -31234,9 +32578,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -31307,9 +32654,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -31343,9 +32693,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -31399,7 +32752,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -31456,6 +32808,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -31540,7 +32893,6 @@ components:
- coupons
- referrals
createdLoyaltyPointsCount: 9.0
- evaluationGroupId: 2
couponSettings:
couponPattern: SUMMER-####-####
validCharacters:
@@ -31597,6 +32949,7 @@ components:
activeRulesetId: 6
reservecouponEffectCount: 9
updatedBy: Jane Doe
+ frontendState: running
created: 2020-06-10T09:05:27.993483Z
referralCreationCount: 8
couponRedemptionCount: 163
@@ -32177,6 +33530,51 @@ components:
- data
- hasMore
inline_response_200_11:
+ example:
+ data:
+ - accountId: 3886
+ created: 2020-06-10T09:05:27.993483Z
+ name: Europe access group
+ subscribedApplicationsIds:
+ - 1
+ - 2
+ - 3
+ modified: 2021-09-12T10:12:42Z
+ description: A group that gives access to all the campaigns for the Europe
+ market.
+ id: 6
+ campaignIds:
+ - 4
+ - 6
+ - 8
+ - accountId: 3886
+ created: 2020-06-10T09:05:27.993483Z
+ name: Europe access group
+ subscribedApplicationsIds:
+ - 1
+ - 2
+ - 3
+ modified: 2021-09-12T10:12:42Z
+ description: A group that gives access to all the campaigns for the Europe
+ market.
+ id: 6
+ campaignIds:
+ - 4
+ - 6
+ - 8
+ totalResultSize: 1
+ properties:
+ totalResultSize:
+ example: 1
+ type: integer
+ data:
+ items:
+ $ref: '#/components/schemas/CampaignGroup'
+ type: array
+ required:
+ - data
+ - totalResultSize
+ inline_response_200_12:
example:
data:
- activeRulesetId: 5
@@ -32455,7 +33853,7 @@ components:
required:
- data
- hasMore
- inline_response_200_12:
+ inline_response_200_13:
example:
data:
- cardBased: true
@@ -32483,9 +33881,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -32519,9 +33920,12 @@ components:
sandbox: true
description: Customers collect 10 points per 1$ spent
title: Point collection
+ canUpdateJoinPolicy: true
subscribedApplications:
- 132
- 97
+ tiersExpirationPolicy: tier_start_date
+ programJoinPolicy: not_join
accountID: 1
defaultValidity: 2W_U
defaultPending: immediate
@@ -32542,11 +33946,12 @@ components:
required:
- data
- totalResultSize
- inline_response_200_13:
+ inline_response_200_14:
example:
data:
- rulesetId: 11
amount: 10.25
+ campaignId: 324
created: 2000-01-23T04:56:07.000+00:00
customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d
type: addition
@@ -32564,6 +33969,7 @@ components:
startDate: 2022-01-02T15:04:05Z07:00
- rulesetId: 11
amount: 10.25
+ campaignId: 324
created: 2000-01-23T04:56:07.000+00:00
customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d
type: addition
@@ -32591,7 +33997,7 @@ components:
required:
- data
- hasMore
- inline_response_200_14:
+ inline_response_200_15:
example:
data:
- ledger:
@@ -32688,7 +34094,7 @@ components:
required:
- data
- hasMore
- inline_response_200_15:
+ inline_response_200_16:
example:
data:
- amount: 10.25
@@ -32731,7 +34137,7 @@ components:
required:
- data
- hasMore
- inline_response_200_16:
+ inline_response_200_17:
example:
data:
- accountId: 3886
@@ -32776,7 +34182,7 @@ components:
type: array
required:
- data
- inline_response_200_17:
+ inline_response_200_18:
example:
data:
- item: item
@@ -32792,57 +34198,6 @@ components:
required:
- data
- hasMore
- inline_response_200_18:
- example:
- data:
- - accountId: 3886
- createdBy: 134
- payload:
- - KTL-WH-ET-1
- - KTL-BL-ET-1
- created: 2020-06-10T09:05:27.993483Z
- campaignId: 7
- subscribedApplicationsIds:
- - 1
- - 2
- - 3
- name: My collection
- modified: 2021-09-12T10:12:42Z
- description: My collection of SKUs
- modifiedBy: 48
- id: 6
- applicationId: 1
- - accountId: 3886
- createdBy: 134
- payload:
- - KTL-WH-ET-1
- - KTL-BL-ET-1
- created: 2020-06-10T09:05:27.993483Z
- campaignId: 7
- subscribedApplicationsIds:
- - 1
- - 2
- - 3
- name: My collection
- modified: 2021-09-12T10:12:42Z
- description: My collection of SKUs
- modifiedBy: 48
- id: 6
- applicationId: 1
- hasMore: true
- totalResultSize: 1
- properties:
- hasMore:
- type: boolean
- totalResultSize:
- example: 1
- type: integer
- data:
- items:
- $ref: '#/components/schemas/Collection'
- type: array
- required:
- - data
inline_response_200_19:
example:
data:
@@ -33284,6 +34639,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -33303,6 +34660,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -33338,6 +34697,8 @@ components:
applicationId: 322
cartItems:
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -33357,6 +34718,8 @@ components:
category: shoes
height: 0.8008281904610115
- remainingQuantity: 1
+ product:
+ name: sample_product
quantity: 1
returnedQuantity: 1
length: 1.4658129805029452
@@ -33531,7 +34894,7 @@ components:
name: Travel audience
sandbox: true
integration: mparticle
- description: Travel audience 18-25
+ description: Travel audience 18-27
integrationId: 382370BKDB946
id: 6
createdIn3rdParty: false
@@ -33541,7 +34904,7 @@ components:
name: Travel audience
sandbox: true
integration: mparticle
- description: Travel audience 18-25
+ description: Travel audience 18-27
integrationId: 382370BKDB946
id: 6
createdIn3rdParty: false
@@ -33560,6 +34923,78 @@ components:
required:
- data
inline_response_200_31:
+ example:
+ data:
+ - membersCount: 1234
+ audienceId: 1
+ - membersCount: 1234
+ audienceId: 1
+ hasMore: true
+ properties:
+ hasMore:
+ type: boolean
+ data:
+ items:
+ $ref: '#/components/schemas/AudienceAnalytics'
+ type: array
+ required:
+ - data
+ inline_response_200_32:
+ example:
+ data:
+ - accountId: 31
+ closedSessions: 3
+ created: 2000-01-23T04:56:07.000+00:00
+ sandbox: false
+ integrationId: URNGV8294NV
+ attributes:
+ Language: english
+ ShippingCountry: DE
+ totalSales: 299.99
+ lastActivity: 2020-02-08T14:15:20Z
+ id: 6
+ loyaltyMemberships:
+ - joined: 2000-01-23T04:56:07.000+00:00
+ loyaltyProgramId: 323414846
+ - joined: 2000-01-23T04:56:07.000+00:00
+ loyaltyProgramId: 323414846
+ audienceMemberships:
+ - name: Travel audience
+ id: 2
+ - name: Travel audience
+ id: 2
+ - accountId: 31
+ closedSessions: 3
+ created: 2000-01-23T04:56:07.000+00:00
+ sandbox: false
+ integrationId: URNGV8294NV
+ attributes:
+ Language: english
+ ShippingCountry: DE
+ totalSales: 299.99
+ lastActivity: 2020-02-08T14:15:20Z
+ id: 6
+ loyaltyMemberships:
+ - joined: 2000-01-23T04:56:07.000+00:00
+ loyaltyProgramId: 323414846
+ - joined: 2000-01-23T04:56:07.000+00:00
+ loyaltyProgramId: 323414846
+ audienceMemberships:
+ - name: Travel audience
+ id: 2
+ - name: Travel audience
+ id: 2
+ hasMore: true
+ properties:
+ hasMore:
+ type: boolean
+ data:
+ items:
+ $ref: '#/components/schemas/CustomerProfile'
+ type: array
+ required:
+ - data
+ inline_response_200_33:
example:
data:
- friendIntegrationId: friendIntegrationId
@@ -33588,7 +35023,7 @@ components:
type: array
required:
- data
- inline_response_200_32:
+ inline_response_200_34:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -33661,10 +35096,12 @@ components:
required:
- data
- totalResultSize
- inline_response_200_33:
+ inline_response_200_35:
example:
data:
- - catalogid: 6
+ - product:
+ name: sample_product
+ catalogid: 6
created: 2020-06-10T09:05:27.993483Z
price: 99.99
attributes:
@@ -33677,7 +35114,9 @@ components:
id: 6
sku: SKU1241028
version: 5
- - catalogid: 6
+ - product:
+ name: sample_product
+ catalogid: 6
created: 2020-06-10T09:05:27.993483Z
price: 99.99
attributes:
@@ -33704,7 +35143,7 @@ components:
type: array
required:
- data
- inline_response_200_34:
+ inline_response_200_36:
example:
data:
- accountId: 3886
@@ -33739,7 +35178,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_35:
+ inline_response_200_37:
example:
data:
- headers:
@@ -33790,7 +35229,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_36:
+ inline_response_200_38:
example:
data:
- webhookId: 1
@@ -33815,7 +35254,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_37:
+ inline_response_200_39:
example:
data:
- requestTime: 2021-07-20T22:00:00Z
@@ -33856,7 +35295,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_38:
+ inline_response_200_40:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -33881,7 +35320,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_39:
+ inline_response_200_41:
example:
data:
- created: 2020-06-10T09:05:27.993483Z
@@ -33896,8 +35335,8 @@ components:
lastAccessed: 2021-09-12T10:14:42Z
id: 6
state: invited
- latestFeedTimestamp: 2020-06-01T00:00:00Z
authMethod: basic_auth
+ latestFeedTimestamp: 2020-06-01T00:00:00Z
lastSignedIn: 2021-09-12T10:12:42Z
email: john.doe@example.com
policy:
@@ -33914,8 +35353,8 @@ components:
lastAccessed: 2021-09-12T10:14:42Z
id: 6
state: invited
- latestFeedTimestamp: 2020-06-01T00:00:00Z
authMethod: basic_auth
+ latestFeedTimestamp: 2020-06-01T00:00:00Z
lastSignedIn: 2021-09-12T10:12:42Z
email: john.doe@example.com
policy:
@@ -33932,7 +35371,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_40:
+ inline_response_200_42:
example:
data:
- new:
@@ -33983,7 +35422,7 @@ components:
type: array
required:
- data
- inline_response_200_41:
+ inline_response_200_43:
example:
data:
- filter: '{}'
@@ -34010,7 +35449,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_42:
+ inline_response_200_44:
example:
data:
- accountId: 3886
@@ -34053,7 +35492,7 @@ components:
required:
- data
- totalResultSize
- inline_response_200_43:
+ inline_response_200_45:
example:
data:
- linkedCampaignIds:
@@ -34098,6 +35537,202 @@ components:
type: array
required:
- data
+ inline_response_200_46:
+ example:
+ data:
+ - period: 1Y
+ createdBy: John Doe
+ created: 2020-06-10T09:05:27.993483Z
+ campaignId: 1
+ name: Order50Discount
+ periodEndOverride:
+ month: 11
+ dayOfMonth: 23
+ hour: 23
+ minute: 59
+ second: 59
+ description: 50% off for every 50th purchase in a year.
+ id: 6
+ title: 50% off on 50th purchase.
+ userId: 1234
+ hasProgress: true
+ target: 50.0
+ - period: 1Y
+ createdBy: John Doe
+ created: 2020-06-10T09:05:27.993483Z
+ campaignId: 1
+ name: Order50Discount
+ periodEndOverride:
+ month: 11
+ dayOfMonth: 23
+ hour: 23
+ minute: 59
+ second: 59
+ description: 50% off for every 50th purchase in a year.
+ id: 6
+ title: 50% off on 50th purchase.
+ userId: 1234
+ hasProgress: true
+ target: 50.0
+ hasMore: true
+ properties:
+ hasMore:
+ type: boolean
+ data:
+ items:
+ $ref: '#/components/schemas/Achievement'
+ type: array
+ required:
+ - data
+ inline_response_200_47:
+ example:
+ data:
+ - endDate: 2000-01-23T04:56:07.000+00:00
+ campaignId: 3
+ name: FreeCoffee10Orders
+ achievementId: 3
+ progress: 10.0
+ completionDate: 2000-01-23T04:56:07.000+00:00
+ title: 50% off on 50th purchase.
+ startDate: 2000-01-23T04:56:07.000+00:00
+ status: completed
+ target: 10.0
+ - endDate: 2000-01-23T04:56:07.000+00:00
+ campaignId: 3
+ name: FreeCoffee10Orders
+ achievementId: 3
+ progress: 10.0
+ completionDate: 2000-01-23T04:56:07.000+00:00
+ title: 50% off on 50th purchase.
+ startDate: 2000-01-23T04:56:07.000+00:00
+ status: completed
+ target: 10.0
+ hasMore: true
+ properties:
+ hasMore:
+ example: true
+ type: boolean
+ data:
+ items:
+ $ref: '#/components/schemas/AchievementProgress'
+ type: array
+ required:
+ - data
+ - hasMore
+ ApplicationAnalyticsDataPoint_totalRevenue:
+ description: The total, pre-discount value of all items purchased in a customer
+ session.
+ properties:
+ total:
+ example: 1.25
+ type: number
+ influenced:
+ example: 3.25
+ type: number
+ ApplicationAnalyticsDataPoint_sessionsCount:
+ description: The number of all closed sessions. The `influenced` value includes
+ only sessions with at least one applied effect.
+ properties:
+ total:
+ example: 15.0
+ type: number
+ influenced:
+ example: 5.0
+ type: number
+ ApplicationAnalyticsDataPoint_avgItemsPerSession:
+ description: The number of items from sessions divided by the number of sessions.
+ The `influenced` value includes only sessions with at least one applied effect.
+ properties:
+ total:
+ example: 1.25
+ type: number
+ influenced:
+ example: 3.25
+ type: number
+ ApplicationAnalyticsDataPoint_avgSessionValue:
+ description: The average customer session value, calculated by dividing the
+ revenue value by the number of sessions. The `influenced` value includes only
+ sessions with at least one applied effect.
+ properties:
+ total:
+ example: 1.25
+ type: number
+ influenced:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_totalRevenue:
+ description: The total, pre-discount value of all items purchased in a customer
+ session.
+ properties:
+ value:
+ example: 1.25
+ type: number
+ influence_rate:
+ example: 3.25
+ type: number
+ trend:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_sessionsCount:
+ description: The number of all closed sessions. The `influenced` value includes
+ only sessions with at least one applied effect.
+ properties:
+ value:
+ example: 12.0
+ type: number
+ influence_rate:
+ example: 3.25
+ type: number
+ trend:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_avgItemsPerSession:
+ description: The number of items from sessions divided by the number of sessions.
+ The `influenced` value includes only sessions with at least one applied effect.
+ properties:
+ value:
+ example: 12.0
+ type: number
+ uplift:
+ example: 3.25
+ type: number
+ trend:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_avgSessionValue:
+ description: The average customer session value, calculated by dividing the
+ revenue value by the number of sessions. The `influenced` value includes only
+ sessions with at least one applied effect.
+ properties:
+ value:
+ example: 12.0
+ type: number
+ uplift:
+ example: 3.25
+ type: number
+ trend:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_totalDiscounts:
+ description: The total value of discounts given for cart items in influenced
+ sessions.
+ properties:
+ value:
+ example: 10.0
+ type: number
+ trend:
+ example: 3.25
+ type: number
+ ApplicationCampaignAnalytics_couponsCount:
+ description: The number of times a coupon was successfully redeemed in influenced
+ sessions.
+ properties:
+ value:
+ example: 10.0
+ type: number
+ trend:
+ example: 3.25
+ type: number
securitySchemes:
api_key_v1:
description: |
diff --git a/build.gradle b/build.gradle
index bb4bff00..762cf03a 100644
--- a/build.gradle
+++ b/build.gradle
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'java'
group = 'one.talon'
-version = '6.0.1'
+version = '7.0.0'
buildscript {
repositories {
diff --git a/build.sbt b/build.sbt
index 18c1ee8c..e2100fc2 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 := "6.0.1",
+ version := "7.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
diff --git a/docs/AccountDashboardStatistic.md b/docs/AccountDashboardStatistic.md
index b7efdc79..5dd825a9 100644
--- a/docs/AccountDashboardStatistic.md
+++ b/docs/AccountDashboardStatistic.md
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
**discounts** | [**List<AccountDashboardStatisticDiscount>**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional]
**loyaltyPoints** | [**List<AccountDashboardStatisticLoyaltyPoints>**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional]
**referrals** | [**List<AccountDashboardStatisticReferrals>**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional]
-**apiCalls** | [**List<AccountDashboardStatisticApiCalls>**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional]
**campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | |
diff --git a/docs/Achievement.md b/docs/Achievement.md
index c46d73b4..4475727b 100644
--- a/docs/Achievement.md
+++ b/docs/Achievement.md
@@ -12,11 +12,13 @@ Name | Type | Description | Notes
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
**title** | **String** | The display name for the achievement in the Campaign Manager. |
**description** | **String** | A description of the achievement. |
-**target** | [**BigDecimal**](BigDecimal.md) | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. |
-**period** | **String** | The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. |
+**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
+**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. |
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
+**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
**userId** | **Integer** | ID of the user that created this achievement. |
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
+**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
diff --git a/docs/AchievementAdditionalProperties.md b/docs/AchievementAdditionalProperties.md
index 83623dd2..45331ff8 100644
--- a/docs/AchievementAdditionalProperties.md
+++ b/docs/AchievementAdditionalProperties.md
@@ -6,8 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+**campaignId** | **Integer** | ID of the campaign, to which the achievement belongs to |
**userId** | **Integer** | ID of the user that created this achievement. |
**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
+**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md
new file mode 100644
index 00000000..13346663
--- /dev/null
+++ b/docs/AchievementProgress.md
@@ -0,0 +1,31 @@
+
+
+# AchievementProgress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**achievementId** | **Integer** | The internal ID of the achievement. |
+**name** | **String** | The internal name of the achievement used in API requests. |
+**title** | **String** | The display name of the achievement in the Campaign Manager. |
+**campaignId** | **Integer** | The ID of the campaign the achievement belongs to. |
+**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. |
+**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
+**progress** | [**BigDecimal**](BigDecimal.md) | The current progress of the customer in the achievement. |
+**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the customer started the achievement. |
+**completionDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the customer completed the achievement. | [optional]
+**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the achievement ends and resets for the customer. |
+
+
+
+## Enum: StatusEnum
+
+Name | Value
+---- | -----
+INPROGRESS | "inprogress"
+COMPLETED | "completed"
+EXPIRED | "expired"
+
+
+
diff --git a/docs/AddItemCatalogAction.md b/docs/AddItemCatalogAction.md
index b84a64f6..32aec3ee 100644
--- a/docs/AddItemCatalogAction.md
+++ b/docs/AddItemCatalogAction.md
@@ -2,7 +2,7 @@
# AddItemCatalogAction
-The specific properties of the \"ADD\" catalog sync action.
+The specific properties of the \"ADD\" catalog sync action.
## Properties
Name | Type | Description | Notes
@@ -10,7 +10,8 @@ Name | Type | Description | Notes
**sku** | **String** | The unique SKU of the item to add. |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. | [optional]
**attributes** | [**Object**](.md) | The attributes of the item to add. | [optional]
-**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional]
+**product** | [**Product**](Product.md) | | [optional]
+**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. **Note**: When set to `true`: - If you do not provide a new `price` value, the existing `price` value is retained. - If you do not provide a new `product` value, the `product` value is set to `null`. | [optional]
diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
index fcf24c23..6def97f0 100644
--- a/docs/AdditionalCampaignProperties.md
+++ b/docs/AdditionalCampaignProperties.md
@@ -27,6 +27,18 @@ Name | Type | Description | Notes
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
+**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. |
+
+
+
+## Enum: FrontendStateEnum
+
+Name | Value
+---- | -----
+EXPIRED | "expired"
+SCHEDULED | "scheduled"
+RUNNING | "running"
+DRAFT | "draft"
diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md
index ff3f40b3..d0fff825 100644
--- a/docs/ApplicationAPIKey.md
+++ b/docs/ApplicationAPIKey.md
@@ -7,9 +7,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**title** | **String** | Title for API Key. |
-**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expired. |
+**title** | **String** | Title of the API key. |
+**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expires. |
**platform** | [**PlatformEnum**](#PlatformEnum) | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
+**type** | [**TypeEnum**](#TypeEnum) | The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. | [optional]
+**timeOffset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. | [optional]
**id** | **Integer** | ID of the API Key. |
**createdBy** | **Integer** | ID of user who created. |
**accountID** | **Integer** | ID of account the key is used for. |
@@ -35,3 +37,11 @@ EMARSYS | "emarsys"
+## Enum: TypeEnum
+
+Name | Value
+---- | -----
+STAGING | "staging"
+
+
+
diff --git a/docs/ApplicationAnalyticsDataPoint.md b/docs/ApplicationAnalyticsDataPoint.md
new file mode 100644
index 00000000..d02dc8c2
--- /dev/null
+++ b/docs/ApplicationAnalyticsDataPoint.md
@@ -0,0 +1,19 @@
+
+
+# ApplicationAnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | [optional]
+**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | [optional]
+**totalRevenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) | | [optional]
+**sessionsCount** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) | | [optional]
+**avgItemsPerSession** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) | | [optional]
+**avgSessionValue** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) | | [optional]
+**totalDiscounts** | [**BigDecimal**](BigDecimal.md) | The total value of discounts given for cart items in influenced sessions. | [optional]
+**couponsCount** | [**BigDecimal**](BigDecimal.md) | The number of times a coupon was successfully redeemed in influenced sessions. | [optional]
+
+
+
diff --git a/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md b/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md
new file mode 100644
index 00000000..404b02a4
--- /dev/null
+++ b/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationAnalyticsDataPointAvgItemsPerSession
+
+The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenced** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationAnalyticsDataPointAvgSessionValue.md b/docs/ApplicationAnalyticsDataPointAvgSessionValue.md
new file mode 100644
index 00000000..def2660a
--- /dev/null
+++ b/docs/ApplicationAnalyticsDataPointAvgSessionValue.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationAnalyticsDataPointAvgSessionValue
+
+The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenced** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationAnalyticsDataPointSessionsCount.md b/docs/ApplicationAnalyticsDataPointSessionsCount.md
new file mode 100644
index 00000000..8078a792
--- /dev/null
+++ b/docs/ApplicationAnalyticsDataPointSessionsCount.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationAnalyticsDataPointSessionsCount
+
+The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenced** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationAnalyticsDataPointTotalRevenue.md b/docs/ApplicationAnalyticsDataPointTotalRevenue.md
new file mode 100644
index 00000000..41d729c3
--- /dev/null
+++ b/docs/ApplicationAnalyticsDataPointTotalRevenue.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationAnalyticsDataPointTotalRevenue
+
+The total, pre-discount value of all items purchased in a customer session.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenced** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md
new file mode 100644
index 00000000..fc7ae1b1
--- /dev/null
+++ b/docs/ApplicationCampaignAnalytics.md
@@ -0,0 +1,36 @@
+
+
+# ApplicationCampaignAnalytics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. | [optional]
+**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. | [optional]
+**campaignId** | **Integer** | The ID of the campaign. | [optional]
+**campaignName** | **String** | The name of the campaign. | [optional]
+**campaignTags** | **List<String>** | A list of tags for the campaign. | [optional]
+**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | [optional]
+**campaignActiveRulesetId** | **Integer** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
+**campaignStartTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes active. | [optional]
+**campaignEndTime** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the campaign becomes inactive. | [optional]
+**totalRevenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) | | [optional]
+**sessionsCount** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) | | [optional]
+**avgItemsPerSession** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) | | [optional]
+**avgSessionValue** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) | | [optional]
+**totalDiscounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) | | [optional]
+**couponsCount** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) | | [optional]
+
+
+
+## Enum: CampaignStateEnum
+
+Name | Value
+---- | -----
+ENABLED | "enabled"
+DISABLED | "disabled"
+ARCHIVED | "archived"
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md b/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md
new file mode 100644
index 00000000..bc2b56ce
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md
@@ -0,0 +1,15 @@
+
+
+# ApplicationCampaignAnalyticsAvgItemsPerSession
+
+The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**uplift** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsAvgSessionValue.md b/docs/ApplicationCampaignAnalyticsAvgSessionValue.md
new file mode 100644
index 00000000..d2586861
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsAvgSessionValue.md
@@ -0,0 +1,15 @@
+
+
+# ApplicationCampaignAnalyticsAvgSessionValue
+
+The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**uplift** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsCouponsCount.md b/docs/ApplicationCampaignAnalyticsCouponsCount.md
new file mode 100644
index 00000000..4979ce96
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsCouponsCount.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationCampaignAnalyticsCouponsCount
+
+The number of times a coupon was successfully redeemed in influenced sessions.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsSessionsCount.md b/docs/ApplicationCampaignAnalyticsSessionsCount.md
new file mode 100644
index 00000000..a7ad4cd9
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsSessionsCount.md
@@ -0,0 +1,15 @@
+
+
+# ApplicationCampaignAnalyticsSessionsCount
+
+The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenceRate** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsTotalDiscounts.md b/docs/ApplicationCampaignAnalyticsTotalDiscounts.md
new file mode 100644
index 00000000..f6dfa8b2
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsTotalDiscounts.md
@@ -0,0 +1,14 @@
+
+
+# ApplicationCampaignAnalyticsTotalDiscounts
+
+The total value of discounts given for cart items in influenced sessions.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCampaignAnalyticsTotalRevenue.md b/docs/ApplicationCampaignAnalyticsTotalRevenue.md
new file mode 100644
index 00000000..ceaa7acb
--- /dev/null
+++ b/docs/ApplicationCampaignAnalyticsTotalRevenue.md
@@ -0,0 +1,15 @@
+
+
+# ApplicationCampaignAnalyticsTotalRevenue
+
+The total, pre-discount value of all items purchased in a customer session.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**influenceRate** | [**BigDecimal**](BigDecimal.md) | | [optional]
+**trend** | [**BigDecimal**](BigDecimal.md) | | [optional]
+
+
+
diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md
index 401f3380..fb152708 100644
--- a/docs/ApplicationCustomer.md
+++ b/docs/ApplicationCustomer.md
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
-**sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
+**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/AudienceAnalytics.md b/docs/AudienceAnalytics.md
index 93747ef3..e2307465 100644
--- a/docs/AudienceAnalytics.md
+++ b/docs/AudienceAnalytics.md
@@ -2,13 +2,13 @@
# AudienceAnalytics
-The audiences and their members count.
+The audiences and their member count.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**audienceId** | **Integer** | The ID of the audience. | [optional]
-**membersCount** | **Integer** | The count of members under a single audience. | [optional]
+**membersCount** | **Integer** | The member count of the audience. | [optional]
diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md
index f5e58eaf..c256d527 100644
--- a/docs/AudienceCustomer.md
+++ b/docs/AudienceCustomer.md
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
-**sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
+**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<Integer>** | A list of the IDs of the Applications that are connected to this customer profile. | [optional]
**connectedAudiences** | **List<Integer>** | 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 4c2f4965..bf4ec0da 100644
--- a/docs/BaseCampaign.md
+++ b/docs/BaseCampaign.md
@@ -19,7 +19,6 @@ Name | Type | Description | Notes
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
-**evaluationGroupId** | **Integer** | 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<Integer>** | 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]
@@ -44,6 +43,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md
index 4fc16981..502fe4c6 100644
--- a/docs/BaseLoyaltyProgram.md
+++ b/docs/BaseLoyaltyProgram.md
@@ -14,8 +14,19 @@ Name | Type | Description | Notes
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
**usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
-**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
+**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
+**tiersExpireIn** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
+**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
+
+
+
+## Enum: TiersExpirationPolicyEnum
+
+Name | Value
+---- | -----
+TIER_START_DATE | "tier_start_date"
+PROGRAM_JOIN_DATE | "program_join_date"
@@ -28,3 +39,13 @@ BALANCE_BASED | "balance_based"
+## Enum: ProgramJoinPolicyEnum
+
+Name | Value
+---- | -----
+NOT_JOIN | "not_join"
+POINTS_ACTIVATED | "points_activated"
+POINTS_EARNED | "points_earned"
+
+
+
diff --git a/docs/BaseNotification.md b/docs/BaseNotification.md
index 3d07c924..62ee4c22 100644
--- a/docs/BaseNotification.md
+++ b/docs/BaseNotification.md
@@ -22,7 +22,9 @@ Name | Value
CAMPAIGN | "campaign"
LOYALTY_ADDED_DEDUCTED_POINTS | "loyalty_added_deducted_points"
COUPON | "coupon"
+EXPIRING_COUPONS | "expiring_coupons"
EXPIRING_POINTS | "expiring_points"
+CARD_EXPIRING_POINTS | "card_expiring_points"
PENDING_TO_ACTIVE_POINTS | "pending_to_active_points"
STRIKETHROUGH_PRICING | "strikethrough_pricing"
TIER_DOWNGRADE | "tier_downgrade"
diff --git a/docs/Campaign.md b/docs/Campaign.md
index a7daeb8a..5c2e2834 100644
--- a/docs/Campaign.md
+++ b/docs/Campaign.md
@@ -24,7 +24,6 @@ Name | Type | Description | Notes
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
-**evaluationGroupId** | **Integer** | 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. |
**linkedStoreIds** | **List<Integer>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
**budgets** | [**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. |
@@ -48,6 +47,7 @@ Name | Type | Description | Notes
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
**updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional]
**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
+**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | A campaign state described exactly as in the Campaign Manager. |
@@ -70,6 +70,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
@@ -82,3 +83,14 @@ ADVANCED | "advanced"
+## Enum: FrontendStateEnum
+
+Name | Value
+---- | -----
+EXPIRED | "expired"
+SCHEDULED | "scheduled"
+RUNNING | "running"
+DRAFT | "draft"
+
+
+
diff --git a/docs/CampaignCreatedNotification.md b/docs/CampaignCreatedNotification.md
index 071bb6bd..05e65abc 100644
--- a/docs/CampaignCreatedNotification.md
+++ b/docs/CampaignCreatedNotification.md
@@ -7,7 +7,7 @@ A notification regarding a campaign that was created.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | |
+**campaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**evaluationPosition** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | |
diff --git a/docs/CampaignDeletedNotification.md b/docs/CampaignDeletedNotification.md
index 21b6e240..9f2d49be 100644
--- a/docs/CampaignDeletedNotification.md
+++ b/docs/CampaignDeletedNotification.md
@@ -7,7 +7,7 @@ A notification regarding a campaign that was deleted.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | |
+**campaign** | [**Campaign**](Campaign.md) | |
**deletedAt** | [**OffsetDateTime**](OffsetDateTime.md) | Time when the campaign was deleted. |
diff --git a/docs/CampaignEditedNotification.md b/docs/CampaignEditedNotification.md
index 40d8fe56..bae43911 100644
--- a/docs/CampaignEditedNotification.md
+++ b/docs/CampaignEditedNotification.md
@@ -7,8 +7,8 @@ A notification regarding a campaign which was edited.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | |
-**oldCampaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | |
+**campaign** | [**Campaign**](Campaign.md) | |
+**oldCampaign** | [**Campaign**](Campaign.md) | |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md
index 78620a72..9dc3750b 100644
--- a/docs/CampaignGroup.md
+++ b/docs/CampaignGroup.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**accountId** | **Integer** | The ID of the account that owns this entity. |
-**name** | **String** | The name of this campaign access group. |
+**name** | **String** | The name of the campaign access group. |
**description** | **String** | A longer description of the campaign access group. | [optional]
**subscribedApplicationsIds** | **List<Integer>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
**campaignIds** | **List<Integer>** | A list of IDs of the campaigns that are part of the campaign access group. | [optional]
diff --git a/docs/CampaignRulesetChangedNotification.md b/docs/CampaignRulesetChangedNotification.md
index b1a8d1cd..385319b1 100644
--- a/docs/CampaignRulesetChangedNotification.md
+++ b/docs/CampaignRulesetChangedNotification.md
@@ -7,7 +7,7 @@ A notification regarding a campaign whose ruleset was changed.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaign** | [**CampaignStateNotification**](CampaignStateNotification.md) | |
+**campaign** | [**Campaign**](Campaign.md) | |
**oldRuleset** | [**Ruleset**](Ruleset.md) | | [optional]
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
diff --git a/docs/CampaignStateChangedNotification.md b/docs/CampaignStateChangedNotification.md
index cf0e7f70..b2dc816f 100644
--- a/docs/CampaignStateChangedNotification.md
+++ b/docs/CampaignStateChangedNotification.md
@@ -7,7 +7,7 @@ A notification regarding a campaign whose state changed.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaign** | [**CampaignForNotification**](CampaignForNotification.md) | |
+**campaign** | [**Campaign**](Campaign.md) | |
**oldState** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] |
**newState** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] |
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
diff --git a/docs/CampaignTemplate.md b/docs/CampaignTemplate.md
index 68d58c5a..0eff1cf5 100644
--- a/docs/CampaignTemplate.md
+++ b/docs/CampaignTemplate.md
@@ -53,6 +53,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/CardExpiringPointsNotificationPolicy.md b/docs/CardExpiringPointsNotificationPolicy.md
new file mode 100644
index 00000000..f82124bd
--- /dev/null
+++ b/docs/CardExpiringPointsNotificationPolicy.md
@@ -0,0 +1,14 @@
+
+
+# CardExpiringPointsNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. |
+**triggers** | [**List<CardExpiringPointsNotificationTrigger>**](CardExpiringPointsNotificationTrigger.md) | |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
+
+
+
diff --git a/docs/CardExpiringPointsNotificationTrigger.md b/docs/CardExpiringPointsNotificationTrigger.md
new file mode 100644
index 00000000..27e5bcf3
--- /dev/null
+++ b/docs/CardExpiringPointsNotificationTrigger.md
@@ -0,0 +1,22 @@
+
+
+# CardExpiringPointsNotificationTrigger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | The amount of period. |
+**period** | [**PeriodEnum**](#PeriodEnum) | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
+
+
+
+## Enum: PeriodEnum
+
+Name | Value
+---- | -----
+W | "w"
+D | "d"
+
+
+
diff --git a/docs/CartItem.md b/docs/CartItem.md
index a7e9d9b9..1e9358b7 100644
--- a/docs/CartItem.md
+++ b/docs/CartItem.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
**remainingQuantity** | **Integer** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional]
**price** | [**BigDecimal**](BigDecimal.md) | 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]
**weight** | [**BigDecimal**](BigDecimal.md) | Weight of item in grams. | [optional]
**height** | [**BigDecimal**](BigDecimal.md) | Height of item in mm. | [optional]
**width** | [**BigDecimal**](BigDecimal.md) | Width of item in mm. | [optional]
diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md
index 8607e990..20a8ffcb 100644
--- a/docs/CatalogItem.md
+++ b/docs/CatalogItem.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
**catalogid** | **Integer** | The ID of the catalog the item belongs to. |
**version** | **Integer** | The version of the catalog item. |
**attributes** | [**List<ItemAttribute>**](ItemAttribute.md) | | [optional]
+**product** | [**Product**](Product.md) | | [optional]
diff --git a/docs/ChangeLoyaltyTierLevelEffectProps.md b/docs/ChangeLoyaltyTierLevelEffectProps.md
index 1759cae7..d1047ef5 100644
--- a/docs/ChangeLoyaltyTierLevelEffectProps.md
+++ b/docs/ChangeLoyaltyTierLevelEffectProps.md
@@ -2,16 +2,16 @@
# ChangeLoyaltyTierLevelEffectProps
-The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded or downgraded due to a validated rule that contained an \"add loyalty points\" effect.
+The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an \"addLoyaltyPoints\" effect.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**ruleTitle** | **String** | The title of the rule that triggered the tier upgrade or downgrade. |
+**ruleTitle** | **String** | The title of the rule that triggered the tier upgrade. |
**programId** | **Integer** | The ID of the loyalty program where these points were added. |
**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. |
-**previousTierName** | **String** | The name of the tier from which the user was upgraded or downgraded. | [optional]
-**newTierName** | **String** | The name of the tier to which the user has been upgraded or downgraded. |
+**previousTierName** | **String** | The name of the tier from which the user was upgraded. | [optional]
+**newTierName** | **String** | The name of the tier to which the user has been upgraded. |
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | The expiration date of the new tier. | [optional]
diff --git a/docs/CouponsNotificationPolicy.md b/docs/CouponsNotificationPolicy.md
index e2be8d30..d44a8b9a 100644
--- a/docs/CouponsNotificationPolicy.md
+++ b/docs/CouponsNotificationPolicy.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
**scopes** | [**List<ScopesEnum>**](#List<ScopesEnum>) | |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
diff --git a/docs/CreateAchievement.md b/docs/CreateAchievement.md
index a3ae4e4f..732e59cc 100644
--- a/docs/CreateAchievement.md
+++ b/docs/CreateAchievement.md
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
**title** | **String** | The display name for the achievement in the Campaign Manager. |
**description** | **String** | A description of the achievement. |
-**target** | [**BigDecimal**](BigDecimal.md) | The maximum number of times a specific action must be completed by a customer profile over a defined period of time. |
-**period** | **String** | The relative duration after which the achievement is reset for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. |
+**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
+**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. |
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
diff --git a/docs/CreateApplicationAPIKey.md b/docs/CreateApplicationAPIKey.md
index 2ba49521..98118644 100644
--- a/docs/CreateApplicationAPIKey.md
+++ b/docs/CreateApplicationAPIKey.md
@@ -6,9 +6,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**title** | **String** | Title for API Key. |
-**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expired. |
+**title** | **String** | Title of the API key. |
+**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expires. |
**platform** | [**PlatformEnum**](#PlatformEnum) | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
+**type** | [**TypeEnum**](#TypeEnum) | The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. | [optional]
+**timeOffset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. | [optional]
@@ -29,3 +31,11 @@ EMARSYS | "emarsys"
+## Enum: TypeEnum
+
+Name | Value
+---- | -----
+STAGING | "staging"
+
+
+
diff --git a/docs/CustomerInventory.md b/docs/CustomerInventory.md
index eed1f820..0dbb1da9 100644
--- a/docs/CustomerInventory.md
+++ b/docs/CustomerInventory.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**referrals** | [**List<InventoryReferral>**](InventoryReferral.md) | | [optional]
**coupons** | [**List<InventoryCoupon>**](InventoryCoupon.md) | The coupons reserved by this profile. This array includes hard and soft reservations. See each coupon's `reservation` property. | [optional]
**giveaways** | [**List<Giveaway>**](Giveaway.md) | | [optional]
+**achievements** | [**List<AchievementProgress>**](AchievementProgress.md) | | [optional]
diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md
index 3383a6e4..1499e664 100644
--- a/docs/CustomerProfile.md
+++ b/docs/CustomerProfile.md
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
-**sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
+**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 2030cb8b..e038b75b 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. - `delete`: Removes the customer profile from the audience. |
+**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. |
**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 1733db91..ae478d35 100644
--- a/docs/CustomerSessionV2.md
+++ b/docs/CustomerSessionV2.md
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
**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**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional]
**referralCode** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional]
-**loyaltyCards** | **List<String>** | Any loyalty cards used. | [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]
diff --git a/docs/DeactivateUserRequest.md b/docs/DeactivateUserRequest.md
new file mode 100644
index 00000000..909210bb
--- /dev/null
+++ b/docs/DeactivateUserRequest.md
@@ -0,0 +1,13 @@
+
+
+# DeactivateUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address associated with the user profile. |
+
+
+
diff --git a/docs/DeleteUserRequest.md b/docs/DeleteUserRequest.md
new file mode 100644
index 00000000..d9071eda
--- /dev/null
+++ b/docs/DeleteUserRequest.md
@@ -0,0 +1,13 @@
+
+
+# DeleteUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address associated with the user profile. |
+
+
+
diff --git a/docs/EmailEntity.md b/docs/EmailEntity.md
index 8f147233..5de07a07 100644
--- a/docs/EmailEntity.md
+++ b/docs/EmailEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**email** | **String** | The email address associated with your account. |
+**email** | **String** | The email address associated with the user profile. |
diff --git a/docs/Environment.md b/docs/Environment.md
index 817cd528..aa4c15c6 100644
--- a/docs/Environment.md
+++ b/docs/Environment.md
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
**variables** | **String** | A stringified version of the environment's Talang variables scope. |
**giveawaysPools** | [**List<GiveawaysPool>**](GiveawaysPool.md) | The giveaways pools that the application is subscribed to. | [optional]
**loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | The loyalty programs that the application is subscribed to. | [optional]
+**achievements** | [**List<Achievement>**](Achievement.md) | The achievements, linked to the campaigns, belonging to the application. | [optional]
**attributes** | [**List<Attribute>**](Attribute.md) | The attributes that the application is subscribed to. | [optional]
**additionalCosts** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional]
**audiences** | [**List<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional]
diff --git a/docs/ExpiringCouponsNotificationPolicy.md b/docs/ExpiringCouponsNotificationPolicy.md
new file mode 100644
index 00000000..14ae9f93
--- /dev/null
+++ b/docs/ExpiringCouponsNotificationPolicy.md
@@ -0,0 +1,14 @@
+
+
+# ExpiringCouponsNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. |
+**triggers** | [**List<ExpiringCouponsNotificationTrigger>**](ExpiringCouponsNotificationTrigger.md) | |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
+
+
+
diff --git a/docs/ExpiringCouponsNotificationTrigger.md b/docs/ExpiringCouponsNotificationTrigger.md
new file mode 100644
index 00000000..92660fa2
--- /dev/null
+++ b/docs/ExpiringCouponsNotificationTrigger.md
@@ -0,0 +1,22 @@
+
+
+# ExpiringCouponsNotificationTrigger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | The amount of period. |
+**period** | [**PeriodEnum**](#PeriodEnum) | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
+
+
+
+## Enum: PeriodEnum
+
+Name | Value
+---- | -----
+W | "w"
+D | "d"
+
+
+
diff --git a/docs/FuncArgDef.md b/docs/FuncArgDef.md
index 87b2332c..a48d2faa 100644
--- a/docs/FuncArgDef.md
+++ b/docs/FuncArgDef.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**TypeEnum**](#TypeEnum) | The type of value this argument expects. |
-**description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. |
+**description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | [optional]
diff --git a/docs/GetIntegrationCouponRequest.md b/docs/GetIntegrationCouponRequest.md
new file mode 100644
index 00000000..c52da1eb
--- /dev/null
+++ b/docs/GetIntegrationCouponRequest.md
@@ -0,0 +1,13 @@
+
+
+# GetIntegrationCouponRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignIds** | **List<Integer>** | A list of IDs of the campaigns to get coupons from. |
+**limit** | **Integer** | The maximum number of coupons included in the response. |
+
+
+
diff --git a/docs/IncreaseAchievementProgressEffectProps.md b/docs/IncreaseAchievementProgressEffectProps.md
new file mode 100644
index 00000000..842e7898
--- /dev/null
+++ b/docs/IncreaseAchievementProgressEffectProps.md
@@ -0,0 +1,19 @@
+
+
+# IncreaseAchievementProgressEffectProps
+
+The properties specific to the \"increaseAchievementProgress\" effect. This gets triggered whenever a validated rule contained an \"increase customer progress\" effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**achievementId** | **Integer** | The internal ID of the achievement. |
+**achievementName** | **String** | The name of the achievement. |
+**progressTrackerId** | **Integer** | The internal ID of the achievement progress tracker. | [optional]
+**delta** | [**BigDecimal**](BigDecimal.md) | The value by which the customer's current progress in the achievement is increased. |
+**value** | [**BigDecimal**](BigDecimal.md) | The current progress of the customer in the achievement. |
+**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
+**isJustCompleted** | **Boolean** | Indicates if the customer has completed the achievement in the current session. |
+
+
+
diff --git a/docs/InlineResponse20011.md b/docs/InlineResponse20011.md
index 6bf7a0e4..8044f6ed 100644
--- a/docs/InlineResponse20011.md
+++ b/docs/InlineResponse20011.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<CampaignTemplate>**](CampaignTemplate.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<CampaignGroup>**](CampaignGroup.md) | |
diff --git a/docs/InlineResponse20012.md b/docs/InlineResponse20012.md
index 9d45a221..e59c0683 100644
--- a/docs/InlineResponse20012.md
+++ b/docs/InlineResponse20012.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | |
+**hasMore** | **Boolean** | |
+**data** | [**List<CampaignTemplate>**](CampaignTemplate.md) | |
diff --git a/docs/InlineResponse20013.md b/docs/InlineResponse20013.md
index f0cd4510..2fffb06d 100644
--- a/docs/InlineResponse20013.md
+++ b/docs/InlineResponse20013.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | |
diff --git a/docs/InlineResponse20014.md b/docs/InlineResponse20014.md
index d417c1c2..fb39f629 100644
--- a/docs/InlineResponse20014.md
+++ b/docs/InlineResponse20014.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | |
-**data** | [**List<LoyaltyCard>**](LoyaltyCard.md) | |
+**data** | [**List<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |
diff --git a/docs/InlineResponse20015.md b/docs/InlineResponse20015.md
index 6b14e42d..75854f39 100644
--- a/docs/InlineResponse20015.md
+++ b/docs/InlineResponse20015.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | true means there is more data in the source collection to request.. |
-**data** | [**List<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |
+**hasMore** | **Boolean** | |
+**data** | [**List<LoyaltyCard>**](LoyaltyCard.md) | |
diff --git a/docs/InlineResponse20016.md b/docs/InlineResponse20016.md
index 9961efb2..1e14d76d 100644
--- a/docs/InlineResponse20016.md
+++ b/docs/InlineResponse20016.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<CollectionWithoutPayload>**](CollectionWithoutPayload.md) | |
+**hasMore** | **Boolean** | true means there is more data in the source collection to request.. |
+**data** | [**List<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |
diff --git a/docs/InlineResponse20017.md b/docs/InlineResponse20017.md
index 183199fd..13d4aade 100644
--- a/docs/InlineResponse20017.md
+++ b/docs/InlineResponse20017.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<CollectionItem>**](CollectionItem.md) | |
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<CollectionWithoutPayload>**](CollectionWithoutPayload.md) | |
diff --git a/docs/InlineResponse20018.md b/docs/InlineResponse20018.md
index 83d10840..9fc0bd21 100644
--- a/docs/InlineResponse20018.md
+++ b/docs/InlineResponse20018.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<Collection>**](Collection.md) | |
+**hasMore** | **Boolean** | |
+**data** | [**List<CollectionItem>**](CollectionItem.md) | |
diff --git a/docs/InlineResponse20031.md b/docs/InlineResponse20031.md
index 4374fb9e..8a81df77 100644
--- a/docs/InlineResponse20031.md
+++ b/docs/InlineResponse20031.md
@@ -7,8 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<ApplicationReferee>**](ApplicationReferee.md) | |
+**data** | [**List<AudienceAnalytics>**](AudienceAnalytics.md) | |
diff --git a/docs/InlineResponse20032.md b/docs/InlineResponse20032.md
index bc22f20d..9256aaca 100644
--- a/docs/InlineResponse20032.md
+++ b/docs/InlineResponse20032.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<Attribute>**](Attribute.md) | |
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse20033.md b/docs/InlineResponse20033.md
index 222446df..7c126f9b 100644
--- a/docs/InlineResponse20033.md
+++ b/docs/InlineResponse20033.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<CatalogItem>**](CatalogItem.md) | |
+**data** | [**List<ApplicationReferee>**](ApplicationReferee.md) | |
diff --git a/docs/InlineResponse20034.md b/docs/InlineResponse20034.md
index 6c0967e6..5704e930 100644
--- a/docs/InlineResponse20034.md
+++ b/docs/InlineResponse20034.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
+**data** | [**List<Attribute>**](Attribute.md) | |
diff --git a/docs/InlineResponse20035.md b/docs/InlineResponse20035.md
index efbae3d4..27b24f50 100644
--- a/docs/InlineResponse20035.md
+++ b/docs/InlineResponse20035.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<CatalogItem>**](CatalogItem.md) | |
diff --git a/docs/InlineResponse20036.md b/docs/InlineResponse20036.md
index ee1c3cf5..b9c287f8 100644
--- a/docs/InlineResponse20036.md
+++ b/docs/InlineResponse20036.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
+**data** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
diff --git a/docs/InlineResponse20037.md b/docs/InlineResponse20037.md
index 701b1c6a..4b01936c 100644
--- a/docs/InlineResponse20037.md
+++ b/docs/InlineResponse20037.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<WebhookLogEntry>**](WebhookLogEntry.md) | |
+**data** | [**List<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
diff --git a/docs/InlineResponse20038.md b/docs/InlineResponse20038.md
index 0d214953..2c92f13f 100644
--- a/docs/InlineResponse20038.md
+++ b/docs/InlineResponse20038.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<EventType>**](EventType.md) | |
+**data** | [**List<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
diff --git a/docs/InlineResponse20039.md b/docs/InlineResponse20039.md
index 3ad75189..45316638 100644
--- a/docs/InlineResponse20039.md
+++ b/docs/InlineResponse20039.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<User>**](User.md) | |
+**data** | [**List<WebhookLogEntry>**](WebhookLogEntry.md) | |
diff --git a/docs/InlineResponse20040.md b/docs/InlineResponse20040.md
index 79b93b7d..724895c7 100644
--- a/docs/InlineResponse20040.md
+++ b/docs/InlineResponse20040.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | | [optional]
-**hasMore** | **Boolean** | | [optional]
-**data** | [**List<Change>**](Change.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<EventType>**](EventType.md) | |
diff --git a/docs/InlineResponse20041.md b/docs/InlineResponse20041.md
index 84b45fed..9514383e 100644
--- a/docs/InlineResponse20041.md
+++ b/docs/InlineResponse20041.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Integer** | |
-**data** | [**List<Export>**](Export.md) | |
+**data** | [**List<User>**](User.md) | |
diff --git a/docs/InlineResponse20042.md b/docs/InlineResponse20042.md
index 85bb4342..d8183c1d 100644
--- a/docs/InlineResponse20042.md
+++ b/docs/InlineResponse20042.md
@@ -6,8 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Integer** | |
-**data** | [**List<Role>**](Role.md) | |
+**totalResultSize** | **Integer** | | [optional]
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<Change>**](Change.md) | |
diff --git a/docs/InlineResponse20043.md b/docs/InlineResponse20043.md
index 19ad1d9d..f8106df0 100644
--- a/docs/InlineResponse20043.md
+++ b/docs/InlineResponse20043.md
@@ -6,9 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Integer** | | [optional]
-**data** | [**List<Store>**](Store.md) | |
+**totalResultSize** | **Integer** | |
+**data** | [**List<Export>**](Export.md) | |
diff --git a/docs/InlineResponse20044.md b/docs/InlineResponse20044.md
new file mode 100644
index 00000000..66a35083
--- /dev/null
+++ b/docs/InlineResponse20044.md
@@ -0,0 +1,13 @@
+
+
+# InlineResponse20044
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalResultSize** | **Integer** | |
+**data** | [**List<Role>**](Role.md) | |
+
+
+
diff --git a/docs/InlineResponse20045.md b/docs/InlineResponse20045.md
new file mode 100644
index 00000000..26456774
--- /dev/null
+++ b/docs/InlineResponse20045.md
@@ -0,0 +1,14 @@
+
+
+# InlineResponse20045
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasMore** | **Boolean** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
+**data** | [**List<Store>**](Store.md) | |
+
+
+
diff --git a/docs/InlineResponse20046.md b/docs/InlineResponse20046.md
new file mode 100644
index 00000000..969d2c36
--- /dev/null
+++ b/docs/InlineResponse20046.md
@@ -0,0 +1,13 @@
+
+
+# InlineResponse20046
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<Achievement>**](Achievement.md) | |
+
+
+
diff --git a/docs/InlineResponse20047.md b/docs/InlineResponse20047.md
new file mode 100644
index 00000000..cf503521
--- /dev/null
+++ b/docs/InlineResponse20047.md
@@ -0,0 +1,13 @@
+
+
+# InlineResponse20047
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasMore** | **Boolean** | |
+**data** | [**List<AchievementProgress>**](AchievementProgress.md) | |
+
+
+
diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md
index b0caa7d6..424a66ff 100644
--- a/docs/IntegrationApi.md
+++ b/docs/IntegrationApi.md
@@ -355,7 +355,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Integer audienceId = 56; // Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+ Integer audienceId = 56; // Integer | The ID of the audience.
try {
apiInstance.deleteAudienceMembershipsV2(audienceId);
} catch (ApiException e) {
@@ -373,7 +373,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
+ **audienceId** | **Integer**| The ID of the audience. |
### Return type
@@ -425,7 +425,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Integer audienceId = 56; // Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+ Integer audienceId = 56; // Integer | The ID of the audience.
try {
apiInstance.deleteAudienceV2(audienceId);
} catch (ApiException e) {
@@ -443,7 +443,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
+ **audienceId** | **Integer**| The ID of the audience. |
### Return type
@@ -611,7 +611,7 @@ null (empty response body)
# **getCustomerInventory**
-> CustomerInventory getCustomerInventory(integrationId, profile, referrals, coupons, loyalty, giveaways)
+> CustomerInventory getCustomerInventory(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements)
List customer data
@@ -645,8 +645,9 @@ public class Example {
Boolean coupons = true; // Boolean | Set to `true` to include coupon information in the response.
Boolean loyalty = true; // Boolean | Set to `true` to include loyalty information in the response.
Boolean giveaways = true; // Boolean | Set to `true` to include giveaways information in the response.
+ Boolean achievements = true; // Boolean | Set to `true` to include achievement information in the response.
try {
- CustomerInventory result = apiInstance.getCustomerInventory(integrationId, profile, referrals, coupons, loyalty, giveaways);
+ CustomerInventory result = apiInstance.getCustomerInventory(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationApi#getCustomerInventory");
@@ -669,6 +670,7 @@ Name | Type | Description | Notes
**coupons** | **Boolean**| Set to `true` to include coupon information in the response. | [optional]
**loyalty** | **Boolean**| Set to `true` to include loyalty information in the response. | [optional]
**giveaways** | **Boolean**| Set to `true` to include giveaways information in the response. | [optional]
+ **achievements** | **Boolean**| Set to `true` to include achievement information in the response. | [optional]
### Return type
@@ -947,7 +949,7 @@ 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.
String status = "active"; // String | Filter points based on their status.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
- Integer pageSize = 50; // Integer | The number of items in this response.
+ Integer pageSize = 50; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
InlineResponse2003 result = apiInstance.getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, status, subledgerId, pageSize, skip);
@@ -971,7 +973,7 @@ Name | Type | Description | Notes
**loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
**status** | **String**| Filter points based on their status. | [optional] [default to active] [enum: active, pending, expired]
**subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 50]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
@@ -1029,9 +1031,9 @@ 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.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
String loyaltyTransactionType = "loyaltyTransactionType_example"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
- OffsetDateTime startDate = new OffsetDateTime(); // 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 startDate = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
InlineResponse2001 result = apiInstance.getLoyaltyCardTransactions(loyaltyProgramId, loyaltyCardId, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip);
@@ -1055,9 +1057,9 @@ Name | Type | Description | Notes
**loyaltyCardId** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
**subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional]
**loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [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]
+ **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
@@ -1115,7 +1117,7 @@ public class Example {
String integrationId = "integrationId_example"; // String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
String status = "active"; // String | Filter points based on their status.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
- Integer pageSize = 50; // Integer | The number of items in this response.
+ Integer pageSize = 50; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
InlineResponse2004 result = apiInstance.getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, status, subledgerId, pageSize, skip);
@@ -1139,7 +1141,7 @@ Name | Type | Description | Notes
**integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
**status** | **String**| Filter points based on their status. | [optional] [default to active] [enum: active, pending, expired]
**subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 50]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
@@ -1197,9 +1199,9 @@ public class Example {
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 subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
String loyaltyTransactionType = "loyaltyTransactionType_example"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
- OffsetDateTime startDate = new OffsetDateTime(); // 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 startDate = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- Integer pageSize = 50; // Integer | The number of items in this response.
+ Integer pageSize = 50; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
InlineResponse2002 result = apiInstance.getLoyaltyProgramProfileTransactions(loyaltyProgramId, integrationId, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip);
@@ -1223,9 +1225,9 @@ Name | Type | Description | Notes
**integrationId** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
**subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional]
**loyaltyTransactionType** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional] [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]
+ **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 50]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
@@ -1549,7 +1551,7 @@ Name | Type | Description | Notes
Sync cart item catalog
-Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: - Add an item to the catalog. - Edit the attributes of an item in the catalog. - Edit the attributes of more than one item in the catalog. - Remove an item from the catalog. - Remove more than one item from the catalog. **Note:** For more information, see [our documentation on 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-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) 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\": \"shoe\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100 }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\" }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items at once</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 several items from the catalog at once</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 one or more of the following actions for a given cart item catalog: - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog. You can 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**: 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 several 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>Editing 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>Editing the attributes of several 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 several 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
@@ -1723,7 +1725,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Integer audienceId = 56; // Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+ Integer audienceId = 56; // Integer | The ID of the audience.
Object body = null; // Object | body
try {
apiInstance.updateAudienceCustomersAttributes(audienceId, body);
@@ -1742,7 +1744,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
+ **audienceId** | **Integer**| The ID of the audience. |
**body** | **Object**| body |
### Return type
@@ -1795,7 +1797,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Integer audienceId = 56; // Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+ Integer audienceId = 56; // Integer | The ID of the audience.
UpdateAudience body = new UpdateAudience(); // UpdateAudience | body
try {
Audience result = apiInstance.updateAudienceV2(audienceId, body);
@@ -1815,7 +1817,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
+ **audienceId** | **Integer**| The ID of the audience. |
**body** | [**UpdateAudience**](UpdateAudience.md)| body |
### Return type
@@ -1844,7 +1846,7 @@ Name | Type | Description | Notes
Update multiple customer profiles' audiences
-Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+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
@@ -2062,7 +2064,7 @@ Name | Type | Description | Notes
# **updateCustomerSessionV2**
-> IntegrationStateV2 updateCustomerSessionV2(customerSessionId, body, dry)
+> IntegrationStateV2 updateCustomerSessionV2(customerSessionId, body, dry, now)
Update customer session
@@ -2093,8 +2095,9 @@ public class Example {
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.
IntegrationRequest body = 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 will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).
+ OffsetDateTime now = new OffsetDateTime(); // 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`.
try {
- IntegrationStateV2 result = apiInstance.updateCustomerSessionV2(customerSessionId, body, dry);
+ IntegrationStateV2 result = apiInstance.updateCustomerSessionV2(customerSessionId, body, dry, now);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationApi#updateCustomerSessionV2");
@@ -2114,6 +2117,7 @@ Name | Type | Description | Notes
**customerSessionId** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. |
**body** | [**IntegrationRequest**](IntegrationRequest.md)| body |
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional]
+ **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]
### Return type
diff --git a/docs/LoginParams.md b/docs/LoginParams.md
index f1b4bca4..2730c9c5 100644
--- a/docs/LoginParams.md
+++ b/docs/LoginParams.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**email** | **String** | The email address associated with your account. |
+**email** | **String** | The email address associated with the user profile. |
**password** | **String** | The password for your account. |
diff --git a/docs/LoyaltyLedgerTransactions.md b/docs/LoyaltyLedgerTransactions.md
index 9791ed50..41a6c2f9 100644
--- a/docs/LoyaltyLedgerTransactions.md
+++ b/docs/LoyaltyLedgerTransactions.md
@@ -7,7 +7,7 @@ List of loyalty ledger transactions.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | true means there is more data in the source collection to request. | [optional]
+**hasMore** | **Boolean** | If `true`, it means that there is more data to request in the source collection. | [optional]
**data** | [**List<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of transaction entries from a loyalty ledger. | [optional]
diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md
index 272cfb1c..f4581814 100644
--- a/docs/LoyaltyProgram.md
+++ b/docs/LoyaltyProgram.md
@@ -17,18 +17,30 @@ Name | Type | Description | Notes
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |
**usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |
-**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
+**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
+**tiersExpireIn** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
+**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**accountID** | **Integer** | The ID of the Talon.One account that owns this program. |
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
**tiers** | [**List<LoyaltyTier>**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional]
**timezone** | **String** | A string containing an IANA timezone descriptor. |
**cardBased** | **Boolean** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. |
**canUpdateTiers** | **Boolean** | `True` if the tier definitions can be updated. | [optional]
+**canUpdateJoinPolicy** | **Boolean** | Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`. | [optional]
**canUpgradeToAdvancedTiers** | **Boolean** | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. | [optional]
+## Enum: TiersExpirationPolicyEnum
+
+Name | Value
+---- | -----
+TIER_START_DATE | "tier_start_date"
+PROGRAM_JOIN_DATE | "program_join_date"
+
+
+
## Enum: TiersDowngradePolicyEnum
Name | Value
@@ -38,3 +50,13 @@ BALANCE_BASED | "balance_based"
+## Enum: ProgramJoinPolicyEnum
+
+Name | Value
+---- | -----
+NOT_JOIN | "not_join"
+POINTS_ACTIVATED | "points_activated"
+POINTS_EARNED | "points_earned"
+
+
+
diff --git a/docs/LoyaltyProgramLedgers.md b/docs/LoyaltyProgramLedgers.md
index d9010edc..b2bba196 100644
--- a/docs/LoyaltyProgramLedgers.md
+++ b/docs/LoyaltyProgramLedgers.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
**id** | **Integer** | The internal ID of loyalty program. |
**title** | **String** | Visible name of loyalty program. |
**name** | **String** | Internal name of loyalty program. |
+**joinDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date on which the customer joined the loyalty program in RFC3339. **Note**: This is in the loyalty program's time zone. | [optional]
**ledger** | [**LedgerInfo**](LedgerInfo.md) | |
**subLedgers** | [**Map<String, LedgerInfo>**](LedgerInfo.md) | A map containing information about each loyalty subledger. | [optional]
diff --git a/docs/LoyaltyProgramTransaction.md b/docs/LoyaltyProgramTransaction.md
index bbb4da02..d3f56252 100644
--- a/docs/LoyaltyProgramTransaction.md
+++ b/docs/LoyaltyProgramTransaction.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | ID of the loyalty ledger transaction. |
**programId** | **Integer** | ID of the loyalty program. |
+**campaignId** | **Integer** | ID of the campaign. | [optional]
**created** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time the loyalty transaction occurred. |
**type** | [**TypeEnum**](#TypeEnum) | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. |
**amount** | [**BigDecimal**](BigDecimal.md) | Amount of loyalty points added or deducted in the transaction. |
diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md
index 411c4d47..37af01b7 100644
--- a/docs/ManagementApi.md
+++ b/docs/ManagementApi.md
@@ -8,6 +8,7 @@ Method | HTTP request | Description
[**addLoyaltyPoints**](ManagementApi.md#addLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
[**copyCampaignToApplications**](ManagementApi.md#copyCampaignToApplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
[**createAccountCollection**](ManagementApi.md#createAccountCollection) | **POST** /v1/collections | Create account-level collection
+[**createAchievement**](ManagementApi.md#createAchievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
[**createAdditionalCost**](ManagementApi.md#createAdditionalCost) | **POST** /v1/additional_costs | Create additional cost
[**createAttribute**](ManagementApi.md#createAttribute) | **POST** /v1/attributes | Create custom attribute
[**createCampaignFromTemplate**](ManagementApi.md#createCampaignFromTemplate) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
@@ -15,11 +16,15 @@ Method | HTTP request | Description
[**createCoupons**](ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
[**createCouponsAsync**](ManagementApi.md#createCouponsAsync) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
[**createCouponsForMultipleRecipients**](ManagementApi.md#createCouponsForMultipleRecipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients
+[**createInviteEmail**](ManagementApi.md#createInviteEmail) | **POST** /v1/invite_emails | Resend invitation email
+[**createInviteV2**](ManagementApi.md#createInviteV2) | **POST** /v2/invites | Invite user
[**createPasswordRecoveryEmail**](ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset
[**createSession**](ManagementApi.md#createSession) | **POST** /v1/sessions | Create session
[**createStore**](ManagementApi.md#createStore) | **POST** /v1/applications/{applicationId}/stores | Create store
+[**deactivateUserByEmail**](ManagementApi.md#deactivateUserByEmail) | **POST** /v1/users/deactivate | Deactivate user by email address
[**deductLoyaltyCardPoints**](ManagementApi.md#deductLoyaltyCardPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
[**deleteAccountCollection**](ManagementApi.md#deleteAccountCollection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
+[**deleteAchievement**](ManagementApi.md#deleteAchievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
[**deleteCampaign**](ManagementApi.md#deleteCampaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
[**deleteCollection**](ManagementApi.md#deleteCollection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection
[**deleteCoupon**](ManagementApi.md#deleteCoupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon
@@ -27,8 +32,12 @@ Method | HTTP request | Description
[**deleteLoyaltyCard**](ManagementApi.md#deleteLoyaltyCard) | **DELETE** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card
[**deleteReferral**](ManagementApi.md#deleteReferral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral
[**deleteStore**](ManagementApi.md#deleteStore) | **DELETE** /v1/applications/{applicationId}/stores/{storeId} | Delete store
+[**deleteUser**](ManagementApi.md#deleteUser) | **DELETE** /v1/users/{userId} | Delete user
+[**deleteUserByEmail**](ManagementApi.md#deleteUserByEmail) | **POST** /v1/users/delete | Delete user by email address
[**destroySession**](ManagementApi.md#destroySession) | **DELETE** /v1/sessions | Destroy session
[**exportAccountCollectionItems**](ManagementApi.md#exportAccountCollectionItems) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
+[**exportAchievements**](ManagementApi.md#exportAchievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
+[**exportAudiencesMemberships**](ManagementApi.md#exportAudiencesMemberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
[**exportCollectionItems**](ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
[**exportCoupons**](ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
[**exportCustomerSessions**](ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
@@ -45,6 +54,7 @@ Method | HTTP request | Description
[**getAccount**](ManagementApi.md#getAccount) | **GET** /v1/accounts/{accountId} | Get account details
[**getAccountAnalytics**](ManagementApi.md#getAccountAnalytics) | **GET** /v1/accounts/{accountId}/analytics | Get account analytics
[**getAccountCollection**](ManagementApi.md#getAccountCollection) | **GET** /v1/collections/{collectionId} | Get account-level collection
+[**getAchievement**](ManagementApi.md#getAchievement) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement
[**getAdditionalCost**](ManagementApi.md#getAdditionalCost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
[**getAdditionalCosts**](ManagementApi.md#getAdditionalCosts) | **GET** /v1/additional_costs | List additional costs
[**getAllAccessLogs**](ManagementApi.md#getAllAccessLogs) | **GET** /v1/access_logs | List access logs
@@ -62,10 +72,14 @@ Method | HTTP request | Description
[**getApplications**](ManagementApi.md#getApplications) | **GET** /v1/applications | List Applications
[**getAttribute**](ManagementApi.md#getAttribute) | **GET** /v1/attributes/{attributeId} | Get custom attribute
[**getAttributes**](ManagementApi.md#getAttributes) | **GET** /v1/attributes | List custom attributes
+[**getAudienceMemberships**](ManagementApi.md#getAudienceMemberships) | **GET** /v1/audiences/{audienceId}/memberships | List audience members
[**getAudiences**](ManagementApi.md#getAudiences) | **GET** /v1/audiences | List audiences
+[**getAudiencesAnalytics**](ManagementApi.md#getAudiencesAnalytics) | **GET** /v1/audiences/analytics | List audience analytics
[**getCampaign**](ManagementApi.md#getCampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get campaign
[**getCampaignAnalytics**](ManagementApi.md#getCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
[**getCampaignByAttributes**](ManagementApi.md#getCampaignByAttributes) | **POST** /v1/applications/{applicationId}/campaigns_search | List campaigns that match the given attributes
+[**getCampaignGroup**](ManagementApi.md#getCampaignGroup) | **GET** /v1/campaign_groups/{campaignGroupId} | Get campaign access group
+[**getCampaignGroups**](ManagementApi.md#getCampaignGroups) | **GET** /v1/campaign_groups | List campaign access groups
[**getCampaignTemplates**](ManagementApi.md#getCampaignTemplates) | **GET** /v1/campaign_templates | List campaign templates
[**getCampaigns**](ManagementApi.md#getCampaigns) | **GET** /v1/applications/{applicationId}/campaigns | List campaigns
[**getChanges**](ManagementApi.md#getChanges) | **GET** /v1/changes | Get audit logs for an account
@@ -76,6 +90,7 @@ Method | HTTP request | Description
[**getCustomerActivityReportsWithoutTotalCount**](ManagementApi.md#getCustomerActivityReportsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers
[**getCustomerAnalytics**](ManagementApi.md#getCustomerAnalytics) | **GET** /v1/applications/{applicationId}/customers/{customerId}/analytics | Get customer's analytics report
[**getCustomerProfile**](ManagementApi.md#getCustomerProfile) | **GET** /v1/customers/{customerId} | Get customer profile
+[**getCustomerProfileAchievementProgress**](ManagementApi.md#getCustomerProfileAchievementProgress) | **GET** /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements
[**getCustomerProfiles**](ManagementApi.md#getCustomerProfiles) | **GET** /v1/customers/no_total | List customer profiles
[**getCustomersByAttributes**](ManagementApi.md#getCustomersByAttributes) | **POST** /v1/customer_search/no_total | List customer profiles matching the given attributes
[**getEventTypes**](ManagementApi.md#getEventTypes) | **GET** /v1/event_types | List event types
@@ -101,6 +116,7 @@ Method | HTTP request | Description
[**getWebhooks**](ManagementApi.md#getWebhooks) | **GET** /v1/webhooks | List webhooks
[**importAccountCollection**](ManagementApi.md#importAccountCollection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
[**importAllowedList**](ManagementApi.md#importAllowedList) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
+[**importAudiencesMemberships**](ManagementApi.md#importAudiencesMemberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
[**importCollection**](ManagementApi.md#importCollection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
[**importCoupons**](ManagementApi.md#importCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
[**importLoyaltyCards**](ManagementApi.md#importLoyaltyCards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards
@@ -109,6 +125,7 @@ Method | HTTP request | Description
[**importPoolGiveaways**](ManagementApi.md#importPoolGiveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool
[**importReferrals**](ManagementApi.md#importReferrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals
[**listAccountCollections**](ManagementApi.md#listAccountCollections) | **GET** /v1/collections | List collections in account
+[**listAchievements**](ManagementApi.md#listAchievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
[**listCatalogItems**](ManagementApi.md#listCatalogItems) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
[**listCollections**](ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
[**listCollectionsInApplication**](ManagementApi.md#listCollectionsInApplication) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
@@ -123,6 +140,7 @@ Method | HTTP request | Description
[**searchCouponsAdvancedWithoutTotalCount**](ManagementApi.md#searchCouponsAdvancedWithoutTotalCount) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
[**transferLoyaltyCard**](ManagementApi.md#transferLoyaltyCard) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
[**updateAccountCollection**](ManagementApi.md#updateAccountCollection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
+[**updateAchievement**](ManagementApi.md#updateAchievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
[**updateAdditionalCost**](ManagementApi.md#updateAdditionalCost) | **PUT** /v1/additional_costs/{additionalCostId} | Update additional cost
[**updateAttribute**](ManagementApi.md#updateAttribute) | **PUT** /v1/attributes/{attributeId} | Update custom attribute
[**updateCampaign**](ManagementApi.md#updateCampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign
@@ -131,7 +149,9 @@ Method | HTTP request | Description
[**updateCouponBatch**](ManagementApi.md#updateCouponBatch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons
[**updateLoyaltyCard**](ManagementApi.md#updateLoyaltyCard) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status
[**updateReferral**](ManagementApi.md#updateReferral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral
+[**updateRoleV2**](ManagementApi.md#updateRoleV2) | **PUT** /v2/roles/{roleId} | Update role
[**updateStore**](ManagementApi.md#updateStore) | **PUT** /v1/applications/{applicationId}/stores/{storeId} | Update store
+[**updateUser**](ManagementApi.md#updateUser) | **PUT** /v1/users/{userId} | Update user
@@ -453,6 +473,88 @@ Name | Type | Description | Notes
**401** | Unauthorized | - |
**409** | Conflict. A collection with this name already exists. | - |
+
+# **createAchievement**
+> Achievement createAchievement(applicationId, campaignId, body)
+
+Create achievement
+
+Create a new achievement in a specific campaign.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ CreateAchievement body = new CreateAchievement(); // CreateAchievement | body
+ try {
+ Achievement result = apiInstance.createAchievement(applicationId, campaignId, body);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#createAchievement");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **body** | [**CreateAchievement**](CreateAchievement.md)| body |
+
+### Return type
+
+[**Achievement**](Achievement.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Created | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
+**409** | Conflict. An achievement with this name or title already exists. | - |
+
# **createAdditionalCost**
> AccountAdditionalCost createAdditionalCost(body)
@@ -1002,13 +1104,13 @@ Name | Type | Description | Notes
**200** | OK | - |
**204** | No Content | - |
-
-# **createPasswordRecoveryEmail**
-> NewPasswordEmail createPasswordRecoveryEmail(body)
+
+# **createInviteEmail**
+> NewInviteEmail createInviteEmail(body)
-Request a password reset
+Resend invitation email
-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.
+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
@@ -1038,12 +1140,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- NewPasswordEmail body = new NewPasswordEmail(); // NewPasswordEmail | body
+ NewInviteEmail body = new NewInviteEmail(); // NewInviteEmail | body
try {
- NewPasswordEmail result = apiInstance.createPasswordRecoveryEmail(body);
+ NewInviteEmail result = apiInstance.createInviteEmail(body);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#createPasswordRecoveryEmail");
+ System.err.println("Exception when calling ManagementApi#createInviteEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1057,11 +1159,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**NewPasswordEmail**](NewPasswordEmail.md)| body |
+ **body** | [**NewInviteEmail**](NewInviteEmail.md)| body |
### Return type
-[**NewPasswordEmail**](NewPasswordEmail.md)
+[**NewInviteEmail**](NewInviteEmail.md)
### Authorization
@@ -1075,15 +1177,15 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Created | - |
+**201** | Created | - |
-
-# **createSession**
-> Session createSession(body)
+
+# **createInviteV2**
+> User createInviteV2(body)
-Create session
+Invite user
-Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
+Create a new 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
@@ -1113,12 +1215,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- LoginParams body = new LoginParams(); // LoginParams | body
+ NewInvitation body = new NewInvitation(); // NewInvitation | body
try {
- Session result = apiInstance.createSession(body);
+ User result = apiInstance.createInviteV2(body);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#createSession");
+ System.err.println("Exception when calling ManagementApi#createInviteV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1132,11 +1234,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**LoginParams**](LoginParams.md)| body |
+ **body** | [**NewInvitation**](NewInvitation.md)| body |
### Return type
-[**Session**](Session.md)
+[**User**](User.md)
### Authorization
@@ -1152,13 +1254,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**201** | Created | - |
-
-# **createStore**
-> Store createStore(applicationId, body)
+
+# **createPasswordRecoveryEmail**
+> NewPasswordEmail createPasswordRecoveryEmail(body)
-Create store
+Request a password reset
-Create a new store in a specific Application.
+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
@@ -1188,13 +1290,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- NewStore body = new NewStore(); // NewStore | body
+ NewPasswordEmail body = new NewPasswordEmail(); // NewPasswordEmail | body
try {
- Store result = apiInstance.createStore(applicationId, body);
+ NewPasswordEmail result = apiInstance.createPasswordRecoveryEmail(body);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#createStore");
+ System.err.println("Exception when calling ManagementApi#createPasswordRecoveryEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1208,12 +1309,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **body** | [**NewStore**](NewStore.md)| body |
+ **body** | [**NewPasswordEmail**](NewPasswordEmail.md)| body |
### Return type
-[**Store**](Store.md)
+[**NewPasswordEmail**](NewPasswordEmail.md)
### Authorization
@@ -1227,17 +1327,15 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Created | - |
-**400** | Bad request | - |
-**409** | Conflict. A store with this integration ID already exists for this application. | - |
+**204** | Created | - |
-
-# **deductLoyaltyCardPoints**
-> deductLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, body)
+
+# **createSession**
+> Session createSession(body)
-Deduct points from card
+Create session
-Deduct points from the given loyalty card in the specified card-based loyalty program.
+Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
### Example
```java
@@ -1267,13 +1365,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String 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.
- DeductLoyaltyPoints body = new DeductLoyaltyPoints(); // DeductLoyaltyPoints | body
+ LoginParams body = new LoginParams(); // LoginParams | body
try {
- apiInstance.deductLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, body);
+ Session result = apiInstance.createSession(body);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deductLoyaltyCardPoints");
+ System.err.println("Exception when calling ManagementApi#createSession");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1287,13 +1384,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **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. |
- **body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
+ **body** | [**LoginParams**](LoginParams.md)| body |
### Return type
-null (empty response body)
+[**Session**](Session.md)
### Authorization
@@ -1307,18 +1402,15 @@ null (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | No Content | - |
-**400** | Bad request | - |
-**401** | Unauthorized | - |
-**404** | Not found | - |
+**201** | Created | - |
-
-# **deleteAccountCollection**
-> deleteAccountCollection(collectionId)
+
+# **createStore**
+> Store createStore(applicationId, body)
-Delete account-level collection
+Create store
-Delete a given account-level collection.
+Create a new store in a specific Application.
### Example
```java
@@ -1348,11 +1440,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ NewStore body = new NewStore(); // NewStore | body
try {
- apiInstance.deleteAccountCollection(collectionId);
+ Store result = apiInstance.createStore(applicationId, body);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteAccountCollection");
+ System.err.println("Exception when calling ManagementApi#createStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1366,11 +1460,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **body** | [**NewStore**](NewStore.md)| body |
### Return type
-null (empty response body)
+[**Store**](Store.md)
### Authorization
@@ -1378,22 +1473,23 @@ null (empty response body)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | No Content | - |
-**404** | Not found | - |
+**201** | Created | - |
+**400** | Bad request | - |
+**409** | Conflict. A store with this integration ID already exists for this application. | - |
-
-# **deleteCampaign**
-> deleteCampaign(applicationId, campaignId)
+
+# **deactivateUserByEmail**
+> deactivateUserByEmail(body)
-Delete campaign
+Deactivate user by email address
-Delete the given campaign.
+Deactivate a specific user by their email address.
### Example
```java
@@ -1423,12 +1519,11 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ DeactivateUserRequest body = new DeactivateUserRequest(); // DeactivateUserRequest | body
try {
- apiInstance.deleteCampaign(applicationId, campaignId);
+ apiInstance.deactivateUserByEmail(body);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteCampaign");
+ System.err.println("Exception when calling ManagementApi#deactivateUserByEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1442,8 +1537,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **body** | [**DeactivateUserRequest**](DeactivateUserRequest.md)| body |
### Return type
@@ -1455,7 +1549,7 @@ null (empty response body)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: Not defined
### HTTP response details
@@ -1463,13 +1557,13 @@ null (empty response body)
|-------------|-------------|------------------|
**204** | No Content | - |
-
-# **deleteCollection**
-> deleteCollection(applicationId, campaignId, collectionId)
+
+# **deductLoyaltyCardPoints**
+> deductLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, body)
-Delete campaign-level collection
+Deduct points from card
-Delete a given campaign-level collection.
+Deduct points from the given loyalty card in the specified card-based loyalty program.
### Example
```java
@@ -1499,13 +1593,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ String 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.
+ DeductLoyaltyPoints body = new DeductLoyaltyPoints(); // DeductLoyaltyPoints | body
try {
- apiInstance.deleteCollection(applicationId, campaignId, collectionId);
+ apiInstance.deductLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, body);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteCollection");
+ System.err.println("Exception when calling ManagementApi#deductLoyaltyCardPoints");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1519,9 +1613,9 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
+ **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **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. |
+ **body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
### Return type
@@ -1533,22 +1627,24 @@ null (empty response body)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
+**400** | Bad request | - |
**401** | Unauthorized | - |
+**404** | Not found | - |
-
-# **deleteCoupon**
-> deleteCoupon(applicationId, campaignId, couponId)
+
+# **deleteAccountCollection**
+> deleteAccountCollection(collectionId)
-Delete coupon
+Delete account-level collection
-Delete the specified coupon.
+Delete a given account-level collection.
### Example
```java
@@ -1578,13 +1674,11 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- String couponId = "couponId_example"; // String | 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.
+ Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
try {
- apiInstance.deleteCoupon(applicationId, campaignId, couponId);
+ apiInstance.deleteAccountCollection(collectionId);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteCoupon");
+ System.err.println("Exception when calling ManagementApi#deleteAccountCollection");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1598,9 +1692,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **couponId** | **String**| 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. |
+ **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
### Return type
@@ -1613,20 +1705,21 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
+**404** | Not found | - |
-
-# **deleteCoupons**
-> deleteCoupons(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch)
+
+# **deleteAchievement**
+> deleteAchievement(applicationId, campaignId, achievementId)
-Delete coupons
+Delete achievement
-Deletes all the coupons matching the specified criteria.
+Delete the specified achievement.
### Example
```java
@@ -1658,23 +1751,90 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime startsAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime startsBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime expiresAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime expiresBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- String valid = "valid_example"; // String | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
- String batchId = "batchId_example"; // String | Filter results by batches of coupons
- String usable = "usable_example"; // String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
- Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
- String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.
- Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code
+ Integer achievementId = 56; // Integer | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
try {
- apiInstance.deleteCoupons(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch);
+ apiInstance.deleteAchievement(applicationId, campaignId, achievementId);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteCoupons");
+ System.err.println("Exception when calling ManagementApi#deleteAchievement");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **achievementId** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
+
+
+# **deleteCampaign**
+> deleteCampaign(applicationId, campaignId)
+
+Delete campaign
+
+Delete the given campaign.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ try {
+ apiInstance.deleteCampaign(applicationId, campaignId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#deleteCampaign");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1690,19 +1850,6 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **startsAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **startsBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **expiresAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **expiresBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **valid** | **String**| - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
- **batchId** | **String**| Filter results by batches of coupons | [optional]
- **usable** | **String**| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | [optional] [enum: true, false]
- **referralId** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
- **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional]
- **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
### Return type
@@ -1722,13 +1869,13 @@ null (empty response body)
|-------------|-------------|------------------|
**204** | No Content | - |
-
-# **deleteLoyaltyCard**
-> deleteLoyaltyCard(loyaltyProgramId, loyaltyCardId)
+
+# **deleteCollection**
+> deleteCollection(applicationId, campaignId, collectionId)
-Delete loyalty card
+Delete campaign-level collection
-Delete the given loyalty card.
+Delete a given campaign-level collection.
### Example
```java
@@ -1758,12 +1905,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String 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.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
try {
- apiInstance.deleteLoyaltyCard(loyaltyProgramId, loyaltyCardId);
+ apiInstance.deleteCollection(applicationId, campaignId, collectionId);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteLoyaltyCard");
+ System.err.println("Exception when calling ManagementApi#deleteCollection");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1777,8 +1925,9 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **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. |
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
### Return type
@@ -1798,15 +1947,14 @@ null (empty response body)
|-------------|-------------|------------------|
**204** | No Content | - |
**401** | Unauthorized | - |
-**404** | Not found | - |
-
-# **deleteReferral**
-> deleteReferral(applicationId, campaignId, referralId)
+
+# **deleteCoupon**
+> deleteCoupon(applicationId, campaignId, couponId)
-Delete referral
+Delete coupon
-Delete the specified referral.
+Delete the specified coupon.
### Example
```java
@@ -1838,11 +1986,11 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- String referralId = "referralId_example"; // String | The ID of the referral code.
+ String couponId = "couponId_example"; // String | 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.
try {
- apiInstance.deleteReferral(applicationId, campaignId, referralId);
+ apiInstance.deleteCoupon(applicationId, campaignId, couponId);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteReferral");
+ System.err.println("Exception when calling ManagementApi#deleteCoupon");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1858,7 +2006,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **referralId** | **String**| The ID of the referral code. |
+ **couponId** | **String**| 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. |
### Return type
@@ -1878,13 +2026,13 @@ null (empty response body)
|-------------|-------------|------------------|
**204** | No Content | - |
-
-# **deleteStore**
-> deleteStore(applicationId, storeId)
+
+# **deleteCoupons**
+> deleteCoupons(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch)
-Delete store
+Delete coupons
-Delete the specified store.
+Deletes all the coupons matching the specified criteria.
### Example
```java
@@ -1915,11 +2063,24 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- String storeId = "storeId_example"; // String | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime startsAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime startsBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime expiresAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime expiresBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String valid = "valid_example"; // String | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
+ String batchId = "batchId_example"; // String | Filter results by batches of coupons
+ String usable = "usable_example"; // String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
+ Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
+ String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.
+ Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code
try {
- apiInstance.deleteStore(applicationId, storeId);
+ apiInstance.deleteCoupons(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#deleteStore");
+ System.err.println("Exception when calling ManagementApi#deleteCoupons");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1934,7 +2095,20 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **storeId** | **String**| The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
+ **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **startsAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **startsBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **expiresAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **expiresBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **valid** | **String**| - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
+ **batchId** | **String**| Filter results by batches of coupons | [optional]
+ **usable** | **String**| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | [optional] [enum: true, false]
+ **referralId** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
+ **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional]
+ **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
### Return type
@@ -1947,21 +2121,20 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
-**404** | Not found | - |
-
-# **destroySession**
-> destroySession()
+
+# **deleteLoyaltyCard**
+> deleteLoyaltyCard(loyaltyProgramId, loyaltyCardId)
-Destroy session
+Delete loyalty card
-Destroys the session.
+Delete the given loyalty card.
### Example
```java
@@ -1991,10 +2164,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ String 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.
try {
- apiInstance.destroySession();
+ apiInstance.deleteLoyaltyCard(loyaltyProgramId, loyaltyCardId);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#destroySession");
+ System.err.println("Exception when calling ManagementApi#deleteLoyaltyCard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2005,7 +2180,11 @@ public class Example {
```
### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **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. |
### Return type
@@ -2018,20 +2197,22 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
-
-# **exportAccountCollectionItems**
-> String exportAccountCollectionItems(collectionId)
+
+# **deleteReferral**
+> deleteReferral(applicationId, campaignId, referralId)
-Export account-level collection's items
+Delete referral
-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/).
+Delete the specified referral.
### Example
```java
@@ -2061,12 +2242,974 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ String referralId = "referralId_example"; // String | The ID of the referral code.
+ try {
+ apiInstance.deleteReferral(applicationId, campaignId, referralId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#deleteReferral");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **referralId** | **String**| The ID of the referral code. |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+
+
+# **deleteStore**
+> deleteStore(applicationId, storeId)
+
+Delete store
+
+Delete the specified store.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ String storeId = "storeId_example"; // String | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
+ try {
+ apiInstance.deleteStore(applicationId, storeId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#deleteStore");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **storeId** | **String**| The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+**404** | Not found | - |
+
+
+# **deleteUser**
+> deleteUser(userId)
+
+Delete user
+
+Delete a specific user.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer userId = 56; // Integer | The ID of the user.
+ try {
+ apiInstance.deleteUser(userId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#deleteUser");
+ 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
+------------- | ------------- | ------------- | -------------
+ **userId** | **Integer**| The ID of the user. |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+
+
+# **deleteUserByEmail**
+> deleteUserByEmail(body)
+
+Delete user by email address
+
+Delete a specific user by their email address.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ DeleteUserRequest body = new DeleteUserRequest(); // DeleteUserRequest | body
+ try {
+ apiInstance.deleteUserByEmail(body);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#deleteUserByEmail");
+ 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
+------------- | ------------- | ------------- | -------------
+ **body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+
+
+# **destroySession**
+> destroySession()
+
+Destroy session
+
+Destroys the session.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ try {
+ apiInstance.destroySession();
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#destroySession");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content | - |
+
+
+# **exportAccountCollectionItems**
+> String exportAccountCollectionItems(collectionId)
+
+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/).
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
+ try {
+ String result = apiInstance.exportAccountCollectionItems(collectionId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportAccountCollectionItems");
+ 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
+------------- | ------------- | ------------- | -------------
+ **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**401** | Unauthorized - Invalid API key | - |
+**404** | Not found | - |
+
+
+# **exportAchievements**
+> String exportAchievements(applicationId, campaignId, achievementId)
+
+Export achievement customer data
+
+Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - `profileIntegrationID`: The integration ID of the customer profile participating in the achievement. - `title`: The display name of the achievement in the Campaign Manager. - `target`: The required number of actions or the transactional milestone to complete the achievement. - `progress`: The current progress of the customer in the achievement. - `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. - `startDate`: The date on which the customer profile started the achievement in RFC3339. - `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. - `completionDate`: The date on which the customer profile completed the achievement in RFC3339.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer achievementId = 56; // Integer | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
+ try {
+ String result = apiInstance.exportAchievements(applicationId, campaignId, achievementId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportAchievements");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **achievementId** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
+
+
+# **exportAudiencesMemberships**
+> String exportAudiencesMemberships(audienceId)
+
+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.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer audienceId = 56; // Integer | The ID of the audience.
+ try {
+ String result = apiInstance.exportAudiencesMemberships(audienceId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportAudiencesMemberships");
+ 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
+------------- | ------------- | ------------- | -------------
+ **audienceId** | **Integer**| The ID of the audience. |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized - Invalid API key | - |
+**404** | Not found | - |
+
+
+# **exportCollectionItems**
+> String exportCollectionItems(applicationId, campaignId, collectionId)
+
+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/).
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ try {
+ String result = apiInstance.exportCollectionItems(applicationId, campaignId, collectionId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportCollectionItems");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
+
+
+# **exportCoupons**
+> String exportCoupons(applicationId, campaignId, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, batchId, exactMatch, dateFormat, campaignState, valuesOnly)
+
+Export coupons
+
+Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+
+### Example
+```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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String valid = "valid_example"; // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
+ String usable = "usable_example"; // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
+ String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
+ String batchId = "batchId_example"; // String | Filter results by batches of coupons
+ Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code.
+ String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
+ String campaignState = "campaignState_example"; // String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
+ Boolean valuesOnly = false; // Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
+ try {
+ String result = apiInstance.exportCoupons(applicationId, campaignId, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, batchId, exactMatch, dateFormat, campaignState, valuesOnly);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportCoupons");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
+ **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
+ **usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] [enum: true, false]
+ **referralId** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
+ **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. | [optional]
+ **batchId** | **String**| Filter results by batches of coupons | [optional]
+ **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
+ **campaignState** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | [optional] [enum: enabled, disabled, archived, draft, scheduled, running, expired]
+ **valuesOnly** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
+
+# **exportCustomerSessions**
+> String exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState)
+
+Export customer sessions
+
+Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-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
+// 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ String profileIntegrationId = "profileIntegrationId_example"; // String | Only return sessions for the customer that matches this customer integration ID.
+ String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
+ String customerSessionState = "customerSessionState_example"; // String | Filter results by state.
+ try {
+ String result = apiInstance.exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportCustomerSessions");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **profileIntegrationId** | **String**| Only return sessions for the customer that matches this customer integration ID. | [optional]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
+ **customerSessionState** | **String**| Filter results by state. | [optional] [enum: open, closed, partially_returned, cancelled]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
+
+# **exportCustomersTiers**
+> String exportCustomersTiers(loyaltyProgramId, subledgerIds, tierNames)
+
+Export customers' tier data
+
+Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
+
+### Example
+```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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
+ List
subledgerIds = Arrays.asList(); // List | An array of subledgers IDs to filter the export by.
+ List tierNames = Arrays.asList(); // List | An array of tier names to filter the export by.
+ try {
+ String result = apiInstance.exportCustomersTiers(loyaltyProgramId, subledgerIds, tierNames);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#exportCustomersTiers");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **loyaltyProgramId** | **String**| The identifier for the loyalty program. |
+ **subledgerIds** | [**List<String>**](String.md)| An array of subledgers IDs to filter the export by. | [optional]
+ **tierNames** | [**List<String>**](String.md)| An array of tier names to filter the export by. | [optional]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/csv
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
+
+# **exportEffects**
+> String exportEffects(applicationId, campaignId, createdBefore, createdAfter, dateFormat)
+
+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.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
try {
- String result = apiInstance.exportAccountCollectionItems(collectionId);
+ String result = apiInstance.exportEffects(applicationId, campaignId, createdBefore, createdAfter, dateFormat);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportAccountCollectionItems");
+ System.err.println("Exception when calling ManagementApi#exportEffects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2080,7 +3223,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
+ **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
### Return type
@@ -2099,16 +3246,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**401** | Unauthorized - Invalid API key | - |
-**404** | Not found | - |
-
-# **exportCollectionItems**
-> String exportCollectionItems(applicationId, campaignId, collectionId)
+
+# **exportLoyaltyBalance**
+> String exportLoyaltyBalance(loyaltyProgramId, endDate)
-Export campaign-level collection's items
+Export customer loyalty balance to CSV
-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/).
+⚠️ 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/).
### Example
```java
@@ -2138,14 +3283,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
+ String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
+ OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
try {
- String result = apiInstance.exportCollectionItems(applicationId, campaignId, collectionId);
+ String result = apiInstance.exportLoyaltyBalance(loyaltyProgramId, endDate);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportCollectionItems");
+ System.err.println("Exception when calling ManagementApi#exportLoyaltyBalance");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2159,9 +3303,8 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
+ **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]
### Return type
@@ -2180,16 +3323,16 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**400** | Bad request | - |
**401** | Unauthorized | - |
-**404** | Not found | - |
-
-# **exportCoupons**
-> String exportCoupons(applicationId, campaignId, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, batchId, exactMatch, dateFormat, campaignState, valuesOnly)
+
+# **exportLoyaltyBalances**
+> String exportLoyaltyBalances(loyaltyProgramId, endDate)
-Export coupons
+Export customer loyalty balances
-Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
+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.
### Example
```java
@@ -2219,26 +3362,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- String valid = "valid_example"; // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
- String usable = "usable_example"; // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- Integer referralId = 56; // Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
- String recipientIntegrationId = "recipientIntegrationId_example"; // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
- String batchId = "batchId_example"; // String | Filter results by batches of coupons
- Boolean exactMatch = false; // Boolean | Filter results to an exact case-insensitive matching against the coupon code.
- String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
- String campaignState = "campaignState_example"; // String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
- Boolean valuesOnly = false; // Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
+ String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
+ OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
try {
- String result = apiInstance.exportCoupons(applicationId, campaignId, sort, value, createdBefore, createdAfter, valid, usable, referralId, recipientIntegrationId, batchId, exactMatch, dateFormat, campaignState, valuesOnly);
+ String result = apiInstance.exportLoyaltyBalances(loyaltyProgramId, endDate);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportCoupons");
+ System.err.println("Exception when calling ManagementApi#exportLoyaltyBalances");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2252,21 +3382,8 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
- **usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] [enum: true, false]
- **referralId** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
- **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. | [optional]
- **batchId** | **String**| Filter results by batches of coupons | [optional]
- **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
- **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
- **campaignState** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | [optional] [enum: enabled, disabled, archived, draft, scheduled, running, expired]
- **valuesOnly** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false]
+ **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]
### Return type
@@ -2285,14 +3402,16 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
-
-# **exportCustomerSessions**
-> String exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState)
+
+# **exportLoyaltyCardBalances**
+> String exportLoyaltyCardBalances(loyaltyProgramId, endDate)
-Export customer sessions
+Export all card transaction logs
-Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
+Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
### Example
```java
@@ -2322,17 +3441,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
- String profileIntegrationId = "profileIntegrationId_example"; // String | Only return sessions for the customer that matches this customer integration ID.
- String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
- String customerSessionState = "customerSessionState_example"; // String | Filter results by state.
+ Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
try {
- String result = apiInstance.exportCustomerSessions(applicationId, createdBefore, createdAfter, profileIntegrationId, dateFormat, customerSessionState);
+ String result = apiInstance.exportLoyaltyCardBalances(loyaltyProgramId, endDate);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportCustomerSessions");
+ System.err.println("Exception when calling ManagementApi#exportLoyaltyCardBalances");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2346,12 +3461,8 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
- **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
- **profileIntegrationId** | **String**| Only return sessions for the customer that matches this customer integration ID. | [optional]
- **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
- **customerSessionState** | **String**| Filter results by state. | [optional] [enum: open, closed, partially_returned, cancelled]
+ **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **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]
### Return type
@@ -2370,14 +3481,16 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
-
-# **exportCustomersTiers**
-> String exportCustomersTiers(loyaltyProgramId, subledgerIds, tierNames)
+
+# **exportLoyaltyCardLedger**
+> String exportLoyaltyCardLedger(loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, dateFormat)
-Export customers' tier data
+Export card's ledger log
-Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
+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/).
### Example
```java
@@ -2407,14 +3520,16 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- List subledgerIds = Arrays.asList(); // List | An array of subledgers IDs to filter the export by.
- List tierNames = Arrays.asList(); // List | An array of tier names to filter the export by.
+ Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ String 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.
+ OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
+ String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
try {
- String result = apiInstance.exportCustomersTiers(loyaltyProgramId, subledgerIds, tierNames);
+ String result = apiInstance.exportLoyaltyCardLedger(loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, dateFormat);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportCustomersTiers");
+ System.err.println("Exception when calling ManagementApi#exportLoyaltyCardLedger");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2428,9 +3543,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **String**| The identifier for the loyalty program. |
- **subledgerIds** | [**List<String>**](String.md)| An array of subledgers IDs to filter the export by. | [optional]
- **tierNames** | [**List<String>**](String.md)| An array of tier names to filter the export by. | [optional]
+ **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **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. |
+ **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. |
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
### Return type
@@ -2449,14 +3566,16 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
-
-# **exportEffects**
-> String exportEffects(applicationId, campaignId, createdBefore, createdAfter, dateFormat)
+
+# **exportLoyaltyLedger**
+> String exportLoyaltyLedger(rangeStart, rangeEnd, loyaltyProgramId, integrationId, dateFormat)
-Export triggered effects
+Export customer's transaction logs
-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 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 type of the loyalty program. - `name`: The name of the loyalty program. - `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.
### Example
```java
@@ -2486,16 +3605,16 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
+ String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
+ String integrationId = "integrationId_example"; // String | The identifier of the profile.
String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
try {
- String result = apiInstance.exportEffects(applicationId, campaignId, createdBefore, createdAfter, dateFormat);
+ String result = apiInstance.exportLoyaltyLedger(rangeStart, rangeEnd, loyaltyProgramId, integrationId, dateFormat);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportEffects");
+ System.err.println("Exception when calling ManagementApi#exportLoyaltyLedger");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2509,10 +3628,10 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
- **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **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. |
+ **loyaltyProgramId** | **String**| The identifier for the loyalty program. |
+ **integrationId** | **String**| The identifier of the profile. |
**dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
### Return type
@@ -2533,13 +3652,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **exportLoyaltyBalance**
-> String exportLoyaltyBalance(loyaltyProgramId, endDate)
+
+# **exportPoolGiveaways**
+> String exportPoolGiveaways(poolId, createdBefore, createdAfter)
-Export customer loyalty balance to CSV
+Export giveaway codes of a giveaway pool
-⚠️ 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/).
+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.
### Example
```java
@@ -2569,13 +3688,14 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ Integer poolId = 56; // Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
try {
- String result = apiInstance.exportLoyaltyBalance(loyaltyProgramId, endDate);
+ String result = apiInstance.exportPoolGiveaways(poolId, createdBefore, createdAfter);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportLoyaltyBalance");
+ System.err.println("Exception when calling ManagementApi#exportPoolGiveaways");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2589,8 +3709,9 @@ 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]
+ **poolId** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
+ **createdBefore** | **OffsetDateTime**| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | [optional]
+ **createdAfter** | **OffsetDateTime**| Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. | [optional]
### Return type
@@ -2610,15 +3731,14 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
**400** | Bad request | - |
-**401** | Unauthorized | - |
-
-# **exportLoyaltyBalances**
-> String exportLoyaltyBalances(loyaltyProgramId, endDate)
+
+# **exportReferrals**
+> String exportReferrals(applicationId, campaignId, createdBefore, createdAfter, valid, usable, batchId, dateFormat)
-Export customer loyalty balances
+Export referrals
-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 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.
### Example
```java
@@ -2648,13 +3768,19 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String valid = "valid_example"; // String | - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
+ String usable = "usable_example"; // String | - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
+ String batchId = "batchId_example"; // String | Filter results by batches of referrals
+ String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
try {
- String result = apiInstance.exportLoyaltyBalances(loyaltyProgramId, endDate);
+ String result = apiInstance.exportReferrals(applicationId, campaignId, createdBefore, createdAfter, valid, usable, batchId, dateFormat);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportLoyaltyBalances");
+ System.err.println("Exception when calling ManagementApi#exportReferrals");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2668,8 +3794,14 @@ 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]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
+ **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **valid** | **String**| - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
+ **usable** | **String**| - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned. | [optional] [enum: true, false]
+ **batchId** | **String**| Filter results by batches of referrals | [optional]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
### Return type
@@ -2688,16 +3820,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**400** | Bad request | - |
-**401** | Unauthorized | - |
-
-# **exportLoyaltyCardBalances**
-> String exportLoyaltyCardBalances(loyaltyProgramId, endDate)
+
+# **getAccessLogsWithoutTotalCount**
+> InlineResponse20019 getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, path, method, status, pageSize, skip, sort)
-Export all card transaction logs
+Get access logs for Application
-Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
+Retrieve the list of API calls sent to the specified Application.
### Example
```java
@@ -2726,14 +3856,21 @@ public class Example {
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//manager_auth.setApiKeyPrefix("Token");
- ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- OffsetDateTime endDate = new OffsetDateTime(); // OffsetDateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
+ String path = "path_example"; // String | Only return results where the request path matches the given regular expression.
+ String method = "method_example"; // String | Only return results where the request method matches the given regular expression.
+ String status = "status_example"; // String | Filter results by HTTP status codes.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- String result = apiInstance.exportLoyaltyCardBalances(loyaltyProgramId, endDate);
+ InlineResponse20019 result = apiInstance.getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, path, method, status, pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportLoyaltyCardBalances");
+ System.err.println("Exception when calling ManagementApi#getAccessLogsWithoutTotalCount");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2747,12 +3884,19 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **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]
+ **applicationId** | **Integer**| 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. |
+ **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]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-**String**
+[**InlineResponse20019**](InlineResponse20019.md)
### Authorization
@@ -2761,22 +3905,20 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/csv
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**400** | Bad request | - |
-**401** | Unauthorized | - |
-
-# **exportLoyaltyCardLedger**
-> String exportLoyaltyCardLedger(loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, dateFormat)
+
+# **getAccount**
+> Account getAccount(accountId)
-Export card's ledger log
+Get account details
-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/).
+Return the details of your companies Talon.One account.
### Example
```java
@@ -2806,16 +3948,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String 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.
- OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
+ Integer accountId = 56; // Integer | 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.
try {
- String result = apiInstance.exportLoyaltyCardLedger(loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, dateFormat);
+ Account result = apiInstance.getAccount(accountId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportLoyaltyCardLedger");
+ System.err.println("Exception when calling ManagementApi#getAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2829,15 +3967,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **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. |
- **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. |
- **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
+ **accountId** | **Integer**| 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. |
### Return type
-**String**
+[**Account**](Account.md)
### Authorization
@@ -2846,22 +3980,20 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/csv
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**401** | Unauthorized | - |
-**404** | Not found | - |
-
-# **exportLoyaltyLedger**
-> String exportLoyaltyLedger(rangeStart, rangeEnd, loyaltyProgramId, integrationId, dateFormat)
+
+# **getAccountAnalytics**
+> AccountAnalytics getAccountAnalytics(accountId)
-Export customer's transaction logs
+Get account analytics
-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 type of the loyalty program. - `name`: The name of the loyalty program. - `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.
+Return the analytics of your Talon.One account.
### Example
```java
@@ -2891,16 +4023,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- String loyaltyProgramId = "loyaltyProgramId_example"; // String | The identifier for the loyalty program.
- String integrationId = "integrationId_example"; // String | The identifier of the profile.
- String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
+ Integer accountId = 56; // Integer | 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.
try {
- String result = apiInstance.exportLoyaltyLedger(rangeStart, rangeEnd, loyaltyProgramId, integrationId, dateFormat);
+ AccountAnalytics result = apiInstance.getAccountAnalytics(accountId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportLoyaltyLedger");
+ System.err.println("Exception when calling ManagementApi#getAccountAnalytics");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2914,15 +4042,11 @@ 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. |
- **loyaltyProgramId** | **String**| The identifier for the loyalty program. |
- **integrationId** | **String**| The identifier of the profile. |
- **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
+ **accountId** | **Integer**| 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. |
### Return type
-**String**
+[**AccountAnalytics**](AccountAnalytics.md)
### Authorization
@@ -2931,20 +4055,20 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/csv
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **exportPoolGiveaways**
-> String exportPoolGiveaways(poolId, createdBefore, createdAfter)
+
+# **getAccountCollection**
+> Collection getAccountCollection(collectionId)
-Export giveaway codes of a giveaway pool
+Get account-level collection
-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.
+Retrieve a given account-level collection.
### Example
```java
@@ -2974,14 +4098,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer poolId = 56; // Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
+ Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
try {
- String result = apiInstance.exportPoolGiveaways(poolId, createdBefore, createdAfter);
+ Collection result = apiInstance.getAccountCollection(collectionId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportPoolGiveaways");
+ System.err.println("Exception when calling ManagementApi#getAccountCollection");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2995,13 +4117,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **poolId** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
- **createdBefore** | **OffsetDateTime**| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | [optional]
- **createdAfter** | **OffsetDateTime**| Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. | [optional]
+ **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
### Return type
-**String**
+[**Collection**](Collection.md)
### Authorization
@@ -3010,21 +4130,21 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/csv
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**400** | Bad request | - |
+**404** | Not found | - |
-
-# **exportReferrals**
-> String exportReferrals(applicationId, campaignId, createdBefore, createdAfter, valid, usable, batchId, dateFormat)
+
+# **getAchievement**
+> Achievement getAchievement(applicationId, campaignId, achievementId)
-Export referrals
+Get achievement
-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.
+Get the details of a specific achievement.
### Example
```java
@@ -3055,18 +4175,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
- String valid = "valid_example"; // String | - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
- String usable = "usable_example"; // String | - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
- String batchId = "batchId_example"; // String | Filter results by batches of referrals
- String dateFormat = "dateFormat_example"; // String | Determines the format of dates in the export document.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer achievementId = 56; // Integer | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
try {
- String result = apiInstance.exportReferrals(applicationId, campaignId, createdBefore, createdAfter, valid, usable, batchId, dateFormat);
+ Achievement result = apiInstance.getAchievement(applicationId, campaignId, achievementId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#exportReferrals");
+ System.err.println("Exception when calling ManagementApi#getAchievement");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3081,17 +4196,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
- **createdBefore** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **valid** | **String**| - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | [optional] [enum: expired, validNow, validFuture]
- **usable** | **String**| - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned. | [optional] [enum: true, false]
- **batchId** | **String**| Filter results by batches of referrals | [optional]
- **dateFormat** | **String**| Determines the format of dates in the export document. | [optional] [enum: excel, ISO8601]
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **achievementId** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. |
### Return type
-**String**
+[**Achievement**](Achievement.md)
### Authorization
@@ -3100,20 +4210,22 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- - **Accept**: application/csv
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
-
-# **getAccessLogsWithoutTotalCount**
-> InlineResponse20019 getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, path, method, status, pageSize, skip, sort)
+
+# **getAdditionalCost**
+> AccountAdditionalCost getAdditionalCost(additionalCostId)
-Get access logs for Application
+Get additional cost
-Retrieve the list of API calls sent to the specified Application.
+Returns the additional cost.
### Example
```java
@@ -3143,20 +4255,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- String path = "path_example"; // String | Only return results where the request path matches the given regular expression.
- String method = "method_example"; // String | Only return results where the request method matches the given regular expression.
- String status = "status_example"; // String | Filter results by HTTP status codes.
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Integer additionalCostId = 56; // Integer | The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
try {
- InlineResponse20019 result = apiInstance.getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, path, method, status, pageSize, skip, sort);
+ AccountAdditionalCost result = apiInstance.getAdditionalCost(additionalCostId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAccessLogsWithoutTotalCount");
+ System.err.println("Exception when calling ManagementApi#getAdditionalCost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3170,19 +4274,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| 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. |
- **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **additionalCostId** | **Integer**| The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. |
### Return type
-[**InlineResponse20019**](InlineResponse20019.md)
+[**AccountAdditionalCost**](AccountAdditionalCost.md)
### Authorization
@@ -3198,13 +4294,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAccount**
-> Account getAccount(accountId)
+
+# **getAdditionalCosts**
+> InlineResponse20036 getAdditionalCosts(pageSize, skip, sort)
-Get account details
+List additional costs
-Return the details of your companies Talon.One account.
+Returns all the defined additional costs for the account.
### Example
```java
@@ -3234,12 +4330,14 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer accountId = 56; // Integer | 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.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- Account result = apiInstance.getAccount(accountId);
+ InlineResponse20036 result = apiInstance.getAdditionalCosts(pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAccount");
+ System.err.println("Exception when calling ManagementApi#getAdditionalCosts");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3253,11 +4351,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **accountId** | **Integer**| 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. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**Account**](Account.md)
+[**InlineResponse20036**](InlineResponse20036.md)
### Authorization
@@ -3273,13 +4373,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAccountAnalytics**
-> AccountAnalytics getAccountAnalytics(accountId)
+
+# **getAllAccessLogs**
+> InlineResponse20020 getAllAccessLogs(rangeStart, rangeEnd, path, method, status, pageSize, skip, sort)
-Get account analytics
+List access logs
-Return the analytics of your Talon.One account.
+Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
### Example
```java
@@ -3309,12 +4409,19 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer accountId = 56; // Integer | 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.
+ OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
+ String path = "path_example"; // String | Only return results where the request path matches the given regular expression.
+ String method = "method_example"; // String | Only return results where the request method matches the given regular expression.
+ String status = "status_example"; // String | Filter results by HTTP status codes.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- AccountAnalytics result = apiInstance.getAccountAnalytics(accountId);
+ InlineResponse20020 result = apiInstance.getAllAccessLogs(rangeStart, rangeEnd, path, method, status, pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAccountAnalytics");
+ System.err.println("Exception when calling ManagementApi#getAllAccessLogs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3328,11 +4435,18 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **accountId** | **Integer**| 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. |
+ **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. | [optional]
+ **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. | [optional]
+ **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]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**AccountAnalytics**](AccountAnalytics.md)
+[**InlineResponse20020**](InlineResponse20020.md)
### Authorization
@@ -3348,13 +4462,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAccountCollection**
-> Collection getAccountCollection(collectionId)
+
+# **getAllRoles**
+> InlineResponse20044 getAllRoles()
-Get account-level collection
+List roles
-Retrieve a given account-level collection.
+List all roles.
### Example
```java
@@ -3384,12 +4498,11 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
try {
- Collection result = apiInstance.getAccountCollection(collectionId);
+ InlineResponse20044 result = apiInstance.getAllRoles();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAccountCollection");
+ System.err.println("Exception when calling ManagementApi#getAllRoles");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3400,14 +4513,11 @@ public class Example {
```
### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
+This endpoint does not need any parameter.
### Return type
-[**Collection**](Collection.md)
+[**InlineResponse20044**](InlineResponse20044.md)
### Authorization
@@ -3422,15 +4532,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**404** | Not found | - |
-
-# **getAdditionalCost**
-> AccountAdditionalCost getAdditionalCost(additionalCostId)
+
+# **getApplication**
+> Application getApplication(applicationId)
-Get additional cost
+Get Application
-Returns the additional cost.
+Get the application specified by the ID.
### Example
```java
@@ -3460,12 +4569,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer additionalCostId = 56; // Integer | The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
try {
- AccountAdditionalCost result = apiInstance.getAdditionalCost(additionalCostId);
+ Application result = apiInstance.getApplication(applicationId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAdditionalCost");
+ System.err.println("Exception when calling ManagementApi#getApplication");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3479,11 +4588,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **additionalCostId** | **Integer**| The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. |
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
### Return type
-[**AccountAdditionalCost**](AccountAdditionalCost.md)
+[**Application**](Application.md)
### Authorization
@@ -3499,13 +4608,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAdditionalCosts**
-> InlineResponse20034 getAdditionalCosts(pageSize, skip, sort)
+
+# **getApplicationApiHealth**
+> ApplicationApiHealth getApplicationApiHealth(applicationId)
-List additional costs
+Get Application health
-Returns all the defined additional costs for the account.
+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. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
### Example
```java
@@ -3535,14 +4644,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
try {
- InlineResponse20034 result = apiInstance.getAdditionalCosts(pageSize, skip, sort);
+ ApplicationApiHealth result = apiInstance.getApplicationApiHealth(applicationId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAdditionalCosts");
+ System.err.println("Exception when calling ManagementApi#getApplicationApiHealth");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3556,13 +4663,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
### Return type
-[**InlineResponse20034**](InlineResponse20034.md)
+[**ApplicationApiHealth**](ApplicationApiHealth.md)
### Authorization
@@ -3578,13 +4683,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAllAccessLogs**
-> InlineResponse20020 getAllAccessLogs(rangeStart, rangeEnd, path, method, status, pageSize, skip, sort)
+
+# **getApplicationCustomer**
+> ApplicationCustomer getApplicationCustomer(applicationId, customerId)
-List access logs
+Get application's customer
-Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
+Retrieve the customers of the specified application.
### Example
```java
@@ -3614,19 +4719,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- String path = "path_example"; // String | Only return results where the request path matches the given regular expression.
- String method = "method_example"; // String | Only return results where the request method matches the given regular expression.
- String status = "status_example"; // String | Filter results by HTTP status codes.
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer customerId = 56; // Integer | 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.
try {
- InlineResponse20020 result = apiInstance.getAllAccessLogs(rangeStart, rangeEnd, path, method, status, pageSize, skip, sort);
+ ApplicationCustomer result = apiInstance.getApplicationCustomer(applicationId, customerId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAllAccessLogs");
+ System.err.println("Exception when calling ManagementApi#getApplicationCustomer");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3640,18 +4739,12 @@ 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. |
- **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **customerId** | **Integer**| 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. |
### Return type
-[**InlineResponse20020**](InlineResponse20020.md)
+[**ApplicationCustomer**](ApplicationCustomer.md)
### Authorization
@@ -3667,13 +4760,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAllRoles**
-> InlineResponse20042 getAllRoles()
+
+# **getApplicationCustomerFriends**
+> InlineResponse20033 getApplicationCustomerFriends(applicationId, integrationId, pageSize, skip, sort, withTotalResultSize)
-List roles
+List friends referred by customer profile
-List all roles.
+List the friends referred by the specified customer profile in this Application.
### Example
```java
@@ -3703,11 +4796,17 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ String integrationId = "integrationId_example"; // String | The Integration ID of the Advocate's Profile.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
try {
- InlineResponse20042 result = apiInstance.getAllRoles();
+ InlineResponse20033 result = apiInstance.getApplicationCustomerFriends(applicationId, integrationId, pageSize, skip, sort, withTotalResultSize);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAllRoles");
+ System.err.println("Exception when calling ManagementApi#getApplicationCustomerFriends");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3718,11 +4817,19 @@ public class Example {
```
### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **integrationId** | **String**| The Integration ID of the Advocate's Profile. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
### Return type
-[**InlineResponse20042**](InlineResponse20042.md)
+[**InlineResponse20033**](InlineResponse20033.md)
### Authorization
@@ -3738,13 +4845,13 @@ This endpoint does not need any parameter.
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplication**
-> Application getApplication(applicationId)
+
+# **getApplicationCustomers**
+> InlineResponse20022 getApplicationCustomers(applicationId, integrationId, pageSize, skip, withTotalResultSize)
-Get Application
+List application's customers
-Get the application specified by the ID.
+List all the customers of the specified application.
### Example
```java
@@ -3775,11 +4882,15 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ String integrationId = "integrationId_example"; // String | Filter results performing an exact matching against the profile integration identifier.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
try {
- Application result = apiInstance.getApplication(applicationId);
+ InlineResponse20022 result = apiInstance.getApplicationCustomers(applicationId, integrationId, pageSize, skip, withTotalResultSize);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplication");
+ System.err.println("Exception when calling ManagementApi#getApplicationCustomers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3794,10 +4905,14 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **integrationId** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
### Return type
-[**Application**](Application.md)
+[**InlineResponse20022**](InlineResponse20022.md)
### Authorization
@@ -3813,13 +4928,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationApiHealth**
-> ApplicationApiHealth getApplicationApiHealth(applicationId)
+
+# **getApplicationCustomersByAttributes**
+> InlineResponse20023 getApplicationCustomersByAttributes(applicationId, body, pageSize, skip, withTotalResultSize)
-Get Application health
+List application customers matching the given attributes
-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. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
+Get a list of the application customers matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
### Example
```java
@@ -3850,11 +4965,15 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ CustomerProfileSearchQuery body = new CustomerProfileSearchQuery(); // CustomerProfileSearchQuery | body
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
try {
- ApplicationApiHealth result = apiInstance.getApplicationApiHealth(applicationId);
+ InlineResponse20023 result = apiInstance.getApplicationCustomersByAttributes(applicationId, body, pageSize, skip, withTotalResultSize);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationApiHealth");
+ System.err.println("Exception when calling ManagementApi#getApplicationCustomersByAttributes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3869,10 +4988,14 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
### Return type
-[**ApplicationApiHealth**](ApplicationApiHealth.md)
+[**InlineResponse20023**](InlineResponse20023.md)
### Authorization
@@ -3880,7 +5003,7 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
@@ -3888,13 +5011,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationCustomer**
-> ApplicationCustomer getApplicationCustomer(applicationId, customerId)
+
+# **getApplicationEventTypes**
+> InlineResponse20029 getApplicationEventTypes(applicationId, pageSize, skip, sort)
-Get application's customer
+List Applications event types
-Retrieve the customers of the specified application.
+Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2)
### Example
```java
@@ -3925,12 +5048,14 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer customerId = 56; // Integer | 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.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- ApplicationCustomer result = apiInstance.getApplicationCustomer(applicationId, customerId);
+ InlineResponse20029 result = apiInstance.getApplicationEventTypes(applicationId, pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationCustomer");
+ System.err.println("Exception when calling ManagementApi#getApplicationEventTypes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -3945,11 +5070,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **customerId** | **Integer**| 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. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**ApplicationCustomer**](ApplicationCustomer.md)
+[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
@@ -3965,13 +5092,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationCustomerFriends**
-> InlineResponse20031 getApplicationCustomerFriends(applicationId, integrationId, pageSize, skip, sort, withTotalResultSize)
+
+# **getApplicationEventsWithoutTotalCount**
+> InlineResponse20028 getApplicationEventsWithoutTotalCount(applicationId, pageSize, skip, sort, type, createdBefore, createdAfter, session, profile, customerName, customerEmail, couponCode, referralCode, ruleQuery, campaignQuery)
-List friends referred by customer profile
+List Applications events
-List the friends referred by the specified customer profile in this Application.
+Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
### Example
```java
@@ -4002,16 +5129,25 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- String integrationId = "integrationId_example"; // String | The Integration ID of the Advocate's Profile.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ String type = "type_example"; // String | Comma-separated list of types by which to filter events. Must be exact match(es).
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String session = "session_example"; // String | Session integration ID filter for events. Must be exact match.
+ String profile = "profile_example"; // String | Profile integration ID filter for events. Must be exact match.
+ String customerName = "customerName_example"; // String | Customer name filter for events. Will match substrings case-insensitively.
+ String customerEmail = "customerEmail_example"; // String | Customer e-mail address filter for events. Will match substrings case-insensitively.
+ String couponCode = "couponCode_example"; // String | Coupon code
+ String referralCode = "referralCode_example"; // String | Referral code
+ String ruleQuery = "ruleQuery_example"; // String | Rule name filter for events
+ String campaignQuery = "campaignQuery_example"; // String | Campaign name filter for events
try {
- InlineResponse20031 result = apiInstance.getApplicationCustomerFriends(applicationId, integrationId, pageSize, skip, sort, withTotalResultSize);
+ InlineResponse20028 result = apiInstance.getApplicationEventsWithoutTotalCount(applicationId, pageSize, skip, sort, type, createdBefore, createdAfter, session, profile, customerName, customerEmail, couponCode, referralCode, ruleQuery, campaignQuery);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationCustomerFriends");
+ System.err.println("Exception when calling ManagementApi#getApplicationEventsWithoutTotalCount");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4026,15 +5162,24 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **integrationId** | **String**| The Integration ID of the Advocate's Profile. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
+ **type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
+ **createdBefore** | **OffsetDateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
+ **profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
+ **customerName** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
+ **customerEmail** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
+ **couponCode** | **String**| Coupon code | [optional]
+ **referralCode** | **String**| Referral code | [optional]
+ **ruleQuery** | **String**| Rule name filter for events | [optional]
+ **campaignQuery** | **String**| Campaign name filter for events | [optional]
### Return type
-[**InlineResponse20031**](InlineResponse20031.md)
+[**InlineResponse20028**](InlineResponse20028.md)
### Authorization
@@ -4050,13 +5195,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationCustomers**
-> InlineResponse20022 getApplicationCustomers(applicationId, integrationId, pageSize, skip, withTotalResultSize)
+
+# **getApplicationSession**
+> ApplicationSession getApplicationSession(applicationId, sessionId)
-List application's customers
+Get Application session
-List all the customers of the specified application.
+Get the details of the given session. You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
### Example
```java
@@ -4087,15 +5232,12 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- String integrationId = "integrationId_example"; // String | Filter results performing an exact matching against the profile integration identifier.
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ Integer sessionId = 56; // Integer | The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
try {
- InlineResponse20022 result = apiInstance.getApplicationCustomers(applicationId, integrationId, pageSize, skip, withTotalResultSize);
+ ApplicationSession result = apiInstance.getApplicationSession(applicationId, sessionId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationCustomers");
+ System.err.println("Exception when calling ManagementApi#getApplicationSession");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4110,14 +5252,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **integrationId** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
+ **sessionId** | **Integer**| The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. |
### Return type
-[**InlineResponse20022**](InlineResponse20022.md)
+[**ApplicationSession**](ApplicationSession.md)
### Authorization
@@ -4133,13 +5272,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationCustomersByAttributes**
-> InlineResponse20023 getApplicationCustomersByAttributes(applicationId, body, pageSize, skip, withTotalResultSize)
+
+# **getApplicationSessions**
+> InlineResponse20027 getApplicationSessions(applicationId, pageSize, skip, sort, profile, state, createdBefore, createdAfter, coupon, referral, integrationId, storeIntegrationId)
-List application customers matching the given attributes
+List Application sessions
-Get a list of the application customers matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
+List all the sessions of the specified Application.
### Example
```java
@@ -4170,15 +5309,22 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- CustomerProfileSearchQuery body = new CustomerProfileSearchQuery(); // CustomerProfileSearchQuery | body
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ String profile = "profile_example"; // String | Profile integration ID filter for sessions. Must be exact match.
+ String state = "state_example"; // String | Filter by sessions with this state. Must be exact match.
+ OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
+ OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
+ String coupon = "coupon_example"; // String | Filter by sessions with this coupon. Must be exact match.
+ String referral = "referral_example"; // String | Filter by sessions with this referral. Must be exact match.
+ String integrationId = "integrationId_example"; // String | Filter by sessions with this integrationId. Must be exact match.
+ String storeIntegrationId = "storeIntegrationId_example"; // String | The integration ID of the store. You choose this ID when you create a store.
try {
- InlineResponse20023 result = apiInstance.getApplicationCustomersByAttributes(applicationId, body, pageSize, skip, withTotalResultSize);
+ InlineResponse20027 result = apiInstance.getApplicationSessions(applicationId, pageSize, skip, sort, profile, state, createdBefore, createdAfter, coupon, referral, integrationId, storeIntegrationId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationCustomersByAttributes");
+ System.err.println("Exception when calling ManagementApi#getApplicationSessions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4193,14 +5339,21 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
+ **state** | **String**| Filter by sessions with this state. Must be exact match. | [optional] [enum: open, closed, partially_returned, cancelled]
+ **createdBefore** | **OffsetDateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
+ **coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
+ **referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
+ **integrationId** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
+ **storeIntegrationId** | **String**| The integration ID of the store. You choose this ID when you create a store. | [optional]
### Return type
-[**InlineResponse20023**](InlineResponse20023.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
@@ -4208,21 +5361,21 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | OK | - |
-
-
-# **getApplicationEventTypes**
-> InlineResponse20029 getApplicationEventTypes(applicationId, pageSize, skip, sort)
+**200** | OK | - |
-List Applications event types
+
+# **getApplications**
+> InlineResponse2005 getApplications(pageSize, skip, sort)
-Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2)
+List Applications
+
+List all applications in the current account.
### Example
```java
@@ -4252,15 +5405,14 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- InlineResponse20029 result = apiInstance.getApplicationEventTypes(applicationId, pageSize, skip, sort);
+ InlineResponse2005 result = apiInstance.getApplications(pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationEventTypes");
+ System.err.println("Exception when calling ManagementApi#getApplications");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4274,14 +5426,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**InlineResponse20029**](InlineResponse20029.md)
+[**InlineResponse2005**](InlineResponse2005.md)
### Authorization
@@ -4297,13 +5448,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationEventsWithoutTotalCount**
-> InlineResponse20028 getApplicationEventsWithoutTotalCount(applicationId, pageSize, skip, sort, type, createdBefore, createdAfter, session, profile, customerName, customerEmail, couponCode, referralCode, ruleQuery, campaignQuery)
+
+# **getAttribute**
+> Attribute getAttribute(attributeId)
-List Applications events
+Get custom attribute
-Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
+Retrieve the specified custom attribute.
### Example
```java
@@ -4333,26 +5484,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- String type = "type_example"; // String | Comma-separated list of types by which to filter events. Must be exact match(es).
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
- String session = "session_example"; // String | Session integration ID filter for events. Must be exact match.
- String profile = "profile_example"; // String | Profile integration ID filter for events. Must be exact match.
- String customerName = "customerName_example"; // String | Customer name filter for events. Will match substrings case-insensitively.
- String customerEmail = "customerEmail_example"; // String | Customer e-mail address filter for events. Will match substrings case-insensitively.
- String couponCode = "couponCode_example"; // String | Coupon code
- String referralCode = "referralCode_example"; // String | Referral code
- String ruleQuery = "ruleQuery_example"; // String | Rule name filter for events
- String campaignQuery = "campaignQuery_example"; // String | Campaign name filter for events
+ Integer attributeId = 56; // Integer | 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**.
try {
- InlineResponse20028 result = apiInstance.getApplicationEventsWithoutTotalCount(applicationId, pageSize, skip, sort, type, createdBefore, createdAfter, session, profile, customerName, customerEmail, couponCode, referralCode, ruleQuery, campaignQuery);
+ Attribute result = apiInstance.getAttribute(attributeId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationEventsWithoutTotalCount");
+ System.err.println("Exception when calling ManagementApi#getAttribute");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4366,25 +5503,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
- **createdBefore** | **OffsetDateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
- **profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
- **customerName** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
- **customerEmail** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
- **couponCode** | **String**| Coupon code | [optional]
- **referralCode** | **String**| Referral code | [optional]
- **ruleQuery** | **String**| Rule name filter for events | [optional]
- **campaignQuery** | **String**| Campaign name filter for events | [optional]
+ **attributeId** | **Integer**| 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**. |
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
+[**Attribute**](Attribute.md)
### Authorization
@@ -4400,13 +5523,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationSession**
-> ApplicationSession getApplicationSession(applicationId, sessionId)
+
+# **getAttributes**
+> InlineResponse20034 getAttributes(pageSize, skip, sort, entity)
-Get Application session
+List custom attributes
-Get the details of the given session. You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
+Return all the custom attributes for the account.
### Example
```java
@@ -4436,13 +5559,15 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer sessionId = 56; // Integer | The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ String entity = "entity_example"; // String | Returned attributes will be filtered by supplied entity.
try {
- ApplicationSession result = apiInstance.getApplicationSession(applicationId, sessionId);
+ InlineResponse20034 result = apiInstance.getAttributes(pageSize, skip, sort, entity);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationSession");
+ System.err.println("Exception when calling ManagementApi#getAttributes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4456,12 +5581,14 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **sessionId** | **Integer**| The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **entity** | **String**| Returned attributes will be filtered by supplied entity. | [optional]
### Return type
-[**ApplicationSession**](ApplicationSession.md)
+[**InlineResponse20034**](InlineResponse20034.md)
### Authorization
@@ -4477,13 +5604,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getApplicationSessions**
-> InlineResponse20027 getApplicationSessions(applicationId, pageSize, skip, sort, profile, state, createdBefore, createdAfter, coupon, referral, integrationId)
+
+# **getAudienceMemberships**
+> InlineResponse20032 getAudienceMemberships(audienceId, pageSize, skip, sort, profileQuery)
-List Application sessions
+List audience members
-List all the sessions of the specified Application.
+Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.
### Example
```java
@@ -4513,22 +5640,16 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer audienceId = 56; // Integer | The ID of the audience.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- String profile = "profile_example"; // String | Profile integration ID filter for sessions. Must be exact match.
- String state = "state_example"; // String | Filter by sessions with this state. Must be exact match.
- OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
- OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
- String coupon = "coupon_example"; // String | Filter by sessions with this coupon. Must be exact match.
- String referral = "referral_example"; // String | Filter by sessions with this referral. Must be exact match.
- String integrationId = "integrationId_example"; // String | Filter by sessions with this integrationId. Must be exact match.
+ String profileQuery = "profileQuery_example"; // String | The filter to select a profile.
try {
- InlineResponse20027 result = apiInstance.getApplicationSessions(applicationId, pageSize, skip, sort, profile, state, createdBefore, createdAfter, coupon, referral, integrationId);
+ InlineResponse20032 result = apiInstance.getAudienceMemberships(audienceId, pageSize, skip, sort, profileQuery);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplicationSessions");
+ System.err.println("Exception when calling ManagementApi#getAudienceMemberships");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4542,21 +5663,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **audienceId** | **Integer**| The ID of the audience. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
- **state** | **String**| Filter by sessions with this state. Must be exact match. | [optional] [enum: open, closed, partially_returned, cancelled]
- **createdBefore** | **OffsetDateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **createdAfter** | **OffsetDateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
- **coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
- **referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
- **integrationId** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
+ **profileQuery** | **String**| The filter to select a profile. | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20032**](InlineResponse20032.md)
### Authorization
@@ -4571,14 +5686,15 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**404** | Not found | - |
-
-# **getApplications**
-> InlineResponse2005 getApplications(pageSize, skip, sort)
+
+# **getAudiences**
+> InlineResponse20030 getAudiences(pageSize, skip, sort, withTotalResultSize)
-List Applications
+List audiences
-List all applications in the current account.
+Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
### Example
```java
@@ -4608,14 +5724,15 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
try {
- InlineResponse2005 result = apiInstance.getApplications(pageSize, skip, sort);
+ InlineResponse20030 result = apiInstance.getAudiences(pageSize, skip, sort, withTotalResultSize);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getApplications");
+ System.err.println("Exception when calling ManagementApi#getAudiences");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4629,13 +5746,14 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
### Return type
-[**InlineResponse2005**](InlineResponse2005.md)
+[**InlineResponse20030**](InlineResponse20030.md)
### Authorization
@@ -4651,13 +5769,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAttribute**
-> Attribute getAttribute(attributeId)
+
+# **getAudiencesAnalytics**
+> InlineResponse20031 getAudiencesAnalytics(audienceIds, sort)
-Get custom attribute
+List audience analytics
-Retrieve the specified custom attribute.
+Get a list of audience IDs and their member count.
### Example
```java
@@ -4687,12 +5805,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer attributeId = 56; // Integer | 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**.
+ String audienceIds = "audienceIds_example"; // String | The IDs of one or more audiences, separated by commas, by which to filter results.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- Attribute result = apiInstance.getAttribute(attributeId);
+ InlineResponse20031 result = apiInstance.getAudiencesAnalytics(audienceIds, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAttribute");
+ System.err.println("Exception when calling ManagementApi#getAudiencesAnalytics");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4706,11 +5825,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **attributeId** | **Integer**| 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**. |
+ **audienceIds** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. |
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**Attribute**](Attribute.md)
+[**InlineResponse20031**](InlineResponse20031.md)
### Authorization
@@ -4726,13 +5846,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAttributes**
-> InlineResponse20032 getAttributes(pageSize, skip, sort, entity)
+
+# **getCampaign**
+> Campaign getCampaign(applicationId, campaignId)
-List custom attributes
+Get campaign
-Return all the custom attributes for the account.
+Retrieve the given campaign.
### Example
```java
@@ -4762,15 +5882,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- String entity = "entity_example"; // String | Returned attributes will be filtered by supplied entity.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
try {
- InlineResponse20032 result = apiInstance.getAttributes(pageSize, skip, sort, entity);
+ Campaign result = apiInstance.getCampaign(applicationId, campaignId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAttributes");
+ System.err.println("Exception when calling ManagementApi#getCampaign");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4784,14 +5902,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **entity** | **String**| Returned attributes will be filtered by supplied entity. | [optional]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
### Return type
-[**InlineResponse20032**](InlineResponse20032.md)
+[**Campaign**](Campaign.md)
### Authorization
@@ -4807,13 +5923,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getAudiences**
-> InlineResponse20030 getAudiences(pageSize, skip, sort, withTotalResultSize)
+
+# **getCampaignAnalytics**
+> InlineResponse20021 getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, granularity)
-List audiences
+Get analytics of campaigns
-Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
+Retrieve statistical data about the performance of the given campaign.
### Example
```java
@@ -4843,15 +5959,16 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
- Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
+ String granularity = "granularity_example"; // String | The time interval between the results in the returned time-series.
try {
- InlineResponse20030 result = apiInstance.getAudiences(pageSize, skip, sort, withTotalResultSize);
+ InlineResponse20021 result = apiInstance.getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, granularity);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getAudiences");
+ System.err.println("Exception when calling ManagementApi#getCampaignAnalytics");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4865,14 +5982,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
- **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| 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. |
+ **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
-[**InlineResponse20030**](InlineResponse20030.md)
+[**InlineResponse20021**](InlineResponse20021.md)
### Authorization
@@ -4888,13 +6006,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getCampaign**
-> Campaign getCampaign(applicationId, campaignId)
+
+# **getCampaignByAttributes**
+> InlineResponse2006 getCampaignByAttributes(applicationId, body, pageSize, skip, sort, campaignState)
-Get campaign
+List campaigns that match the given attributes
-Retrieve the given campaign.
+Get a list of all the campaigns that match a set of attributes.
### Example
```java
@@ -4925,12 +6043,16 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ CampaignSearch body = new CampaignSearch(); // CampaignSearch | body
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ String campaignState = "campaignState_example"; // String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
try {
- Campaign result = apiInstance.getCampaign(applicationId, campaignId);
+ InlineResponse2006 result = apiInstance.getCampaignByAttributes(applicationId, body, pageSize, skip, sort, campaignState);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getCampaign");
+ System.err.println("Exception when calling ManagementApi#getCampaignByAttributes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -4945,11 +6067,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **body** | [**CampaignSearch**](CampaignSearch.md)| body |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **campaignState** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | [optional] [enum: enabled, disabled, archived, draft, scheduled, running, expired]
### Return type
-[**Campaign**](Campaign.md)
+[**InlineResponse2006**](InlineResponse2006.md)
### Authorization
@@ -4957,7 +6083,7 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
@@ -4965,13 +6091,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getCampaignAnalytics**
-> InlineResponse20021 getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, granularity)
+
+# **getCampaignGroup**
+> CampaignGroup getCampaignGroup(campaignGroupId)
-Get analytics of campaigns
+Get campaign access group
-Retrieve statistical data about the performance of the given campaign.
+Get a campaign access group specified by its ID.
### Example
```java
@@ -5001,16 +6127,12 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- String granularity = "granularity_example"; // String | The time interval between the results in the returned time-series.
+ Integer campaignGroupId = 56; // Integer | The ID of the campaign access group.
try {
- InlineResponse20021 result = apiInstance.getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, granularity);
+ CampaignGroup result = apiInstance.getCampaignGroup(campaignGroupId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getCampaignAnalytics");
+ System.err.println("Exception when calling ManagementApi#getCampaignGroup");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -5024,15 +6146,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| 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. |
- **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]
+ **campaignGroupId** | **Integer**| The ID of the campaign access group. |
### Return type
-[**InlineResponse20021**](InlineResponse20021.md)
+[**CampaignGroup**](CampaignGroup.md)
### Authorization
@@ -5048,13 +6166,13 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
-
-# **getCampaignByAttributes**
-> InlineResponse2006 getCampaignByAttributes(applicationId, body, pageSize, skip, sort, campaignState)
+
+# **getCampaignGroups**
+> InlineResponse20011 getCampaignGroups(pageSize, skip, sort)
-List campaigns that match the given attributes
+List campaign access groups
-Get a list of all the campaigns that match a set of attributes.
+List the campaign access groups in the current account.
### Example
```java
@@ -5084,17 +6202,14 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- CampaignSearch body = new CampaignSearch(); // CampaignSearch | body
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- String campaignState = "campaignState_example"; // String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
try {
- InlineResponse2006 result = apiInstance.getCampaignByAttributes(applicationId, body, pageSize, skip, sort, campaignState);
+ InlineResponse20011 result = apiInstance.getCampaignGroups(pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#getCampaignByAttributes");
+ System.err.println("Exception when calling ManagementApi#getCampaignGroups");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -5108,16 +6223,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **body** | [**CampaignSearch**](CampaignSearch.md)| body |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **campaignState** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | [optional] [enum: enabled, disabled, archived, draft, scheduled, running, expired]
### Return type
-[**InlineResponse2006**](InlineResponse2006.md)
+[**InlineResponse20011**](InlineResponse20011.md)
### Authorization
@@ -5125,7 +6237,7 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
@@ -5135,7 +6247,7 @@ Name | Type | Description | Notes
# **getCampaignTemplates**
-> InlineResponse20011 getCampaignTemplates(pageSize, skip, sort, state, name, tags, userId)
+> InlineResponse20012 getCampaignTemplates(pageSize, skip, sort, state, name, tags, userId)
List campaign templates
@@ -5169,7 +6281,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String state = "state_example"; // String | Filter results by the state of the campaign template.
@@ -5177,7 +6289,7 @@ public class Example {
String tags = "tags_example"; // String | Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
Integer userId = 56; // Integer | Filter results by user ID.
try {
- InlineResponse20011 result = apiInstance.getCampaignTemplates(pageSize, skip, sort, state, name, tags, userId);
+ InlineResponse20012 result = apiInstance.getCampaignTemplates(pageSize, skip, sort, state, name, tags, userId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getCampaignTemplates");
@@ -5194,7 +6306,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**state** | **String**| Filter results by the state of the campaign template. | [optional] [enum: enabled, disabled, draft]
@@ -5204,7 +6316,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20011**](InlineResponse20011.md)
+[**InlineResponse20012**](InlineResponse20012.md)
### Authorization
@@ -5257,7 +6369,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String campaignState = "campaignState_example"; // String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
@@ -5287,7 +6399,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**campaignState** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | [optional] [enum: enabled, disabled, archived, draft, scheduled, running, expired]
@@ -5320,7 +6432,7 @@ Name | Type | Description | Notes
# **getChanges**
-> InlineResponse20040 getChanges(pageSize, skip, sort, applicationId, entityPath, userId, createdBefore, createdAfter, withTotalResultSize, managementKeyId, includeOld)
+> InlineResponse20042 getChanges(pageSize, skip, sort, applicationId, entityPath, userId, createdBefore, createdAfter, withTotalResultSize, managementKeyId, includeOld)
Get audit logs for an account
@@ -5354,7 +6466,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
BigDecimal applicationId = new BigDecimal(); // BigDecimal | Filter results by Application ID.
@@ -5366,7 +6478,7 @@ public class Example {
Integer managementKeyId = 56; // Integer | Filter results that match the given management key ID.
Boolean includeOld = true; // Boolean | When this flag is set to false, the state without the change will not be returned. The default value is true.
try {
- InlineResponse20040 result = apiInstance.getChanges(pageSize, skip, sort, applicationId, entityPath, userId, createdBefore, createdAfter, withTotalResultSize, managementKeyId, includeOld);
+ InlineResponse20042 result = apiInstance.getChanges(pageSize, skip, sort, applicationId, entityPath, userId, createdBefore, createdAfter, withTotalResultSize, managementKeyId, includeOld);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getChanges");
@@ -5383,7 +6495,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**applicationId** | **BigDecimal**| Filter results by Application ID. | [optional]
@@ -5397,7 +6509,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20040**](InlineResponse20040.md)
+[**InlineResponse20042**](InlineResponse20042.md)
### Authorization
@@ -5495,7 +6607,7 @@ Name | Type | Description | Notes
# **getCollectionItems**
-> InlineResponse20017 getCollectionItems(collectionId, pageSize, skip)
+> InlineResponse20018 getCollectionItems(collectionId, pageSize, skip)
Get collection items
@@ -5530,10 +6642,10 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
- InlineResponse20017 result = apiInstance.getCollectionItems(collectionId, pageSize, skip);
+ InlineResponse20018 result = apiInstance.getCollectionItems(collectionId, pageSize, skip);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getCollectionItems");
@@ -5551,12 +6663,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
-[**InlineResponse20017**](InlineResponse20017.md)
+[**InlineResponse20018**](InlineResponse20018.md)
### Authorization
@@ -5611,7 +6723,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
@@ -5643,7 +6755,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
@@ -5711,10 +6823,10 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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 rangeEnd = new OffsetDateTime(); // 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.
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer customerId = 56; // Integer | 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.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
CustomerActivityReport result = apiInstance.getCustomerActivityReport(rangeStart, rangeEnd, applicationId, customerId, pageSize, skip);
@@ -5735,10 +6847,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. |
+ **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. |
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**customerId** | **Integer**| 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. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
@@ -5796,9 +6908,9 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
OffsetDateTime rangeStart = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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 rangeEnd = new OffsetDateTime(); // 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.
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String name = "name_example"; // String | Only return reports matching the customer name
@@ -5824,9 +6936,9 @@ 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. |
+ **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. |
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**name** | **String**| Only return reports matching the customer name | [optional]
@@ -5890,7 +7002,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer customerId = 56; // Integer | 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.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
@@ -5913,7 +7025,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**customerId** | **Integer**| 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. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
@@ -6010,6 +7122,93 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
+
+# **getCustomerProfileAchievementProgress**
+> InlineResponse20047 getCustomerProfileAchievementProgress(applicationId, integrationId, pageSize, skip, achievementId, title)
+
+List customer achievements
+
+For the given customer profile, list all the achievements that match your filter criteria.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ String integrationId = "integrationId_example"; // String | The identifier of the profile.
+ Integer pageSize = 50; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ Integer achievementId = 56; // Integer | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
+ String title = "title_example"; // String | Filter results by the `title` of an achievement.
+ try {
+ InlineResponse20047 result = apiInstance.getCustomerProfileAchievementProgress(applicationId, integrationId, pageSize, skip, achievementId, title);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#getCustomerProfileAchievementProgress");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **integrationId** | **String**| The identifier of the profile. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **achievementId** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. | [optional]
+ **title** | **String**| Filter results by the `title` of an achievement. | [optional]
+
+### Return type
+
+[**InlineResponse20047**](InlineResponse20047.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
+
# **getCustomerProfiles**
> InlineResponse20025 getCustomerProfiles(pageSize, skip, sandbox)
@@ -6046,7 +7245,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or Live customer.
try {
@@ -6067,7 +7266,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to false]
@@ -6126,7 +7325,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
CustomerProfileSearchQuery body = new CustomerProfileSearchQuery(); // CustomerProfileSearchQuery | body
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
Boolean sandbox = false; // Boolean | Indicates whether you are pointing to a sandbox or Live customer.
try {
@@ -6148,7 +7347,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to false]
@@ -6172,7 +7371,7 @@ Name | Type | Description | Notes
# **getEventTypes**
-> InlineResponse20038 getEventTypes(name, includeOldVersions, pageSize, skip, sort)
+> InlineResponse20040 getEventTypes(name, includeOldVersions, pageSize, skip, sort)
List event types
@@ -6208,11 +7407,11 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
String name = "name_example"; // String | Filter results to event types with the given name. This parameter implies `includeOldVersions`.
Boolean includeOldVersions = false; // Boolean | Include all versions of every event type.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- InlineResponse20038 result = apiInstance.getEventTypes(name, includeOldVersions, pageSize, skip, sort);
+ InlineResponse20040 result = apiInstance.getEventTypes(name, includeOldVersions, pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getEventTypes");
@@ -6231,13 +7430,13 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| Filter results to event types with the given name. This parameter implies `includeOldVersions`. | [optional]
**includeOldVersions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**InlineResponse20038**](InlineResponse20038.md)
+[**InlineResponse20040**](InlineResponse20040.md)
### Authorization
@@ -6255,7 +7454,7 @@ Name | Type | Description | Notes
# **getExports**
-> InlineResponse20041 getExports(pageSize, skip, applicationId, campaignId, entity)
+> InlineResponse20043 getExports(pageSize, skip, applicationId, campaignId, entity)
Get exports
@@ -6289,13 +7488,13 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
BigDecimal applicationId = new BigDecimal(); // BigDecimal | Filter results by Application ID.
Integer campaignId = 56; // Integer | Filter by the campaign ID on which the limit counters are used.
String entity = "entity_example"; // String | The name of the entity type that was exported.
try {
- InlineResponse20041 result = apiInstance.getExports(pageSize, skip, applicationId, campaignId, entity);
+ InlineResponse20043 result = apiInstance.getExports(pageSize, skip, applicationId, campaignId, entity);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getExports");
@@ -6312,7 +7511,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**applicationId** | **BigDecimal**| Filter results by Application ID. | [optional]
**campaignId** | **Integer**| Filter by the campaign ID on which the limit counters are used. | [optional]
@@ -6320,7 +7519,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20041**](InlineResponse20041.md)
+[**InlineResponse20043**](InlineResponse20043.md)
### Authorization
@@ -6418,7 +7617,7 @@ Name | Type | Description | Notes
# **getLoyaltyCardTransactionLogs**
-> InlineResponse20015 getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, startDate, endDate, pageSize, skip, subledgerId)
+> InlineResponse20016 getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, startDate, endDate, pageSize, skip, subledgerId)
List card's transactions
@@ -6454,13 +7653,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
String 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.
- OffsetDateTime startDate = new OffsetDateTime(); // 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 startDate = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
try {
- InlineResponse20015 result = apiInstance.getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, startDate, endDate, pageSize, skip, subledgerId);
+ InlineResponse20016 result = apiInstance.getLoyaltyCardTransactionLogs(loyaltyProgramId, loyaltyCardId, startDate, endDate, pageSize, skip, subledgerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getLoyaltyCardTransactionLogs");
@@ -6479,15 +7678,15 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
**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. |
- **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]
+ **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**subledgerId** | **String**| The ID of the subledger by which we filter the data. | [optional]
### Return type
-[**InlineResponse20015**](InlineResponse20015.md)
+[**InlineResponse20016**](InlineResponse20016.md)
### Authorization
@@ -6507,7 +7706,7 @@ Name | Type | Description | Notes
# **getLoyaltyCards**
-> InlineResponse20014 getLoyaltyCards(loyaltyProgramId, pageSize, skip, sort, identifier, profileId)
+> InlineResponse20015 getLoyaltyCards(loyaltyProgramId, pageSize, skip, sort, identifier, profileId)
List loyalty cards
@@ -6542,13 +7741,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String identifier = "identifier_example"; // String | Optional query parameter to search cards by identifier.
Integer profileId = 56; // Integer | Filter by the profile ID.
try {
- InlineResponse20014 result = apiInstance.getLoyaltyCards(loyaltyProgramId, pageSize, skip, sort, identifier, profileId);
+ InlineResponse20015 result = apiInstance.getLoyaltyCards(loyaltyProgramId, pageSize, skip, sort, identifier, profileId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getLoyaltyCards");
@@ -6566,7 +7765,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**identifier** | **String**| Optional query parameter to search cards by identifier. | [optional]
@@ -6574,7 +7773,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20014**](InlineResponse20014.md)
+[**InlineResponse20015**](InlineResponse20015.md)
### Authorization
@@ -6705,7 +7904,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ Integer loyaltyProgramId = 56; // Integer | 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.
try {
LoyaltyProgram result = apiInstance.getLoyaltyProgram(loyaltyProgramId);
System.out.println(result);
@@ -6724,7 +7923,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **loyaltyProgramId** | **Integer**| Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
### Return type
@@ -6746,11 +7945,11 @@ Name | Type | Description | Notes
# **getLoyaltyProgramTransactions**
-> InlineResponse20013 getLoyaltyProgramTransactions(loyaltyProgramId, loyaltyTransactionType, subledgerId, startDate, endDate, pageSize, skip)
+> InlineResponse20014 getLoyaltyProgramTransactions(loyaltyProgramId, loyaltyTransactionType, subledgerId, startDate, endDate, pageSize, skip)
List loyalty program transactions
-Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. 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:** 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).
### Example
```java
@@ -6780,15 +7979,15 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ Integer loyaltyProgramId = 56; // Integer | 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 = "loyaltyTransactionType_example"; // String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
String subledgerId = "subledgerId_example"; // String | The ID of the subledger by which we filter the data.
- OffsetDateTime startDate = new OffsetDateTime(); // 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 startDate = new OffsetDateTime(); // 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 = new OffsetDateTime(); // 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.
- Integer pageSize = 50; // Integer | The number of items in this response.
+ Integer pageSize = 50; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
try {
- InlineResponse20013 result = apiInstance.getLoyaltyProgramTransactions(loyaltyProgramId, loyaltyTransactionType, subledgerId, startDate, endDate, pageSize, skip);
+ InlineResponse20014 result = apiInstance.getLoyaltyProgramTransactions(loyaltyProgramId, loyaltyTransactionType, subledgerId, startDate, endDate, pageSize, skip);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getLoyaltyProgramTransactions");
@@ -6805,17 +8004,17 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **loyaltyProgramId** | **Integer**| 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]
- **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]
+ **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]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 50]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
### Return type
-[**InlineResponse20013**](InlineResponse20013.md)
+[**InlineResponse20014**](InlineResponse20014.md)
### Authorization
@@ -6836,7 +8035,7 @@ Name | Type | Description | Notes
# **getLoyaltyPrograms**
-> InlineResponse20012 getLoyaltyPrograms()
+> InlineResponse20013 getLoyaltyPrograms()
List loyalty programs
@@ -6871,7 +8070,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
- InlineResponse20012 result = apiInstance.getLoyaltyPrograms();
+ InlineResponse20013 result = apiInstance.getLoyaltyPrograms();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getLoyaltyPrograms");
@@ -6889,7 +8088,7 @@ This endpoint does not need any parameter.
### Return type
-[**InlineResponse20012**](InlineResponse20012.md)
+[**InlineResponse20013**](InlineResponse20013.md)
### Authorization
@@ -6941,7 +8140,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ Integer loyaltyProgramId = 56; // Integer | 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.
try {
LoyaltyDashboardData result = apiInstance.getLoyaltyStatistics(loyaltyProgramId);
System.out.println(result);
@@ -6960,7 +8159,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **loyaltyProgramId** | **Integer**| Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
### Return type
@@ -7018,7 +8217,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String code = "code_example"; // String | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
@@ -7047,7 +8246,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**code** | **String**| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
@@ -7111,7 +8310,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer roleId = 56; // Integer | The ID of role.
+ Integer roleId = 56; // Integer | ID of role. **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint.
try {
Role result = apiInstance.getRole(roleId);
System.out.println(result);
@@ -7130,7 +8329,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **roleId** | **Integer**| The ID of role. |
+ **roleId** | **Integer**| ID of role. **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint. |
### Return type
@@ -7267,7 +8466,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
@@ -7290,7 +8489,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
@@ -7467,7 +8666,7 @@ Name | Type | Description | Notes
# **getUsers**
-> InlineResponse20039 getUsers(pageSize, skip, sort)
+> InlineResponse20041 getUsers(pageSize, skip, sort)
List users in account
@@ -7501,11 +8700,11 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
try {
- InlineResponse20039 result = apiInstance.getUsers(pageSize, skip, sort);
+ InlineResponse20041 result = apiInstance.getUsers(pageSize, skip, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getUsers");
@@ -7522,13 +8721,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
### Return type
-[**InlineResponse20039**](InlineResponse20039.md)
+[**InlineResponse20041**](InlineResponse20041.md)
### Authorization
@@ -7621,7 +8820,7 @@ Name | Type | Description | Notes
# **getWebhookActivationLogs**
-> InlineResponse20036 getWebhookActivationLogs(pageSize, skip, sort, integrationRequestUuid, webhookId, applicationId, campaignId, createdBefore, createdAfter)
+> InlineResponse20038 getWebhookActivationLogs(pageSize, skip, sort, integrationRequestUuid, webhookId, applicationId, campaignId, createdBefore, createdAfter)
List webhook activation log entries
@@ -7655,7 +8854,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String integrationRequestUuid = "integrationRequestUuid_example"; // String | Filter results by integration request UUID.
@@ -7665,7 +8864,7 @@ public class Example {
OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
try {
- InlineResponse20036 result = apiInstance.getWebhookActivationLogs(pageSize, skip, sort, integrationRequestUuid, webhookId, applicationId, campaignId, createdBefore, createdAfter);
+ InlineResponse20038 result = apiInstance.getWebhookActivationLogs(pageSize, skip, sort, integrationRequestUuid, webhookId, applicationId, campaignId, createdBefore, createdAfter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getWebhookActivationLogs");
@@ -7682,7 +8881,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**integrationRequestUuid** | **String**| Filter results by integration request UUID. | [optional]
@@ -7694,7 +8893,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20036**](InlineResponse20036.md)
+[**InlineResponse20038**](InlineResponse20038.md)
### Authorization
@@ -7712,7 +8911,7 @@ Name | Type | Description | Notes
# **getWebhookLogs**
-> InlineResponse20037 getWebhookLogs(pageSize, skip, sort, status, webhookId, applicationId, campaignId, requestUuid, createdBefore, createdAfter)
+> InlineResponse20039 getWebhookLogs(pageSize, skip, sort, status, webhookId, applicationId, campaignId, requestUuid, createdBefore, createdAfter)
List webhook log entries
@@ -7746,7 +8945,7 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String status = "status_example"; // String | Filter results by HTTP status codes.
@@ -7757,7 +8956,7 @@ public class Example {
OffsetDateTime createdBefore = new OffsetDateTime(); // OffsetDateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
OffsetDateTime createdAfter = new OffsetDateTime(); // OffsetDateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
try {
- InlineResponse20037 result = apiInstance.getWebhookLogs(pageSize, skip, sort, status, webhookId, applicationId, campaignId, requestUuid, createdBefore, createdAfter);
+ InlineResponse20039 result = apiInstance.getWebhookLogs(pageSize, skip, sort, status, webhookId, applicationId, campaignId, requestUuid, createdBefore, createdAfter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getWebhookLogs");
@@ -7774,7 +8973,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**status** | **String**| Filter results by HTTP status codes. | [optional] [enum: success, error]
@@ -7787,7 +8986,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20037**](InlineResponse20037.md)
+[**InlineResponse20039**](InlineResponse20039.md)
### Authorization
@@ -7805,7 +9004,7 @@ Name | Type | Description | Notes
# **getWebhooks**
-> InlineResponse20035 getWebhooks(applicationIds, sort, pageSize, skip, creationType, visibility, outgoingIntegrationsTypeId, title)
+> InlineResponse20037 getWebhooks(applicationIds, sort, pageSize, skip, creationType, visibility, outgoingIntegrationsTypeId, title)
List webhooks
@@ -7841,14 +9040,14 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
String applicationIds = "applicationIds_example"; // String | Filter by one or more Application IDs, separated by a comma.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String creationType = "creationType_example"; // String | Filter results by creation type.
String visibility = "visibility_example"; // String | Filter results by visibility.
Integer outgoingIntegrationsTypeId = 56; // Integer | Filter results by outgoing integration type ID.
String title = "title_example"; // String | Filter results performing case-insensitive matching against the webhook title.
try {
- InlineResponse20035 result = apiInstance.getWebhooks(applicationIds, sort, pageSize, skip, creationType, visibility, outgoingIntegrationsTypeId, title);
+ InlineResponse20037 result = apiInstance.getWebhooks(applicationIds, sort, pageSize, skip, creationType, visibility, outgoingIntegrationsTypeId, title);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getWebhooks");
@@ -7867,7 +9066,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationIds** | **String**| Filter by one or more Application IDs, separated by a comma. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**creationType** | **String**| Filter results by creation type. | [optional] [enum: templateWebhooks, webhooks]
**visibility** | **String**| Filter results by visibility. | [optional] [enum: visible, hidden]
@@ -7876,7 +9075,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20035**](InlineResponse20035.md)
+[**InlineResponse20037**](InlineResponse20037.md)
### Authorization
@@ -7929,7 +9128,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importAccountCollection(collectionId, upFile);
System.out.println(result);
@@ -7949,7 +9148,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8008,7 +9207,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer attributeId = 56; // Integer | 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**.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importAllowedList(attributeId, upFile);
System.out.println(result);
@@ -8028,7 +9227,87 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attributeId** | **Integer**| 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**. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
+
+### Return type
+
+[**ModelImport**](ModelImport.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized - Invalid API key | - |
+**404** | Not found | - |
+
+
+# **importAudiencesMemberships**
+> ModelImport importAudiencesMemberships(audienceId, upFile)
+
+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 ```
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer audienceId = 56; // Integer | The ID of the audience.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
+ try {
+ ModelImport result = apiInstance.importAudiencesMemberships(audienceId, upFile);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#importAudiencesMemberships");
+ 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
+------------- | ------------- | ------------- | -------------
+ **audienceId** | **Integer**| The ID of the audience. |
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8090,7 +9369,7 @@ public class Example {
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
Integer collectionId = 56; // Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importCollection(applicationId, campaignId, collectionId, upFile);
System.out.println(result);
@@ -8112,7 +9391,7 @@ Name | Type | Description | Notes
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
**collectionId** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8135,7 +9414,7 @@ Name | Type | Description | Notes
# **importCoupons**
-> ModelImport importCoupons(applicationId, campaignId, upFile)
+> ModelImport importCoupons(applicationId, campaignId, skipDuplicates, upFile)
Import coupons
@@ -8171,9 +9450,10 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ Boolean skipDuplicates = true; // Boolean | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
- ModelImport result = apiInstance.importCoupons(applicationId, campaignId, upFile);
+ ModelImport result = apiInstance.importCoupons(applicationId, campaignId, skipDuplicates, upFile);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#importCoupons");
@@ -8192,7 +9472,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **skipDuplicates** | **Boolean**| An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8249,7 +9530,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importLoyaltyCards(loyaltyProgramId, upFile);
System.out.println(result);
@@ -8269,7 +9550,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8297,7 +9578,7 @@ Name | Type | Description | Notes
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. 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 a tier, the customer is assigned to match the new information provided in the CSV file. - 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 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. 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 ```
### Example
```java
@@ -8327,8 +9608,8 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ Integer loyaltyProgramId = 56; // Integer | 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 upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importLoyaltyCustomersTiers(loyaltyProgramId, upFile);
System.out.println(result);
@@ -8347,8 +9628,8 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **loyaltyProgramId** | **Integer**| 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. |
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8377,7 +9658,7 @@ Name | Type | Description | Notes
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 loyalty program type, you can import the points into a given customer profile or into a given _active_ 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. - `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. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `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`. - `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. - `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. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `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`. - `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 ```
### Example
```java
@@ -8407,8 +9688,8 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer loyaltyProgramId = 56; // Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ Integer loyaltyProgramId = 56; // Integer | 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 upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importLoyaltyPoints(loyaltyProgramId, upFile);
System.out.println(result);
@@ -8427,8 +9708,8 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **loyaltyProgramId** | **Integer**| 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. |
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8485,7 +9766,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer poolId = 56; // Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
try {
ModelImport result = apiInstance.importPoolGiveaways(poolId, upFile);
System.out.println(result);
@@ -8505,7 +9786,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**poolId** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
### Return type
@@ -8561,14 +9842,95 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- String upFile = "upFile_example"; // String | The file with the information about the data that should be imported.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ String upFile = "upFile_example"; // String | The file containing the data that is being imported.
+ try {
+ ModelImport result = apiInstance.importReferrals(applicationId, campaignId, upFile);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#importReferrals");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **upFile** | **String**| The file containing the data that is being imported. | [optional]
+
+### Return type
+
+[**ModelImport**](ModelImport.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
+
+# **listAccountCollections**
+> InlineResponse20017 listAccountCollections(pageSize, skip, sort, withTotalResultSize, name)
+
+List collections in account
+
+List account-level collections in the account.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer pageSize = 1000; // Integer | The number of items in the response.
+ Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
+ String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
+ Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ String name = "name_example"; // String | Filter by collection name.
try {
- ModelImport result = apiInstance.importReferrals(applicationId, campaignId, upFile);
+ InlineResponse20017 result = apiInstance.listAccountCollections(pageSize, skip, sort, withTotalResultSize, name);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#importReferrals");
+ System.err.println("Exception when calling ManagementApi#listAccountCollections");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -8582,13 +9944,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **upFile** | **String**| The file with the information about the data that should be imported. | [optional]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
+ **name** | **String**| Filter by collection name. | [optional]
### Return type
-[**ModelImport**](ModelImport.md)
+[**InlineResponse20017**](InlineResponse20017.md)
### Authorization
@@ -8596,21 +9960,24 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
-
-# **listAccountCollections**
-> InlineResponse20016 listAccountCollections(pageSize, skip, sort, withTotalResultSize, name)
+
+# **listAchievements**
+> InlineResponse20046 listAchievements(applicationId, campaignId, pageSize, skip, title)
-List collections in account
+List achievements
-List account-level collections in the account.
+List all the achievements for a specific campaign.
### Example
```java
@@ -8640,16 +10007,16 @@ public class Example {
//manager_auth.setApiKeyPrefix("Token");
ManagementApi apiInstance = new ManagementApi(defaultClient);
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer pageSize = 50; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
- String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
- Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
- String name = "name_example"; // String | Filter by collection name.
+ String title = "title_example"; // String | Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
try {
- InlineResponse20016 result = apiInstance.listAccountCollections(pageSize, skip, sort, withTotalResultSize, name);
+ InlineResponse20046 result = apiInstance.listAchievements(applicationId, campaignId, pageSize, skip, title);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementApi#listAccountCollections");
+ System.err.println("Exception when calling ManagementApi#listAchievements");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -8663,15 +10030,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 50]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
- **withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
- **name** | **String**| Filter by collection name. | [optional]
+ **title** | **String**| Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned. | [optional]
### Return type
-[**InlineResponse20016**](InlineResponse20016.md)
+[**InlineResponse20046**](InlineResponse20046.md)
### Authorization
@@ -8686,13 +10053,10 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
-**400** | Bad request | - |
-**401** | Unauthorized | - |
-**404** | Not found | - |
# **listCatalogItems**
-> InlineResponse20033 listCatalogItems(catalogId, pageSize, skip, withTotalResultSize, sku)
+> InlineResponse20035 listCatalogItems(catalogId, pageSize, skip, withTotalResultSize, sku, productNames)
List items in a catalog
@@ -8727,12 +10091,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer catalogId = 56; // Integer | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
- String sku = "sku_example"; // String | The SKU of the item.
+ List sku = Arrays.asList(); // List | Filter results by one or more SKUs. Must be exact match.
+ List productNames = Arrays.asList(); // List | Filter results by one or more product names. Must be exact match.
try {
- InlineResponse20033 result = apiInstance.listCatalogItems(catalogId, pageSize, skip, withTotalResultSize, sku);
+ InlineResponse20035 result = apiInstance.listCatalogItems(catalogId, pageSize, skip, withTotalResultSize, sku, productNames);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#listCatalogItems");
@@ -8750,14 +10115,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**catalogId** | **Integer**| The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
- **sku** | **String**| The SKU of the item. | [optional]
+ **sku** | [**List<String>**](String.md)| Filter results by one or more SKUs. Must be exact match. | [optional]
+ **productNames** | [**List<String>**](String.md)| Filter results by one or more product names. Must be exact match. | [optional]
### Return type
-[**InlineResponse20033**](InlineResponse20033.md)
+[**InlineResponse20035**](InlineResponse20035.md)
### Authorization
@@ -8775,7 +10141,7 @@ Name | Type | Description | Notes
# **listCollections**
-> InlineResponse20018 listCollections(applicationId, campaignId, pageSize, skip, sort, withTotalResultSize, name)
+> InlineResponse20017 listCollections(applicationId, campaignId, pageSize, skip, sort, withTotalResultSize, name)
List collections in campaign
@@ -8811,13 +10177,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
String name = "name_example"; // String | Filter by collection name.
try {
- InlineResponse20018 result = apiInstance.listCollections(applicationId, campaignId, pageSize, skip, sort, withTotalResultSize, name);
+ InlineResponse20017 result = apiInstance.listCollections(applicationId, campaignId, pageSize, skip, sort, withTotalResultSize, name);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#listCollections");
@@ -8836,7 +10202,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
@@ -8844,7 +10210,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20018**](InlineResponse20018.md)
+[**InlineResponse20017**](InlineResponse20017.md)
### Authorization
@@ -8863,7 +10229,7 @@ Name | Type | Description | Notes
# **listCollectionsInApplication**
-> InlineResponse20018 listCollectionsInApplication(applicationId, pageSize, skip, sort, withTotalResultSize, name)
+> InlineResponse20017 listCollectionsInApplication(applicationId, pageSize, skip, sort, withTotalResultSize, name)
List collections in Application
@@ -8898,13 +10264,13 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
String name = "name_example"; // String | Filter by collection name.
try {
- InlineResponse20018 result = apiInstance.listCollectionsInApplication(applicationId, pageSize, skip, sort, withTotalResultSize, name);
+ InlineResponse20017 result = apiInstance.listCollectionsInApplication(applicationId, pageSize, skip, sort, withTotalResultSize, name);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#listCollectionsInApplication");
@@ -8922,7 +10288,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
@@ -8930,7 +10296,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20018**](InlineResponse20018.md)
+[**InlineResponse20017**](InlineResponse20017.md)
### Authorization
@@ -8949,7 +10315,7 @@ Name | Type | Description | Notes
# **listStores**
-> InlineResponse20043 listStores(applicationId, pageSize, skip, sort, withTotalResultSize, campaignId, name, integrationId)
+> InlineResponse20045 listStores(applicationId, pageSize, skip, sort, withTotalResultSize, campaignId, name, integrationId, query)
List stores
@@ -8984,15 +10350,16 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
Boolean withTotalResultSize = true; // Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
BigDecimal campaignId = new BigDecimal(); // BigDecimal | Filter results by campaign.
String name = "name_example"; // String | The name of the store.
String integrationId = "integrationId_example"; // String | The integration ID of the store.
+ String query = "query_example"; // String | Filter results by `name` or `integrationId`.
try {
- InlineResponse20043 result = apiInstance.listStores(applicationId, pageSize, skip, sort, withTotalResultSize, campaignId, name, integrationId);
+ InlineResponse20045 result = apiInstance.listStores(applicationId, pageSize, skip, sort, withTotalResultSize, campaignId, name, integrationId, query);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#listStores");
@@ -9010,17 +10377,18 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**withTotalResultSize** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
**campaignId** | **BigDecimal**| Filter results by campaign. | [optional]
**name** | **String**| The name of the store. | [optional]
**integrationId** | **String**| The integration ID of the store. | [optional]
+ **query** | **String**| Filter results by `name` or `integrationId`. | [optional]
### Return type
-[**InlineResponse20043**](InlineResponse20043.md)
+[**InlineResponse20045**](InlineResponse20045.md)
### Authorization
@@ -9118,7 +10486,7 @@ null (empty response body)
Create notification about added or deducted loyalty points
-Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications).
+Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
### Example
```java
@@ -9278,7 +10646,7 @@ Name | Type | Description | Notes
Create notification about pending loyalty points
-Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-loyalty-notifications).
+Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
### Example
```java
@@ -9546,7 +10914,7 @@ public class Example {
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Object body = null; // Object | body
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
@@ -9579,7 +10947,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**body** | **Object**| body |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
@@ -9650,7 +11018,7 @@ public class Example {
Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
Object body = null; // Object | body
- Integer pageSize = 1000; // Integer | The number of items in this response.
+ Integer pageSize = 1000; // Integer | The number of items in the response.
Integer skip = 56; // Integer | The number of items to skip when paging through large result sets.
String sort = "sort_example"; // String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
String value = "value_example"; // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
@@ -9683,7 +11051,7 @@ Name | Type | Description | Notes
**applicationId** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
**campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
**body** | **Object**| body |
- **pageSize** | **Integer**| The number of items in this response. | [optional] [default to 1000]
+ **pageSize** | **Integer**| The number of items in the response. | [optional] [default to 1000]
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
@@ -9875,6 +11243,90 @@ Name | Type | Description | Notes
**401** | Unauthorized | - |
**409** | Conflict. A collection with this name already exists. | - |
+
+# **updateAchievement**
+> Achievement updateAchievement(applicationId, campaignId, achievementId, body)
+
+Update achievement
+
+Update the details of a specific achievement.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer applicationId = 56; // Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
+ Integer campaignId = 56; // Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
+ Integer achievementId = 56; // Integer | The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
+ UpdateAchievement body = new UpdateAchievement(); // UpdateAchievement | body
+ try {
+ Achievement result = apiInstance.updateAchievement(applicationId, campaignId, achievementId, body);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#updateAchievement");
+ 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** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
+ **campaignId** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
+ **achievementId** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. |
+ **body** | [**UpdateAchievement**](UpdateAchievement.md)| body |
+
+### Return type
+
+[**Achievement**](Achievement.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+**400** | Bad request | - |
+**401** | Unauthorized | - |
+**404** | Not found | - |
+
# **updateAdditionalCost**
> AccountAdditionalCost updateAdditionalCost(additionalCostId, body)
@@ -10512,6 +11964,83 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | OK | - |
+
+# **updateRoleV2**
+> RoleV2 updateRoleV2(roleId, body)
+
+Update role
+
+Update a specific role.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer roleId = 56; // Integer | The ID of role.
+ RoleV2Base body = new RoleV2Base(); // RoleV2Base | body
+ try {
+ RoleV2 result = apiInstance.updateRoleV2(roleId, body);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#updateRoleV2");
+ 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
+------------- | ------------- | ------------- | -------------
+ **roleId** | **Integer**| The ID of role. |
+ **body** | **RoleV2Base**| body |
+
+### Return type
+
+[**RoleV2**](RoleV2.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
# **updateStore**
> Store updateStore(applicationId, storeId, body)
@@ -10593,3 +12122,80 @@ Name | Type | Description | Notes
**400** | Bad request | - |
**404** | Not found | - |
+
+# **updateUser**
+> User updateUser(userId, body)
+
+Update user
+
+Update the details of a specific user.
+
+### 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: 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");
+
+ ManagementApi apiInstance = new ManagementApi(defaultClient);
+ Integer userId = 56; // Integer | The ID of the user.
+ UpdateUser body = new UpdateUser(); // UpdateUser | body
+ try {
+ User result = apiInstance.updateUser(userId, body);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ManagementApi#updateUser");
+ 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
+------------- | ------------- | ------------- | -------------
+ **userId** | **Integer**| The ID of the user. |
+ **body** | [**UpdateUser**](UpdateUser.md)| body |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK | - |
+
diff --git a/docs/MessageLogEntries.md b/docs/MessageLogEntries.md
new file mode 100644
index 00000000..dbe5b413
--- /dev/null
+++ b/docs/MessageLogEntries.md
@@ -0,0 +1,13 @@
+
+
+# MessageLogEntries
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nextCursor** | **byte[]** | The next value in the database. **Note:** If this value is not present, it means that there are no more values in the database for this combination of request parameters. | [optional]
+**data** | [**List<MessageLogEntry>**](MessageLogEntry.md) | List of message logs. |
+
+
+
diff --git a/docs/MessageLogEntry.md b/docs/MessageLogEntry.md
new file mode 100644
index 00000000..07d962c0
--- /dev/null
+++ b/docs/MessageLogEntry.md
@@ -0,0 +1,34 @@
+
+
+# MessageLogEntry
+
+Message Log.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the message. |
+**service** | **String** | Name of the service that generated the log entry. |
+**changeType** | **String** | Type of change that triggered the notification. | [optional]
+**notificationId** | **Integer** | ID of the notification. | [optional]
+**notificationName** | **String** | The name of the notification. | [optional]
+**request** | [**MessageLogRequest**](MessageLogRequest.md) | | [optional]
+**response** | [**MessageLogResponse**](MessageLogResponse.md) | | [optional]
+**createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the log entry was created. |
+**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | The entity type the log is related to. | [optional]
+**url** | **String** | The target URL of the request. | [optional]
+**applicationId** | **Integer** | Identifier of the Application. | [optional]
+**loyaltyProgramId** | **Integer** | Identifier of the loyalty program. | [optional]
+
+
+
+## Enum: EntityTypeEnum
+
+Name | Value
+---- | -----
+APPLICATION | "application"
+LOYALTY_PROGRAM | "loyalty_program"
+WEBHOOK | "webhook"
+
+
+
diff --git a/docs/MessageLogRequest.md b/docs/MessageLogRequest.md
new file mode 100644
index 00000000..3c1cc429
--- /dev/null
+++ b/docs/MessageLogRequest.md
@@ -0,0 +1,14 @@
+
+
+# MessageLogRequest
+
+Details of the request.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the request was made. |
+**request** | **byte[]** | Raw request data. |
+
+
+
diff --git a/docs/MessageLogResponse.md b/docs/MessageLogResponse.md
new file mode 100644
index 00000000..850cce36
--- /dev/null
+++ b/docs/MessageLogResponse.md
@@ -0,0 +1,15 @@
+
+
+# MessageLogResponse
+
+Details of the response.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the response was received. |
+**response** | **byte[]** | Raw response data. |
+**status** | **Integer** | HTTP status code of the response. |
+
+
+
diff --git a/docs/NewAccountSignUp.md b/docs/NewAccountSignUp.md
index a3b506db..0164cbda 100644
--- a/docs/NewAccountSignUp.md
+++ b/docs/NewAccountSignUp.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**email** | **String** | The email address associated with your account. |
+**email** | **String** | The email address associated with the user profile. |
**password** | **String** | The password for your account. |
**companyName** | **String** | |
diff --git a/docs/NewApplicationAPIKey.md b/docs/NewApplicationAPIKey.md
index 071e76fb..561bebaf 100644
--- a/docs/NewApplicationAPIKey.md
+++ b/docs/NewApplicationAPIKey.md
@@ -7,9 +7,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**title** | **String** | Title for API Key. |
-**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expired. |
+**title** | **String** | Title of the API key. |
+**expires** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key expires. |
**platform** | [**PlatformEnum**](#PlatformEnum) | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
+**type** | [**TypeEnum**](#TypeEnum) | The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. | [optional]
+**timeOffset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. | [optional]
**id** | **Integer** | ID of the API Key. |
**createdBy** | **Integer** | ID of user who created. |
**accountID** | **Integer** | ID of account the key is used for. |
@@ -36,3 +38,11 @@ EMARSYS | "emarsys"
+## Enum: TypeEnum
+
+Name | Value
+---- | -----
+STAGING | "staging"
+
+
+
diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md
index 5f03e85e..bbe30a93 100644
--- a/docs/NewCampaign.md
+++ b/docs/NewCampaign.md
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
-**evaluationGroupId** | **Integer** | 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<Integer>** | 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]
+**evaluationGroupId** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
@@ -45,6 +45,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/NewCampaignGroup.md b/docs/NewCampaignGroup.md
index ec4821e7..73199ce1 100644
--- a/docs/NewCampaignGroup.md
+++ b/docs/NewCampaignGroup.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **String** | The name of this campaign access group. |
+**name** | **String** | The name of the campaign access group. |
**description** | **String** | A longer description of the campaign access group. | [optional]
**subscribedApplicationsIds** | **List<Integer>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
**campaignIds** | **List<Integer>** | A list of IDs of the campaigns that are part of the campaign access group. | [optional]
diff --git a/docs/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md
index ef14a2cc..763fa515 100644
--- a/docs/NewCampaignTemplate.md
+++ b/docs/NewCampaignTemplate.md
@@ -43,6 +43,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md
index 2595a5e7..43596cec 100644
--- a/docs/NewCustomerSessionV2.md
+++ b/docs/NewCustomerSessionV2.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**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**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional]
**referralCode** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional]
-**loyaltyCards** | **List<String>** | Any loyalty cards used. | [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). | [optional]
**cartItems** | [**List<CartItem>**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional]
**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
diff --git a/docs/NewInvitation.md b/docs/NewInvitation.md
index f55aa6ba..9c8f4203 100644
--- a/docs/NewInvitation.md
+++ b/docs/NewInvitation.md
@@ -7,11 +7,11 @@ Parameters for inviting a new user.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the user being invited. | [optional]
-**email** | **String** | |
-**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` | [optional]
-**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. We recommend using this flag over using the `acl` with value `{\"Role\": 127}`. | [optional]
-**roles** | **List<Integer>** | An array of role IDs to assign to the new user. | [optional]
+**name** | **String** | Name of the user. | [optional]
+**email** | **String** | Email address of the user. |
+**isAdmin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
+**roles** | **List<Integer>** | A list of the IDs of the roles assigned to the user. | [optional]
+**acl** | **String** | Indicates the access level of the user. | [optional]
diff --git a/docs/NewInviteEmail.md b/docs/NewInviteEmail.md
index 14bc426b..9c199a1a 100644
--- a/docs/NewInviteEmail.md
+++ b/docs/NewInviteEmail.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**email** | **String** | |
-**token** | **String** | |
+**email** | **String** | Email address of the user. |
+**token** | **String** | Invitation token of the user. |
diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md
index fc938fa1..d0965865 100644
--- a/docs/NewLoyaltyProgram.md
+++ b/docs/NewLoyaltyProgram.md
@@ -15,8 +15,10 @@ Name | Type | Description | Notes
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |
**usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |
-**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
+**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
+**tiersExpireIn** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
+**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
**tiers** | [**List<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
**timezone** | **String** | A string containing an IANA timezone descriptor. |
@@ -24,6 +26,15 @@ Name | Type | Description | Notes
+## Enum: TiersExpirationPolicyEnum
+
+Name | Value
+---- | -----
+TIER_START_DATE | "tier_start_date"
+PROGRAM_JOIN_DATE | "program_join_date"
+
+
+
## Enum: TiersDowngradePolicyEnum
Name | Value
@@ -33,3 +44,13 @@ BALANCE_BASED | "balance_based"
+## Enum: ProgramJoinPolicyEnum
+
+Name | Value
+---- | -----
+NOT_JOIN | "not_join"
+POINTS_ACTIVATED | "points_activated"
+POINTS_EARNED | "points_earned"
+
+
+
diff --git a/docs/NewNotificationTest.md b/docs/NewNotificationTest.md
index 84ae8c7b..a3e12ad9 100644
--- a/docs/NewNotificationTest.md
+++ b/docs/NewNotificationTest.md
@@ -7,8 +7,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**TypeEnum**](#TypeEnum) | The notification type. |
-**queryParams** | **List<String>** | Array of query parameters. | [optional]
-**headers** | **List<String>** | List of API HTTP headers for the given webhook-based notification. | [optional]
+**queryParams** | **Map<String, String>** | Array of query parameters. | [optional]
+**headers** | **Map<String, String>** | List of API HTTP headers for the given webhook-based notification. | [optional]
**verb** | [**VerbEnum**](#VerbEnum) | API method for this notification. |
**url** | **String** | API URL for the given notification. |
**payload** | **String** | API payload of this notification. |
@@ -22,12 +22,14 @@ Name | Value
CAMPAIGN | "campaign"
LOYALTY_ADDED_DEDUCTED_POINTS | "loyalty_added_deducted_points"
COUPON | "coupon"
+EXPIRING_COUPONS | "expiring_coupons"
EXPIRING_POINTS | "expiring_points"
PENDING_TO_ACTIVE_POINTS | "pending_to_active_points"
STRIKETHROUGH_PRICING | "strikethrough_pricing"
TIER_DOWNGRADE | "tier_downgrade"
TIER_UPGRADE | "tier_upgrade"
TIER_WILL_DOWNGRADE | "tier_will_downgrade"
+CARD_EXPIRING_POINTS | "card_expiring_points"
diff --git a/docs/NewRoleV2.md b/docs/NewRoleV2.md
index 08bda01e..b2351704 100644
--- a/docs/NewRoleV2.md
+++ b/docs/NewRoleV2.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the role. |
**description** | **String** | Description of the role. |
**permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional]
-**members** | **List<Integer>** | A list of user identifiers the role is assigned to. | [optional]
+**members** | **List<Integer>** | A list of user IDs the role is assigned to. | [optional]
diff --git a/docs/NewStore.md b/docs/NewStore.md
index 60b65a9a..13fd2b77 100644
--- a/docs/NewStore.md
+++ b/docs/NewStore.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**name** | **String** | The name of the store. |
**description** | **String** | The description of the store. |
**attributes** | [**Object**](.md) | The attributes of the store. | [optional]
-**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. |
+**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. **Note**: You cannot edit the `integrationId` after the store has been created. |
diff --git a/docs/NewUser.md b/docs/NewUser.md
index d155372b..89f9eacc 100644
--- a/docs/NewUser.md
+++ b/docs/NewUser.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**email** | **String** | The email address associated with your account. |
+**email** | **String** | The email address associated with the user profile. |
**password** | **String** | The password for your account. |
**name** | **String** | Your name. | [optional]
**inviteToken** | **String** | |
diff --git a/docs/NotificationListItem.md b/docs/NotificationListItem.md
new file mode 100644
index 00000000..0e021bd9
--- /dev/null
+++ b/docs/NotificationListItem.md
@@ -0,0 +1,15 @@
+
+
+# NotificationListItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notificationId** | **Integer** | The ID of the notification. |
+**notificationName** | **String** | The name of the notification. |
+**entityId** | **Integer** | The ID of the entity to which this notification belongs. For example, in case of a loyalty notification, this value is the ID of the loyalty program. |
+**enabled** | **Boolean** | Indicates whether the notification is activated. |
+
+
+
diff --git a/docs/NotificationTest.md b/docs/NotificationTest.md
index 9007c5a5..5d5b36eb 100644
--- a/docs/NotificationTest.md
+++ b/docs/NotificationTest.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**httpResponse** | **String** | The returned http response. |
-**httpStatus** | **String** | The returned http status code and status message. |
+**httpStatus** | **Integer** | The returned http status code. |
diff --git a/docs/PatchItemCatalogAction.md b/docs/PatchItemCatalogAction.md
index 5eb2e300..ee27c32c 100644
--- a/docs/PatchItemCatalogAction.md
+++ b/docs/PatchItemCatalogAction.md
@@ -2,7 +2,7 @@
# PatchItemCatalogAction
-The specific properties of the \"PATCH\" catalog sync action.
+The specific properties of the \"PATCH\" catalog sync action. **Note:** - If you do not provide a new `price` value, the existing `price` value is retained. - If you do not provide a new `product` value, the `product` value is set to `null`.
## Properties
Name | Type | Description | Notes
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
**sku** | **String** | The unique SKU of the item to patch. |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. | [optional]
**attributes** | [**Object**](.md) | The attributes of the item to patch. | [optional]
+**product** | [**Product**](Product.md) | | [optional]
**createIfNotExists** | **Boolean** | Indicates whether to create an item if the SKU does not exist. | [optional]
diff --git a/docs/PendingPointsNotificationPolicy.md b/docs/PendingPointsNotificationPolicy.md
index a2843431..9b4db933 100644
--- a/docs/PendingPointsNotificationPolicy.md
+++ b/docs/PendingPointsNotificationPolicy.md
@@ -7,6 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
diff --git a/docs/Product.md b/docs/Product.md
new file mode 100644
index 00000000..dc0d1480
--- /dev/null
+++ b/docs/Product.md
@@ -0,0 +1,13 @@
+
+
+# Product
+
+The specific properties of the product this item belongs to, if available.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the product. |
+
+
+
diff --git a/docs/RoleV2.md b/docs/RoleV2.md
index a404e9dc..bfcd0b68 100644
--- a/docs/RoleV2.md
+++ b/docs/RoleV2.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the role. | [optional]
**description** | **String** | Description of the role. | [optional]
**permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional]
-**members** | **List<Integer>** | A list of user identifiers the role is assigned to. | [optional]
+**members** | **List<Integer>** | A list of user IDs the role is assigned to. | [optional]
diff --git a/docs/RoleV2Base.md b/docs/RoleV2Base.md
index 24d573f1..2557f618 100644
--- a/docs/RoleV2Base.md
+++ b/docs/RoleV2Base.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the role. | [optional]
**description** | **String** | Description of the role. | [optional]
**permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional]
-**members** | **List<Integer>** | A list of user identifiers the role is assigned to. | [optional]
+**members** | **List<Integer>** | A list of user IDs the role is assigned to. | [optional]
diff --git a/docs/RoleV2Permissions.md b/docs/RoleV2Permissions.md
index 1897ee76..270f4d01 100644
--- a/docs/RoleV2Permissions.md
+++ b/docs/RoleV2Permissions.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**permissionSets** | [**List<RoleV2PermissionSet>**](RoleV2PermissionSet.md) | List of grouped logical operations to use as a reference in the roles section. Each group of logical operations has a name. | [optional]
+**permissionSets** | [**List<RoleV2PermissionSet>**](RoleV2PermissionSet.md) | List of grouped logical operations referenced by roles. | [optional]
**roles** | [**RoleV2RolesGroup**](RoleV2RolesGroup.md) | | [optional]
diff --git a/docs/SamlConnectionInternal.md b/docs/SamlConnectionInternal.md
new file mode 100644
index 00000000..23e731e8
--- /dev/null
+++ b/docs/SamlConnectionInternal.md
@@ -0,0 +1,13 @@
+
+
+# SamlConnectionInternal
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | ID of the SAML service. |
+**metadataDocument** | **String** | Identity Provider metadata XML document. |
+
+
+
diff --git a/docs/SamlLoginEndpoint.md b/docs/SamlLoginEndpoint.md
index ff6ae9d2..11e32a8b 100644
--- a/docs/SamlLoginEndpoint.md
+++ b/docs/SamlLoginEndpoint.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Integer** | ID of the SAML login endpoint. |
**name** | **String** | ID of the SAML service. |
-**loginURL** | **String** | Single Sign-On URL. |
+**loginURL** | **String** | The single sign-on URL. |
diff --git a/docs/Store.md b/docs/Store.md
index f6d85aea..5cddd021 100644
--- a/docs/Store.md
+++ b/docs/Store.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**name** | **String** | The name of the store. |
**description** | **String** | The description of the store. |
**attributes** | [**Object**](.md) | The attributes of the store. | [optional]
-**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. |
+**integrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. **Note**: You cannot edit the `integrationId` after the store has been created. |
**applicationId** | **Integer** | The ID of the application that owns this entity. |
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update on this entity. |
**linkedCampaignIds** | **List<Integer>** | A list of IDs of the campaigns that are linked with current store. | [optional]
diff --git a/docs/TalangAttribute.md b/docs/TalangAttribute.md
index 50b0eaa7..9135ab0c 100644
--- a/docs/TalangAttribute.md
+++ b/docs/TalangAttribute.md
@@ -41,6 +41,7 @@ GIVEAWAY | "Giveaway"
REFERRAL | "Referral"
SESSION | "Session"
STORE | "Store"
+ACHIEVEMENTS | "Achievements"
diff --git a/docs/TemplateArgDef.md b/docs/TemplateArgDef.md
index 13777b0e..cda5288d 100644
--- a/docs/TemplateArgDef.md
+++ b/docs/TemplateArgDef.md
@@ -8,7 +8,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**TypeEnum**](#TypeEnum) | The type of value this argument expects. |
-**description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. |
+**description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | [optional]
**title** | **String** | A campaigner friendly name for the argument, this will be shown in the rule editor. |
**ui** | [**Object**](.md) | Arbitrary metadata that may be used to render an input for this argument. |
**picklistID** | **Integer** | ID of the picklist linked to a template. | [optional]
diff --git a/docs/TierDowngradeNotificationPolicy.md b/docs/TierDowngradeNotificationPolicy.md
index 10d51fb3..831cab4f 100644
--- a/docs/TierDowngradeNotificationPolicy.md
+++ b/docs/TierDowngradeNotificationPolicy.md
@@ -7,6 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the notification. |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
diff --git a/docs/TierUpgradeNotificationPolicy.md b/docs/TierUpgradeNotificationPolicy.md
index 1de5e72c..997866db 100644
--- a/docs/TierUpgradeNotificationPolicy.md
+++ b/docs/TierUpgradeNotificationPolicy.md
@@ -7,6 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
diff --git a/docs/TierWillDowngradeNotificationPolicy.md b/docs/TierWillDowngradeNotificationPolicy.md
index bcd21009..a5cde860 100644
--- a/docs/TierWillDowngradeNotificationPolicy.md
+++ b/docs/TierWillDowngradeNotificationPolicy.md
@@ -7,6 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the notification. |
+**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
**triggers** | [**List<TierWillDowngradeNotificationTrigger>**](TierWillDowngradeNotificationTrigger.md) | |
diff --git a/docs/TimePoint.md b/docs/TimePoint.md
index 53715ab9..3e69e308 100644
--- a/docs/TimePoint.md
+++ b/docs/TimePoint.md
@@ -2,17 +2,17 @@
# TimePoint
-The absolute duration after which the achievement is reset for a particular customer profile.
+The absolute duration after which the achievement ends and resets for a particular customer profile. **Note**: The duration follows the time zone of the Application this achievement belongs to.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**month** | **Integer** | The achievement is reset in this month. **Note**: Only applicable if the period is set to `Y`. | [optional]
-**dayOfMonth** | **Integer** | The achievement is reset on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. | [optional]
-**dayOfWeek** | **Integer** | The achievement is reset on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. | [optional]
-**hour** | **Integer** | The achievement is reset at this hour. |
-**minute** | **Integer** | The achievement is reset at this minute. |
-**second** | **Integer** | The achievement is reset at this second. |
+**month** | **Integer** | The achievement ends and resets in this month. **Note**: Only applicable if the period is set to `Y`. | [optional]
+**dayOfMonth** | **Integer** | The achievement ends and resets on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. | [optional]
+**dayOfWeek** | **Integer** | The achievement ends and resets on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. | [optional]
+**hour** | **Integer** | The achievement ends and resets at this hour. |
+**minute** | **Integer** | The achievement ends and resets at this minute. |
+**second** | **Integer** | The achievement ends and resets at this second. |
diff --git a/docs/UpdateAchievement.md b/docs/UpdateAchievement.md
index 017e39e6..a4f88953 100644
--- a/docs/UpdateAchievement.md
+++ b/docs/UpdateAchievement.md
@@ -6,8 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+**name** | **String** | The internal name of the achievement used in API requests. | [optional]
**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional]
**description** | **String** | A description of the achievement. | [optional]
+**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
+**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. | [optional]
+**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
diff --git a/docs/UpdateApplicationAPIKey.md b/docs/UpdateApplicationAPIKey.md
new file mode 100644
index 00000000..b98defda
--- /dev/null
+++ b/docs/UpdateApplicationAPIKey.md
@@ -0,0 +1,12 @@
+
+
+# UpdateApplicationAPIKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timeOffset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. |
+
+
+
diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md
index a39ff467..b7361845 100644
--- a/docs/UpdateCampaign.md
+++ b/docs/UpdateCampaign.md
@@ -44,6 +44,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md
index e4b70edf..da80f1e2 100644
--- a/docs/UpdateCampaignGroup.md
+++ b/docs/UpdateCampaignGroup.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **String** | The name of this campaign access group. |
+**name** | **String** | The name of the campaign access group. |
**description** | **String** | A longer description of the campaign access group. | [optional]
**subscribedApplicationsIds** | **List<Integer>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
**campaignIds** | **List<Integer>** | A list of IDs of the campaigns that are part of the campaign access group. | [optional]
diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md
index eafc7aaf..29628490 100644
--- a/docs/UpdateCampaignTemplate.md
+++ b/docs/UpdateCampaignTemplate.md
@@ -45,6 +45,7 @@ REFERRALS | "referrals"
LOYALTY | "loyalty"
GIVEAWAYS | "giveaways"
STRIKETHROUGH | "strikethrough"
+ACHIEVEMENTS | "achievements"
diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md
index 7d762668..8f4d62cc 100644
--- a/docs/UpdateLoyaltyProgram.md
+++ b/docs/UpdateLoyaltyProgram.md
@@ -15,12 +15,23 @@ Name | Type | Description | Notes
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
**usersPerCardLimit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
-**tiersExpireIn** | **String** | The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
+**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
+**tiersExpireIn** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**tiersDowngradePolicy** | [**TiersDowngradePolicyEnum**](#TiersDowngradePolicyEnum) | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
+**programJoinPolicy** | [**ProgramJoinPolicyEnum**](#ProgramJoinPolicyEnum) | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**tiers** | [**List<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
+## Enum: TiersExpirationPolicyEnum
+
+Name | Value
+---- | -----
+TIER_START_DATE | "tier_start_date"
+PROGRAM_JOIN_DATE | "program_join_date"
+
+
+
## Enum: TiersDowngradePolicyEnum
Name | Value
@@ -30,3 +41,13 @@ BALANCE_BASED | "balance_based"
+## Enum: ProgramJoinPolicyEnum
+
+Name | Value
+---- | -----
+NOT_JOIN | "not_join"
+POINTS_ACTIVATED | "points_activated"
+POINTS_EARNED | "points_earned"
+
+
+
diff --git a/docs/UpdateUser.md b/docs/UpdateUser.md
index b179742c..15cc8535 100644
--- a/docs/UpdateUser.md
+++ b/docs/UpdateUser.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **String** | The user name. | [optional]
-**policy** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [optional]
-**state** | [**StateEnum**](#StateEnum) | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional]
-**roles** | **List<Integer>** | List of roles to assign to the user. | [optional]
-**applicationNotificationSubscriptions** | [**Object**](.md) | | [optional]
-**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. | [optional]
+**name** | **String** | Name of the user. | [optional]
+**state** | [**StateEnum**](#StateEnum) | The state of the user. - `deactivated`: The user has been deactivated. - `active`: The user is active. **Note**: Only `admin` users can update the state of another user. | [optional]
+**isAdmin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
+**policy** | **String** | Indicates the access level of the user. | [optional]
+**roles** | **List<Integer>** | A list of the IDs of the roles assigned to the user. **Note**: Use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint to find the ID of a role. | [optional]
+**applicationNotificationSubscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
diff --git a/docs/User.md b/docs/User.md
index 47a789e6..0190e234 100644
--- a/docs/User.md
+++ b/docs/User.md
@@ -10,19 +10,19 @@ Name | Type | Description | Notes
**id** | **Integer** | Internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
-**email** | **String** | The email address associated with your account. |
+**email** | **String** | The email address associated with the user profile. |
**accountId** | **Integer** | The ID of the account that owns this entity. |
-**inviteToken** | **String** | Invite token, empty if the user as already accepted their invite. |
-**state** | [**StateEnum**](#StateEnum) | Current user state. |
-**name** | **String** | Full name |
-**policy** | [**Object**](.md) | User ACL Policy |
-**latestFeedTimestamp** | [**OffsetDateTime**](OffsetDateTime.md) | Latest timestamp the user has been notified for feed. | [optional]
-**roles** | **List<Integer>** | Contains a list of all roles the user is a member of. | [optional]
-**applicationNotificationSubscriptions** | [**Object**](.md) | | [optional]
-**authMethod** | **String** | The Authentication method for this user. | [optional]
-**isAdmin** | **Boolean** | An indication of whether the user has admin permissions. | [optional]
-**lastSignedIn** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time when the user last signed in to Talon.One. | [optional]
-**lastAccessed** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time of the user's last activity after signing in to Talon.One. | [optional]
+**name** | **String** | Name of the user. |
+**state** | [**StateEnum**](#StateEnum) | State of the user. |
+**inviteToken** | **String** | Invitation token of the user. **Note**: If the user has already accepted their invitation, this is `null`. |
+**isAdmin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
+**policy** | [**Object**](.md) | Access level of the user. |
+**roles** | **List<Integer>** | A list of the IDs of the roles assigned to the user. | [optional]
+**authMethod** | **String** | Authentication method for this user. | [optional]
+**applicationNotificationSubscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
+**lastSignedIn** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the user last signed in to Talon.One. | [optional]
+**lastAccessed** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the user's last activity after signing in to Talon.One. | [optional]
+**latestFeedTimestamp** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the user was notified for feed. | [optional]
diff --git a/pom.xml b/pom.xml
index 165f24d0..739c54db 100644
--- a/pom.xml
+++ b/pom.xml
@@ -5,7 +5,7 @@
talon-one-client
jar
talon-one-client
- 6.0.1
+ 7.0.0
https://github.com/talon-one/maven-artefacts
Talon.One unified JAVA SDK. It allows for programmatic access to the integration and management API with their respective authentication strategies
diff --git a/src/main/java/one/talon/ApiClient.java b/src/main/java/one/talon/ApiClient.java
index c76b417e..52323709 100644
--- a/src/main/java/one/talon/ApiClient.java
+++ b/src/main/java/one/talon/ApiClient.java
@@ -132,7 +132,7 @@ private void init() {
json = new JSON();
// Set default User-Agent.
- setUserAgent("OpenAPI-Generator/6.0.1/java");
+ setUserAgent("OpenAPI-Generator/7.0.0/java");
authentications = new HashMap();
}
diff --git a/src/main/java/one/talon/api/IntegrationApi.java b/src/main/java/one/talon/api/IntegrationApi.java
index b65a06c4..7261db53 100644
--- a/src/main/java/one/talon/api/IntegrationApi.java
+++ b/src/main/java/one/talon/api/IntegrationApi.java
@@ -592,7 +592,7 @@ public okhttp3.Call createReferralsForMultipleAdvocatesAsync(NewReferralsForMult
}
/**
* Build call for deleteAudienceMembershipsV2
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -651,7 +651,7 @@ private okhttp3.Call deleteAudienceMembershipsV2ValidateBeforeCall(Integer audie
/**
* Delete audience memberships
* Remove all members from this audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @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
@@ -668,7 +668,7 @@ public void deleteAudienceMembershipsV2(Integer audienceId) throws ApiException
/**
* Delete audience memberships
* Remove all members from this audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @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
* @http.response.details
@@ -687,7 +687,7 @@ public ApiResponse deleteAudienceMembershipsV2WithHttpInfo(Integer audienc
/**
* Delete audience memberships (asynchronously)
* Remove all members from this audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (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
@@ -707,7 +707,7 @@ public okhttp3.Call deleteAudienceMembershipsV2Async(Integer audienceId, final A
}
/**
* Build call for deleteAudienceV2
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -767,7 +767,7 @@ private okhttp3.Call deleteAudienceV2ValidateBeforeCall(Integer audienceId, fina
/**
* 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).
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @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
@@ -785,7 +785,7 @@ public void deleteAudienceV2(Integer audienceId) throws ApiException {
/**
* Delete audience
* Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. **Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience).
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @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
* @http.response.details
@@ -805,7 +805,7 @@ public ApiResponse deleteAudienceV2WithHttpInfo(Integer audienceId) throws
/**
* 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).
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (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
@@ -1075,6 +1075,7 @@ public okhttp3.Call deleteCustomerDataAsync(String integrationId, final ApiCallb
* @param coupons Set to `true` to include coupon information in the response. (optional)
* @param loyalty Set to `true` to include loyalty information in the response. (optional)
* @param giveaways Set to `true` to include giveaways information in the response. (optional)
+ * @param achievements Set to `true` to include achievement information in the response. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -1086,7 +1087,7 @@ public okhttp3.Call deleteCustomerDataAsync(String integrationId, final ApiCallb
| 404 | Not found | - |
*/
- public okhttp3.Call getCustomerInventoryCall(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getCustomerInventoryCall(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, Boolean achievements, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
@@ -1115,6 +1116,10 @@ public okhttp3.Call getCustomerInventoryCall(String integrationId, Boolean profi
localVarQueryParams.addAll(localVarApiClient.parameterToPair("giveaways", giveaways));
}
+ if (achievements != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("achievements", achievements));
+ }
+
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
@@ -1137,7 +1142,7 @@ public okhttp3.Call getCustomerInventoryCall(String integrationId, Boolean profi
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, Boolean achievements, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'integrationId' is set
if (integrationId == null) {
@@ -1145,7 +1150,7 @@ private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId
}
- okhttp3.Call localVarCall = getCustomerInventoryCall(integrationId, profile, referrals, coupons, loyalty, giveaways, _callback);
+ okhttp3.Call localVarCall = getCustomerInventoryCall(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements, _callback);
return localVarCall;
}
@@ -1159,6 +1164,7 @@ private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId
* @param coupons Set to `true` to include coupon information in the response. (optional)
* @param loyalty Set to `true` to include loyalty information in the response. (optional)
* @param giveaways Set to `true` to include giveaways information in the response. (optional)
+ * @param achievements Set to `true` to include achievement information in the response. (optional)
* @return CustomerInventory
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1169,8 +1175,8 @@ private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId
| 404 | Not found | - |
*/
- public CustomerInventory getCustomerInventory(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways) throws ApiException {
- ApiResponse localVarResp = getCustomerInventoryWithHttpInfo(integrationId, profile, referrals, coupons, loyalty, giveaways);
+ public CustomerInventory getCustomerInventory(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, Boolean achievements) throws ApiException {
+ ApiResponse localVarResp = getCustomerInventoryWithHttpInfo(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements);
return localVarResp.getData();
}
@@ -1183,6 +1189,7 @@ public CustomerInventory getCustomerInventory(String integrationId, Boolean prof
* @param coupons Set to `true` to include coupon information in the response. (optional)
* @param loyalty Set to `true` to include loyalty information in the response. (optional)
* @param giveaways Set to `true` to include giveaways information in the response. (optional)
+ * @param achievements Set to `true` to include achievement information in the response. (optional)
* @return ApiResponse<CustomerInventory>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1193,8 +1200,8 @@ public CustomerInventory getCustomerInventory(String integrationId, Boolean prof
| 404 | Not found | - |
*/
- public ApiResponse getCustomerInventoryWithHttpInfo(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways) throws ApiException {
- okhttp3.Call localVarCall = getCustomerInventoryValidateBeforeCall(integrationId, profile, referrals, coupons, loyalty, giveaways, null);
+ public ApiResponse getCustomerInventoryWithHttpInfo(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, Boolean achievements) throws ApiException {
+ okhttp3.Call localVarCall = getCustomerInventoryValidateBeforeCall(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -1208,6 +1215,7 @@ public ApiResponse getCustomerInventoryWithHttpInfo(String in
* @param coupons Set to `true` to include coupon information in the response. (optional)
* @param loyalty Set to `true` to include loyalty information in the response. (optional)
* @param giveaways Set to `true` to include giveaways information in the response. (optional)
+ * @param achievements Set to `true` to include achievement information in the response. (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
@@ -1219,9 +1227,9 @@ public ApiResponse getCustomerInventoryWithHttpInfo(String in
| 404 | Not found | - |
*/
- public okhttp3.Call getCustomerInventoryAsync(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getCustomerInventoryAsync(String integrationId, Boolean profile, Boolean referrals, Boolean coupons, Boolean loyalty, Boolean giveaways, Boolean achievements, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = getCustomerInventoryValidateBeforeCall(integrationId, profile, referrals, coupons, loyalty, giveaways, _callback);
+ okhttp3.Call localVarCall = getCustomerInventoryValidateBeforeCall(integrationId, profile, referrals, coupons, loyalty, giveaways, achievements, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
@@ -1633,7 +1641,7 @@ public okhttp3.Call getLoyaltyCardBalancesAsync(Integer loyaltyProgramId, String
* @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. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback Callback for upload/download progress
* @return Call to execute
@@ -1720,7 +1728,7 @@ private okhttp3.Call getLoyaltyCardPointsValidateBeforeCall(Integer loyaltyProgr
* @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. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return InlineResponse2003
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1745,7 +1753,7 @@ public InlineResponse2003 getLoyaltyCardPoints(Integer loyaltyProgramId, String
* @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. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return ApiResponse<InlineResponse2003>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1771,7 +1779,7 @@ public ApiResponse getLoyaltyCardPointsWithHttpInfo(Integer
* @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. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1798,9 +1806,9 @@ public okhttp3.Call getLoyaltyCardPointsAsync(Integer loyaltyProgramId, String l
* @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. (required)
* @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 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 pageSize The number of items in this response. (optional, default to 1000)
+ * @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
* @return Call to execute
@@ -1895,9 +1903,9 @@ private okhttp3.Call getLoyaltyCardTransactionsValidateBeforeCall(Integer loyalt
* @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. (required)
* @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 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 pageSize The number of items in this response. (optional, default to 1000)
+ * @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 InlineResponse2001
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1922,9 +1930,9 @@ public InlineResponse2001 getLoyaltyCardTransactions(Integer loyaltyProgramId, S
* @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. (required)
* @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 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 pageSize The number of items in this response. (optional, default to 1000)
+ * @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<InlineResponse2001>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1950,9 +1958,9 @@ public ApiResponse getLoyaltyCardTransactionsWithHttpInfo(In
* @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. (required)
* @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 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 pageSize The number of items in this response. (optional, default to 1000)
+ * @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
* @return The request call
@@ -1979,7 +1987,7 @@ public okhttp3.Call getLoyaltyCardTransactionsAsync(Integer loyaltyProgramId, St
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback Callback for upload/download progress
* @return Call to execute
@@ -2066,7 +2074,7 @@ private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(Integer lo
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return InlineResponse2004
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2091,7 +2099,7 @@ public InlineResponse2004 getLoyaltyProgramProfilePoints(Integer loyaltyProgramI
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return ApiResponse<InlineResponse2004>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2117,7 +2125,7 @@ public ApiResponse getLoyaltyProgramProfilePointsWithHttpInf
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
- * @param pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2144,9 +2152,9 @@ public okhttp3.Call getLoyaltyProgramProfilePointsAsync(Integer loyaltyProgramId
* @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 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 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 pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback Callback for upload/download progress
* @return Call to execute
@@ -2241,9 +2249,9 @@ private okhttp3.Call getLoyaltyProgramProfileTransactionsValidateBeforeCall(Inte
* @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 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 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 pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return InlineResponse2002
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2268,9 +2276,9 @@ public InlineResponse2002 getLoyaltyProgramProfileTransactions(Integer loyaltyPr
* @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 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 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 pageSize The number of items in this response. (optional, default to 50)
+ * @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)
* @return ApiResponse<InlineResponse2002>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2296,9 +2304,9 @@ public ApiResponse getLoyaltyProgramProfileTransactionsWithH
* @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 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 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 pageSize The number of items in this response. (optional, default to 50)
+ * @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 _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2906,7 +2914,7 @@ private okhttp3.Call syncCatalogValidateBeforeCall(Integer catalogId, CatalogSyn
/**
* Sync cart item catalog
- * Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: - Add an item to the catalog. - Edit the attributes of an item in the catalog. - Edit the attributes of more than one item in the catalog. - Remove an item from the catalog. - Remove more than one item from the catalog. **Note:** For more information, see [our documentation on 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-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) 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\": \"shoe\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100 }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\" }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items at once</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 several items from the catalog at once</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 one or more of the following actions for a given cart item catalog: - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog. You can 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**: 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 several 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>Editing 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>Editing the attributes of several 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 several 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 body body (required)
* @return Catalog
@@ -2927,7 +2935,7 @@ public Catalog syncCatalog(Integer catalogId, CatalogSyncRequest body) throws Ap
/**
* Sync cart item catalog
- * Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: - Add an item to the catalog. - Edit the attributes of an item in the catalog. - Edit the attributes of more than one item in the catalog. - Remove an item from the catalog. - Remove more than one item from the catalog. **Note:** For more information, see [our documentation on 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-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) 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\": \"shoe\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100 }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\" }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items at once</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 several items from the catalog at once</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 one or more of the following actions for a given cart item catalog: - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog. You can 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**: 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 several 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>Editing 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>Editing the attributes of several 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 several 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 body body (required)
* @return ApiResponse<Catalog>
@@ -2949,7 +2957,7 @@ public ApiResponse syncCatalogWithHttpInfo(Integer catalogId, CatalogSy
/**
* Sync cart item catalog (asynchronously)
- * Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: - Add an item to the catalog. - Edit the attributes of an item in the catalog. - Edit the attributes of more than one item in the catalog. - Remove an item from the catalog. - Remove more than one item from the catalog. **Note:** For more information, see [our documentation on 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-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) 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\": \"shoe\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100 }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\" }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items at once</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 several items from the catalog at once</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 one or more of the following actions for a given cart item catalog: - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog. You can 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**: 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 several 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>Editing 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>Editing the attributes of several 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 several 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 body body (required)
* @param _callback The callback to be executed when the API call finishes
@@ -3111,7 +3119,7 @@ public okhttp3.Call trackEventV2Async(IntegrationEventV2Request body, String sil
}
/**
* Build call for updateAudienceCustomersAttributes
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -3176,7 +3184,7 @@ private okhttp3.Call updateAudienceCustomersAttributesValidateBeforeCall(Integer
/**
* Update profile attributes for all customers in audience
* Update the specified profile attributes to the provided values for all customers in the specified audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3194,7 +3202,7 @@ public void updateAudienceCustomersAttributes(Integer audienceId, Object body) t
/**
* Update profile attributes for all customers in audience
* Update the specified profile attributes to the provided values for all customers in the specified audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3214,7 +3222,7 @@ public ApiResponse updateAudienceCustomersAttributesWithHttpInfo(Integer a
/**
* Update profile attributes for all customers in audience (asynchronously)
* Update the specified profile attributes to the provided values for all customers in the specified audience.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -3235,7 +3243,7 @@ public okhttp3.Call updateAudienceCustomersAttributesAsync(Integer audienceId, O
}
/**
* Build call for updateAudienceV2
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -3300,7 +3308,7 @@ private okhttp3.Call updateAudienceV2ValidateBeforeCall(Integer audienceId, Upda
/**
* Update audience name
* Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @return Audience
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3320,7 +3328,7 @@ public Audience updateAudienceV2(Integer audienceId, UpdateAudience body) throws
/**
* Update audience name
* Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @return ApiResponse<Audience>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3341,7 +3349,7 @@ public ApiResponse updateAudienceV2WithHttpInfo(Integer audienceId, Up
/**
* Update audience name (asynchronously)
* Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
- * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). (required)
+ * @param audienceId The ID of the audience. (required)
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -3421,7 +3429,7 @@ private okhttp3.Call updateCustomerProfileAudiencesValidateBeforeCall(CustomerPr
/**
* Update multiple customer profiles' audiences
- * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * 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 body body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3439,7 +3447,7 @@ public void updateCustomerProfileAudiences(CustomerProfileAudienceRequest body)
/**
* Update multiple customer profiles' audiences
- * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * 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 body body (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -3459,7 +3467,7 @@ public ApiResponse updateCustomerProfileAudiencesWithHttpInfo(CustomerProf
/**
* Update multiple customer profiles' audiences (asynchronously)
- * Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000. **Note:** You can also add customer profiles to or remove them from an audience using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
+ * 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 body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -3758,6 +3766,7 @@ public okhttp3.Call updateCustomerProfilesV2Async(MultipleCustomerProfileIntegra
* @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 body body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (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 _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -3770,7 +3779,7 @@ public okhttp3.Call updateCustomerProfilesV2Async(MultipleCustomerProfileIntegra
| 409 | Too many requests or limit reached - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - |
*/
- public okhttp3.Call updateCustomerSessionV2Call(String customerSessionId, IntegrationRequest body, Boolean dry, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateCustomerSessionV2Call(String customerSessionId, IntegrationRequest body, Boolean dry, OffsetDateTime now, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
@@ -3783,6 +3792,10 @@ public okhttp3.Call updateCustomerSessionV2Call(String customerSessionId, Integr
localVarQueryParams.addAll(localVarApiClient.parameterToPair("dry", dry));
}
+ if (now != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("now", now));
+ }
+
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
@@ -3805,7 +3818,7 @@ public okhttp3.Call updateCustomerSessionV2Call(String customerSessionId, Integr
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(String customerSessionId, IntegrationRequest body, Boolean dry, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(String customerSessionId, IntegrationRequest body, Boolean dry, OffsetDateTime now, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'customerSessionId' is set
if (customerSessionId == null) {
@@ -3818,7 +3831,7 @@ private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(String customerSe
}
- okhttp3.Call localVarCall = updateCustomerSessionV2Call(customerSessionId, body, dry, _callback);
+ okhttp3.Call localVarCall = updateCustomerSessionV2Call(customerSessionId, body, dry, now, _callback);
return localVarCall;
}
@@ -3829,6 +3842,7 @@ private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(String customerSe
* @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 body body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (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)
* @return IntegrationStateV2
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3840,8 +3854,8 @@ private okhttp3.Call updateCustomerSessionV2ValidateBeforeCall(String customerSe
| 409 | Too many requests or limit reached - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - |
*/
- public IntegrationStateV2 updateCustomerSessionV2(String customerSessionId, IntegrationRequest body, Boolean dry) throws ApiException {
- ApiResponse localVarResp = updateCustomerSessionV2WithHttpInfo(customerSessionId, body, dry);
+ public IntegrationStateV2 updateCustomerSessionV2(String customerSessionId, IntegrationRequest body, Boolean dry, OffsetDateTime now) throws ApiException {
+ ApiResponse localVarResp = updateCustomerSessionV2WithHttpInfo(customerSessionId, body, dry, now);
return localVarResp.getData();
}
@@ -3851,6 +3865,7 @@ public IntegrationStateV2 updateCustomerSessionV2(String customerSessionId, Inte
* @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 body body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (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)
* @return ApiResponse<IntegrationStateV2>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3862,8 +3877,8 @@ public IntegrationStateV2 updateCustomerSessionV2(String customerSessionId, Inte
| 409 | Too many requests or limit reached - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - |
*/
- public ApiResponse updateCustomerSessionV2WithHttpInfo(String customerSessionId, IntegrationRequest body, Boolean dry) throws ApiException {
- okhttp3.Call localVarCall = updateCustomerSessionV2ValidateBeforeCall(customerSessionId, body, dry, null);
+ public ApiResponse updateCustomerSessionV2WithHttpInfo(String customerSessionId, IntegrationRequest body, Boolean dry, OffsetDateTime now) throws ApiException {
+ okhttp3.Call localVarCall = updateCustomerSessionV2ValidateBeforeCall(customerSessionId, body, dry, now, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -3874,6 +3889,7 @@ public ApiResponse updateCustomerSessionV2WithHttpInfo(Strin
* @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 body body (required)
* @param dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (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 _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
@@ -3886,9 +3902,9 @@ public ApiResponse updateCustomerSessionV2WithHttpInfo(Strin
| 409 | Too many requests or limit reached - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). | - |
*/
- public okhttp3.Call updateCustomerSessionV2Async(String customerSessionId, IntegrationRequest body, Boolean dry, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateCustomerSessionV2Async(String customerSessionId, IntegrationRequest body, Boolean dry, OffsetDateTime now, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = updateCustomerSessionV2ValidateBeforeCall(customerSessionId, body, dry, _callback);
+ okhttp3.Call localVarCall = updateCustomerSessionV2ValidateBeforeCall(customerSessionId, body, dry, now, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
diff --git a/src/main/java/one/talon/api/ManagementApi.java b/src/main/java/one/talon/api/ManagementApi.java
index 3f570d78..98e9f649 100644
--- a/src/main/java/one/talon/api/ManagementApi.java
+++ b/src/main/java/one/talon/api/ManagementApi.java
@@ -30,6 +30,7 @@
import one.talon.model.Account;
import one.talon.model.AccountAdditionalCost;
import one.talon.model.AccountAnalytics;
+import one.talon.model.Achievement;
import one.talon.model.AddLoyaltyPoints;
import one.talon.model.Application;
import one.talon.model.ApplicationApiHealth;
@@ -41,16 +42,20 @@
import java.math.BigDecimal;
import one.talon.model.Campaign;
import one.talon.model.CampaignCopy;
+import one.talon.model.CampaignGroup;
import one.talon.model.CampaignSearch;
import one.talon.model.Collection;
import one.talon.model.Coupon;
+import one.talon.model.CreateAchievement;
import one.talon.model.CreateTemplateCampaign;
import one.talon.model.CreateTemplateCampaignResponse;
import one.talon.model.CustomerActivityReport;
import one.talon.model.CustomerAnalytics;
import one.talon.model.CustomerProfile;
import one.talon.model.CustomerProfileSearchQuery;
+import one.talon.model.DeactivateUserRequest;
import one.talon.model.DeductLoyaltyPoints;
+import one.talon.model.DeleteUserRequest;
import one.talon.model.ErrorResponse;
import one.talon.model.ErrorResponseWithStatus;
import one.talon.model.InlineResponse20010;
@@ -87,6 +92,10 @@
import one.talon.model.InlineResponse20041;
import one.talon.model.InlineResponse20042;
import one.talon.model.InlineResponse20043;
+import one.talon.model.InlineResponse20044;
+import one.talon.model.InlineResponse20045;
+import one.talon.model.InlineResponse20046;
+import one.talon.model.InlineResponse20047;
import one.talon.model.InlineResponse2005;
import one.talon.model.InlineResponse2006;
import one.talon.model.InlineResponse2007;
@@ -106,6 +115,8 @@
import one.talon.model.NewCouponCreationJob;
import one.talon.model.NewCoupons;
import one.talon.model.NewCouponsForMultipleRecipients;
+import one.talon.model.NewInvitation;
+import one.talon.model.NewInviteEmail;
import one.talon.model.NewPassword;
import one.talon.model.NewPasswordEmail;
import one.talon.model.NewStore;
@@ -113,10 +124,13 @@
import org.threeten.bp.OffsetDateTime;
import one.talon.model.Referral;
import one.talon.model.Role;
+import one.talon.model.RoleV2;
+import one.talon.model.RoleV2Base;
import one.talon.model.Ruleset;
import one.talon.model.Session;
import one.talon.model.Store;
import one.talon.model.TransferLoyaltyCard;
+import one.talon.model.UpdateAchievement;
import one.talon.model.UpdateCampaign;
import one.talon.model.UpdateCampaignCollection;
import one.talon.model.UpdateCollection;
@@ -124,6 +138,7 @@
import one.talon.model.UpdateCouponBatch;
import one.talon.model.UpdateLoyaltyCard;
import one.talon.model.UpdateReferral;
+import one.talon.model.UpdateUser;
import one.talon.model.User;
import one.talon.model.Webhook;
@@ -680,6 +695,148 @@ public okhttp3.Call createAccountCollectionAsync(NewCollection body, final ApiCa
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
+ /**
+ * Build call for createAchievement
+ * @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)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 409 | Conflict. An achievement with this name or title already exists. | - |
+
+ */
+ public okhttp3.Call createAchievementCall(Integer applicationId, Integer campaignId, CreateAchievement body, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = body;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}/achievements"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.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);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call createAchievementValidateBeforeCall(Integer applicationId, Integer campaignId, CreateAchievement body, 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 createAchievement(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling createAchievement(Async)");
+ }
+
+ // verify the required parameter 'body' is set
+ if (body == null) {
+ throw new ApiException("Missing the required parameter 'body' when calling createAchievement(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = createAchievementCall(applicationId, campaignId, body, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Create achievement
+ * Create a new achievement in a specific 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 body body (required)
+ * @return Achievement
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 409 | Conflict. An achievement with this name or title already exists. | - |
+
+ */
+ public Achievement createAchievement(Integer applicationId, Integer campaignId, CreateAchievement body) throws ApiException {
+ ApiResponse localVarResp = createAchievementWithHttpInfo(applicationId, campaignId, body);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Create achievement
+ * Create a new achievement in a specific 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 body body (required)
+ * @return ApiResponse<Achievement>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 409 | Conflict. An achievement with this name or title already exists. | - |
+
+ */
+ public ApiResponse createAchievementWithHttpInfo(Integer applicationId, Integer campaignId, CreateAchievement body) throws ApiException {
+ okhttp3.Call localVarCall = createAchievementValidateBeforeCall(applicationId, campaignId, body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Create achievement (asynchronously)
+ * Create a new achievement in a specific 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 body 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
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 409 | Conflict. An achievement with this name or title already exists. | - |
+
+ */
+ public okhttp3.Call createAchievementAsync(Integer applicationId, Integer campaignId, CreateAchievement body, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = createAchievementValidateBeforeCall(applicationId, campaignId, body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
/**
* Build call for createAdditionalCost
* @param body body (required)
@@ -1565,7 +1722,7 @@ public okhttp3.Call createCouponsForMultipleRecipientsAsync(Integer applicationI
return localVarCall;
}
/**
- * Build call for createPasswordRecoveryEmail
+ * Build call for createInviteEmail
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1573,14 +1730,14 @@ public okhttp3.Call createCouponsForMultipleRecipientsAsync(Integer applicationI
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | Created | - |
+ | 201 | Created | - |
*/
- public okhttp3.Call createPasswordRecoveryEmailCall(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createInviteEmailCall(NewInviteEmail body, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/password_recovery_emails";
+ String localVarPath = "/v1/invite_emails";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -1606,57 +1763,57 @@ public okhttp3.Call createPasswordRecoveryEmailCall(NewPasswordEmail body, final
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call createPasswordRecoveryEmailValidateBeforeCall(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call createInviteEmailValidateBeforeCall(NewInviteEmail body, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
- throw new ApiException("Missing the required parameter 'body' when calling createPasswordRecoveryEmail(Async)");
+ throw new ApiException("Missing the required parameter 'body' when calling createInviteEmail(Async)");
}
- okhttp3.Call localVarCall = createPasswordRecoveryEmailCall(body, _callback);
+ okhttp3.Call localVarCall = createInviteEmailCall(body, _callback);
return localVarCall;
}
/**
- * 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.
+ * 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.
* @param body body (required)
- * @return NewPasswordEmail
+ * @return NewInviteEmail
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | Created | - |
+ | 201 | Created | - |
*/
- public NewPasswordEmail createPasswordRecoveryEmail(NewPasswordEmail body) throws ApiException {
- ApiResponse localVarResp = createPasswordRecoveryEmailWithHttpInfo(body);
+ public NewInviteEmail createInviteEmail(NewInviteEmail body) throws ApiException {
+ ApiResponse localVarResp = createInviteEmailWithHttpInfo(body);
return localVarResp.getData();
}
/**
- * 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.
+ * 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.
* @param body body (required)
- * @return ApiResponse<NewPasswordEmail>
+ * @return ApiResponse<NewInviteEmail>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | Created | - |
+ | 201 | Created | - |
*/
- public ApiResponse createPasswordRecoveryEmailWithHttpInfo(NewPasswordEmail body) throws ApiException {
- okhttp3.Call localVarCall = createPasswordRecoveryEmailValidateBeforeCall(body, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ public ApiResponse createInviteEmailWithHttpInfo(NewInviteEmail body) throws ApiException {
+ okhttp3.Call localVarCall = createInviteEmailValidateBeforeCall(body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
- * 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.
+ * 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.
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1664,18 +1821,18 @@ public ApiResponse createPasswordRecoveryEmailWithHttpInfo(New
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | Created | - |
+ | 201 | Created | - |
*/
- public okhttp3.Call createPasswordRecoveryEmailAsync(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createInviteEmailAsync(NewInviteEmail body, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = createPasswordRecoveryEmailValidateBeforeCall(body, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ okhttp3.Call localVarCall = createInviteEmailValidateBeforeCall(body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
- * Build call for createSession
+ * Build call for createInviteV2
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1686,11 +1843,11 @@ public okhttp3.Call createPasswordRecoveryEmailAsync(NewPasswordEmail body, fina
| 201 | Created | - |
*/
- public okhttp3.Call createSessionCall(LoginParams body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createInviteV2Call(NewInvitation body, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/sessions";
+ String localVarPath = "/v2/invites";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -1716,24 +1873,24 @@ public okhttp3.Call createSessionCall(LoginParams body, final ApiCallback _callb
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call createSessionValidateBeforeCall(LoginParams body, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call createInviteV2ValidateBeforeCall(NewInvitation body, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
- throw new ApiException("Missing the required parameter 'body' when calling createSession(Async)");
+ throw new ApiException("Missing the required parameter 'body' when calling createInviteV2(Async)");
}
- okhttp3.Call localVarCall = createSessionCall(body, _callback);
+ okhttp3.Call localVarCall = createInviteV2Call(body, _callback);
return localVarCall;
}
/**
- * 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>
+ * 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.
* @param body body (required)
- * @return Session
+ * @return User
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1741,16 +1898,16 @@ private okhttp3.Call createSessionValidateBeforeCall(LoginParams body, final Api
| 201 | Created | - |
*/
- public Session createSession(LoginParams body) throws ApiException {
- ApiResponse localVarResp = createSessionWithHttpInfo(body);
+ public User createInviteV2(NewInvitation body) throws ApiException {
+ ApiResponse localVarResp = createInviteV2WithHttpInfo(body);
return localVarResp.getData();
}
/**
- * 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>
+ * 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.
* @param body body (required)
- * @return ApiResponse<Session>
+ * @return ApiResponse<User>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1758,15 +1915,15 @@ public Session createSession(LoginParams body) throws ApiException {
| 201 | Created | - |
*/
- public ApiResponse createSessionWithHttpInfo(LoginParams body) throws ApiException {
- okhttp3.Call localVarCall = createSessionValidateBeforeCall(body, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ public ApiResponse createInviteV2WithHttpInfo(NewInvitation body) throws ApiException {
+ okhttp3.Call localVarCall = createInviteV2ValidateBeforeCall(body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
- * 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>
+ * 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.
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1777,16 +1934,15 @@ public ApiResponse createSessionWithHttpInfo(LoginParams body) throws A
| 201 | Created | - |
*/
- public okhttp3.Call createSessionAsync(LoginParams body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createInviteV2Async(NewInvitation body, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = createSessionValidateBeforeCall(body, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ okhttp3.Call localVarCall = createInviteV2ValidateBeforeCall(body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
- * Build call for createStore
- * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * Build call for createPasswordRecoveryEmail
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1794,17 +1950,14 @@ public okhttp3.Call createSessionAsync(LoginParams body, final ApiCallback
| Status Code | Description | Response Headers |
- | 201 | Created | - |
- | 400 | Bad request | - |
- | 409 | Conflict. A store with this integration ID already exists for this application. | - |
+ | 204 | Created | - |
*/
- public okhttp3.Call createStoreCall(Integer applicationId, NewStore body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createPasswordRecoveryEmailCall(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/applications/{applicationId}/stores"
- .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()));
+ String localVarPath = "/v1/password_recovery_emails";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -1830,69 +1983,57 @@ public okhttp3.Call createStoreCall(Integer applicationId, NewStore body, final
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call createStoreValidateBeforeCall(Integer applicationId, NewStore body, 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 createStore(Async)");
- }
+ private okhttp3.Call createPasswordRecoveryEmailValidateBeforeCall(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
- throw new ApiException("Missing the required parameter 'body' when calling createStore(Async)");
+ throw new ApiException("Missing the required parameter 'body' when calling createPasswordRecoveryEmail(Async)");
}
- okhttp3.Call localVarCall = createStoreCall(applicationId, body, _callback);
+ okhttp3.Call localVarCall = createPasswordRecoveryEmailCall(body, _callback);
return localVarCall;
}
/**
- * Create store
- * Create a new store in a specific Application.
- * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * Request a password reset
+ * Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
* @param body body (required)
- * @return Store
+ * @return NewPasswordEmail
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 201 | Created | - |
- | 400 | Bad request | - |
- | 409 | Conflict. A store with this integration ID already exists for this application. | - |
+ | 204 | Created | - |
*/
- public Store createStore(Integer applicationId, NewStore body) throws ApiException {
- ApiResponse localVarResp = createStoreWithHttpInfo(applicationId, body);
+ public NewPasswordEmail createPasswordRecoveryEmail(NewPasswordEmail body) throws ApiException {
+ ApiResponse localVarResp = createPasswordRecoveryEmailWithHttpInfo(body);
return localVarResp.getData();
}
/**
- * Create store
- * Create a new store in a specific Application.
- * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * Request a password reset
+ * Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
* @param body body (required)
- * @return ApiResponse<Store>
+ * @return ApiResponse<NewPasswordEmail>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 201 | Created | - |
- | 400 | Bad request | - |
- | 409 | Conflict. A store with this integration ID already exists for this application. | - |
+ | 204 | Created | - |
*/
- public ApiResponse createStoreWithHttpInfo(Integer applicationId, NewStore body) throws ApiException {
- okhttp3.Call localVarCall = createStoreValidateBeforeCall(applicationId, body, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ public ApiResponse createPasswordRecoveryEmailWithHttpInfo(NewPasswordEmail body) throws ApiException {
+ okhttp3.Call localVarCall = createPasswordRecoveryEmailValidateBeforeCall(body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
- * Create store (asynchronously)
- * Create a new store in a specific Application.
- * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * 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.
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1900,22 +2041,18 @@ public ApiResponse createStoreWithHttpInfo(Integer applicationId, NewStor
* @http.response.details
| Status Code | Description | Response Headers |
- | 201 | Created | - |
- | 400 | Bad request | - |
- | 409 | Conflict. A store with this integration ID already exists for this application. | - |
+ | 204 | Created | - |
*/
- public okhttp3.Call createStoreAsync(Integer applicationId, NewStore body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createPasswordRecoveryEmailAsync(NewPasswordEmail body, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = createStoreValidateBeforeCall(applicationId, body, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ okhttp3.Call localVarCall = createPasswordRecoveryEmailValidateBeforeCall(body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
- * Build call for deductLoyaltyCardPoints
- * @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. (required)
+ * Build call for createSession
* @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1923,19 +2060,14 @@ public okhttp3.Call createStoreAsync(Integer applicationId, NewStore body, final
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | No Content | - |
- | 400 | Bad request | - |
- | 401 | Unauthorized | - |
- | 404 | Not found | - |
+ | 201 | Created | - |
*/
- public okhttp3.Call deductLoyaltyCardPointsCall(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createSessionCall(LoginParams body, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points"
- .replaceAll("\\{" + "loyaltyProgramId" + "\\}", localVarApiClient.escapeString(loyaltyProgramId.toString()))
- .replaceAll("\\{" + "loyaltyCardId" + "\\}", localVarApiClient.escapeString(loyaltyCardId.toString()));
+ String localVarPath = "/v1/sessions";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -1957,80 +2089,187 @@ public okhttp3.Call deductLoyaltyCardPointsCall(Integer loyaltyProgramId, String
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
- return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call deductLoyaltyCardPointsValidateBeforeCall(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call createSessionValidateBeforeCall(LoginParams body, final ApiCallback _callback) throws ApiException {
- // verify the required parameter 'loyaltyProgramId' is set
- if (loyaltyProgramId == null) {
- throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling deductLoyaltyCardPoints(Async)");
+ // verify the required parameter 'body' is set
+ if (body == null) {
+ throw new ApiException("Missing the required parameter 'body' when calling createSession(Async)");
}
- // verify the required parameter 'loyaltyCardId' is set
- if (loyaltyCardId == null) {
- throw new ApiException("Missing the required parameter 'loyaltyCardId' when calling deductLoyaltyCardPoints(Async)");
+
+ okhttp3.Call localVarCall = createSessionCall(body, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * 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>
+ * @param body body (required)
+ * @return Session
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+
+ */
+ public Session createSession(LoginParams body) throws ApiException {
+ ApiResponse localVarResp = createSessionWithHttpInfo(body);
+ return localVarResp.getData();
+ }
+
+ /**
+ * 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>
+ * @param body body (required)
+ * @return ApiResponse<Session>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+
+ */
+ public ApiResponse createSessionWithHttpInfo(LoginParams body) throws ApiException {
+ okhttp3.Call localVarCall = createSessionValidateBeforeCall(body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * 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>
+ * @param body 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
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+
+ */
+ public okhttp3.Call createSessionAsync(LoginParams body, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = createSessionValidateBeforeCall(body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for createStore
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
+ * @param body 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
+
+ | Status Code | Description | Response Headers |
+ | 201 | Created | - |
+ | 400 | Bad request | - |
+ | 409 | Conflict. A store with this integration ID already exists for this application. | - |
+
+ */
+ public okhttp3.Call createStoreCall(Integer applicationId, NewStore body, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = body;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/stores"
+ .replaceAll("\\{" + "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);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call createStoreValidateBeforeCall(Integer applicationId, NewStore body, 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 createStore(Async)");
}
// verify the required parameter 'body' is set
if (body == null) {
- throw new ApiException("Missing the required parameter 'body' when calling deductLoyaltyCardPoints(Async)");
+ throw new ApiException("Missing the required parameter 'body' when calling createStore(Async)");
}
- okhttp3.Call localVarCall = deductLoyaltyCardPointsCall(loyaltyProgramId, loyaltyCardId, body, _callback);
+ okhttp3.Call localVarCall = createStoreCall(applicationId, body, _callback);
return localVarCall;
}
/**
- * Deduct points from card
- * Deduct points from the given loyalty card in the specified card-based loyalty program.
- * @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. (required)
+ * Create store
+ * Create a new store in a specific Application.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
+ * @return Store
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | No Content | - |
+ | 201 | Created | - |
| 400 | Bad request | - |
- | 401 | Unauthorized | - |
- | 404 | Not found | - |
+ | 409 | Conflict. A store with this integration ID already exists for this application. | - |
*/
- public void deductLoyaltyCardPoints(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body) throws ApiException {
- deductLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, body);
+ public Store createStore(Integer applicationId, NewStore body) throws ApiException {
+ ApiResponse localVarResp = createStoreWithHttpInfo(applicationId, body);
+ return localVarResp.getData();
}
/**
- * Deduct points from card
- * Deduct points from the given loyalty card in the specified card-based loyalty program.
- * @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. (required)
+ * Create store
+ * Create a new store in a specific Application.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
- * @return ApiResponse<Void>
+ * @return ApiResponse<Store>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | No Content | - |
+ | 201 | Created | - |
| 400 | Bad request | - |
- | 401 | Unauthorized | - |
- | 404 | Not found | - |
+ | 409 | Conflict. A store with this integration ID already exists for this application. | - |
*/
- public ApiResponse deductLoyaltyCardPointsWithHttpInfo(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body) throws ApiException {
- okhttp3.Call localVarCall = deductLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, body, null);
- return localVarApiClient.execute(localVarCall);
+ public ApiResponse createStoreWithHttpInfo(Integer applicationId, NewStore body) throws ApiException {
+ okhttp3.Call localVarCall = createStoreValidateBeforeCall(applicationId, body, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
- * Deduct points from card (asynchronously)
- * Deduct points from the given loyalty card in the specified card-based loyalty program.
- * @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. (required)
+ * Create store (asynchronously)
+ * Create a new store in a specific Application.
+ * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. (required)
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2038,21 +2277,21 @@ public ApiResponse deductLoyaltyCardPointsWithHttpInfo(Integer loyaltyProg
* @http.response.details
| Status Code | Description | Response Headers |
- | 204 | No Content | - |
+ | 201 | Created | - |
| 400 | Bad request | - |
- | 401 | Unauthorized | - |
- | 404 | Not found | - |
+ | 409 | Conflict. A store with this integration ID already exists for this application. | - |
*/
- public okhttp3.Call deductLoyaltyCardPointsAsync(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createStoreAsync(Integer applicationId, NewStore body, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = deductLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, body, _callback);
- localVarApiClient.executeAsync(localVarCall, _callback);
+ okhttp3.Call localVarCall = createStoreValidateBeforeCall(applicationId, body, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
- * 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)
+ * Build call for deactivateUserByEmail
+ * @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2060,15 +2299,13 @@ public okhttp3.Call deductLoyaltyCardPointsAsync(Integer loyaltyProgramId, Strin
| Status Code | Description | Response Headers |
| 204 | No Content | - |
- | 404 | Not found | - |
*/
- public okhttp3.Call deleteAccountCollectionCall(Integer collectionId, final ApiCallback _callback) throws ApiException {
- Object localVarPostBody = null;
+ public okhttp3.Call deactivateUserByEmailCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/collections/{collectionId}"
- .replaceAll("\\{" + "collectionId" + "\\}", localVarApiClient.escapeString(collectionId.toString()));
+ String localVarPath = "/v1/users/deactivate";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -2076,7 +2313,7 @@ public okhttp3.Call deleteAccountCollectionCall(Integer collectionId, final ApiC
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/json"
+
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
@@ -2084,67 +2321,65 @@ public okhttp3.Call deleteAccountCollectionCall(Integer collectionId, final ApiC
}
final String[] localVarContentTypes = {
-
+ "application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
- return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call deleteAccountCollectionValidateBeforeCall(Integer collectionId, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call deactivateUserByEmailValidateBeforeCall(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException {
- // verify the required parameter 'collectionId' is set
- if (collectionId == null) {
- throw new ApiException("Missing the required parameter 'collectionId' when calling deleteAccountCollection(Async)");
+ // verify the required parameter 'body' is set
+ if (body == null) {
+ throw new ApiException("Missing the required parameter 'body' when calling deactivateUserByEmail(Async)");
}
- okhttp3.Call localVarCall = deleteAccountCollectionCall(collectionId, _callback);
+ okhttp3.Call localVarCall = deactivateUserByEmailCall(body, _callback);
return localVarCall;
}
/**
- * 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)
+ * Deactivate user by email address
+ * Deactivate a specific user by their email address.
+ * @param body body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
| 204 | No Content | - |
- | 404 | Not found | - |
*/
- public void deleteAccountCollection(Integer collectionId) throws ApiException {
- deleteAccountCollectionWithHttpInfo(collectionId);
+ public void deactivateUserByEmail(DeactivateUserRequest body) throws ApiException {
+ deactivateUserByEmailWithHttpInfo(body);
}
/**
- * 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)
+ * Deactivate user by email address
+ * Deactivate a specific user by their email address.
+ * @param body body (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
| Status Code | Description | Response Headers |
| 204 | No Content | - |
- | 404 | Not found | - |
*/
- public ApiResponse deleteAccountCollectionWithHttpInfo(Integer collectionId) throws ApiException {
- okhttp3.Call localVarCall = deleteAccountCollectionValidateBeforeCall(collectionId, null);
+ public ApiResponse deactivateUserByEmailWithHttpInfo(DeactivateUserRequest body) throws ApiException {
+ okhttp3.Call localVarCall = deactivateUserByEmailValidateBeforeCall(body, null);
return localVarApiClient.execute(localVarCall);
}
/**
- * 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)
+ * Deactivate user by email address (asynchronously)
+ * Deactivate a specific user by their email address.
+ * @param body 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
@@ -2152,19 +2387,19 @@ public ApiResponse deleteAccountCollectionWithHttpInfo(Integer collectionI
| Status Code | Description | Response Headers |
| 204 | No Content | - |
- | 404 | Not found | - |
*/
- public okhttp3.Call deleteAccountCollectionAsync(Integer collectionId, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deactivateUserByEmailAsync(DeactivateUserRequest body, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = deleteAccountCollectionValidateBeforeCall(collectionId, _callback);
+ okhttp3.Call localVarCall = deactivateUserByEmailValidateBeforeCall(body, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
- * Build call for deleteCampaign
- * @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)
+ * Build call for deductLoyaltyCardPoints
+ * @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. (required)
+ * @param body body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2172,15 +2407,18 @@ public okhttp3.Call deleteAccountCollectionAsync(Integer collectionId, final Api
| Status Code | Description | Response Headers |
| 204 | No Content | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
*/
- public okhttp3.Call deleteCampaignCall(Integer applicationId, Integer campaignId, final ApiCallback _callback) throws ApiException {
- Object localVarPostBody = null;
+ public okhttp3.Call deductLoyaltyCardPointsCall(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = body;
// create path and map variables
- String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}"
- .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
- .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()));
+ String localVarPath = "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points"
+ .replaceAll("\\{" + "loyaltyProgramId" + "\\}", localVarApiClient.escapeString(loyaltyProgramId.toString()))
+ .replaceAll("\\{" + "loyaltyCardId" + "\\}", localVarApiClient.escapeString(loyaltyCardId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
@@ -2188,7 +2426,7 @@ public okhttp3.Call deleteCampaignCall(Integer applicationId, Integer campaignId
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
-
+ "application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
@@ -2196,73 +2434,1055 @@ public okhttp3.Call deleteCampaignCall(Integer applicationId, Integer campaignId
}
final String[] localVarContentTypes = {
-
+ "application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
- return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call deleteCampaignValidateBeforeCall(Integer applicationId, Integer campaignId, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call deductLoyaltyCardPointsValidateBeforeCall(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+
+ // verify the required parameter 'loyaltyProgramId' is set
+ if (loyaltyProgramId == null) {
+ throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling deductLoyaltyCardPoints(Async)");
+ }
+
+ // verify the required parameter 'loyaltyCardId' is set
+ if (loyaltyCardId == null) {
+ throw new ApiException("Missing the required parameter 'loyaltyCardId' when calling deductLoyaltyCardPoints(Async)");
+ }
+
+ // verify the required parameter 'body' is set
+ if (body == null) {
+ throw new ApiException("Missing the required parameter 'body' when calling deductLoyaltyCardPoints(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deductLoyaltyCardPointsCall(loyaltyProgramId, loyaltyCardId, body, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Deduct points from card
+ * Deduct points from the given loyalty card in the specified card-based loyalty program.
+ * @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. (required)
+ * @param body body (required)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public void deductLoyaltyCardPoints(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body) throws ApiException {
+ deductLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, body);
+ }
+
+ /**
+ * Deduct points from card
+ * Deduct points from the given loyalty card in the specified card-based loyalty program.
+ * @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. (required)
+ * @param body body (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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public ApiResponse deductLoyaltyCardPointsWithHttpInfo(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body) throws ApiException {
+ okhttp3.Call localVarCall = deductLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, body, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Deduct points from card (asynchronously)
+ * Deduct points from the given loyalty card in the specified card-based loyalty program.
+ * @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. (required)
+ * @param body 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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 400 | Bad request | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deductLoyaltyCardPointsAsync(Integer loyaltyProgramId, String loyaltyCardId, DeductLoyaltyPoints body, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deductLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, body, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * 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 _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deleteAccountCollectionCall(Integer collectionId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/collections/{collectionId}"
+ .replaceAll("\\{" + "collectionId" + "\\}", localVarApiClient.escapeString(collectionId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+ "application/json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteAccountCollectionValidateBeforeCall(Integer collectionId, final ApiCallback _callback) throws ApiException {
+
+ // verify the required parameter 'collectionId' is set
+ if (collectionId == null) {
+ throw new ApiException("Missing the required parameter 'collectionId' when calling deleteAccountCollection(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteAccountCollectionCall(collectionId, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * 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)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 404 | Not found | - |
+
+ */
+ public void deleteAccountCollection(Integer collectionId) throws ApiException {
+ deleteAccountCollectionWithHttpInfo(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)
+ * @return ApiResponse<Void>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 404 | Not found | - |
+
+ */
+ public ApiResponse deleteAccountCollectionWithHttpInfo(Integer collectionId) throws ApiException {
+ okhttp3.Call localVarCall = deleteAccountCollectionValidateBeforeCall(collectionId, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * 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 _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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deleteAccountCollectionAsync(Integer collectionId, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteAccountCollectionValidateBeforeCall(collectionId, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteAchievement
+ * @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 achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. (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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deleteAchievementCall(Integer applicationId, Integer campaignId, Integer achievementId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()))
+ .replaceAll("\\{" + "achievementId" + "\\}", localVarApiClient.escapeString(achievementId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+ "application/json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteAchievementValidateBeforeCall(Integer applicationId, Integer campaignId, Integer achievementId, 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 deleteAchievement(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling deleteAchievement(Async)");
+ }
+
+ // verify the required parameter 'achievementId' is set
+ if (achievementId == null) {
+ throw new ApiException("Missing the required parameter 'achievementId' when calling deleteAchievement(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteAchievementCall(applicationId, campaignId, achievementId, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Delete achievement
+ * Delete the specified achievement.
+ * @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 achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. (required)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public void deleteAchievement(Integer applicationId, Integer campaignId, Integer achievementId) throws ApiException {
+ deleteAchievementWithHttpInfo(applicationId, campaignId, achievementId);
+ }
+
+ /**
+ * Delete achievement
+ * Delete the specified achievement.
+ * @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 achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) 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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public ApiResponse deleteAchievementWithHttpInfo(Integer applicationId, Integer campaignId, Integer achievementId) throws ApiException {
+ okhttp3.Call localVarCall = deleteAchievementValidateBeforeCall(applicationId, campaignId, achievementId, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Delete achievement (asynchronously)
+ * Delete the specified achievement.
+ * @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 achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) 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
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deleteAchievementAsync(Integer applicationId, Integer campaignId, Integer achievementId, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteAchievementValidateBeforeCall(applicationId, campaignId, achievementId, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteCampaign
+ * @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 Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCampaignCall(Integer applicationId, Integer campaignId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteCampaignValidateBeforeCall(Integer applicationId, Integer campaignId, 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 deleteCampaign(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling deleteCampaign(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteCampaignCall(applicationId, campaignId, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Delete campaign
+ * Delete 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)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public void deleteCampaign(Integer applicationId, Integer campaignId) throws ApiException {
+ deleteCampaignWithHttpInfo(applicationId, campaignId);
+ }
+
+ /**
+ * Delete campaign
+ * Delete 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)
+ * @return ApiResponse<Void>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public ApiResponse deleteCampaignWithHttpInfo(Integer applicationId, Integer campaignId) throws ApiException {
+ okhttp3.Call localVarCall = deleteCampaignValidateBeforeCall(applicationId, campaignId, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Delete campaign (asynchronously)
+ * Delete 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 _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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCampaignAsync(Integer applicationId, Integer campaignId, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteCampaignValidateBeforeCall(applicationId, campaignId, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * 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 _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+
+ */
+ public okhttp3.Call deleteCollectionCall(Integer applicationId, Integer campaignId, Integer collectionId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()))
+ .replaceAll("\\{" + "collectionId" + "\\}", localVarApiClient.escapeString(collectionId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+ "application/json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteCollectionValidateBeforeCall(Integer applicationId, Integer campaignId, Integer collectionId, 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 deleteCollection(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling deleteCollection(Async)");
+ }
+
+ // verify the required parameter 'collectionId' is set
+ if (collectionId == null) {
+ throw new ApiException("Missing the required parameter 'collectionId' when calling deleteCollection(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteCollectionCall(applicationId, campaignId, collectionId, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Delete campaign-level collection
+ * 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)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+
+ */
+ public void deleteCollection(Integer applicationId, Integer campaignId, Integer collectionId) throws ApiException {
+ deleteCollectionWithHttpInfo(applicationId, campaignId, collectionId);
+ }
+
+ /**
+ * Delete campaign-level collection
+ * 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)
+ * @return ApiResponse<Void>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+
+ */
+ public ApiResponse deleteCollectionWithHttpInfo(Integer applicationId, Integer campaignId, Integer collectionId) throws ApiException {
+ okhttp3.Call localVarCall = deleteCollectionValidateBeforeCall(applicationId, campaignId, collectionId, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Delete campaign-level collection (asynchronously)
+ * 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 _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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+
+ */
+ public okhttp3.Call deleteCollectionAsync(Integer applicationId, Integer campaignId, Integer collectionId, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteCollectionValidateBeforeCall(applicationId, campaignId, collectionId, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteCoupon
+ * @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)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCouponCall(Integer applicationId, Integer campaignId, String couponId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()))
+ .replaceAll("\\{" + "couponId" + "\\}", localVarApiClient.escapeString(couponId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteCouponValidateBeforeCall(Integer applicationId, Integer campaignId, String couponId, 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 deleteCoupon(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling deleteCoupon(Async)");
+ }
+
+ // verify the required parameter 'couponId' is set
+ if (couponId == null) {
+ throw new ApiException("Missing the required parameter 'couponId' when calling deleteCoupon(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteCouponCall(applicationId, campaignId, couponId, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Delete coupon
+ * Delete the specified coupon.
+ * @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)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public void deleteCoupon(Integer applicationId, Integer campaignId, String couponId) throws ApiException {
+ deleteCouponWithHttpInfo(applicationId, campaignId, couponId);
+ }
+
+ /**
+ * Delete coupon
+ * Delete the specified coupon.
+ * @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)
+ * @return ApiResponse<Void>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public ApiResponse deleteCouponWithHttpInfo(Integer applicationId, Integer campaignId, String couponId) throws ApiException {
+ okhttp3.Call localVarCall = deleteCouponValidateBeforeCall(applicationId, campaignId, couponId, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Delete coupon (asynchronously)
+ * Delete the specified coupon.
+ * @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)
+ * @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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCouponAsync(Integer applicationId, Integer campaignId, String couponId, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteCouponValidateBeforeCall(applicationId, campaignId, couponId, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteCoupons
+ * @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 value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional)
+ * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. (optional)
+ * @param batchId Filter results by batches of coupons (optional)
+ * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional)
+ * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional)
+ * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional)
+ * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCouponsCall(Integer applicationId, Integer campaignId, String value, OffsetDateTime createdBefore, OffsetDateTime createdAfter, OffsetDateTime startsAfter, OffsetDateTime startsBefore, OffsetDateTime expiresAfter, OffsetDateTime expiresBefore, String valid, String batchId, String usable, Integer referralId, String recipientIntegrationId, Boolean exactMatch, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons"
+ .replaceAll("\\{" + "applicationId" + "\\}", localVarApiClient.escapeString(applicationId.toString()))
+ .replaceAll("\\{" + "campaignId" + "\\}", localVarApiClient.escapeString(campaignId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ if (value != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("value", value));
+ }
+
+ if (createdBefore != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("createdBefore", createdBefore));
+ }
+
+ if (createdAfter != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("createdAfter", createdAfter));
+ }
+
+ if (startsAfter != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("startsAfter", startsAfter));
+ }
+
+ if (startsBefore != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("startsBefore", startsBefore));
+ }
+
+ if (expiresAfter != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("expiresAfter", expiresAfter));
+ }
+
+ if (expiresBefore != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("expiresBefore", expiresBefore));
+ }
+
+ if (valid != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("valid", valid));
+ }
+
+ if (batchId != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("batchId", batchId));
+ }
+
+ if (usable != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("usable", usable));
+ }
+
+ if (referralId != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("referralId", referralId));
+ }
+
+ if (recipientIntegrationId != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("recipientIntegrationId", recipientIntegrationId));
+ }
+
+ if (exactMatch != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("exactMatch", exactMatch));
+ }
+
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteCouponsValidateBeforeCall(Integer applicationId, Integer campaignId, String value, OffsetDateTime createdBefore, OffsetDateTime createdAfter, OffsetDateTime startsAfter, OffsetDateTime startsBefore, OffsetDateTime expiresAfter, OffsetDateTime expiresBefore, String valid, String batchId, String usable, Integer referralId, String recipientIntegrationId, Boolean exactMatch, 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 deleteCampaign(Async)");
+ throw new ApiException("Missing the required parameter 'applicationId' when calling deleteCoupons(Async)");
+ }
+
+ // verify the required parameter 'campaignId' is set
+ if (campaignId == null) {
+ throw new ApiException("Missing the required parameter 'campaignId' when calling deleteCoupons(Async)");
+ }
+
+
+ okhttp3.Call localVarCall = deleteCouponsCall(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch, _callback);
+ return localVarCall;
+
+ }
+
+ /**
+ * Delete coupons
+ * Deletes all the coupons matching the specified criteria.
+ * @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 value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional)
+ * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. (optional)
+ * @param batchId Filter results by batches of coupons (optional)
+ * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional)
+ * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional)
+ * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional)
+ * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false)
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public void deleteCoupons(Integer applicationId, Integer campaignId, String value, OffsetDateTime createdBefore, OffsetDateTime createdAfter, OffsetDateTime startsAfter, OffsetDateTime startsBefore, OffsetDateTime expiresAfter, OffsetDateTime expiresBefore, String valid, String batchId, String usable, Integer referralId, String recipientIntegrationId, Boolean exactMatch) throws ApiException {
+ deleteCouponsWithHttpInfo(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch);
+ }
+
+ /**
+ * Delete coupons
+ * Deletes all the coupons matching the specified criteria.
+ * @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 value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional)
+ * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. (optional)
+ * @param batchId Filter results by batches of coupons (optional)
+ * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional)
+ * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional)
+ * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional)
+ * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false)
+ * @return ApiResponse<Void>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public ApiResponse deleteCouponsWithHttpInfo(Integer applicationId, Integer campaignId, String value, OffsetDateTime createdBefore, OffsetDateTime createdAfter, OffsetDateTime startsAfter, OffsetDateTime startsBefore, OffsetDateTime expiresAfter, OffsetDateTime expiresBefore, String valid, String batchId, String usable, Integer referralId, String recipientIntegrationId, Boolean exactMatch) throws ApiException {
+ okhttp3.Call localVarCall = deleteCouponsValidateBeforeCall(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch, null);
+ return localVarApiClient.execute(localVarCall);
+ }
+
+ /**
+ * Delete coupons (asynchronously)
+ * Deletes all the coupons matching the specified criteria.
+ * @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 value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. (optional)
+ * @param createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional)
+ * @param valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. (optional)
+ * @param batchId Filter results by batches of coupons (optional)
+ * @param usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional)
+ * @param referralId Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional)
+ * @param recipientIntegrationId Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional)
+ * @param exactMatch Filter results to an exact case-insensitive matching against the coupon code (optional, default to false)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+
+ */
+ public okhttp3.Call deleteCouponsAsync(Integer applicationId, Integer campaignId, String value, OffsetDateTime createdBefore, OffsetDateTime createdAfter, OffsetDateTime startsAfter, OffsetDateTime startsBefore, OffsetDateTime expiresAfter, OffsetDateTime expiresBefore, String valid, String batchId, String usable, Integer referralId, String recipientIntegrationId, Boolean exactMatch, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteCouponsValidateBeforeCall(applicationId, campaignId, value, createdBefore, createdAfter, startsAfter, startsBefore, expiresAfter, expiresBefore, valid, batchId, usable, referralId, recipientIntegrationId, exactMatch, _callback);
+ localVarApiClient.executeAsync(localVarCall, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteLoyaltyCard
+ * @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. (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
+
+ | Status Code | Description | Response Headers |
+ | 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
+
+ */
+ public okhttp3.Call deleteLoyaltyCardCall(Integer loyaltyProgramId, String loyaltyCardId, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}"
+ .replaceAll("\\{" + "loyaltyProgramId" + "\\}", localVarApiClient.escapeString(loyaltyProgramId.toString()))
+ .replaceAll("\\{" + "loyaltyCardId" + "\\}", localVarApiClient.escapeString(loyaltyCardId.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+ final String[] localVarAccepts = {
+ "application/json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+
+ String[] localVarAuthNames = new String[] { "management_key", "manager_auth" };
+ return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteLoyaltyCardValidateBeforeCall(Integer loyaltyProgramId, String loyaltyCardId, final ApiCallback _callback) throws ApiException {
+
+ // verify the required parameter 'loyaltyProgramId' is set
+ if (loyaltyProgramId == null) {
+ throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling deleteLoyaltyCard(Async)");
}
- // verify the required parameter 'campaignId' is set
- if (campaignId == null) {
- throw new ApiException("Missing the required parameter 'campaignId' when calling deleteCampaign(Async)");
+ // verify the required parameter 'loyaltyCardId' is set
+ if (loyaltyCardId == null) {
+ throw new ApiException("Missing the required parameter 'loyaltyCardId' when calling deleteLoyaltyCard(Async)");
}
- okhttp3.Call localVarCall = deleteCampaignCall(applicationId, campaignId, _callback);
+ okhttp3.Call localVarCall = deleteLoyaltyCardCall(loyaltyProgramId, loyaltyCardId, _callback);
return localVarCall;
}
/**
- * Delete campaign
- * Delete 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)
+ * Delete loyalty card
+ * Delete the given loyalty card.
+ * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
+ * @param 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. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
| Status Code | Description | Response Headers |
| 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
*/
- public void deleteCampaign(Integer applicationId, Integer campaignId) throws ApiException {
- deleteCampaignWithHttpInfo(applicationId, campaignId);
+ public void deleteLoyaltyCard(Integer loyaltyProgramId, String loyaltyCardId) throws ApiException {
+ deleteLoyaltyCardWithHttpInfo(loyaltyProgramId, loyaltyCardId);
}
/**
- * Delete campaign
- * Delete 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)
+ * Delete loyalty card
+ * Delete the given loyalty card.
+ * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
+ * @param 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. (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
| Status Code | Description | Response Headers |
| 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
*/
- public ApiResponse deleteCampaignWithHttpInfo(Integer applicationId, Integer campaignId) throws ApiException {
- okhttp3.Call localVarCall = deleteCampaignValidateBeforeCall(applicationId, campaignId, null);
+ public ApiResponse deleteLoyaltyCardWithHttpInfo(Integer loyaltyProgramId, String loyaltyCardId) throws ApiException {
+ okhttp3.Call localVarCall = deleteLoyaltyCardValidateBeforeCall(loyaltyProgramId, loyaltyCardId, null);
return localVarApiClient.execute(localVarCall);
}
/**
- * Delete campaign (asynchronously)
- * Delete 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)
+ * Delete loyalty card (asynchronously)
+ * Delete the given loyalty card.
+ * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
+ * @param 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. (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
@@ -2270,19 +3490,21 @@ public ApiResponse deleteCampaignWithHttpInfo(Integer applicationId, Integ
| Status Code | Description | Response Headers |
| 204 | No Content | - |
+ | 401 | Unauthorized | - |
+ | 404 | Not found | - |
*/
- public okhttp3.Call deleteCampaignAsync(Integer applicationId, Integer campaignId, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deleteLoyaltyCardAsync(Integer loyaltyProgramId, String loyaltyCardId, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = deleteCampaignValidateBeforeCall(applicationId, campaignId, _callback);
+ okhttp3.Call localVarCall = deleteLoyaltyCardValidateBeforeCall(loyaltyProgramId, loyaltyCardId, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
- * Build call for deleteCollection
+ * Build call for deleteReferral
* @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 referralId The ID of the referral code. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2290,17 +3512,16 @@ public okhttp3.Call deleteCampaignAsync(Integer applicationId, Integer campaignI